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 = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
 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   u32 al_index, table_index;
 137   session_handle_t lh;
 138   session_type_t st;
 139   session_t *ls = 0;
 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
 155       local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
 156                                                  sep->is_ip4);
 157       ls = listen_session_alloc (0, local_st);
 158       ls->app_index = app->app_index;
 159       ls->app_wrk_index = sep->app_wrk_index;
 160       lh = session_handle (ls);
 161
 162       if ((rv = session_listen (ls, sep)))
 163         {
 164           ls = session_get_from_handle (lh);
 165           session_free (ls);
 166           return rv;
 167         }
 168
 169       ls = session_get_from_handle (lh);
 170       app_listener = app_listener_get (app, al_index);
 171       app_listener->local_index = ls->session_index;
 172       app_listener->ls_handle = lh;
 173       ls->al_index = al_index;
 174
 175       table_index = application_local_session_table (app);
 176       session_lookup_add_session_endpoint (table_index,
 177                                            (session_endpoint_t *) sep, lh);
 178     }
 179
 180   if (application_has_global_scope (app))
 181     {
 182       /*
 183        * Start listening on local endpoint for requested transport and scope.
 184        * Creates a stream session with state LISTENING to be used in session
 185        * lookups, prior to establishing connection. Requests transport to
 186        * build it's own specific listening connection.
 187        */
 188       ls = listen_session_alloc (0, st);
 189       ls->app_index = app->app_index;
 190       ls->app_wrk_index = sep->app_wrk_index;
 191
 192       /* Listen pool can be reallocated if the transport is
 193        * recursive (tls) */
 194       lh = listen_session_get_handle (ls);
 195
 196       if ((rv = session_listen (ls, sep)))
 197         {
 198           ls = listen_session_get_from_handle (lh);
 199           session_free (ls);
 200           return rv;
 201         }
 202       ls = listen_session_get_from_handle (lh);
 203       app_listener = app_listener_get (app, al_index);
 204       app_listener->session_index = ls->session_index;
 205       app_listener->ls_handle = lh;
 206       ls->al_index = al_index;
 207
 208       /* Add to the global lookup table after transport was initialized.
 209        * Lookup table needs to be populated only now because sessions
 210        * with cut-through transport are are added to app local tables that
 211        * are not related to network fibs, i.e., cannot be added as
 212        * connections */
 213       tc = session_get_transport (ls);
 214       if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
 215         {
 216           fib_protocol_t fib_proto;
 217           fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
 218           table_index = session_lookup_get_index_for_fib (fib_proto,
 219                                                           sep->fib_index);
 220           ASSERT (table_index != SESSION_TABLE_INVALID_INDEX);
 221           session_lookup_add_session_endpoint (table_index,
 222                                                (session_endpoint_t *) sep,
 223                                                lh);
 224         }
 225     }
 226
 227   if (!ls)
 228     {
 229       app_listener_free (app, app_listener);
 230       return -1;
 231     }
 232
 233   *listener = app_listener;
 234   return 0;
 235 }
 236
 237 void
 238 app_listener_cleanup (app_listener_t * al)
 239 {
 240   application_t *app = application_get (al->app_index);
 241   session_t *ls;
 242
 243   if (al->session_index != SESSION_INVALID_INDEX)
 244     {
 245       ls = session_get (al->session_index, 0);
 246       session_stop_listen (ls);
 247       listen_session_free (ls);
 248     }
 249   if (al->local_index != SESSION_INVALID_INDEX)
 250     {
 251       session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 252       u32 table_index;
 253
 254       table_index = application_local_session_table (app);
 255       ls = listen_session_get (al->local_index);
 256       ct_session_endpoint (ls, &sep);
 257       session_lookup_del_session_endpoint (table_index, &sep);
 258       session_stop_listen (ls);
 259       listen_session_free (ls);
 260     }
 261   app_listener_free (app, al);
 262 }
 263
 264 static app_worker_t *
 265 app_listener_select_worker (application_t * app, app_listener_t * al)
 266 {
 267   u32 wrk_index;
 268
 269   app = application_get (al->app_index);
 270   wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
 271   if (wrk_index == ~0)
 272     wrk_index = clib_bitmap_first_set (al->workers);
 273
 274   ASSERT (wrk_index != ~0);
 275   al->accept_rotor = wrk_index;
 276   return application_get_worker (app, wrk_index);
 277 }
 278
 279 session_t *
 280 app_listener_get_session (app_listener_t * al)
 281 {
 282   if (al->session_index == SESSION_INVALID_INDEX)
 283     return 0;
 284
 285   return listen_session_get (al->session_index);
 286 }
 287
 288 session_t *
 289 app_listener_get_local_session (app_listener_t * al)
 290 {
 291   if (al->local_index == SESSION_INVALID_INDEX)
 292     return 0;
 293   return listen_session_get (al->local_index);
 294 }
 295
 296 static app_worker_map_t *
 297 app_worker_map_alloc (application_t * app)
 298 {
 299   app_worker_map_t *map;
 300   pool_get (app->worker_maps, map);
 301   clib_memset (map, 0, sizeof (*map));
 302   return map;
 303 }
 304
 305 static u32
 306 app_worker_map_index (application_t * app, app_worker_map_t * map)
 307 {
 308   return (map - app->worker_maps);
 309 }
 310
 311 static void
 312 app_worker_map_free (application_t * app, app_worker_map_t * map)
 313 {
 314   pool_put (app->worker_maps, map);
 315 }
 316
 317 static app_worker_map_t *
 318 app_worker_map_get (application_t * app, u32 map_index)
 319 {
 320   if (pool_is_free_index (app->worker_maps, map_index))
 321     return 0;
 322   return pool_elt_at_index (app->worker_maps, map_index);
 323 }
 324
 325 static const u8 *
 326 app_get_name (application_t * app)
 327 {
 328   return app->name;
 329 }
 330
 331 u32
 332 application_session_table (application_t * app, u8 fib_proto)
 333 {
 334   app_namespace_t *app_ns;
 335   app_ns = app_namespace_get (app->ns_index);
 336   if (!application_has_global_scope (app))
 337     return APP_INVALID_INDEX;
 338   if (fib_proto == FIB_PROTOCOL_IP4)
 339     return session_lookup_get_index_for_fib (fib_proto,
 340                                              app_ns->ip4_fib_index);
 341   else
 342     return session_lookup_get_index_for_fib (fib_proto,
 343                                              app_ns->ip6_fib_index);
 344 }
 345
 346 u32
 347 application_local_session_table (application_t * app)
 348 {
 349   app_namespace_t *app_ns;
 350   if (!application_has_local_scope (app))
 351     return APP_INVALID_INDEX;
 352   app_ns = app_namespace_get (app->ns_index);
 353   return app_ns->local_table_index;
 354 }
 355
 356 /**
 357  * Returns app name for app-index
 358  */
 359 const u8 *
 360 application_name_from_index (u32 app_index)
 361 {
 362   application_t *app = application_get (app_index);
 363   if (!app)
 364     return 0;
 365   return app_get_name (app);
 366 }
 367
 368 static void
 369 application_api_table_add (u32 app_index, u32 api_client_index)
 370 {
 371   if (api_client_index != APP_INVALID_INDEX)
 372     hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
 373 }
 374
 375 static void
 376 application_api_table_del (u32 api_client_index)
 377 {
 378   hash_unset (app_main.app_by_api_client_index, api_client_index);
 379 }
 380
 381 static void
 382 application_name_table_add (application_t * app)
 383 {
 384   hash_set_mem (app_main.app_by_name, app->name, app->app_index);
 385 }
 386
 387 static void
 388 application_name_table_del (application_t * app)
 389 {
 390   hash_unset_mem (app_main.app_by_name, app->name);
 391 }
 392
 393 application_t *
 394 application_lookup (u32 api_client_index)
 395 {
 396   uword *p;
 397   p = hash_get (app_main.app_by_api_client_index, api_client_index);
 398   if (p)
 399     return application_get_if_valid (p[0]);
 400
 401   return 0;
 402 }
 403
 404 application_t *
 405 application_lookup_name (const u8 * name)
 406 {
 407   uword *p;
 408   p = hash_get_mem (app_main.app_by_name, name);
 409   if (p)
 410     return application_get (p[0]);
 411
 412   return 0;
 413 }
 414
 415 static application_t *
 416 application_alloc (void)
 417 {
 418   application_t *app;
 419   pool_get (app_main.app_pool, app);
 420   clib_memset (app, 0, sizeof (*app));
 421   app->app_index = app - app_main.app_pool;
 422   return app;
 423 }
 424
 425 application_t *
 426 application_get (u32 app_index)
 427 {
 428   if (app_index == APP_INVALID_INDEX)
 429     return 0;
 430   return pool_elt_at_index (app_main.app_pool, app_index);
 431 }
 432
 433 application_t *
 434 application_get_if_valid (u32 app_index)
 435 {
 436   if (pool_is_free_index (app_main.app_pool, app_index))
 437     return 0;
 438
 439   return pool_elt_at_index (app_main.app_pool, app_index);
 440 }
 441
 442 static void
 443 application_verify_cb_fns (session_cb_vft_t * cb_fns)
 444 {
 445   if (cb_fns->session_accept_callback == 0)
 446     clib_warning ("No accept callback function provided");
 447   if (cb_fns->session_connected_callback == 0)
 448     clib_warning ("No session connected callback function provided");
 449   if (cb_fns->session_disconnect_callback == 0)
 450     clib_warning ("No session disconnect callback function provided");
 451   if (cb_fns->session_reset_callback == 0)
 452     clib_warning ("No session reset callback function provided");
 453 }
 454
 455 /**
 456  * Check app config for given segment type
 457  *
 458  * Returns 1 on success and 0 otherwise
 459  */
 460 static u8
 461 application_verify_cfg (ssvm_segment_type_t st)
 462 {
 463   u8 is_valid;
 464   if (st == SSVM_SEGMENT_MEMFD)
 465     {
 466       is_valid = (session_main_get_evt_q_segment () != 0);
 467       if (!is_valid)
 468         clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
 469       return is_valid;
 470     }
 471   else if (st == SSVM_SEGMENT_SHM)
 472     {
 473       is_valid = (session_main_get_evt_q_segment () == 0);
 474       if (!is_valid)
 475         clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
 476       return is_valid;
 477     }
 478   else
 479     return 1;
 480 }
 481
 482 static int
 483 application_alloc_and_init (app_init_args_t * a)
 484 {
 485   ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
 486   segment_manager_props_t *props;
 487   vl_api_registration_t *reg;
 488   application_t *app;
 489   u64 *options;
 490
 491   app = application_alloc ();
 492   options = a->options;
 493   /*
 494    * Make sure we support the requested configuration
 495    */
 496   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
 497     {
 498       seg_type = SSVM_SEGMENT_PRIVATE;
 499     }
 500   else if (!a->use_sock_api)
 501     {
 502       reg = vl_api_client_index_to_registration (a->api_client_index);
 503       if (!reg)
 504         return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 505       if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 506         seg_type = SSVM_SEGMENT_SHM;
 507     }
 508
 509   if ((options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 510       && seg_type != SSVM_SEGMENT_MEMFD)
 511     {
 512       clib_warning ("mq eventfds can only be used if socket transport is "
 513                     "used for binary api");
 514       return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 515     }
 516
 517   if (!application_verify_cfg (seg_type))
 518     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 519
 520   if (options[APP_OPTIONS_PREALLOC_FIFO_PAIRS]
 521       && options[APP_OPTIONS_PREALLOC_FIFO_HDRS])
 522     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 523
 524   /* Check that the obvious things are properly set up */
 525   application_verify_cb_fns (a->session_cb_vft);
 526
 527   app->flags = options[APP_OPTIONS_FLAGS];
 528   app->cb_fns = *a->session_cb_vft;
 529   app->ns_index = options[APP_OPTIONS_NAMESPACE];
 530   app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
 531   app->name = vec_dup (a->name);
 532
 533   /* If no scope enabled, default to global */
 534   if (!application_has_global_scope (app)
 535       && !application_has_local_scope (app))
 536     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 537
 538   props = application_segment_manager_properties (app);
 539   segment_manager_props_init (props);
 540   props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
 541   props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
 542   props->prealloc_fifo_hdrs = options[APP_OPTIONS_PREALLOC_FIFO_HDRS];
 543   if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
 544     {
 545       props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
 546       props->add_segment = 1;
 547     }
 548   if (options[APP_OPTIONS_RX_FIFO_SIZE])
 549     props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
 550   if (options[APP_OPTIONS_TX_FIFO_SIZE])
 551     props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
 552   if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
 553     props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
 554   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 555     props->use_mq_eventfd = 1;
 556   if (options[APP_OPTIONS_TLS_ENGINE])
 557     app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
 558   if (options[APP_OPTIONS_MAX_FIFO_SIZE])
 559     props->max_fifo_size = options[APP_OPTIONS_MAX_FIFO_SIZE];
 560   if (options[APP_OPTIONS_HIGH_WATERMARK])
 561     props->high_watermark = options[APP_OPTIONS_HIGH_WATERMARK];
 562   if (options[APP_OPTIONS_LOW_WATERMARK])
 563     props->low_watermark = options[APP_OPTIONS_LOW_WATERMARK];
 564   if (options[APP_OPTIONS_PCT_FIRST_ALLOC])
 565     props->pct_first_alloc = options[APP_OPTIONS_PCT_FIRST_ALLOC];
 566   props->segment_type = seg_type;
 567
 568   /* Add app to lookup by api_client_index table */
 569   if (!application_is_builtin (app))
 570     application_api_table_add (app->app_index, a->api_client_index);
 571   else
 572     application_name_table_add (app);
 573
 574   a->app_index = app->app_index;
 575
 576   APP_DBG ("New app name: %v api index: %u index %u", app->name,
 577            a->api_client_index, app->app_index);
 578
 579   return 0;
 580 }
 581
 582 static void
 583 application_free (application_t * app)
 584 {
 585   app_worker_map_t *wrk_map;
 586   app_worker_t *app_wrk;
 587
 588   /*
 589    * The app event queue allocated in first segment is cleared with
 590    * the segment manager. No need to explicitly free it.
 591    */
 592   APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
 593
 594   if (application_is_proxy (app))
 595     application_remove_proxy (app);
 596
 597   /*
 598    * Free workers
 599    */
 600
 601   /* *INDENT-OFF* */
 602   pool_flush (wrk_map, app->worker_maps, ({
 603     app_wrk = app_worker_get (wrk_map->wrk_index);
 604     app_worker_free (app_wrk);
 605   }));
 606   /* *INDENT-ON* */
 607   pool_free (app->worker_maps);
 608
 609   /*
 610    * Cleanup remaining state
 611    */
 612   if (application_is_builtin (app))
 613     application_name_table_del (app);
 614   vec_free (app->name);
 615   pool_put (app_main.app_pool, app);
 616 }
 617
 618 static void
 619 application_detach_process (application_t * app, u32 api_client_index)
 620 {
 621   vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
 622   app_worker_map_t *wrk_map;
 623   u32 *wrks = 0, *wrk_index;
 624   app_worker_t *app_wrk;
 625
 626   if (api_client_index == ~0)
 627     {
 628       application_free (app);
 629       return;
 630     }
 631
 632   APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
 633            app->app_index, api_client_index);
 634
 635   /* *INDENT-OFF* */
 636   pool_foreach (wrk_map, app->worker_maps, ({
 637     app_wrk = app_worker_get (wrk_map->wrk_index);
 638     if (app_wrk->api_client_index == api_client_index)
 639       vec_add1 (wrks, app_wrk->wrk_index);
 640   }));
 641   /* *INDENT-ON* */
 642
 643   if (!vec_len (wrks))
 644     {
 645       clib_warning ("no workers for app %u api_index %u", app->app_index,
 646                     api_client_index);
 647       return;
 648     }
 649
 650   args->app_index = app->app_index;
 651   args->api_client_index = api_client_index;
 652   vec_foreach (wrk_index, wrks)
 653   {
 654     app_wrk = app_worker_get (wrk_index[0]);
 655     args->wrk_map_index = app_wrk->wrk_map_index;
 656     args->is_add = 0;
 657     vnet_app_worker_add_del (args);
 658   }
 659   vec_free (wrks);
 660 }
 661
 662 app_worker_t *
 663 application_get_worker (application_t * app, u32 wrk_map_index)
 664 {
 665   app_worker_map_t *map;
 666   map = app_worker_map_get (app, wrk_map_index);
 667   if (!map)
 668     return 0;
 669   return app_worker_get (map->wrk_index);
 670 }
 671
 672 app_worker_t *
 673 application_get_default_worker (application_t * app)
 674 {
 675   return application_get_worker (app, 0);
 676 }
 677
 678 u32
 679 application_n_workers (application_t * app)
 680 {
 681   return pool_elts (app->worker_maps);
 682 }
 683
 684 app_worker_t *
 685 application_listener_select_worker (session_t * ls)
 686 {
 687   application_t *app;
 688   app_listener_t *al;
 689
 690   app = application_get (ls->app_index);
 691   al = app_listener_get (app, ls->al_index);
 692   return app_listener_select_worker (app, al);
 693 }
 694
 695 int
 696 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
 697 {
 698   app_worker_map_t *wrk_map;
 699   app_worker_t *app_wrk;
 700   segment_manager_t *sm;
 701   int rv;
 702
 703   app_wrk = app_worker_alloc (app);
 704   wrk_map = app_worker_map_alloc (app);
 705   wrk_map->wrk_index = app_wrk->wrk_index;
 706   app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
 707
 708   /*
 709    * Setup first segment manager
 710    */
 711   sm = segment_manager_alloc ();
 712   sm->app_wrk_index = app_wrk->wrk_index;
 713
 714   if ((rv = segment_manager_init (sm)))
 715     {
 716       app_worker_free (app_wrk);
 717       return rv;
 718     }
 719   sm->first_is_protected = 1;
 720
 721   /*
 722    * Setup app worker
 723    */
 724   app_wrk->first_segment_manager = segment_manager_index (sm);
 725   app_wrk->listeners_table = hash_create (0, sizeof (u64));
 726   app_wrk->event_queue = segment_manager_event_queue (sm);
 727   app_wrk->app_is_builtin = application_is_builtin (app);
 728
 729   *wrk = app_wrk;
 730
 731   return 0;
 732 }
 733
 734 int
 735 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
 736 {
 737   fifo_segment_t *fs;
 738   app_worker_map_t *wrk_map;
 739   app_worker_t *app_wrk;
 740   segment_manager_t *sm;
 741   application_t *app;
 742   int rv;
 743
 744   app = application_get (a->app_index);
 745   if (!app)
 746     return VNET_API_ERROR_INVALID_VALUE;
 747
 748   if (a->is_add)
 749     {
 750       if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
 751         return rv;
 752
 753       /* Map worker api index to the app */
 754       app_wrk->api_client_index = a->api_client_index;
 755       application_api_table_add (app->app_index, a->api_client_index);
 756
 757       sm = segment_manager_get (app_wrk->first_segment_manager);
 758       fs = segment_manager_get_segment_w_lock (sm, 0);
 759       a->segment = &fs->ssvm;
 760       a->segment_handle = segment_manager_segment_handle (sm, fs);
 761       segment_manager_segment_reader_unlock (sm);
 762       a->evt_q = app_wrk->event_queue;
 763       a->wrk_map_index = app_wrk->wrk_map_index;
 764     }
 765   else
 766     {
 767       wrk_map = app_worker_map_get (app, a->wrk_map_index);
 768       if (!wrk_map)
 769         return VNET_API_ERROR_INVALID_VALUE;
 770
 771       app_wrk = app_worker_get (wrk_map->wrk_index);
 772       if (!app_wrk)
 773         return VNET_API_ERROR_INVALID_VALUE;
 774
 775       application_api_table_del (app_wrk->api_client_index);
 776       app_worker_free (app_wrk);
 777       app_worker_map_free (app, wrk_map);
 778       if (application_n_workers (app) == 0)
 779         application_free (app);
 780     }
 781   return 0;
 782 }
 783
 784 static int
 785 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
 786 {
 787   app_namespace_t *app_ns;
 788   if (vec_len (namespace_id) == 0)
 789     {
 790       /* Use default namespace */
 791       *app_ns_index = 0;
 792       return 0;
 793     }
 794
 795   *app_ns_index = app_namespace_index_from_id (namespace_id);
 796   if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
 797     return VNET_API_ERROR_APP_INVALID_NS;
 798   app_ns = app_namespace_get (*app_ns_index);
 799   if (!app_ns)
 800     return VNET_API_ERROR_APP_INVALID_NS;
 801   if (app_ns->ns_secret != secret)
 802     return VNET_API_ERROR_APP_WRONG_NS_SECRET;
 803   return 0;
 804 }
 805
 806 static u8 *
 807 app_name_from_api_index (u32 api_client_index)
 808 {
 809   vl_api_registration_t *regp;
 810   regp = vl_api_client_index_to_registration (api_client_index);
 811   if (regp)
 812     return format (0, "%s", regp->name);
 813
 814   clib_warning ("api client index %u does not have an api registration!",
 815                 api_client_index);
 816   return format (0, "unknown");
 817 }
 818
 819 /**
 820  * Attach application to vpp
 821  *
 822  * Allocates a vpp app, i.e., a structure that keeps back pointers
 823  * to external app and a segment manager for shared memory fifo based
 824  * communication with the external app.
 825  */
 826 int
 827 vnet_application_attach (vnet_app_attach_args_t * a)
 828 {
 829   fifo_segment_t *fs;
 830   application_t *app = 0;
 831   app_worker_t *app_wrk;
 832   segment_manager_t *sm;
 833   u32 app_ns_index = 0;
 834   u8 *app_name = 0;
 835   u64 secret;
 836   int rv;
 837
 838   if (a->api_client_index != APP_INVALID_INDEX)
 839     app = application_lookup (a->api_client_index);
 840   else if (a->name)
 841     app = application_lookup_name (a->name);
 842   else
 843     return VNET_API_ERROR_INVALID_VALUE;
 844
 845   if (app)
 846     return VNET_API_ERROR_APP_ALREADY_ATTACHED;
 847
 848   /* Socket api sets the name and validates namespace prior to attach */
 849   if (!a->use_sock_api)
 850     {
 851       if (a->api_client_index != APP_INVALID_INDEX)
 852         {
 853           app_name = app_name_from_api_index (a->api_client_index);
 854           a->name = app_name;
 855         }
 856
 857       secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
 858       if ((rv =
 859            app_validate_namespace (a->namespace_id, secret, &app_ns_index)))
 860         return rv;
 861       a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
 862     }
 863
 864   if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
 865     return rv;
 866
 867   app = application_get (a->app_index);
 868   if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
 869     return rv;
 870
 871   a->app_evt_q = app_wrk->event_queue;
 872   app_wrk->api_client_index = a->api_client_index;
 873   sm = segment_manager_get (app_wrk->first_segment_manager);
 874   fs = segment_manager_get_segment_w_lock (sm, 0);
 875
 876   if (application_is_proxy (app))
 877     application_setup_proxy (app);
 878
 879   ASSERT (vec_len (fs->ssvm.name) <= 128);
 880   a->segment = &fs->ssvm;
 881   a->segment_handle = segment_manager_segment_handle (sm, fs);
 882
 883   segment_manager_segment_reader_unlock (sm);
 884   vec_free (app_name);
 885   return 0;
 886 }
 887
 888 /**
 889  * Detach application from vpp
 890  */
 891 int
 892 vnet_application_detach (vnet_app_detach_args_t * a)
 893 {
 894   application_t *app;
 895
 896   app = application_get_if_valid (a->app_index);
 897   if (!app)
 898     {
 899       clib_warning ("app not attached");
 900       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 901     }
 902
 903   app_interface_check_thread_and_barrier (vnet_application_detach, a);
 904   application_detach_process (app, a->api_client_index);
 905   return 0;
 906 }
 907
 908
 909 static u8
 910 session_endpoint_in_ns (session_endpoint_t * sep)
 911 {
 912   u8 is_lep = session_endpoint_is_local (sep);
 913   if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
 914       && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
 915     {
 916       clib_warning ("sw_if_index %u not configured with ip %U",
 917                     sep->sw_if_index, format_ip46_address, &sep->ip,
 918                     sep->is_ip4);
 919       return 0;
 920     }
 921   return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
 922 }
 923
 924 static void
 925 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
 926                                  application_t * app, u8 is_connect)
 927 {
 928   app_namespace_t *app_ns;
 929   u32 ns_index, fib_index;
 930
 931   ns_index = app->ns_index;
 932
 933   /* App is a transport proto, so fetch the calling app's ns */
 934   if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
 935     ns_index = sep->ns_index;
 936
 937   app_ns = app_namespace_get (ns_index);
 938   if (!app_ns)
 939     return;
 940
 941   /* Ask transport and network to bind to/connect using local interface
 942    * that "supports" app's namespace. This will fix our local connection
 943    * endpoint.
 944    */
 945
 946   /* If in default namespace and user requested a fib index use it */
 947   if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
 948     fib_index = sep->fib_index;
 949   else
 950     fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
 951   sep->peer.fib_index = fib_index;
 952   sep->fib_index = fib_index;
 953
 954   if (!is_connect)
 955     {
 956       sep->sw_if_index = app_ns->sw_if_index;
 957     }
 958   else
 959     {
 960       if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
 961           && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
 962           && sep->peer.sw_if_index != app_ns->sw_if_index)
 963         clib_warning ("Local sw_if_index different from app ns sw_if_index");
 964
 965       sep->peer.sw_if_index = app_ns->sw_if_index;
 966     }
 967 }
 968
 969 int
 970 vnet_listen (vnet_listen_args_t * a)
 971 {
 972   app_listener_t *app_listener;
 973   app_worker_t *app_wrk;
 974   application_t *app;
 975   int rv;
 976
 977   ASSERT (vlib_thread_is_main_w_barrier ());
 978
 979   app = application_get_if_valid (a->app_index);
 980   if (!app)
 981     return SESSION_E_NOAPP;
 982
 983   app_wrk = application_get_worker (app, a->wrk_map_index);
 984   if (!app_wrk)
 985     return SESSION_E_INVALID_APPWRK;
 986
 987   a->sep_ext.app_wrk_index = app_wrk->wrk_index;
 988
 989   session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
 990   if (!session_endpoint_in_ns (&a->sep))
 991     return SESSION_E_INVALID_NS;
 992
 993   /*
 994    * Check if we already have an app listener
 995    */
 996   app_listener = app_listener_lookup (app, &a->sep_ext);
 997   if (app_listener)
 998     {
 999       if (app_listener->app_index != app->app_index)
1000         return SESSION_E_ALREADY_LISTENING;
1001       if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1002         return rv;
1003       a->handle = app_listener_handle (app_listener);
1004       return 0;
1005     }
1006
1007   /*
1008    * Create new app listener
1009    */
1010   if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1011     return rv;
1012
1013   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1014     {
1015       app_listener_cleanup (app_listener);
1016       return rv;
1017     }
1018
1019   a->handle = app_listener_handle (app_listener);
1020   return 0;
1021 }
1022
1023 int
1024 vnet_connect (vnet_connect_args_t * a)
1025 {
1026   app_worker_t *client_wrk;
1027   application_t *client;
1028
1029   ASSERT (vlib_thread_is_main_w_barrier ());
1030
1031   if (session_endpoint_is_zero (&a->sep))
1032     return SESSION_E_INVALID_RMT_IP;
1033
1034   client = application_get (a->app_index);
1035   session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1036   client_wrk = application_get_worker (client, a->wrk_map_index);
1037
1038   /*
1039    * First check the local scope for locally attached destinations.
1040    * If we have local scope, we pass *all* connects through it since we may
1041    * have special policy rules even for non-local destinations, think proxy.
1042    */
1043   if (application_has_local_scope (client))
1044     {
1045       int rv;
1046
1047       a->sep_ext.original_tp = a->sep_ext.transport_proto;
1048       a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1049       rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1050       if (rv <= 0)
1051         return rv;
1052       a->sep_ext.transport_proto = a->sep_ext.original_tp;
1053     }
1054   /*
1055    * Not connecting to a local server, propagate to transport
1056    */
1057   return app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1058 }
1059
1060 int
1061 vnet_unlisten (vnet_unlisten_args_t * a)
1062 {
1063   app_worker_t *app_wrk;
1064   app_listener_t *al;
1065   application_t *app;
1066
1067   ASSERT (vlib_thread_is_main_w_barrier ());
1068
1069   if (!(app = application_get_if_valid (a->app_index)))
1070     return SESSION_E_NOAPP;
1071
1072   if (!(al = app_listener_get_w_handle (a->handle)))
1073     return SESSION_E_NOLISTEN;
1074
1075   if (al->app_index != app->app_index)
1076     {
1077       clib_warning ("app doesn't own handle %llu!", a->handle);
1078       return SESSION_E_OWNER;
1079     }
1080
1081   app_wrk = application_get_worker (app, a->wrk_map_index);
1082   if (!app_wrk)
1083     {
1084       clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1085       return SESSION_E_INVALID_APPWRK;
1086     }
1087
1088   return app_worker_stop_listen (app_wrk, al);
1089 }
1090
1091 int
1092 vnet_disconnect_session (vnet_disconnect_args_t * a)
1093 {
1094   app_worker_t *app_wrk;
1095   session_t *s;
1096
1097   s = session_get_from_handle_if_valid (a->handle);
1098   if (!s)
1099     return SESSION_E_NOSESSION;
1100
1101   app_wrk = app_worker_get (s->app_wrk_index);
1102   if (app_wrk->app_index != a->app_index)
1103     return SESSION_E_OWNER;
1104
1105   /* We're peeking into another's thread pool. Make sure */
1106   ASSERT (s->session_index == session_index_from_handle (a->handle));
1107
1108   session_close (s);
1109   return 0;
1110 }
1111
1112 int
1113 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1114 {
1115   app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1116   app_listener_t *app_listener;
1117   application_t *app;
1118   int rv;
1119
1120   if (!old_wrk)
1121     return SESSION_E_INVALID_APPWRK;
1122
1123   hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1124   if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1125       && s->rx_fifo)
1126     segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1127
1128   app = application_get (old_wrk->app_index);
1129   if (!app)
1130     return SESSION_E_NOAPP;
1131
1132   app_listener = app_listener_get (app, s->al_index);
1133
1134   /* Only remove from lb for now */
1135   app_listener->workers = clib_bitmap_set (app_listener->workers,
1136                                            old_wrk->wrk_map_index, 0);
1137
1138   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1139     return rv;
1140
1141   s->app_wrk_index = app_wrk->wrk_index;
1142
1143   return 0;
1144 }
1145
1146 int
1147 application_is_proxy (application_t * app)
1148 {
1149   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1150 }
1151
1152 int
1153 application_is_builtin (application_t * app)
1154 {
1155   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1156 }
1157
1158 int
1159 application_is_builtin_proxy (application_t * app)
1160 {
1161   return (application_is_proxy (app) && application_is_builtin (app));
1162 }
1163
1164 u8
1165 application_has_local_scope (application_t * app)
1166 {
1167   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1168 }
1169
1170 u8
1171 application_has_global_scope (application_t * app)
1172 {
1173   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1174 }
1175
1176 static clib_error_t *
1177 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1178                                         u8 transport_proto, u8 is_start)
1179 {
1180   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1181   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1182   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1183   transport_connection_t *tc;
1184   app_worker_t *app_wrk;
1185   app_listener_t *al;
1186   session_t *s;
1187   u32 flags;
1188
1189   /* TODO decide if we want proxy to be enabled for all workers */
1190   app_wrk = application_get_default_worker (app);
1191   if (is_start)
1192     {
1193       s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1194       if (!s)
1195         {
1196           sep.is_ip4 = is_ip4;
1197           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1198           sep.sw_if_index = app_ns->sw_if_index;
1199           sep.transport_proto = transport_proto;
1200           sep.app_wrk_index = app_wrk->wrk_index;       /* only default */
1201
1202           /* force global scope listener */
1203           flags = app->flags;
1204           app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1205           app_listener_alloc_and_init (app, &sep, &al);
1206           app->flags = flags;
1207
1208           app_worker_start_listen (app_wrk, al);
1209           s = listen_session_get (al->session_index);
1210           s->flags |= SESSION_F_PROXY;
1211         }
1212     }
1213   else
1214     {
1215       s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1216       ASSERT (s);
1217     }
1218
1219   tc = listen_session_get_transport (s);
1220
1221   if (!ip_is_zero (&tc->lcl_ip, 1))
1222     {
1223       u32 sti;
1224       sep.is_ip4 = is_ip4;
1225       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1226       sep.transport_proto = transport_proto;
1227       sep.port = 0;
1228       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1229       if (is_start)
1230         session_lookup_add_session_endpoint (sti,
1231                                              (session_endpoint_t *) & sep,
1232                                              s->session_index);
1233       else
1234         session_lookup_del_session_endpoint (sti,
1235                                              (session_endpoint_t *) & sep);
1236     }
1237
1238   return 0;
1239 }
1240
1241 static void
1242 application_start_stop_proxy_local_scope (application_t * app,
1243                                           u8 transport_proto, u8 is_start)
1244 {
1245   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1246   app_namespace_t *app_ns;
1247   app_ns = app_namespace_get (app->ns_index);
1248   sep.is_ip4 = 1;
1249   sep.transport_proto = transport_proto;
1250   sep.port = 0;
1251
1252   if (is_start)
1253     {
1254       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1255                                            app->app_index);
1256       sep.is_ip4 = 0;
1257       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1258                                            app->app_index);
1259     }
1260   else
1261     {
1262       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1263       sep.is_ip4 = 0;
1264       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1265     }
1266 }
1267
1268 void
1269 application_start_stop_proxy (application_t * app,
1270                               transport_proto_t transport_proto, u8 is_start)
1271 {
1272   if (application_has_local_scope (app))
1273     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1274
1275   if (application_has_global_scope (app))
1276     {
1277       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1278                                               transport_proto, is_start);
1279       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1280                                               transport_proto, is_start);
1281     }
1282 }
1283
1284 void
1285 application_setup_proxy (application_t * app)
1286 {
1287   u16 transports = app->proxied_transports;
1288   transport_proto_t tp;
1289
1290   ASSERT (application_is_proxy (app));
1291
1292   /* *INDENT-OFF* */
1293   transport_proto_foreach (tp, ({
1294     if (transports & (1 << tp))
1295       application_start_stop_proxy (app, tp, 1);
1296   }));
1297   /* *INDENT-ON* */
1298 }
1299
1300 void
1301 application_remove_proxy (application_t * app)
1302 {
1303   u16 transports = app->proxied_transports;
1304   transport_proto_t tp;
1305
1306   ASSERT (application_is_proxy (app));
1307
1308   /* *INDENT-OFF* */
1309   transport_proto_foreach (tp, ({
1310     if (transports & (1 << tp))
1311       application_start_stop_proxy (app, tp, 0);
1312   }));
1313   /* *INDENT-ON* */
1314 }
1315
1316 segment_manager_props_t *
1317 application_segment_manager_properties (application_t * app)
1318 {
1319   return &app->sm_properties;
1320 }
1321
1322 segment_manager_props_t *
1323 application_get_segment_manager_properties (u32 app_index)
1324 {
1325   application_t *app = application_get (app_index);
1326   return &app->sm_properties;
1327 }
1328
1329 clib_error_t *
1330 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1331 {
1332   /* Deprected, will be remove after 20.01 */
1333   app_cert_key_pair_t *ckpair;
1334   ckpair = app_cert_key_pair_get_default ();
1335   ckpair->cert = vec_dup (a->cert);
1336   return 0;
1337 }
1338
1339 clib_error_t *
1340 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1341 {
1342   /* Deprected, will be remove after 20.01 */
1343   app_cert_key_pair_t *ckpair;
1344   ckpair = app_cert_key_pair_get_default ();
1345   ckpair->key = vec_dup (a->key);
1346   return 0;
1347 }
1348
1349 static void
1350 application_format_listeners (application_t * app, int verbose)
1351 {
1352   vlib_main_t *vm = vlib_get_main ();
1353   app_worker_map_t *wrk_map;
1354   app_worker_t *app_wrk;
1355   u32 sm_index;
1356   u64 handle;
1357
1358   if (!app)
1359     {
1360       vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1361                        0, 0, verbose);
1362       return;
1363     }
1364
1365   /* *INDENT-OFF* */
1366   pool_foreach (wrk_map, app->worker_maps, ({
1367     app_wrk = app_worker_get (wrk_map->wrk_index);
1368     if (hash_elts (app_wrk->listeners_table) == 0)
1369       continue;
1370     hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1371       vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1372                        handle, sm_index, verbose);
1373     }));
1374   }));
1375   /* *INDENT-ON* */
1376 }
1377
1378 static void
1379 application_format_connects (application_t * app, int verbose)
1380 {
1381   app_worker_map_t *wrk_map;
1382   app_worker_t *app_wrk;
1383
1384   if (!app)
1385     {
1386       app_worker_format_connects (0, verbose);
1387       return;
1388     }
1389
1390   /* *INDENT-OFF* */
1391   pool_foreach (wrk_map, app->worker_maps, ({
1392     app_wrk = app_worker_get (wrk_map->wrk_index);
1393     app_worker_format_connects (app_wrk, verbose);
1394   }));
1395   /* *INDENT-ON* */
1396 }
1397
1398 u8 *
1399 format_cert_key_pair (u8 * s, va_list * args)
1400 {
1401   app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1402   int key_len = 0, cert_len = 0;
1403   cert_len = vec_len (ckpair->cert);
1404   key_len = vec_len (ckpair->key);
1405   if (ckpair->cert_key_index == 0)
1406     s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1407   else
1408     s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1409                 cert_len, key_len);
1410   return s;
1411 }
1412
1413 u8 *
1414 format_crypto_engine (u8 * s, va_list * args)
1415 {
1416   u32 engine = va_arg (*args, u32);
1417   switch (engine)
1418     {
1419     case CRYPTO_ENGINE_NONE:
1420       return format (s, "none");
1421     case CRYPTO_ENGINE_MBEDTLS:
1422       return format (s, "mbedtls");
1423     case CRYPTO_ENGINE_OPENSSL:
1424       return format (s, "openssl");
1425     case CRYPTO_ENGINE_PICOTLS:
1426       return format (s, "picotls");
1427     case CRYPTO_ENGINE_VPP:
1428       return format (s, "vpp");
1429     default:
1430       return format (s, "unknown engine");
1431     }
1432   return s;
1433 }
1434
1435 uword
1436 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1437 {
1438   u8 *a = va_arg (*args, u8 *);
1439   if (unformat (input, "mbedtls"))
1440     *a = CRYPTO_ENGINE_MBEDTLS;
1441   else if (unformat (input, "openssl"))
1442     *a = CRYPTO_ENGINE_OPENSSL;
1443   else if (unformat (input, "picotls"))
1444     *a = CRYPTO_ENGINE_PICOTLS;
1445   else if (unformat (input, "vpp"))
1446     *a = CRYPTO_ENGINE_VPP;
1447   else
1448     return 0;
1449   return 1;
1450 }
1451
1452 u8 *
1453 format_crypto_context (u8 * s, va_list * args)
1454 {
1455   crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1456   s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1457               crctx->n_subscribers, crctx->ckpair_index);
1458   s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1459   return s;
1460 }
1461
1462 u8 *
1463 format_application (u8 * s, va_list * args)
1464 {
1465   application_t *app = va_arg (*args, application_t *);
1466   CLIB_UNUSED (int verbose) = va_arg (*args, int);
1467   segment_manager_props_t *props;
1468   const u8 *app_ns_name, *app_name;
1469   app_worker_map_t *wrk_map;
1470   app_worker_t *app_wrk;
1471
1472   if (app == 0)
1473     {
1474       if (!verbose)
1475         s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1476       return s;
1477     }
1478
1479   app_name = app_get_name (app);
1480   app_ns_name = app_namespace_id_from_index (app->ns_index);
1481   props = application_segment_manager_properties (app);
1482   if (!verbose)
1483     {
1484       s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1485                   app_ns_name);
1486       return s;
1487     }
1488
1489   s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1490               app_name, app->app_index, app->ns_index,
1491               format_memory_size, props->add_segment_size);
1492   s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1493               format_memory_size, props->rx_fifo_size,
1494               format_memory_size, props->tx_fifo_size);
1495
1496   /* *INDENT-OFF* */
1497   pool_foreach (wrk_map, app->worker_maps, ({
1498       app_wrk = app_worker_get (wrk_map->wrk_index);
1499       s = format (s, "%U", format_app_worker, app_wrk);
1500   }));
1501   /* *INDENT-ON* */
1502
1503   return s;
1504 }
1505
1506 void
1507 application_format_all_listeners (vlib_main_t * vm, int verbose)
1508 {
1509   application_t *app;
1510
1511   if (!pool_elts (app_main.app_pool))
1512     {
1513       vlib_cli_output (vm, "No active server bindings");
1514       return;
1515     }
1516
1517   application_format_listeners (0, verbose);
1518
1519   /* *INDENT-OFF* */
1520   pool_foreach (app, app_main.app_pool, ({
1521     application_format_listeners (app, verbose);
1522   }));
1523   /* *INDENT-ON* */
1524 }
1525
1526 void
1527 application_format_all_clients (vlib_main_t * vm, int verbose)
1528 {
1529   application_t *app;
1530
1531   if (!pool_elts (app_main.app_pool))
1532     {
1533       vlib_cli_output (vm, "No active apps");
1534       return;
1535     }
1536
1537   application_format_connects (0, verbose);
1538
1539   /* *INDENT-OFF* */
1540   pool_foreach (app, app_main.app_pool, ({
1541     application_format_connects (app, verbose);
1542   }));
1543   /* *INDENT-ON* */
1544 }
1545
1546 static clib_error_t *
1547 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1548                              vlib_cli_command_t * cmd)
1549 {
1550   app_cert_key_pair_t *ckpair;
1551   session_cli_return_if_not_enabled ();
1552
1553   /* *INDENT-OFF* */
1554   pool_foreach (ckpair, app_main.cert_key_pair_store, ({
1555     vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1556   }));
1557   /* *INDENT-ON* */
1558   return 0;
1559 }
1560
1561 static inline void
1562 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1563 {
1564   app_worker_map_t *map;
1565   app_worker_t *wrk;
1566   /* *INDENT-OFF* */
1567   pool_foreach (map, app->worker_maps, ({
1568     wrk = app_worker_get (map->wrk_index);
1569     vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1570                      map->wrk_index, format_svm_msg_q,
1571                      wrk->event_queue);
1572   }));
1573   /* *INDENT-ON* */
1574 }
1575
1576 static clib_error_t *
1577 appliction_format_all_app_mq (vlib_main_t * vm)
1578 {
1579   application_t *app;
1580   int i, n_threads;
1581
1582   n_threads = vec_len (vlib_mains);
1583
1584   for (i = 0; i < n_threads; i++)
1585     {
1586       vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1587                        session_main_get_vpp_event_queue (i));
1588     }
1589
1590   /* *INDENT-OFF* */
1591   pool_foreach (app, app_main.app_pool, ({
1592       appliction_format_app_mq (vm, app);
1593   }));
1594   /* *INDENT-ON* */
1595   return 0;
1596 }
1597
1598 static clib_error_t *
1599 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1600                      vlib_cli_command_t * cmd)
1601 {
1602   int do_server = 0, do_client = 0, do_mq = 0;
1603   application_t *app;
1604   u32 app_index = ~0;
1605   int verbose = 0;
1606
1607   session_cli_return_if_not_enabled ();
1608
1609   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1610     {
1611       if (unformat (input, "server"))
1612         do_server = 1;
1613       else if (unformat (input, "client"))
1614         do_client = 1;
1615       else if (unformat (input, "mq"))
1616         do_mq = 1;
1617       else if (unformat (input, "%u", &app_index))
1618         ;
1619       else if (unformat (input, "verbose"))
1620         verbose = 1;
1621       else
1622         return clib_error_return (0, "unknown input `%U'",
1623                                   format_unformat_error, input);
1624     }
1625
1626   if (do_mq && app_index != ~0)
1627     {
1628       app = application_get_if_valid (app_index);
1629       if (!app)
1630         return clib_error_return (0, "No app with index %u", app_index);
1631
1632       appliction_format_app_mq (vm, app);
1633       return 0;
1634     }
1635
1636   if (do_mq)
1637     {
1638       appliction_format_all_app_mq (vm);
1639       return 0;
1640     }
1641
1642   if (do_server)
1643     {
1644       application_format_all_listeners (vm, verbose);
1645       return 0;
1646     }
1647
1648   if (do_client)
1649     {
1650       application_format_all_clients (vm, verbose);
1651       return 0;
1652     }
1653
1654   if (app_index != ~0)
1655     {
1656       app = application_get_if_valid (app_index);
1657       if (!app)
1658         return clib_error_return (0, "No app with index %u", app_index);
1659
1660       vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1661       return 0;
1662     }
1663
1664   /* Print app related info */
1665   if (!do_server && !do_client)
1666     {
1667       vlib_cli_output (vm, "%U", format_application, 0, 0);
1668       /* *INDENT-OFF* */
1669       pool_foreach (app, app_main.app_pool, ({
1670         vlib_cli_output (vm, "%U", format_application, app, 0);
1671       }));
1672       /* *INDENT-ON* */
1673     }
1674
1675   return 0;
1676 }
1677
1678 /* Certificate store */
1679
1680 static app_cert_key_pair_t *
1681 app_cert_key_pair_alloc ()
1682 {
1683   app_cert_key_pair_t *ckpair;
1684   pool_get (app_main.cert_key_pair_store, ckpair);
1685   clib_memset (ckpair, 0, sizeof (*ckpair));
1686   ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
1687   return ckpair;
1688 }
1689
1690 app_cert_key_pair_t *
1691 app_cert_key_pair_get_if_valid (u32 index)
1692 {
1693   if (pool_is_free_index (app_main.cert_key_pair_store, index))
1694     return 0;
1695   return app_cert_key_pair_get (index);
1696 }
1697
1698 app_cert_key_pair_t *
1699 app_cert_key_pair_get (u32 index)
1700 {
1701   return pool_elt_at_index (app_main.cert_key_pair_store, index);
1702 }
1703
1704 app_cert_key_pair_t *
1705 app_cert_key_pair_get_default ()
1706 {
1707   /* To maintain legacy bapi */
1708   return app_cert_key_pair_get (0);
1709 }
1710
1711 int
1712 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
1713 {
1714   app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
1715   ckpair->cert = vec_dup (a->cert);
1716   ckpair->key = vec_dup (a->key);
1717   a->index = ckpair->cert_key_index;
1718   return 0;
1719 }
1720
1721 int
1722 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
1723 {
1724   app_cert_key_pair_t *ckpair;
1725   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1726     return -1;
1727   if (vec_search (ckpair->app_interests, app_index) != ~0)
1728     vec_add1 (ckpair->app_interests, app_index);
1729   return 0;
1730 }
1731
1732 int
1733 vnet_app_del_cert_key_pair (u32 index)
1734 {
1735   app_cert_key_pair_t *ckpair;
1736   application_t *app;
1737   u32 *app_index;
1738
1739   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1740     return (VNET_API_ERROR_INVALID_VALUE);
1741
1742   vec_foreach (app_index, ckpair->app_interests)
1743   {
1744     if ((app = application_get_if_valid (*app_index))
1745         && app->cb_fns.app_cert_key_pair_delete_callback)
1746       app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
1747   }
1748
1749   vec_free (ckpair->cert);
1750   vec_free (ckpair->key);
1751   pool_put (app_main.cert_key_pair_store, ckpair);
1752   return 0;
1753 }
1754
1755 clib_error_t *
1756 application_init (vlib_main_t * vm)
1757 {
1758   /* Add a certificate with index 0 to support legacy apis */
1759   (void) app_cert_key_pair_alloc ();
1760   app_main.last_crypto_engine = CRYPTO_ENGINE_LAST;
1761   app_main.app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
1762   return 0;
1763 }
1764
1765 /* *INDENT-OFF* */
1766 VLIB_INIT_FUNCTION (application_init);
1767
1768 VLIB_CLI_COMMAND (show_app_command, static) =
1769 {
1770   .path = "show app",
1771   .short_help = "show app [app_id] [server|client] [mq] [verbose]",
1772   .function = show_app_command_fn,
1773 };
1774
1775 VLIB_CLI_COMMAND (show_certificate_command, static) =
1776 {
1777   .path = "show app certificate",
1778   .short_help = "list app certs and keys present in store",
1779   .function = show_certificate_command_fn,
1780 };
1781 /* *INDENT-ON* */
1782
1783 crypto_engine_type_t
1784 app_crypto_engine_type_add (void)
1785 {
1786   return (++app_main.last_crypto_engine);
1787 }
1788
1789 u8
1790 app_crypto_engine_n_types (void)
1791 {
1792   return (app_main.last_crypto_engine + 1);
1793 }
1794
1795 /*
1796  * fd.io coding-style-patch-verification: ON
1797  *
1798  * Local Variables:
1799  * eval: (c-set-style "gnu")
1800  * End:
1801  */