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