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       reg = vl_api_client_index_to_registration (a->api_client_index);
 499       if (!reg)
 500         return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 501       if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 502         seg_type = SSVM_SEGMENT_SHM;
 503     }
 504   else
 505     {
 506       seg_type = SSVM_SEGMENT_PRIVATE;
 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   /* Check that the obvious things are properly set up */
 521   application_verify_cb_fns (a->session_cb_vft);
 522
 523   app->flags = options[APP_OPTIONS_FLAGS];
 524   app->cb_fns = *a->session_cb_vft;
 525   app->ns_index = options[APP_OPTIONS_NAMESPACE];
 526   app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
 527   app->name = vec_dup (a->name);
 528
 529   /* If no scope enabled, default to global */
 530   if (!application_has_global_scope (app)
 531       && !application_has_local_scope (app))
 532     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 533
 534   props = application_segment_manager_properties (app);
 535   segment_manager_props_init (props);
 536   props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
 537   props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
 538   if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
 539     {
 540       props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
 541       props->add_segment = 1;
 542     }
 543   if (options[APP_OPTIONS_RX_FIFO_SIZE])
 544     props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
 545   if (options[APP_OPTIONS_TX_FIFO_SIZE])
 546     props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
 547   if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
 548     props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
 549   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 550     props->use_mq_eventfd = 1;
 551   if (options[APP_OPTIONS_TLS_ENGINE])
 552     app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
 553   props->segment_type = seg_type;
 554
 555   /* Add app to lookup by api_client_index table */
 556   if (!application_is_builtin (app))
 557     application_api_table_add (app->app_index, a->api_client_index);
 558   else
 559     application_name_table_add (app);
 560
 561   a->app_index = app->app_index;
 562
 563   APP_DBG ("New app name: %v api index: %u index %u", app->name,
 564            a->api_client_index, app->app_index);
 565
 566   return 0;
 567 }
 568
 569 static void
 570 application_free (application_t * app)
 571 {
 572   app_worker_map_t *wrk_map;
 573   app_worker_t *app_wrk;
 574
 575   /*
 576    * The app event queue allocated in first segment is cleared with
 577    * the segment manager. No need to explicitly free it.
 578    */
 579   APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
 580
 581   if (application_is_proxy (app))
 582     application_remove_proxy (app);
 583
 584   /*
 585    * Free workers
 586    */
 587
 588   /* *INDENT-OFF* */
 589   pool_flush (wrk_map, app->worker_maps, ({
 590     app_wrk = app_worker_get (wrk_map->wrk_index);
 591     app_worker_free (app_wrk);
 592   }));
 593   /* *INDENT-ON* */
 594   pool_free (app->worker_maps);
 595
 596   /*
 597    * Cleanup remaining state
 598    */
 599   if (application_is_builtin (app))
 600     application_name_table_del (app);
 601   vec_free (app->name);
 602   pool_put (app_main.app_pool, app);
 603 }
 604
 605 static void
 606 application_detach_process (application_t * app, u32 api_client_index)
 607 {
 608   vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
 609   app_worker_map_t *wrk_map;
 610   u32 *wrks = 0, *wrk_index;
 611   app_worker_t *app_wrk;
 612
 613   if (api_client_index == ~0)
 614     {
 615       application_free (app);
 616       return;
 617     }
 618
 619   APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
 620            app->app_index, api_client_index);
 621
 622   /* *INDENT-OFF* */
 623   pool_foreach (wrk_map, app->worker_maps, ({
 624     app_wrk = app_worker_get (wrk_map->wrk_index);
 625     if (app_wrk->api_client_index == api_client_index)
 626       vec_add1 (wrks, app_wrk->wrk_index);
 627   }));
 628   /* *INDENT-ON* */
 629
 630   if (!vec_len (wrks))
 631     {
 632       clib_warning ("no workers for app %u api_index %u", app->app_index,
 633                     api_client_index);
 634       return;
 635     }
 636
 637   args->app_index = app->app_index;
 638   args->api_client_index = api_client_index;
 639   vec_foreach (wrk_index, wrks)
 640   {
 641     app_wrk = app_worker_get (wrk_index[0]);
 642     args->wrk_map_index = app_wrk->wrk_map_index;
 643     args->is_add = 0;
 644     vnet_app_worker_add_del (args);
 645   }
 646   vec_free (wrks);
 647 }
 648
 649 app_worker_t *
 650 application_get_worker (application_t * app, u32 wrk_map_index)
 651 {
 652   app_worker_map_t *map;
 653   map = app_worker_map_get (app, wrk_map_index);
 654   if (!map)
 655     return 0;
 656   return app_worker_get (map->wrk_index);
 657 }
 658
 659 app_worker_t *
 660 application_get_default_worker (application_t * app)
 661 {
 662   return application_get_worker (app, 0);
 663 }
 664
 665 u32
 666 application_n_workers (application_t * app)
 667 {
 668   return pool_elts (app->worker_maps);
 669 }
 670
 671 app_worker_t *
 672 application_listener_select_worker (session_t * ls)
 673 {
 674   application_t *app;
 675   app_listener_t *al;
 676
 677   app = application_get (ls->app_index);
 678   al = app_listener_get (app, ls->al_index);
 679   return app_listener_select_worker (app, al);
 680 }
 681
 682 int
 683 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
 684 {
 685   app_worker_map_t *wrk_map;
 686   app_worker_t *app_wrk;
 687   segment_manager_t *sm;
 688   int rv;
 689
 690   app_wrk = app_worker_alloc (app);
 691   wrk_map = app_worker_map_alloc (app);
 692   wrk_map->wrk_index = app_wrk->wrk_index;
 693   app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
 694
 695   /*
 696    * Setup first segment manager
 697    */
 698   sm = segment_manager_alloc ();
 699   sm->app_wrk_index = app_wrk->wrk_index;
 700
 701   if ((rv = segment_manager_init (sm, app->sm_properties.segment_size,
 702                                   app->sm_properties.prealloc_fifos)))
 703     {
 704       app_worker_free (app_wrk);
 705       return rv;
 706     }
 707   sm->first_is_protected = 1;
 708
 709   /*
 710    * Setup app worker
 711    */
 712   app_wrk->first_segment_manager = segment_manager_index (sm);
 713   app_wrk->listeners_table = hash_create (0, sizeof (u64));
 714   app_wrk->event_queue = segment_manager_event_queue (sm);
 715   app_wrk->app_is_builtin = application_is_builtin (app);
 716
 717   *wrk = app_wrk;
 718
 719   return 0;
 720 }
 721
 722 int
 723 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
 724 {
 725   fifo_segment_t *fs;
 726   app_worker_map_t *wrk_map;
 727   app_worker_t *app_wrk;
 728   segment_manager_t *sm;
 729   application_t *app;
 730   int rv;
 731
 732   app = application_get (a->app_index);
 733   if (!app)
 734     return VNET_API_ERROR_INVALID_VALUE;
 735
 736   if (a->is_add)
 737     {
 738       if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
 739         return rv;
 740
 741       /* Map worker api index to the app */
 742       app_wrk->api_client_index = a->api_client_index;
 743       application_api_table_add (app->app_index, a->api_client_index);
 744
 745       sm = segment_manager_get (app_wrk->first_segment_manager);
 746       fs = segment_manager_get_segment_w_lock (sm, 0);
 747       a->segment = &fs->ssvm;
 748       a->segment_handle = segment_manager_segment_handle (sm, fs);
 749       segment_manager_segment_reader_unlock (sm);
 750       a->evt_q = app_wrk->event_queue;
 751       a->wrk_map_index = app_wrk->wrk_map_index;
 752     }
 753   else
 754     {
 755       wrk_map = app_worker_map_get (app, a->wrk_map_index);
 756       if (!wrk_map)
 757         return VNET_API_ERROR_INVALID_VALUE;
 758
 759       app_wrk = app_worker_get (wrk_map->wrk_index);
 760       if (!app_wrk)
 761         return VNET_API_ERROR_INVALID_VALUE;
 762
 763       application_api_table_del (app_wrk->api_client_index);
 764       app_worker_free (app_wrk);
 765       app_worker_map_free (app, wrk_map);
 766       if (application_n_workers (app) == 0)
 767         application_free (app);
 768     }
 769   return 0;
 770 }
 771
 772 static int
 773 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
 774 {
 775   app_namespace_t *app_ns;
 776   if (vec_len (namespace_id) == 0)
 777     {
 778       /* Use default namespace */
 779       *app_ns_index = 0;
 780       return 0;
 781     }
 782
 783   *app_ns_index = app_namespace_index_from_id (namespace_id);
 784   if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
 785     return VNET_API_ERROR_APP_INVALID_NS;
 786   app_ns = app_namespace_get (*app_ns_index);
 787   if (!app_ns)
 788     return VNET_API_ERROR_APP_INVALID_NS;
 789   if (app_ns->ns_secret != secret)
 790     return VNET_API_ERROR_APP_WRONG_NS_SECRET;
 791   return 0;
 792 }
 793
 794 static u8 *
 795 app_name_from_api_index (u32 api_client_index)
 796 {
 797   vl_api_registration_t *regp;
 798   regp = vl_api_client_index_to_registration (api_client_index);
 799   if (regp)
 800     return format (0, "%s", regp->name);
 801
 802   clib_warning ("api client index %u does not have an api registration!",
 803                 api_client_index);
 804   return format (0, "unknown");
 805 }
 806
 807 /**
 808  * Attach application to vpp
 809  *
 810  * Allocates a vpp app, i.e., a structure that keeps back pointers
 811  * to external app and a segment manager for shared memory fifo based
 812  * communication with the external app.
 813  */
 814 int
 815 vnet_application_attach (vnet_app_attach_args_t * a)
 816 {
 817   fifo_segment_t *fs;
 818   application_t *app = 0;
 819   app_worker_t *app_wrk;
 820   segment_manager_t *sm;
 821   u32 app_ns_index = 0;
 822   u8 *app_name = 0;
 823   u64 secret;
 824   int rv;
 825
 826   if (a->api_client_index != APP_INVALID_INDEX)
 827     app = application_lookup (a->api_client_index);
 828   else if (a->name)
 829     app = application_lookup_name (a->name);
 830   else
 831     return VNET_API_ERROR_INVALID_VALUE;
 832
 833   if (app)
 834     return VNET_API_ERROR_APP_ALREADY_ATTACHED;
 835
 836   if (a->api_client_index != APP_INVALID_INDEX)
 837     {
 838       app_name = app_name_from_api_index (a->api_client_index);
 839       a->name = app_name;
 840     }
 841
 842   secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
 843   if ((rv = app_validate_namespace (a->namespace_id, secret, &app_ns_index)))
 844     return rv;
 845   a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
 846
 847   if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
 848     return rv;
 849
 850   app = application_get (a->app_index);
 851   if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
 852     return rv;
 853
 854   a->app_evt_q = app_wrk->event_queue;
 855   app_wrk->api_client_index = a->api_client_index;
 856   sm = segment_manager_get (app_wrk->first_segment_manager);
 857   fs = segment_manager_get_segment_w_lock (sm, 0);
 858
 859   if (application_is_proxy (app))
 860     application_setup_proxy (app);
 861
 862   ASSERT (vec_len (fs->ssvm.name) <= 128);
 863   a->segment = &fs->ssvm;
 864   a->segment_handle = segment_manager_segment_handle (sm, fs);
 865
 866   segment_manager_segment_reader_unlock (sm);
 867   vec_free (app_name);
 868   return 0;
 869 }
 870
 871 /**
 872  * Detach application from vpp
 873  */
 874 int
 875 vnet_application_detach (vnet_app_detach_args_t * a)
 876 {
 877   application_t *app;
 878
 879   app = application_get_if_valid (a->app_index);
 880   if (!app)
 881     {
 882       clib_warning ("app not attached");
 883       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 884     }
 885
 886   app_interface_check_thread_and_barrier (vnet_application_detach, a);
 887   application_detach_process (app, a->api_client_index);
 888   return 0;
 889 }
 890
 891
 892 static u8
 893 session_endpoint_in_ns (session_endpoint_t * sep)
 894 {
 895   u8 is_lep = session_endpoint_is_local (sep);
 896   if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
 897       && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
 898     {
 899       clib_warning ("sw_if_index %u not configured with ip %U",
 900                     sep->sw_if_index, format_ip46_address, &sep->ip,
 901                     sep->is_ip4);
 902       return 0;
 903     }
 904   return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
 905 }
 906
 907 static void
 908 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
 909                                  application_t * app, u8 is_connect)
 910 {
 911   app_namespace_t *app_ns;
 912   u32 ns_index, fib_index;
 913
 914   ns_index = app->ns_index;
 915
 916   /* App is a transport proto, so fetch the calling app's ns */
 917   if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
 918     ns_index = sep->ns_index;
 919
 920   app_ns = app_namespace_get (ns_index);
 921   if (!app_ns)
 922     return;
 923
 924   /* Ask transport and network to bind to/connect using local interface
 925    * that "supports" app's namespace. This will fix our local connection
 926    * endpoint.
 927    */
 928
 929   /* If in default namespace and user requested a fib index use it */
 930   if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
 931     fib_index = sep->fib_index;
 932   else
 933     fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
 934   sep->peer.fib_index = fib_index;
 935   sep->fib_index = fib_index;
 936
 937   if (!is_connect)
 938     {
 939       sep->sw_if_index = app_ns->sw_if_index;
 940     }
 941   else
 942     {
 943       if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
 944           && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
 945           && sep->peer.sw_if_index != app_ns->sw_if_index)
 946         clib_warning ("Local sw_if_index different from app ns sw_if_index");
 947
 948       sep->peer.sw_if_index = app_ns->sw_if_index;
 949     }
 950 }
 951
 952 int
 953 vnet_listen (vnet_listen_args_t * a)
 954 {
 955   app_listener_t *app_listener;
 956   app_worker_t *app_wrk;
 957   application_t *app;
 958   int rv;
 959
 960   ASSERT (vlib_thread_is_main_w_barrier ());
 961
 962   app = application_get_if_valid (a->app_index);
 963   if (!app)
 964     return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 965
 966   app_wrk = application_get_worker (app, a->wrk_map_index);
 967   if (!app_wrk)
 968     return VNET_API_ERROR_INVALID_VALUE;
 969
 970   a->sep_ext.app_wrk_index = app_wrk->wrk_index;
 971
 972   session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
 973   if (!session_endpoint_in_ns (&a->sep))
 974     return VNET_API_ERROR_INVALID_VALUE_2;
 975
 976   /*
 977    * Check if we already have an app listener
 978    */
 979   app_listener = app_listener_lookup (app, &a->sep_ext);
 980   if (app_listener)
 981     {
 982       if (app_listener->app_index != app->app_index)
 983         return VNET_API_ERROR_ADDRESS_IN_USE;
 984       if (app_worker_start_listen (app_wrk, app_listener))
 985         return -1;
 986       a->handle = app_listener_handle (app_listener);
 987       return 0;
 988     }
 989
 990   /*
 991    * Create new app listener
 992    */
 993   if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
 994     return rv;
 995
 996   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
 997     {
 998       app_listener_cleanup (app_listener);
 999       return rv;
1000     }
1001
1002   a->handle = app_listener_handle (app_listener);
1003   return 0;
1004 }
1005
1006 int
1007 vnet_connect (vnet_connect_args_t * a)
1008 {
1009   app_worker_t *client_wrk;
1010   application_t *client;
1011
1012   ASSERT (vlib_thread_is_main_w_barrier ());
1013
1014   if (session_endpoint_is_zero (&a->sep))
1015     return VNET_API_ERROR_INVALID_VALUE;
1016
1017   client = application_get (a->app_index);
1018   session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1019   client_wrk = application_get_worker (client, a->wrk_map_index);
1020
1021   /*
1022    * First check the local scope for locally attached destinations.
1023    * If we have local scope, we pass *all* connects through it since we may
1024    * have special policy rules even for non-local destinations, think proxy.
1025    */
1026   if (application_has_local_scope (client))
1027     {
1028       int rv;
1029
1030       a->sep_ext.original_tp = a->sep_ext.transport_proto;
1031       a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1032       rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1033       if (rv <= 0)
1034         return rv;
1035     }
1036   /*
1037    * Not connecting to a local server, propagate to transport
1038    */
1039   if (app_worker_connect_session (client_wrk, &a->sep, a->api_context))
1040     return VNET_API_ERROR_SESSION_CONNECT;
1041   return 0;
1042 }
1043
1044 int
1045 vnet_unlisten (vnet_unlisten_args_t * a)
1046 {
1047   app_worker_t *app_wrk;
1048   app_listener_t *al;
1049   application_t *app;
1050
1051   ASSERT (vlib_thread_is_main_w_barrier ());
1052
1053   if (!(app = application_get_if_valid (a->app_index)))
1054     return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1055
1056   if (!(al = app_listener_get_w_handle (a->handle)))
1057     return -1;
1058
1059   if (al->app_index != app->app_index)
1060     {
1061       clib_warning ("app doesn't own handle %llu!", a->handle);
1062       return -1;
1063     }
1064
1065   app_wrk = application_get_worker (app, a->wrk_map_index);
1066   if (!app_wrk)
1067     {
1068       clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1069       return -1;
1070     }
1071
1072   return app_worker_stop_listen (app_wrk, al);
1073 }
1074
1075 int
1076 vnet_disconnect_session (vnet_disconnect_args_t * a)
1077 {
1078   app_worker_t *app_wrk;
1079   session_t *s;
1080
1081   s = session_get_from_handle_if_valid (a->handle);
1082   if (!s)
1083     return VNET_API_ERROR_INVALID_VALUE;
1084   app_wrk = app_worker_get (s->app_wrk_index);
1085   if (app_wrk->app_index != a->app_index)
1086     return VNET_API_ERROR_INVALID_VALUE;
1087
1088   /* We're peeking into another's thread pool. Make sure */
1089   ASSERT (s->session_index == session_index_from_handle (a->handle));
1090
1091   session_close (s);
1092   return 0;
1093 }
1094
1095 int
1096 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1097 {
1098   app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1099   app_listener_t *app_listener;
1100   application_t *app;
1101
1102   if (!old_wrk)
1103     return -1;
1104
1105   hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1106   if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1107       && s->rx_fifo)
1108     segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1109
1110   app = application_get (old_wrk->app_index);
1111   if (!app)
1112     return -1;
1113
1114   app_listener = app_listener_get (app, s->al_index);
1115
1116   /* Only remove from lb for now */
1117   app_listener->workers = clib_bitmap_set (app_listener->workers,
1118                                            old_wrk->wrk_map_index, 0);
1119
1120   if (app_worker_start_listen (app_wrk, app_listener))
1121     return -1;
1122
1123   s->app_wrk_index = app_wrk->wrk_index;
1124
1125   return 0;
1126 }
1127
1128 int
1129 application_is_proxy (application_t * app)
1130 {
1131   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1132 }
1133
1134 int
1135 application_is_builtin (application_t * app)
1136 {
1137   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1138 }
1139
1140 int
1141 application_is_builtin_proxy (application_t * app)
1142 {
1143   return (application_is_proxy (app) && application_is_builtin (app));
1144 }
1145
1146 u8
1147 application_has_local_scope (application_t * app)
1148 {
1149   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1150 }
1151
1152 u8
1153 application_has_global_scope (application_t * app)
1154 {
1155   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1156 }
1157
1158 static clib_error_t *
1159 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1160                                         u8 transport_proto, u8 is_start)
1161 {
1162   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1163   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1164   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1165   transport_connection_t *tc;
1166   app_worker_t *app_wrk;
1167   app_listener_t *al;
1168   session_t *s;
1169   u32 flags;
1170
1171   /* TODO decide if we want proxy to be enabled for all workers */
1172   app_wrk = application_get_default_worker (app);
1173   if (is_start)
1174     {
1175       s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1176       if (!s)
1177         {
1178           sep.is_ip4 = is_ip4;
1179           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1180           sep.sw_if_index = app_ns->sw_if_index;
1181           sep.transport_proto = transport_proto;
1182           sep.app_wrk_index = app_wrk->wrk_index;       /* only default */
1183
1184           /* force global scope listener */
1185           flags = app->flags;
1186           app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1187           app_listener_alloc_and_init (app, &sep, &al);
1188           app->flags = flags;
1189
1190           app_worker_start_listen (app_wrk, al);
1191           s = listen_session_get (al->session_index);
1192           s->flags |= SESSION_F_PROXY;
1193         }
1194     }
1195   else
1196     {
1197       s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1198       ASSERT (s);
1199     }
1200
1201   tc = listen_session_get_transport (s);
1202
1203   if (!ip_is_zero (&tc->lcl_ip, 1))
1204     {
1205       u32 sti;
1206       sep.is_ip4 = is_ip4;
1207       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1208       sep.transport_proto = transport_proto;
1209       sep.port = 0;
1210       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1211       if (is_start)
1212         session_lookup_add_session_endpoint (sti,
1213                                              (session_endpoint_t *) & sep,
1214                                              s->session_index);
1215       else
1216         session_lookup_del_session_endpoint (sti,
1217                                              (session_endpoint_t *) & sep);
1218     }
1219
1220   return 0;
1221 }
1222
1223 static void
1224 application_start_stop_proxy_local_scope (application_t * app,
1225                                           u8 transport_proto, u8 is_start)
1226 {
1227   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1228   app_namespace_t *app_ns;
1229   app_ns = app_namespace_get (app->ns_index);
1230   sep.is_ip4 = 1;
1231   sep.transport_proto = transport_proto;
1232   sep.port = 0;
1233
1234   if (is_start)
1235     {
1236       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1237                                            app->app_index);
1238       sep.is_ip4 = 0;
1239       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1240                                            app->app_index);
1241     }
1242   else
1243     {
1244       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1245       sep.is_ip4 = 0;
1246       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1247     }
1248 }
1249
1250 void
1251 application_start_stop_proxy (application_t * app,
1252                               transport_proto_t transport_proto, u8 is_start)
1253 {
1254   if (application_has_local_scope (app))
1255     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1256
1257   if (application_has_global_scope (app))
1258     {
1259       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1260                                               transport_proto, is_start);
1261       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1262                                               transport_proto, is_start);
1263     }
1264 }
1265
1266 void
1267 application_setup_proxy (application_t * app)
1268 {
1269   u16 transports = app->proxied_transports;
1270   transport_proto_t tp;
1271
1272   ASSERT (application_is_proxy (app));
1273
1274   /* *INDENT-OFF* */
1275   transport_proto_foreach (tp, ({
1276     if (transports & (1 << tp))
1277       application_start_stop_proxy (app, tp, 1);
1278   }));
1279   /* *INDENT-ON* */
1280 }
1281
1282 void
1283 application_remove_proxy (application_t * app)
1284 {
1285   u16 transports = app->proxied_transports;
1286   transport_proto_t tp;
1287
1288   ASSERT (application_is_proxy (app));
1289
1290   /* *INDENT-OFF* */
1291   transport_proto_foreach (tp, ({
1292     if (transports & (1 << tp))
1293       application_start_stop_proxy (app, tp, 0);
1294   }));
1295   /* *INDENT-ON* */
1296 }
1297
1298 segment_manager_props_t *
1299 application_segment_manager_properties (application_t * app)
1300 {
1301   return &app->sm_properties;
1302 }
1303
1304 segment_manager_props_t *
1305 application_get_segment_manager_properties (u32 app_index)
1306 {
1307   application_t *app = application_get (app_index);
1308   return &app->sm_properties;
1309 }
1310
1311 clib_error_t *
1312 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1313 {
1314   /* Deprected, will be remove after 20.01 */
1315   app_cert_key_pair_t *ckpair;
1316   ckpair = app_cert_key_pair_get_default ();
1317   ckpair->cert = vec_dup (a->cert);
1318   return 0;
1319 }
1320
1321 clib_error_t *
1322 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1323 {
1324   /* Deprected, will be remove after 20.01 */
1325   app_cert_key_pair_t *ckpair;
1326   ckpair = app_cert_key_pair_get_default ();
1327   ckpair->key = vec_dup (a->key);
1328   return 0;
1329 }
1330
1331 static void
1332 application_format_listeners (application_t * app, int verbose)
1333 {
1334   vlib_main_t *vm = vlib_get_main ();
1335   app_worker_map_t *wrk_map;
1336   app_worker_t *app_wrk;
1337   u32 sm_index;
1338   u64 handle;
1339
1340   if (!app)
1341     {
1342       vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1343                        0, 0, verbose);
1344       return;
1345     }
1346
1347   /* *INDENT-OFF* */
1348   pool_foreach (wrk_map, app->worker_maps, ({
1349     app_wrk = app_worker_get (wrk_map->wrk_index);
1350     if (hash_elts (app_wrk->listeners_table) == 0)
1351       continue;
1352     hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1353       vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1354                        handle, sm_index, verbose);
1355     }));
1356   }));
1357   /* *INDENT-ON* */
1358 }
1359
1360 static void
1361 application_format_connects (application_t * app, int verbose)
1362 {
1363   app_worker_map_t *wrk_map;
1364   app_worker_t *app_wrk;
1365
1366   if (!app)
1367     {
1368       app_worker_format_connects (0, verbose);
1369       return;
1370     }
1371
1372   /* *INDENT-OFF* */
1373   pool_foreach (wrk_map, app->worker_maps, ({
1374     app_wrk = app_worker_get (wrk_map->wrk_index);
1375     app_worker_format_connects (app_wrk, verbose);
1376   }));
1377   /* *INDENT-ON* */
1378 }
1379
1380 u8 *
1381 format_cert_key_pair (u8 * s, va_list * args)
1382 {
1383   app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1384   int key_len = 0, cert_len = 0;
1385   cert_len = vec_len (ckpair->cert);
1386   key_len = vec_len (ckpair->key);
1387   if (ckpair->cert_key_index == 0)
1388     s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1389   else
1390     s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1391                 cert_len, key_len);
1392   return s;
1393 }
1394
1395 u8 *
1396 format_crypto_engine (u8 * s, va_list * args)
1397 {
1398   u32 engine = va_arg (*args, u32);
1399   switch (engine)
1400     {
1401     case CRYPTO_ENGINE_NONE:
1402       return format (s, "none");
1403     case CRYPTO_ENGINE_MBEDTLS:
1404       return format (s, "mbedtls");
1405     case CRYPTO_ENGINE_OPENSSL:
1406       return format (s, "openssl");
1407     case CRYPTO_ENGINE_PICOTLS:
1408       return format (s, "picotls");
1409     case CRYPTO_ENGINE_VPP:
1410       return format (s, "vpp");
1411     default:
1412       return format (s, "unknown engine");
1413     }
1414   return s;
1415 }
1416
1417 uword
1418 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1419 {
1420   u8 *a = va_arg (*args, u8 *);
1421   if (unformat (input, "mbedtls"))
1422     *a = CRYPTO_ENGINE_MBEDTLS;
1423   else if (unformat (input, "openssl"))
1424     *a = CRYPTO_ENGINE_OPENSSL;
1425   else if (unformat (input, "picotls"))
1426     *a = CRYPTO_ENGINE_PICOTLS;
1427   else if (unformat (input, "vpp"))
1428     *a = CRYPTO_ENGINE_VPP;
1429   else
1430     return 0;
1431   return 1;
1432 }
1433
1434 u8 *
1435 format_crypto_context (u8 * s, va_list * args)
1436 {
1437   crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1438   s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1439               crctx->n_subscribers, crctx->ckpair_index);
1440   s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1441   return s;
1442 }
1443
1444 u8 *
1445 format_application (u8 * s, va_list * args)
1446 {
1447   application_t *app = va_arg (*args, application_t *);
1448   CLIB_UNUSED (int verbose) = va_arg (*args, int);
1449   segment_manager_props_t *props;
1450   const u8 *app_ns_name, *app_name;
1451   app_worker_map_t *wrk_map;
1452   app_worker_t *app_wrk;
1453
1454   if (app == 0)
1455     {
1456       if (!verbose)
1457         s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1458       return s;
1459     }
1460
1461   app_name = app_get_name (app);
1462   app_ns_name = app_namespace_id_from_index (app->ns_index);
1463   props = application_segment_manager_properties (app);
1464   if (!verbose)
1465     {
1466       s = format (s, "%-10u%-20v%-40s", app->app_index, app_name,
1467                   app_ns_name);
1468       return s;
1469     }
1470
1471   s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1472               app_name, app->app_index, app->ns_index,
1473               format_memory_size, props->add_segment_size);
1474   s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1475               format_memory_size, props->rx_fifo_size,
1476               format_memory_size, props->tx_fifo_size);
1477
1478   /* *INDENT-OFF* */
1479   pool_foreach (wrk_map, app->worker_maps, ({
1480       app_wrk = app_worker_get (wrk_map->wrk_index);
1481       s = format (s, "%U", format_app_worker, app_wrk);
1482   }));
1483   /* *INDENT-ON* */
1484
1485   return s;
1486 }
1487
1488 void
1489 application_format_all_listeners (vlib_main_t * vm, int verbose)
1490 {
1491   application_t *app;
1492
1493   if (!pool_elts (app_main.app_pool))
1494     {
1495       vlib_cli_output (vm, "No active server bindings");
1496       return;
1497     }
1498
1499   application_format_listeners (0, verbose);
1500
1501   /* *INDENT-OFF* */
1502   pool_foreach (app, app_main.app_pool, ({
1503     application_format_listeners (app, verbose);
1504   }));
1505   /* *INDENT-ON* */
1506 }
1507
1508 void
1509 application_format_all_clients (vlib_main_t * vm, int verbose)
1510 {
1511   application_t *app;
1512
1513   if (!pool_elts (app_main.app_pool))
1514     {
1515       vlib_cli_output (vm, "No active apps");
1516       return;
1517     }
1518
1519   application_format_connects (0, verbose);
1520
1521   /* *INDENT-OFF* */
1522   pool_foreach (app, app_main.app_pool, ({
1523     application_format_connects (app, verbose);
1524   }));
1525   /* *INDENT-ON* */
1526 }
1527
1528 static clib_error_t *
1529 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1530                              vlib_cli_command_t * cmd)
1531 {
1532   app_cert_key_pair_t *ckpair;
1533   session_cli_return_if_not_enabled ();
1534
1535   /* *INDENT-OFF* */
1536   pool_foreach (ckpair, app_main.cert_key_pair_store, ({
1537     vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1538   }));
1539   /* *INDENT-ON* */
1540   return 0;
1541 }
1542
1543 static inline void
1544 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1545 {
1546   app_worker_map_t *map;
1547   app_worker_t *wrk;
1548   /* *INDENT-OFF* */
1549   pool_foreach (map, app->worker_maps, ({
1550     wrk = app_worker_get (map->wrk_index);
1551     vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1552                      map->wrk_index, format_svm_msg_q,
1553                      wrk->event_queue);
1554   }));
1555   /* *INDENT-ON* */
1556 }
1557
1558 static clib_error_t *
1559 appliction_format_all_app_mq (vlib_main_t * vm)
1560 {
1561   application_t *app;
1562   int i, n_threads;
1563
1564   n_threads = vec_len (vlib_mains);
1565
1566   for (i = 0; i < n_threads; i++)
1567     {
1568       vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1569                        session_main_get_vpp_event_queue (i));
1570     }
1571
1572   /* *INDENT-OFF* */
1573   pool_foreach (app, app_main.app_pool, ({
1574       appliction_format_app_mq (vm, app);
1575   }));
1576   /* *INDENT-ON* */
1577   return 0;
1578 }
1579
1580 static clib_error_t *
1581 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1582                      vlib_cli_command_t * cmd)
1583 {
1584   int do_server = 0, do_client = 0, do_mq = 0;
1585   application_t *app;
1586   u32 app_index = ~0;
1587   int verbose = 0;
1588
1589   session_cli_return_if_not_enabled ();
1590
1591   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1592     {
1593       if (unformat (input, "server"))
1594         do_server = 1;
1595       else if (unformat (input, "client"))
1596         do_client = 1;
1597       else if (unformat (input, "mq"))
1598         do_mq = 1;
1599       else if (unformat (input, "%u", &app_index))
1600         ;
1601       else if (unformat (input, "verbose"))
1602         verbose = 1;
1603       else
1604         return clib_error_return (0, "unknown input `%U'",
1605                                   format_unformat_error, input);
1606     }
1607
1608   if (do_mq && app_index != ~0)
1609     {
1610       app = application_get_if_valid (app_index);
1611       if (!app)
1612         return clib_error_return (0, "No app with index %u", app_index);
1613
1614       appliction_format_app_mq (vm, app);
1615       return 0;
1616     }
1617
1618   if (do_mq)
1619     {
1620       appliction_format_all_app_mq (vm);
1621       return 0;
1622     }
1623
1624   if (do_server)
1625     {
1626       application_format_all_listeners (vm, verbose);
1627       return 0;
1628     }
1629
1630   if (do_client)
1631     {
1632       application_format_all_clients (vm, verbose);
1633       return 0;
1634     }
1635
1636   if (app_index != ~0)
1637     {
1638       app = application_get_if_valid (app_index);
1639       if (!app)
1640         return clib_error_return (0, "No app with index %u", app_index);
1641
1642       vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1643       return 0;
1644     }
1645
1646   /* Print app related info */
1647   if (!do_server && !do_client)
1648     {
1649       vlib_cli_output (vm, "%U", format_application, 0, 0);
1650       /* *INDENT-OFF* */
1651       pool_foreach (app, app_main.app_pool, ({
1652         vlib_cli_output (vm, "%U", format_application, app, 0);
1653       }));
1654       /* *INDENT-ON* */
1655     }
1656
1657   return 0;
1658 }
1659
1660 /* Certificate store */
1661
1662 static app_cert_key_pair_t *
1663 app_cert_key_pair_alloc ()
1664 {
1665   app_cert_key_pair_t *ckpair;
1666   pool_get (app_main.cert_key_pair_store, ckpair);
1667   clib_memset (ckpair, 0, sizeof (*ckpair));
1668   ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
1669   return ckpair;
1670 }
1671
1672 app_cert_key_pair_t *
1673 app_cert_key_pair_get_if_valid (u32 index)
1674 {
1675   if (pool_is_free_index (app_main.cert_key_pair_store, index))
1676     return 0;
1677   return app_cert_key_pair_get (index);
1678 }
1679
1680 app_cert_key_pair_t *
1681 app_cert_key_pair_get (u32 index)
1682 {
1683   return pool_elt_at_index (app_main.cert_key_pair_store, index);
1684 }
1685
1686 app_cert_key_pair_t *
1687 app_cert_key_pair_get_default ()
1688 {
1689   /* To maintain legacy bapi */
1690   return app_cert_key_pair_get (0);
1691 }
1692
1693 int
1694 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
1695 {
1696   app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
1697   ckpair->cert = vec_dup (a->cert);
1698   ckpair->key = vec_dup (a->key);
1699   a->index = ckpair->cert_key_index;
1700   return 0;
1701 }
1702
1703 int
1704 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
1705 {
1706   app_cert_key_pair_t *ckpair;
1707   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1708     return -1;
1709   if (vec_search (ckpair->app_interests, app_index) != ~0)
1710     vec_add1 (ckpair->app_interests, app_index);
1711   return 0;
1712 }
1713
1714 int
1715 vnet_app_del_cert_key_pair (u32 index)
1716 {
1717   app_cert_key_pair_t *ckpair;
1718   application_t *app;
1719   u32 *app_index;
1720
1721   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1722     return (VNET_API_ERROR_INVALID_VALUE);
1723
1724   vec_foreach (app_index, ckpair->app_interests)
1725   {
1726     if ((app = application_get_if_valid (*app_index))
1727         && app->cb_fns.app_cert_key_pair_delete_callback)
1728       app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
1729   }
1730
1731   vec_free (ckpair->cert);
1732   vec_free (ckpair->key);
1733   pool_put (app_main.cert_key_pair_store, ckpair);
1734   return 0;
1735 }
1736
1737 clib_error_t *
1738 application_init (vlib_main_t * vm)
1739 {
1740   /* Add a certificate with index 0 to support legacy apis */
1741   (void) app_cert_key_pair_alloc ();
1742   app_main.last_crypto_engine = CRYPTO_ENGINE_LAST;
1743   return 0;
1744 }
1745
1746 /* *INDENT-OFF* */
1747 VLIB_INIT_FUNCTION (application_init);
1748
1749 VLIB_CLI_COMMAND (show_app_command, static) =
1750 {
1751   .path = "show app",
1752   .short_help = "show app [app_id] [server|client] [mq] [verbose]",
1753   .function = show_app_command_fn,
1754 };
1755
1756 VLIB_CLI_COMMAND (show_certificate_command, static) =
1757 {
1758   .path = "show app certificate",
1759   .short_help = "list app certs and keys present in store",
1760   .function = show_certificate_command_fn,
1761 };
1762 /* *INDENT-ON* */
1763
1764 crypto_engine_type_t
1765 app_crypto_engine_type_add (void)
1766 {
1767   return (++app_main.last_crypto_engine);
1768 }
1769
1770 u8
1771 app_crypto_engine_n_types (void)
1772 {
1773   return (app_main.last_crypto_engine + 1);
1774 }
1775
1776 /*
1777  * fd.io coding-style-patch-verification: ON
1778  *
1779  * Local Variables:
1780  * eval: (c-set-style "gnu")
1781  * End:
1782  */