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