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