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  * Hash table of builtin apps by name
  33  */
  34 static uword *app_by_name;
  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 static u8 *
  52 app_get_name (application_t * app)
  53 {
  54   if (!app->name)
  55     return app_get_name_from_reg_index (app);
  56   return app->name;
  57 }
  58
  59 u32
  60 application_session_table (application_t * app, u8 fib_proto)
  61 {
  62   app_namespace_t *app_ns;
  63   app_ns = app_namespace_get (app->ns_index);
  64   if (!application_has_global_scope (app))
  65     return APP_INVALID_INDEX;
  66   if (fib_proto == FIB_PROTOCOL_IP4)
  67     return session_lookup_get_index_for_fib (fib_proto,
  68                                              app_ns->ip4_fib_index);
  69   else
  70     return session_lookup_get_index_for_fib (fib_proto,
  71                                              app_ns->ip6_fib_index);
  72 }
  73
  74 u32
  75 application_local_session_table (application_t * app)
  76 {
  77   app_namespace_t *app_ns;
  78   if (!application_has_local_scope (app))
  79     return APP_INVALID_INDEX;
  80   app_ns = app_namespace_get (app->ns_index);
  81   return app_ns->local_table_index;
  82 }
  83
  84 int
  85 application_api_queue_is_full (application_t * app)
  86 {
  87   svm_queue_t *q;
  88
  89   /* builtin servers are always OK */
  90   if (app->api_client_index == ~0)
  91     return 0;
  92
  93   q = vl_api_client_index_to_input_queue (app->api_client_index);
  94   if (!q)
  95     return 1;
  96
  97   if (q->cursize == q->maxsize)
  98     return 1;
  99   return 0;
 100 }
 101
 102 /**
 103  * Returns app name
 104  *
 105  * Since the name is not stored per app, we generate it on the fly. It is
 106  * the caller's responsibility to free the vector
 107  */
 108 u8 *
 109 application_name_from_index (u32 app_index)
 110 {
 111   application_t *app = application_get (app_index);
 112   if (!app)
 113     return 0;
 114   return app_get_name_from_reg_index (app);
 115 }
 116
 117 static void
 118 application_table_add (application_t * app)
 119 {
 120   if (app->api_client_index != APP_INVALID_INDEX)
 121     hash_set (app_by_api_client_index, app->api_client_index, app->index);
 122   else if (app->name)
 123     hash_set_mem (app_by_name, app->name, app->index);
 124 }
 125
 126 static void
 127 application_table_del (application_t * app)
 128 {
 129   if (app->api_client_index != APP_INVALID_INDEX)
 130     hash_unset (app_by_api_client_index, app->api_client_index);
 131   else if (app->name)
 132     hash_unset_mem (app_by_name, app->name);
 133 }
 134
 135 application_t *
 136 application_lookup (u32 api_client_index)
 137 {
 138   uword *p;
 139   p = hash_get (app_by_api_client_index, api_client_index);
 140   if (p)
 141     return application_get (p[0]);
 142
 143   return 0;
 144 }
 145
 146 application_t *
 147 application_lookup_name (const u8 * name)
 148 {
 149   uword *p;
 150   p = hash_get_mem (app_by_name, name);
 151   if (p)
 152     return application_get (p[0]);
 153
 154   return 0;
 155 }
 156
 157 application_t *
 158 application_new ()
 159 {
 160   application_t *app;
 161   pool_get (app_pool, app);
 162   memset (app, 0, sizeof (*app));
 163   app->index = application_get_index (app);
 164   app->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
 165   app->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
 166   app->local_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
 167   if (CLIB_DEBUG > 1)
 168     clib_warning ("[%d] New app (%d)", getpid (), app->index);
 169   return app;
 170 }
 171
 172 void
 173 application_del (application_t * app)
 174 {
 175   vnet_unbind_args_t _a, *a = &_a;
 176   u64 handle, *handles = 0;
 177   segment_manager_t *sm;
 178   u32 index;
 179   int i;
 180
 181   /*
 182    * The app event queue allocated in first segment is cleared with
 183    * the segment manager. No need to explicitly free it.
 184    */
 185   if (CLIB_DEBUG > 1)
 186     clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
 187
 188   if (application_is_proxy (app))
 189     application_remove_proxy (app);
 190
 191   /*
 192    *  Listener cleanup
 193    */
 194
 195   /* *INDENT-OFF* */
 196   hash_foreach (handle, index, app->listeners_table,
 197   ({
 198     vec_add1 (handles, handle);
 199     sm = segment_manager_get (index);
 200     sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
 201   }));
 202   /* *INDENT-ON* */
 203
 204   for (i = 0; i < vec_len (handles); i++)
 205     {
 206       a->app_index = app->index;
 207       a->handle = handles[i];
 208       /* seg manager is removed when unbind completes */
 209       vnet_unbind (a);
 210     }
 211
 212   /*
 213    * Connects segment manager cleanup
 214    */
 215
 216   if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
 217     {
 218       sm = segment_manager_get (app->connects_seg_manager);
 219       sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
 220       segment_manager_init_del (sm);
 221     }
 222
 223   /* If first segment manager is used by a listener */
 224   if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
 225       && app->first_segment_manager != app->connects_seg_manager)
 226     {
 227       sm = segment_manager_get (app->first_segment_manager);
 228       /* .. and has no fifos, e.g. it might be used for redirected sessions,
 229        * remove it */
 230       if (!segment_manager_has_fifos (sm))
 231         {
 232           sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
 233           segment_manager_del (sm);
 234         }
 235     }
 236
 237   /*
 238    * Local connections cleanup
 239    */
 240   application_local_sessions_del (app);
 241
 242   vec_free (app->tls_cert);
 243   vec_free (app->tls_key);
 244
 245   application_table_del (app);
 246   vec_free (app->name);
 247   pool_put (app_pool, app);
 248 }
 249
 250 static void
 251 application_verify_cb_fns (session_cb_vft_t * cb_fns)
 252 {
 253   if (cb_fns->session_accept_callback == 0)
 254     clib_warning ("No accept callback function provided");
 255   if (cb_fns->session_connected_callback == 0)
 256     clib_warning ("No session connected callback function provided");
 257   if (cb_fns->session_disconnect_callback == 0)
 258     clib_warning ("No session disconnect callback function provided");
 259   if (cb_fns->session_reset_callback == 0)
 260     clib_warning ("No session reset callback function provided");
 261 }
 262
 263 /**
 264  * Check app config for given segment type
 265  *
 266  * Returns 1 on success and 0 otherwise
 267  */
 268 static u8
 269 application_verify_cfg (ssvm_segment_type_t st)
 270 {
 271   u8 is_valid;
 272   if (st == SSVM_SEGMENT_MEMFD)
 273     {
 274       is_valid = (session_manager_get_evt_q_segment () != 0);
 275       if (!is_valid)
 276         clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
 277       return is_valid;
 278     }
 279   else if (st == SSVM_SEGMENT_SHM)
 280     {
 281       is_valid = (session_manager_get_evt_q_segment () == 0);
 282       if (!is_valid)
 283         clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
 284       return is_valid;
 285     }
 286   else
 287     return 1;
 288 }
 289
 290 int
 291 application_init (application_t * app, u32 api_client_index, u8 * app_name,
 292                   u64 * options, session_cb_vft_t * cb_fns)
 293 {
 294   ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
 295   u32 first_seg_size, prealloc_fifo_pairs;
 296   segment_manager_properties_t *props;
 297   vl_api_registration_t *reg;
 298   segment_manager_t *sm;
 299   int rv;
 300
 301   /*
 302    * Make sure we support the requested configuration
 303    */
 304
 305   if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
 306     {
 307       reg = vl_api_client_index_to_registration (api_client_index);
 308       if (!reg)
 309         return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 310       if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 311         seg_type = SSVM_SEGMENT_SHM;
 312     }
 313   else
 314     {
 315       seg_type = SSVM_SEGMENT_PRIVATE;
 316     }
 317
 318   if (!application_verify_cfg (seg_type))
 319     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 320
 321   /*
 322    * Setup segment manager
 323    */
 324   sm = segment_manager_new ();
 325   sm->app_index = app->index;
 326   props = application_segment_manager_properties (app);
 327   segment_manager_properties_init (props);
 328   if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
 329     {
 330       props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
 331       props->add_segment = 1;
 332     }
 333   if (options[APP_OPTIONS_RX_FIFO_SIZE])
 334     props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
 335   if (options[APP_OPTIONS_TX_FIFO_SIZE])
 336     props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
 337   if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
 338     props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
 339   if (options[APP_OPTIONS_TLS_ENGINE])
 340     app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
 341   props->segment_type = seg_type;
 342
 343   first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
 344   prealloc_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
 345
 346   if ((rv = segment_manager_init (sm, first_seg_size, prealloc_fifo_pairs)))
 347     return rv;
 348   sm->first_is_protected = 1;
 349
 350   /*
 351    * Setup application
 352    */
 353   app->first_segment_manager = segment_manager_index (sm);
 354   app->api_client_index = api_client_index;
 355   app->flags = options[APP_OPTIONS_FLAGS];
 356   app->cb_fns = *cb_fns;
 357   app->ns_index = options[APP_OPTIONS_NAMESPACE];
 358   app->listeners_table = hash_create (0, sizeof (u64));
 359   app->local_connects = hash_create (0, sizeof (u64));
 360   app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
 361   app->event_queue = segment_manager_event_queue (sm);
 362   app->name = vec_dup (app_name);
 363
 364   /* If no scope enabled, default to global */
 365   if (!application_has_global_scope (app)
 366       && !application_has_local_scope (app))
 367     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 368
 369   /* Check that the obvious things are properly set up */
 370   application_verify_cb_fns (cb_fns);
 371
 372   /* Add app to lookup by api_client_index table */
 373   application_table_add (app);
 374
 375   /*
 376    * Segment manager for local sessions
 377    */
 378   sm = segment_manager_new ();
 379   sm->app_index = app->index;
 380   app->local_segment_manager = segment_manager_index (sm);
 381
 382   return 0;
 383 }
 384
 385 application_t *
 386 application_get (u32 index)
 387 {
 388   if (index == APP_INVALID_INDEX)
 389     return 0;
 390   return pool_elt_at_index (app_pool, index);
 391 }
 392
 393 application_t *
 394 application_get_if_valid (u32 index)
 395 {
 396   if (pool_is_free_index (app_pool, index))
 397     return 0;
 398
 399   return pool_elt_at_index (app_pool, index);
 400 }
 401
 402 u32
 403 application_get_index (application_t * app)
 404 {
 405   return app - app_pool;
 406 }
 407
 408 static segment_manager_t *
 409 application_alloc_segment_manager (application_t * app)
 410 {
 411   segment_manager_t *sm = 0;
 412
 413   /* If the first segment manager is not in use, don't allocate a new one */
 414   if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
 415       && app->first_segment_manager_in_use == 0)
 416     {
 417       sm = segment_manager_get (app->first_segment_manager);
 418       app->first_segment_manager_in_use = 1;
 419       return sm;
 420     }
 421
 422   sm = segment_manager_new ();
 423   sm->app_index = app->index;
 424
 425   return sm;
 426 }
 427
 428 /**
 429  * Start listening local transport endpoint for requested transport.
 430  *
 431  * Creates a 'dummy' stream session with state LISTENING to be used in session
 432  * lookups, prior to establishing connection. Requests transport to build
 433  * it's own specific listening connection.
 434  */
 435 int
 436 application_start_listen (application_t * srv, session_endpoint_t * sep,
 437                           session_handle_t * res)
 438 {
 439   segment_manager_t *sm;
 440   stream_session_t *s;
 441   session_handle_t handle;
 442   session_type_t sst;
 443
 444   sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
 445   s = listen_session_new (0, sst);
 446   s->app_index = srv->index;
 447
 448   /* Allocate segment manager. All sessions derived out of a listen session
 449    * have fifos allocated by the same segment manager. */
 450   if (!(sm = application_alloc_segment_manager (srv)))
 451     goto err;
 452
 453   /* Add to app's listener table. Useful to find all child listeners
 454    * when app goes down, although, just for unbinding this is not needed */
 455   handle = listen_session_get_handle (s);
 456   hash_set (srv->listeners_table, handle, segment_manager_index (sm));
 457
 458   if (stream_session_listen (s, sep))
 459     {
 460       segment_manager_del (sm);
 461       hash_unset (srv->listeners_table, handle);
 462       goto err;
 463     }
 464
 465   *res = handle;
 466   return 0;
 467
 468 err:
 469   listen_session_del (s);
 470   return -1;
 471 }
 472
 473 /**
 474  * Stop listening on session associated to handle
 475  */
 476 int
 477 application_stop_listen (application_t * srv, session_handle_t handle)
 478 {
 479   stream_session_t *listener;
 480   uword *indexp;
 481   segment_manager_t *sm;
 482
 483   if (srv && hash_get (srv->listeners_table, handle) == 0)
 484     {
 485       clib_warning ("app doesn't own handle %llu!", handle);
 486       return -1;
 487     }
 488
 489   listener = listen_session_get_from_handle (handle);
 490   stream_session_stop_listen (listener);
 491
 492   indexp = hash_get (srv->listeners_table, handle);
 493   ASSERT (indexp);
 494
 495   sm = segment_manager_get (*indexp);
 496   if (srv->first_segment_manager == *indexp)
 497     {
 498       /* Delete sessions but don't remove segment manager */
 499       srv->first_segment_manager_in_use = 0;
 500       segment_manager_del_sessions (sm);
 501     }
 502   else
 503     {
 504       segment_manager_init_del (sm);
 505     }
 506   hash_unset (srv->listeners_table, handle);
 507   listen_session_del (listener);
 508
 509   return 0;
 510 }
 511
 512 int
 513 application_open_session (application_t * app, session_endpoint_t * sep,
 514                           u32 api_context)
 515 {
 516   int rv;
 517
 518   /* Make sure we have a segment manager for connects */
 519   application_alloc_connects_segment_manager (app);
 520
 521   if ((rv = session_open (app->index, sep, api_context)))
 522     return rv;
 523
 524   return 0;
 525 }
 526
 527 int
 528 application_alloc_connects_segment_manager (application_t * app)
 529 {
 530   segment_manager_t *sm;
 531
 532   if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
 533     {
 534       sm = application_alloc_segment_manager (app);
 535       if (sm == 0)
 536         return -1;
 537       app->connects_seg_manager = segment_manager_index (sm);
 538     }
 539   return 0;
 540 }
 541
 542 segment_manager_t *
 543 application_get_connect_segment_manager (application_t * app)
 544 {
 545   ASSERT (app->connects_seg_manager != (u32) ~ 0);
 546   return segment_manager_get (app->connects_seg_manager);
 547 }
 548
 549 segment_manager_t *
 550 application_get_listen_segment_manager (application_t * app,
 551                                         stream_session_t * s)
 552 {
 553   uword *smp;
 554   smp = hash_get (app->listeners_table, listen_session_get_handle (s));
 555   ASSERT (smp != 0);
 556   return segment_manager_get (*smp);
 557 }
 558
 559 segment_manager_t *
 560 application_get_local_segment_manager (application_t * app)
 561 {
 562   return segment_manager_get (app->local_segment_manager);
 563 }
 564
 565 segment_manager_t *
 566 application_get_local_segment_manager_w_session (application_t * app,
 567                                                  local_session_t * ls)
 568 {
 569   stream_session_t *listener;
 570   if (application_local_session_listener_has_transport (ls))
 571     {
 572       listener = listen_session_get (ls->listener_index);
 573       return application_get_listen_segment_manager (app, listener);
 574     }
 575   return segment_manager_get (app->local_segment_manager);
 576 }
 577
 578 int
 579 application_is_proxy (application_t * app)
 580 {
 581   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
 582 }
 583
 584 int
 585 application_is_builtin (application_t * app)
 586 {
 587   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
 588 }
 589
 590 int
 591 application_is_builtin_proxy (application_t * app)
 592 {
 593   return (application_is_proxy (app) && application_is_builtin (app));
 594 }
 595
 596 /**
 597  * Send an API message to the external app, to map new segment
 598  */
 599 int
 600 application_add_segment_notify (u32 app_index, ssvm_private_t * fs)
 601 {
 602   application_t *app = application_get (app_index);
 603   return app->cb_fns.add_segment_callback (app->api_client_index, fs);
 604 }
 605
 606 u8
 607 application_has_local_scope (application_t * app)
 608 {
 609   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
 610 }
 611
 612 u8
 613 application_has_global_scope (application_t * app)
 614 {
 615   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 616 }
 617
 618 u32
 619 application_n_listeners (application_t * app)
 620 {
 621   return hash_elts (app->listeners_table);
 622 }
 623
 624 stream_session_t *
 625 application_first_listener (application_t * app, u8 fib_proto,
 626                             u8 transport_proto)
 627 {
 628   stream_session_t *listener;
 629   u64 handle;
 630   u32 sm_index;
 631   u8 sst;
 632
 633   sst = session_type_from_proto_and_ip (transport_proto,
 634                                         fib_proto == FIB_PROTOCOL_IP4);
 635
 636   /* *INDENT-OFF* */
 637    hash_foreach (handle, sm_index, app->listeners_table, ({
 638      listener = listen_session_get_from_handle (handle);
 639      if (listener->session_type == sst
 640          && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
 641        return listener;
 642    }));
 643   /* *INDENT-ON* */
 644
 645   return 0;
 646 }
 647
 648 stream_session_t *
 649 application_proxy_listener (application_t * app, u8 fib_proto,
 650                             u8 transport_proto)
 651 {
 652   stream_session_t *listener;
 653   u64 handle;
 654   u32 sm_index;
 655   u8 sst;
 656
 657   sst = session_type_from_proto_and_ip (transport_proto,
 658                                         fib_proto == FIB_PROTOCOL_IP4);
 659
 660   /* *INDENT-OFF* */
 661    hash_foreach (handle, sm_index, app->listeners_table, ({
 662      listener = listen_session_get_from_handle (handle);
 663      if (listener->session_type == sst
 664          && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
 665        return listener;
 666    }));
 667   /* *INDENT-ON* */
 668
 669   return 0;
 670 }
 671
 672 static clib_error_t *
 673 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
 674                                         u8 transport_proto, u8 is_start)
 675 {
 676   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
 677   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
 678   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 679   transport_connection_t *tc;
 680   stream_session_t *s;
 681   u64 handle;
 682
 683   if (is_start)
 684     {
 685       s = application_first_listener (app, fib_proto, transport_proto);
 686       if (!s)
 687         {
 688           sep.is_ip4 = is_ip4;
 689           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
 690           sep.sw_if_index = app_ns->sw_if_index;
 691           sep.transport_proto = transport_proto;
 692           application_start_listen (app, &sep, &handle);
 693           s = listen_session_get_from_handle (handle);
 694           s->listener_index = SESSION_PROXY_LISTENER_INDEX;
 695         }
 696     }
 697   else
 698     {
 699       s = application_proxy_listener (app, fib_proto, transport_proto);
 700       ASSERT (s);
 701     }
 702
 703   tc = listen_session_get_transport (s);
 704
 705   if (!ip_is_zero (&tc->lcl_ip, 1))
 706     {
 707       u32 sti;
 708       sep.is_ip4 = is_ip4;
 709       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
 710       sep.transport_proto = transport_proto;
 711       sep.port = 0;
 712       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
 713       if (is_start)
 714         session_lookup_add_session_endpoint (sti, &sep, s->session_index);
 715       else
 716         session_lookup_del_session_endpoint (sti, &sep);
 717     }
 718
 719   return 0;
 720 }
 721
 722 static void
 723 application_start_stop_proxy_local_scope (application_t * app,
 724                                           u8 transport_proto, u8 is_start)
 725 {
 726   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 727   app_namespace_t *app_ns;
 728   app_ns = app_namespace_get (app->ns_index);
 729   sep.is_ip4 = 1;
 730   sep.transport_proto = transport_proto;
 731   sep.port = 0;
 732
 733   if (is_start)
 734     {
 735       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
 736                                            app->index);
 737       sep.is_ip4 = 0;
 738       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
 739                                            app->index);
 740     }
 741   else
 742     {
 743       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
 744       sep.is_ip4 = 0;
 745       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
 746     }
 747 }
 748
 749 void
 750 application_start_stop_proxy (application_t * app,
 751                               transport_proto_t transport_proto, u8 is_start)
 752 {
 753   if (application_has_local_scope (app))
 754     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
 755
 756   if (application_has_global_scope (app))
 757     {
 758       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
 759                                               transport_proto, is_start);
 760       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
 761                                               transport_proto, is_start);
 762     }
 763 }
 764
 765 void
 766 application_setup_proxy (application_t * app)
 767 {
 768   u16 transports = app->proxied_transports;
 769   transport_proto_t tp;
 770
 771   ASSERT (application_is_proxy (app));
 772
 773   /* *INDENT-OFF* */
 774   transport_proto_foreach (tp, ({
 775     if (transports & (1 << tp))
 776       application_start_stop_proxy (app, tp, 1);
 777   }));
 778   /* *INDENT-ON* */
 779 }
 780
 781 void
 782 application_remove_proxy (application_t * app)
 783 {
 784   u16 transports = app->proxied_transports;
 785   transport_proto_t tp;
 786
 787   ASSERT (application_is_proxy (app));
 788
 789   /* *INDENT-OFF* */
 790   transport_proto_foreach (tp, ({
 791     if (transports & (1 << tp))
 792       application_start_stop_proxy (app, tp, 0);
 793   }));
 794   /* *INDENT-ON* */
 795 }
 796
 797 segment_manager_properties_t *
 798 application_segment_manager_properties (application_t * app)
 799 {
 800   return &app->sm_properties;
 801 }
 802
 803 segment_manager_properties_t *
 804 application_get_segment_manager_properties (u32 app_index)
 805 {
 806   application_t *app = application_get (app_index);
 807   return &app->sm_properties;
 808 }
 809
 810 static inline int
 811 app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
 812 {
 813   if (PREDICT_TRUE (!svm_msg_q_is_full (mq)))
 814     {
 815       if (lock)
 816         {
 817           svm_msg_q_add_w_lock (mq, msg);
 818           svm_msg_q_unlock (mq);
 819         }
 820       else if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
 821         {
 822           clib_warning ("msg q add returned");
 823           if (lock)
 824             svm_msg_q_unlock (mq);
 825           return -1;
 826         }
 827     }
 828   else
 829     {
 830       clib_warning ("evt q full");
 831       svm_msg_q_free_msg (mq, msg);
 832       if (lock)
 833         svm_msg_q_unlock (mq);
 834       return -1;
 835     }
 836   return 0;
 837 }
 838
 839 static inline int
 840 app_send_io_evt_rx (application_t * app, stream_session_t * s, u8 lock)
 841 {
 842   session_fifo_event_t *evt;
 843   svm_msg_q_msg_t msg;
 844   svm_msg_q_t *mq;
 845
 846   if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
 847     {
 848       /* Session is closed so app will never clean up. Flush rx fifo */
 849       svm_fifo_dequeue_drop_all (s->server_rx_fifo);
 850       return 0;
 851     }
 852
 853   /* Built-in app? Hand event to the callback... */
 854   if (app->cb_fns.builtin_app_rx_callback)
 855     return app->cb_fns.builtin_app_rx_callback (s);
 856
 857   /* If no need for event, return */
 858   if (!svm_fifo_set_event (s->server_rx_fifo))
 859     return 0;
 860
 861   mq = app->event_queue;
 862   if (lock)
 863     svm_msg_q_lock (mq);
 864
 865   if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
 866     {
 867       clib_warning ("evt q rings full");
 868       if (lock)
 869         svm_msg_q_unlock (mq);
 870       return -1;
 871     }
 872
 873   msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 874   ASSERT (!svm_msg_q_msg_is_invalid (&msg));
 875
 876   evt = (session_fifo_event_t *) svm_msg_q_msg_data (mq, &msg);
 877   evt->fifo = s->server_rx_fifo;
 878   evt->event_type = FIFO_EVENT_APP_RX;
 879
 880   return app_enqueue_evt (mq, &msg, lock);
 881 }
 882
 883 static inline int
 884 app_send_io_evt_tx (application_t * app, stream_session_t * s, u8 lock)
 885 {
 886   svm_msg_q_t *mq;
 887   session_fifo_event_t *evt;
 888   svm_msg_q_msg_t msg;
 889
 890   if (application_is_builtin (app))
 891     return 0;
 892
 893   mq = app->event_queue;
 894   if (lock)
 895     svm_msg_q_lock (mq);
 896
 897   if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
 898     {
 899       clib_warning ("evt q rings full");
 900       if (lock)
 901         svm_msg_q_unlock (mq);
 902       return -1;
 903     }
 904
 905   msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 906   ASSERT (!svm_msg_q_msg_is_invalid (&msg));
 907
 908   evt = (session_fifo_event_t *) svm_msg_q_msg_data (mq, &msg);
 909   evt->event_type = FIFO_EVENT_APP_TX;
 910   evt->fifo = s->server_tx_fifo;
 911
 912   return app_enqueue_evt (mq, &msg, lock);
 913 }
 914
 915 /* *INDENT-OFF* */
 916 typedef int (app_send_evt_handler_fn) (application_t *app,
 917                                        stream_session_t *s,
 918                                        u8 lock);
 919 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
 920     app_send_io_evt_rx,
 921     app_send_io_evt_tx,
 922 };
 923 /* *INDENT-ON* */
 924
 925 /**
 926  * Send event to application
 927  *
 928  * Logic from queue perspective is non-blocking. That is, if there's
 929  * not enough space to enqueue a message, we return. However, if the lock
 930  * flag is set, we do wait for queue mutex.
 931  */
 932 int
 933 application_send_event (application_t * app, stream_session_t * s,
 934                         u8 evt_type)
 935 {
 936   ASSERT (app && evt_type <= FIFO_EVENT_APP_TX);
 937   return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
 938 }
 939
 940 int
 941 application_lock_and_send_event (application_t * app, stream_session_t * s,
 942                                  u8 evt_type)
 943 {
 944   return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
 945 }
 946
 947 local_session_t *
 948 application_alloc_local_session (application_t * app)
 949 {
 950   local_session_t *s;
 951   pool_get (app->local_sessions, s);
 952   memset (s, 0, sizeof (*s));
 953   s->app_index = app->index;
 954   s->session_index = s - app->local_sessions;
 955   s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
 956   return s;
 957 }
 958
 959 void
 960 application_free_local_session (application_t * app, local_session_t * s)
 961 {
 962   pool_put (app->local_sessions, s);
 963   if (CLIB_DEBUG)
 964     memset (s, 0xfc, sizeof (*s));
 965 }
 966
 967 local_session_t *
 968 application_get_local_session (application_t * app, u32 session_index)
 969 {
 970   return pool_elt_at_index (app->local_sessions, session_index);
 971 }
 972
 973 local_session_t *
 974 application_get_local_session_from_handle (session_handle_t handle)
 975 {
 976   application_t *server;
 977   u32 session_index, server_index;
 978   local_session_parse_handle (handle, &server_index, &session_index);
 979   server = application_get (server_index);
 980   return application_get_local_session (server, session_index);
 981 }
 982
 983 always_inline void
 984 application_local_listener_session_endpoint (local_session_t * ll,
 985                                              session_endpoint_t * sep)
 986 {
 987   sep->transport_proto =
 988     session_type_transport_proto (ll->listener_session_type);
 989   sep->port = ll->port;
 990   sep->is_ip4 = ll->listener_session_type & 1;
 991 }
 992
 993 int
 994 application_start_local_listen (application_t * server,
 995                                 session_endpoint_t * sep,
 996                                 session_handle_t * handle)
 997 {
 998   session_handle_t lh;
 999   local_session_t *ll;
1000   u32 table_index;
1001
1002   table_index = application_local_session_table (server);
1003
1004   /* An exact sep match, as opposed to session_lookup_local_listener */
1005   lh = session_lookup_endpoint_listener (table_index, sep, 1);
1006   if (lh != SESSION_INVALID_HANDLE)
1007     return VNET_API_ERROR_ADDRESS_IN_USE;
1008
1009   pool_get (server->local_listen_sessions, ll);
1010   memset (ll, 0, sizeof (*ll));
1011   ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
1012   ll->app_index = server->index;
1013   ll->session_index = ll - server->local_listen_sessions;
1014   ll->port = sep->port;
1015   /* Store the original session type for the unbind */
1016   ll->listener_session_type =
1017     session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
1018   ll->transport_listener_index = ~0;
1019
1020   *handle = application_local_session_handle (ll);
1021   session_lookup_add_session_endpoint (table_index, sep, *handle);
1022
1023   return 0;
1024 }
1025
1026 /**
1027  * Clean up local session table. If we have a listener session use it to
1028  * find the port and proto. If not, the handle must be a local table handle
1029  * so parse it.
1030  */
1031 int
1032 application_stop_local_listen (application_t * server, session_handle_t lh)
1033 {
1034   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1035   u32 table_index, ll_index, server_index;
1036   stream_session_t *sl = 0;
1037   local_session_t *ll, *ls;
1038
1039   table_index = application_local_session_table (server);
1040
1041   /* We have both local and global table binds. Figure from global what
1042    * the sep we should be cleaning up is.
1043    */
1044   if (!session_handle_is_local (lh))
1045     {
1046       sl = listen_session_get_from_handle (lh);
1047       if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
1048         {
1049           clib_warning ("broken listener");
1050           return -1;
1051         }
1052       lh = session_lookup_endpoint_listener (table_index, &sep, 0);
1053       if (lh == SESSION_INVALID_HANDLE)
1054         return -1;
1055     }
1056
1057   local_session_parse_handle (lh, &server_index, &ll_index);
1058   ASSERT (server->index == server_index);
1059   if (!(ll = application_get_local_listen_session (server, ll_index)))
1060     {
1061       clib_warning ("no local listener");
1062       return -1;
1063     }
1064   application_local_listener_session_endpoint (ll, &sep);
1065   session_lookup_del_session_endpoint (table_index, &sep);
1066
1067   /* *INDENT-OFF* */
1068   pool_foreach (ls, server->local_sessions, ({
1069     if (ls->listener_index == ll->session_index)
1070       application_local_session_disconnect (server->index, ls);
1071   }));
1072   /* *INDENT-ON* */
1073   pool_put_index (server->local_listen_sessions, ll->session_index);
1074
1075   return 0;
1076 }
1077
1078 int
1079 application_local_session_connect (u32 table_index, application_t * client,
1080                                    application_t * server,
1081                                    local_session_t * ll, u32 opaque)
1082 {
1083   u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
1084   segment_manager_properties_t *props, *cprops;
1085   int rv, has_transport, seg_index;
1086   svm_fifo_segment_private_t *seg;
1087   segment_manager_t *sm;
1088   local_session_t *ls;
1089   svm_msg_q_t *sq, *cq;
1090
1091   ls = application_alloc_local_session (server);
1092
1093   props = application_segment_manager_properties (server);
1094   cprops = application_segment_manager_properties (client);
1095   evt_q_elts = props->evt_q_size + cprops->evt_q_size;
1096   evt_q_sz = segment_manager_evt_q_expected_size (evt_q_elts);
1097   seg_size = props->rx_fifo_size + props->tx_fifo_size + evt_q_sz + margin;
1098
1099   has_transport = session_has_transport ((stream_session_t *) ll);
1100   if (!has_transport)
1101     {
1102       /* Local sessions don't have backing transport */
1103       ls->port = ll->port;
1104       sm = application_get_local_segment_manager (server);
1105     }
1106   else
1107     {
1108       stream_session_t *sl = (stream_session_t *) ll;
1109       transport_connection_t *tc;
1110       tc = listen_session_get_transport (sl);
1111       ls->port = tc->lcl_port;
1112       sm = application_get_listen_segment_manager (server, sl);
1113     }
1114
1115   seg_index = segment_manager_add_segment (sm, seg_size);
1116   if (seg_index < 0)
1117     {
1118       clib_warning ("failed to add new cut-through segment");
1119       return seg_index;
1120     }
1121   seg = segment_manager_get_segment_w_lock (sm, seg_index);
1122   sq = segment_manager_alloc_queue (seg, props->evt_q_size);
1123   cq = segment_manager_alloc_queue (seg, cprops->evt_q_size);
1124   ls->server_evt_q = pointer_to_uword (sq);
1125   ls->client_evt_q = pointer_to_uword (cq);
1126   rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
1127                                         props->tx_fifo_size,
1128                                         &ls->server_rx_fifo,
1129                                         &ls->server_tx_fifo);
1130   if (rv)
1131     {
1132       clib_warning ("failed to add fifos in cut-through segment");
1133       segment_manager_segment_reader_unlock (sm);
1134       goto failed;
1135     }
1136   ls->server_rx_fifo->master_session_index = ls->session_index;
1137   ls->server_tx_fifo->master_session_index = ls->session_index;
1138   ls->server_rx_fifo->master_thread_index = ~0;
1139   ls->server_tx_fifo->master_thread_index = ~0;
1140   ls->svm_segment_index = seg_index;
1141   ls->listener_index = ll->session_index;
1142   ls->client_index = client->index;
1143   ls->client_opaque = opaque;
1144   ls->listener_session_type = ll->session_type;
1145
1146   if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
1147                                                  &seg->ssvm)))
1148     {
1149       clib_warning ("failed to notify server of new segment");
1150       segment_manager_segment_reader_unlock (sm);
1151       goto failed;
1152     }
1153   segment_manager_segment_reader_unlock (sm);
1154   if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
1155     {
1156       clib_warning ("failed to send accept cut-through notify to server");
1157       goto failed;
1158     }
1159   if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
1160     application_local_session_connect_notify (ls);
1161
1162   return 0;
1163
1164 failed:
1165   if (!has_transport)
1166     segment_manager_del_segment (sm, seg);
1167   return rv;
1168 }
1169
1170 static uword
1171 application_client_local_connect_key (local_session_t * ls)
1172 {
1173   return ((uword) ls->app_index << 32 | (uword) ls->session_index);
1174 }
1175
1176 static void
1177 application_client_local_connect_key_parse (uword key, u32 * app_index,
1178                                             u32 * session_index)
1179 {
1180   *app_index = key >> 32;
1181   *session_index = key & 0xFFFFFFFF;
1182 }
1183
1184 int
1185 application_local_session_connect_notify (local_session_t * ls)
1186 {
1187   svm_fifo_segment_private_t *seg;
1188   application_t *client, *server;
1189   segment_manager_t *sm;
1190   int rv, is_fail = 0;
1191   uword client_key;
1192
1193   client = application_get (ls->client_index);
1194   server = application_get (ls->app_index);
1195   sm = application_get_local_segment_manager_w_session (server, ls);
1196   seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1197   if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1198                                                  &seg->ssvm)))
1199     {
1200       clib_warning ("failed to notify client %u of new segment",
1201                     ls->client_index);
1202       segment_manager_segment_reader_unlock (sm);
1203       application_local_session_disconnect (ls->client_index, ls);
1204       is_fail = 1;
1205     }
1206   else
1207     {
1208       segment_manager_segment_reader_unlock (sm);
1209     }
1210
1211   client->cb_fns.session_connected_callback (client->index, ls->client_opaque,
1212                                              (stream_session_t *) ls,
1213                                              is_fail);
1214
1215   client_key = application_client_local_connect_key (ls);
1216   hash_set (client->local_connects, client_key, client_key);
1217   return 0;
1218 }
1219
1220 int
1221 application_local_session_cleanup (application_t * client,
1222                                    application_t * server,
1223                                    local_session_t * ls)
1224 {
1225   svm_fifo_segment_private_t *seg;
1226   segment_manager_t *sm;
1227   uword client_key;
1228   u8 has_transport;
1229
1230   has_transport = session_has_transport ((stream_session_t *) ls);
1231   client_key = application_client_local_connect_key (ls);
1232   if (!has_transport)
1233     sm = application_get_local_segment_manager_w_session (server, ls);
1234   else
1235     sm = application_get_listen_segment_manager (server,
1236                                                  (stream_session_t *) ls);
1237
1238   seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1239   if (client)
1240     hash_unset (client->local_connects, client_key);
1241
1242   if (!has_transport)
1243     {
1244       server->cb_fns.del_segment_callback (server->api_client_index,
1245                                            &seg->ssvm);
1246       if (client)
1247         client->cb_fns.del_segment_callback (client->api_client_index,
1248                                              &seg->ssvm);
1249       segment_manager_del_segment (sm, seg);
1250     }
1251
1252   application_free_local_session (server, ls);
1253
1254   return 0;
1255 }
1256
1257 int
1258 application_local_session_disconnect (u32 app_index, local_session_t * ls)
1259 {
1260   application_t *client, *server;
1261
1262   client = application_get_if_valid (ls->client_index);
1263   server = application_get (ls->app_index);
1264
1265   if (ls->session_state == SESSION_STATE_CLOSED)
1266     return application_local_session_cleanup (client, server, ls);
1267
1268   if (app_index == ls->client_index)
1269     {
1270       send_local_session_disconnect_callback (ls->app_index, ls);
1271     }
1272   else
1273     {
1274       if (!client)
1275         {
1276           return application_local_session_cleanup (client, server, ls);
1277         }
1278       else if (ls->session_state < SESSION_STATE_READY)
1279         {
1280           client->cb_fns.session_connected_callback (client->index,
1281                                                      ls->client_opaque,
1282                                                      (stream_session_t *) ls,
1283                                                      1 /* is_fail */ );
1284           ls->session_state = SESSION_STATE_CLOSED;
1285           return application_local_session_cleanup (client, server, ls);
1286         }
1287       else
1288         {
1289           send_local_session_disconnect_callback (client->index, ls);
1290         }
1291     }
1292
1293   ls->session_state = SESSION_STATE_CLOSED;
1294
1295   return 0;
1296 }
1297
1298 int
1299 application_local_session_disconnect_w_index (u32 app_index, u32 ls_index)
1300 {
1301   application_t *app;
1302   local_session_t *ls;
1303   app = application_get (app_index);
1304   ls = application_get_local_session (app, ls_index);
1305   return application_local_session_disconnect (app_index, ls);
1306 }
1307
1308 void
1309 application_local_sessions_del (application_t * app)
1310 {
1311   u32 index, server_index, session_index, table_index;
1312   segment_manager_t *sm;
1313   u64 handle, *handles = 0;
1314   local_session_t *ls, *ll;
1315   application_t *server;
1316   session_endpoint_t sep;
1317   int i;
1318
1319   /*
1320    * Local listens. Don't bother with local sessions, we clean them lower
1321    */
1322   table_index = application_local_session_table (app);
1323   /* *INDENT-OFF* */
1324   pool_foreach (ll, app->local_listen_sessions, ({
1325     application_local_listener_session_endpoint (ll, &sep);
1326     session_lookup_del_session_endpoint (table_index, &sep);
1327   }));
1328   /* *INDENT-ON* */
1329
1330   /*
1331    * Local sessions
1332    */
1333   if (app->local_sessions)
1334     {
1335       /* *INDENT-OFF* */
1336       pool_foreach (ls, app->local_sessions, ({
1337         application_local_session_disconnect (app->index, ls);
1338       }));
1339       /* *INDENT-ON* */
1340     }
1341
1342   /*
1343    * Local connects
1344    */
1345   vec_reset_length (handles);
1346   /* *INDENT-OFF* */
1347   hash_foreach (handle, index, app->local_connects, ({
1348     vec_add1 (handles, handle);
1349   }));
1350   /* *INDENT-ON* */
1351
1352   for (i = 0; i < vec_len (handles); i++)
1353     {
1354       application_client_local_connect_key_parse (handles[i], &server_index,
1355                                                   &session_index);
1356       server = application_get_if_valid (server_index);
1357       if (server)
1358         {
1359           ls = application_get_local_session (server, session_index);
1360           application_local_session_disconnect (app->index, ls);
1361         }
1362     }
1363
1364   sm = segment_manager_get (app->local_segment_manager);
1365   sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1366   segment_manager_del (sm);
1367 }
1368
1369 clib_error_t *
1370 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1371 {
1372   application_t *app;
1373   app = application_get (a->app_index);
1374   if (!app)
1375     return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1376                                    0, "app %u doesn't exist", a->app_index);
1377   app->tls_cert = vec_dup (a->cert);
1378   return 0;
1379 }
1380
1381 clib_error_t *
1382 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1383 {
1384   application_t *app;
1385   app = application_get (a->app_index);
1386   if (!app)
1387     return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1388                                    0, "app %u doesn't exist", a->app_index);
1389   app->tls_key = vec_dup (a->key);
1390   return 0;
1391 }
1392
1393 u8 *
1394 format_application_listener (u8 * s, va_list * args)
1395 {
1396   application_t *app = va_arg (*args, application_t *);
1397   u64 handle = va_arg (*args, u64);
1398   u32 sm_index = va_arg (*args, u32);
1399   int verbose = va_arg (*args, int);
1400   stream_session_t *listener;
1401   u8 *app_name, *str;
1402
1403   if (app == 0)
1404     {
1405       if (verbose)
1406         s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
1407                     "API Client", "ListenerID", "SegManager");
1408       else
1409         s = format (s, "%-40s%-20s", "Connection", "App");
1410
1411       return s;
1412     }
1413
1414   app_name = app_get_name_from_reg_index (app);
1415   listener = listen_session_get_from_handle (handle);
1416   str = format (0, "%U", format_stream_session, listener, verbose);
1417
1418   if (verbose)
1419     {
1420       s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
1421                   app->api_client_index, handle, sm_index);
1422     }
1423   else
1424     s = format (s, "%-40s%-20s", str, app_name);
1425
1426   vec_free (app_name);
1427   return s;
1428 }
1429
1430 void
1431 application_format_connects (application_t * app, int verbose)
1432 {
1433   svm_fifo_segment_private_t *fifo_segment;
1434   vlib_main_t *vm = vlib_get_main ();
1435   segment_manager_t *sm;
1436   u8 *app_name, *s = 0;
1437
1438   /* Header */
1439   if (app == 0)
1440     {
1441       if (verbose)
1442         vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1443                          "API Client", "SegManager");
1444       else
1445         vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1446       return;
1447     }
1448
1449   /* make sure */
1450   if (app->connects_seg_manager == (u32) ~ 0)
1451     return;
1452
1453   app_name = app_get_name_from_reg_index (app);
1454
1455   /* Across all fifo segments */
1456   sm = segment_manager_get (app->connects_seg_manager);
1457
1458   /* *INDENT-OFF* */
1459   segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
1460     svm_fifo_t *fifo;
1461     u8 *str;
1462
1463     fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
1464     while (fifo)
1465         {
1466           u32 session_index, thread_index;
1467           stream_session_t *session;
1468
1469           session_index = fifo->master_session_index;
1470           thread_index = fifo->master_thread_index;
1471
1472           session = session_get (session_index, thread_index);
1473           str = format (0, "%U", format_stream_session, session, verbose);
1474
1475           if (verbose)
1476             s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1477                         app->api_client_index, app->connects_seg_manager);
1478           else
1479             s = format (s, "%-40s%-20s", str, app_name);
1480
1481           vlib_cli_output (vm, "%v", s);
1482           vec_reset_length (s);
1483           vec_free (str);
1484
1485           fifo = fifo->next;
1486         }
1487     vec_free (s);
1488   }));
1489   /* *INDENT-ON* */
1490
1491   vec_free (app_name);
1492 }
1493
1494 void
1495 application_format_local_sessions (application_t * app, int verbose)
1496 {
1497   vlib_main_t *vm = vlib_get_main ();
1498   local_session_t *ls;
1499   transport_proto_t tp;
1500   u8 *conn = 0;
1501
1502   /* Header */
1503   if (app == 0)
1504     {
1505       vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
1506                        "ClientApp");
1507       return;
1508     }
1509
1510   /* *INDENT-OFF* */
1511   pool_foreach (ls, app->local_listen_sessions, ({
1512     tp = session_type_transport_proto(ls->listener_session_type);
1513     conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1514                    ls->port);
1515     vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_index, "*");
1516     vec_reset_length (conn);
1517   }));
1518   pool_foreach (ls, app->local_sessions, ({
1519     tp = session_type_transport_proto(ls->listener_session_type);
1520     conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1521                    ls->port);
1522     vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_index,
1523                      ls->client_index);
1524     vec_reset_length (conn);
1525   }));
1526   /* *INDENT-ON* */
1527
1528   vec_free (conn);
1529 }
1530
1531 void
1532 application_format_local_connects (application_t * app, int verbose)
1533 {
1534   vlib_main_t *vm = vlib_get_main ();
1535   u32 app_index, session_index;
1536   application_t *server;
1537   local_session_t *ls;
1538   uword client_key;
1539   u64 value;
1540
1541   /* Header */
1542   if (app == 0)
1543     {
1544       if (verbose)
1545         vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
1546                          "Peer App", "SegManager");
1547       else
1548         vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
1549                          "Peer App");
1550       return;
1551     }
1552
1553   /* *INDENT-OFF* */
1554   hash_foreach (client_key, value, app->local_connects, ({
1555     application_client_local_connect_key_parse (client_key, &app_index,
1556                                                 &session_index);
1557     server = application_get (app_index);
1558     ls = application_get_local_session (server, session_index);
1559     vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_index, ls->client_index);
1560   }));
1561   /* *INDENT-ON* */
1562 }
1563
1564 u8 *
1565 format_application (u8 * s, va_list * args)
1566 {
1567   application_t *app = va_arg (*args, application_t *);
1568   CLIB_UNUSED (int verbose) = va_arg (*args, int);
1569   segment_manager_properties_t *props;
1570   const u8 *app_ns_name;
1571   u8 *app_name;
1572
1573   if (app == 0)
1574     {
1575       if (verbose)
1576         s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
1577                     "API Client", "Namespace", "Add seg size", "Rx-f size",
1578                     "Tx-f size");
1579       else
1580         s = format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
1581                     "Namespace");
1582       return s;
1583     }
1584
1585   app_name = app_get_name (app);
1586   app_ns_name = app_namespace_id_from_index (app->ns_index);
1587   props = application_segment_manager_properties (app);
1588   if (verbose)
1589     s = format (s, "%-10u%-20s%-15d%-15u%-15U%-15U%-15U", app->index,
1590                 app_name, app->api_client_index, app->ns_index,
1591                 format_memory_size, props->add_segment_size,
1592                 format_memory_size, props->rx_fifo_size, format_memory_size,
1593                 props->tx_fifo_size);
1594   else
1595     s = format (s, "%-10u%-20s%-15d%-40s", app->index, app_name,
1596                 app->api_client_index, app_ns_name);
1597   return s;
1598 }
1599
1600
1601 void
1602 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1603 {
1604   application_t *app;
1605   u32 sm_index;
1606   u64 handle;
1607
1608   if (!pool_elts (app_pool))
1609     {
1610       vlib_cli_output (vm, "No active server bindings");
1611       return;
1612     }
1613
1614   if (do_local)
1615     {
1616       application_format_local_sessions (0, verbose);
1617       /* *INDENT-OFF* */
1618       pool_foreach (app, app_pool, ({
1619         if (!pool_elts (app->local_sessions)
1620             && !pool_elts(app->local_connects))
1621           continue;
1622         application_format_local_sessions (app, verbose);
1623       }));
1624       /* *INDENT-ON* */
1625     }
1626   else
1627     {
1628       vlib_cli_output (vm, "%U", format_application_listener, 0 /* header */ ,
1629                        0, 0, verbose);
1630
1631       /* *INDENT-OFF* */
1632       pool_foreach (app, app_pool, ({
1633         if (hash_elts (app->listeners_table) == 0)
1634           continue;
1635         hash_foreach (handle, sm_index, app->listeners_table, ({
1636           vlib_cli_output (vm, "%U", format_application_listener, app,
1637                            handle, sm_index, verbose);
1638         }));
1639       }));
1640       /* *INDENT-ON* */
1641     }
1642 }
1643
1644 void
1645 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1646 {
1647   application_t *app;
1648
1649   if (!pool_elts (app_pool))
1650     {
1651       vlib_cli_output (vm, "No active apps");
1652       return;
1653     }
1654
1655   if (do_local)
1656     {
1657       application_format_local_connects (0, verbose);
1658
1659       /* *INDENT-OFF* */
1660       pool_foreach (app, app_pool, ({
1661         if (app->local_connects)
1662           application_format_local_connects (app, verbose);
1663       }));
1664       /* *INDENT-ON* */
1665     }
1666   else
1667     {
1668       application_format_connects (0, verbose);
1669
1670       /* *INDENT-OFF* */
1671       pool_foreach (app, app_pool, ({
1672         if (app->connects_seg_manager == (u32)~0)
1673           continue;
1674         application_format_connects (app, verbose);
1675       }));
1676       /* *INDENT-ON* */
1677     }
1678 }
1679
1680 static clib_error_t *
1681 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1682                      vlib_cli_command_t * cmd)
1683 {
1684   int do_server = 0, do_client = 0, do_local = 0;
1685   application_t *app;
1686   int verbose = 0;
1687
1688   session_cli_return_if_not_enabled ();
1689
1690   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1691     {
1692       if (unformat (input, "server"))
1693         do_server = 1;
1694       else if (unformat (input, "client"))
1695         do_client = 1;
1696       else if (unformat (input, "local"))
1697         do_local = 1;
1698       else if (unformat (input, "verbose"))
1699         verbose = 1;
1700       else
1701         break;
1702     }
1703
1704   if (do_server)
1705     application_format_all_listeners (vm, do_local, verbose);
1706
1707   if (do_client)
1708     application_format_all_clients (vm, do_local, verbose);
1709
1710   /* Print app related info */
1711   if (!do_server && !do_client)
1712     {
1713       vlib_cli_output (vm, "%U", format_application, 0, verbose);
1714       /* *INDENT-OFF* */
1715       pool_foreach (app, app_pool, ({
1716         vlib_cli_output (vm, "%U", format_application, app, verbose);
1717       }));
1718       /* *INDENT-ON* */
1719     }
1720
1721   return 0;
1722 }
1723
1724 /* *INDENT-OFF* */
1725 VLIB_CLI_COMMAND (show_app_command, static) =
1726 {
1727   .path = "show app",
1728   .short_help = "show app [server|client] [verbose]",
1729   .function = show_app_command_fn,
1730 };
1731 /* *INDENT-ON* */
1732
1733 /*
1734  * fd.io coding-style-patch-verification: ON
1735  *
1736  * Local Variables:
1737  * eval: (c-set-style "gnu")
1738  * End:
1739  */