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