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 void
 416 appsl_pending_rx_mqs_add_tail (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
 417 {
 418   app_rx_mq_elt_t *head;
 419
 420   if (!aw->pending_rx_mqs)
 421     {
 422       elt->next = elt->prev = elt;
 423       aw->pending_rx_mqs = elt;
 424       return;
 425     }
 426
 427   head = aw->pending_rx_mqs;
 428
 429   ASSERT (head != elt);
 430
 431   elt->prev = head->prev;
 432   elt->next = head;
 433
 434   head->prev->next = elt;
 435   head->prev = elt;
 436 }
 437
 438 void
 439 appsl_pending_rx_mqs_del (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
 440 {
 441   if (elt->next == elt)
 442     {
 443       elt->next = elt->prev = 0;
 444       aw->pending_rx_mqs = 0;
 445       return;
 446     }
 447
 448   if (elt == aw->pending_rx_mqs)
 449     aw->pending_rx_mqs = elt->next;
 450
 451   elt->next->prev = elt->prev;
 452   elt->prev->next = elt->next;
 453   elt->next = elt->prev = 0;
 454 }
 455
 456 vlib_node_registration_t appsl_rx_mqs_input_node;
 457
 458 VLIB_NODE_FN (appsl_rx_mqs_input_node)
 459 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 460 {
 461   u32 thread_index = vm->thread_index, n_msgs = 0;
 462   app_rx_mq_elt_t *elt, *next;
 463   app_main_t *am = &app_main;
 464   session_worker_t *wrk;
 465   int __clib_unused rv;
 466   appsl_wrk_t *aw;
 467   u64 buf;
 468
 469   aw = &am->wrk[thread_index];
 470   elt = aw->pending_rx_mqs;
 471   if (!elt)
 472     return 0;
 473
 474   wrk = session_main_get_worker (thread_index);
 475
 476   do
 477     {
 478       if (!(elt->flags & APP_RX_MQ_F_POSTPONED))
 479         rv = read (svm_msg_q_get_eventfd (elt->mq), &buf, sizeof (buf));
 480       n_msgs += session_wrk_handle_mq (wrk, elt->mq);
 481
 482       next = elt->next;
 483       appsl_pending_rx_mqs_del (aw, elt);
 484       if (!svm_msg_q_is_empty (elt->mq))
 485         {
 486           elt->flags |= APP_RX_MQ_F_POSTPONED;
 487           appsl_pending_rx_mqs_add_tail (aw, elt);
 488         }
 489       else
 490         {
 491           elt->flags = 0;
 492         }
 493       elt = next;
 494     }
 495   while (aw->pending_rx_mqs && elt != aw->pending_rx_mqs);
 496
 497   if (aw->pending_rx_mqs)
 498     vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
 499
 500   if (n_msgs && wrk->state == SESSION_WRK_INTERRUPT)
 501     vlib_node_set_interrupt_pending (vm, session_queue_node.index);
 502
 503   return n_msgs;
 504 }
 505
 506 VLIB_REGISTER_NODE (appsl_rx_mqs_input_node) = {
 507   .name = "appsl-rx-mqs-input",
 508   .type = VLIB_NODE_TYPE_INPUT,
 509   .state = VLIB_NODE_STATE_DISABLED,
 510 };
 511
 512 static clib_error_t *
 513 app_rx_mq_fd_read_ready (clib_file_t *cf)
 514 {
 515   app_rx_mq_handle_t *handle = (app_rx_mq_handle_t *) &cf->private_data;
 516   vlib_main_t *vm = vlib_get_main ();
 517   app_main_t *am = &app_main;
 518   app_rx_mq_elt_t *mqe;
 519   application_t *app;
 520   appsl_wrk_t *aw;
 521
 522   ASSERT (vlib_get_thread_index () == handle->thread_index);
 523   app = application_get_if_valid (handle->app_index);
 524   if (!app)
 525     return 0;
 526
 527   mqe = &app->rx_mqs[handle->thread_index];
 528   if ((mqe->flags & APP_RX_MQ_F_PENDING) || svm_msg_q_is_empty (mqe->mq))
 529     return 0;
 530
 531   aw = &am->wrk[handle->thread_index];
 532   appsl_pending_rx_mqs_add_tail (aw, mqe);
 533   mqe->flags |= APP_RX_MQ_F_PENDING;
 534
 535   vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
 536
 537   return 0;
 538 }
 539
 540 static clib_error_t *
 541 app_rx_mq_fd_write_ready (clib_file_t *cf)
 542 {
 543   clib_warning ("should not be called");
 544   return 0;
 545 }
 546
 547 static void
 548 app_rx_mqs_epoll_add (application_t *app, app_rx_mq_elt_t *mqe)
 549 {
 550   clib_file_t template = { 0 };
 551   app_rx_mq_handle_t handle;
 552   u32 thread_index;
 553   int fd;
 554
 555   thread_index = mqe - app->rx_mqs;
 556   fd = svm_msg_q_get_eventfd (mqe->mq);
 557
 558   handle.app_index = app->app_index;
 559   handle.thread_index = thread_index;
 560
 561   template.read_function = app_rx_mq_fd_read_ready;
 562   template.write_function = app_rx_mq_fd_write_ready;
 563   template.file_descriptor = fd;
 564   template.private_data = handle.as_u64;
 565   template.polling_thread_index = thread_index;
 566   template.description =
 567     format (0, "app-%u-rx-mq-%u", app->app_index, thread_index);
 568   mqe->file_index = clib_file_add (&file_main, &template);
 569 }
 570
 571 static void
 572 app_rx_mqs_epoll_del (application_t *app, app_rx_mq_elt_t *mqe)
 573 {
 574   u32 thread_index = mqe - app->rx_mqs;
 575   app_main_t *am = &app_main;
 576   appsl_wrk_t *aw;
 577
 578   aw = &am->wrk[thread_index];
 579
 580   session_wrk_handle_mq (session_main_get_worker (thread_index), mqe->mq);
 581
 582   if (mqe->flags & APP_RX_MQ_F_PENDING)
 583     appsl_pending_rx_mqs_del (aw, mqe);
 584
 585   clib_file_del_by_index (&file_main, mqe->file_index);
 586 }
 587
 588 svm_msg_q_t *
 589 application_rx_mq_get (application_t *app, u32 mq_index)
 590 {
 591   if (!app->rx_mqs)
 592     return 0;
 593
 594   return app->rx_mqs[mq_index].mq;
 595 }
 596
 597 static int
 598 app_rx_mqs_alloc (application_t *app)
 599 {
 600   u32 evt_q_length, evt_size = sizeof (session_event_t);
 601   fifo_segment_t *eqs = &app->rx_mqs_segment;
 602   u32 n_mqs = vlib_num_workers () + 1;
 603   segment_manager_props_t *props;
 604   int i;
 605
 606   props = application_segment_manager_properties (app);
 607   evt_q_length = clib_max (props->evt_q_size, 128);
 608
 609   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
 610   svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
 611     { evt_q_length, evt_size, 0 }, { evt_q_length >> 1, 256, 0 }
 612   };
 613   cfg->consumer_pid = 0;
 614   cfg->n_rings = 2;
 615   cfg->q_nitems = evt_q_length;
 616   cfg->ring_cfgs = rc;
 617
 618   eqs->ssvm.ssvm_size = svm_msg_q_size_to_alloc (cfg) * n_mqs + (16 << 10);
 619   eqs->ssvm.name = format (0, "%s-rx-mqs-seg%c", app->name, 0);
 620
 621   if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
 622     {
 623       clib_warning ("failed to initialize queue segment");
 624       return SESSION_E_SEG_CREATE;
 625     }
 626
 627   fifo_segment_init (eqs);
 628
 629   /* Fifo segment filled only with mqs */
 630   eqs->h->n_mqs = n_mqs;
 631   vec_validate (app->rx_mqs, n_mqs - 1);
 632
 633   for (i = 0; i < n_mqs; i++)
 634     {
 635       app->rx_mqs[i].mq = fifo_segment_msg_q_alloc (eqs, i, cfg);
 636       if (svm_msg_q_alloc_eventfd (app->rx_mqs[i].mq))
 637         {
 638           clib_warning ("eventfd returned");
 639           fifo_segment_cleanup (eqs);
 640           ssvm_delete (&eqs->ssvm);
 641           return SESSION_E_EVENTFD_ALLOC;
 642         }
 643       app_rx_mqs_epoll_add (app, &app->rx_mqs[i]);
 644       app->rx_mqs[i].app_index = app->app_index;
 645     }
 646
 647   return 0;
 648 }
 649
 650 u8
 651 application_use_private_rx_mqs (void)
 652 {
 653   return session_main.use_private_rx_mqs;
 654 }
 655
 656 fifo_segment_t *
 657 application_get_rx_mqs_segment (application_t *app)
 658 {
 659   if (application_use_private_rx_mqs ())
 660     return &app->rx_mqs_segment;
 661   return session_main_get_evt_q_segment ();
 662 }
 663
 664 void
 665 application_enable_rx_mqs_nodes (u8 is_en)
 666 {
 667   u8 state = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
 668
 669   foreach_vlib_main ()
 670     vlib_node_set_state (this_vlib_main, appsl_rx_mqs_input_node.index, state);
 671 }
 672
 673 static application_t *
 674 application_alloc (void)
 675 {
 676   application_t *app;
 677   pool_get (app_main.app_pool, app);
 678   clib_memset (app, 0, sizeof (*app));
 679   app->app_index = app - app_main.app_pool;
 680   return app;
 681 }
 682
 683 application_t *
 684 application_get (u32 app_index)
 685 {
 686   if (app_index == APP_INVALID_INDEX)
 687     return 0;
 688   return pool_elt_at_index (app_main.app_pool, app_index);
 689 }
 690
 691 application_t *
 692 application_get_if_valid (u32 app_index)
 693 {
 694   if (pool_is_free_index (app_main.app_pool, app_index))
 695     return 0;
 696
 697   return pool_elt_at_index (app_main.app_pool, app_index);
 698 }
 699
 700 static void
 701 application_verify_cb_fns (session_cb_vft_t * cb_fns)
 702 {
 703   if (cb_fns->session_accept_callback == 0)
 704     clib_warning ("No accept callback function provided");
 705   if (cb_fns->session_connected_callback == 0)
 706     clib_warning ("No session connected callback function provided");
 707   if (cb_fns->session_disconnect_callback == 0)
 708     clib_warning ("No session disconnect callback function provided");
 709   if (cb_fns->session_reset_callback == 0)
 710     clib_warning ("No session reset callback function provided");
 711 }
 712
 713 /**
 714  * Check app config for given segment type
 715  *
 716  * Returns 1 on success and 0 otherwise
 717  */
 718 static u8
 719 application_verify_cfg (ssvm_segment_type_t st)
 720 {
 721   u8 is_valid;
 722   if (st == SSVM_SEGMENT_MEMFD)
 723     {
 724       is_valid = (session_main_get_evt_q_segment () != 0);
 725       if (!is_valid)
 726         clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
 727       return is_valid;
 728     }
 729   else if (st == SSVM_SEGMENT_SHM)
 730     {
 731       is_valid = (session_main_get_evt_q_segment () == 0);
 732       if (!is_valid)
 733         clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
 734       return is_valid;
 735     }
 736   else
 737     return 1;
 738 }
 739
 740 static int
 741 application_alloc_and_init (app_init_args_t * a)
 742 {
 743   ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
 744   segment_manager_props_t *props;
 745   application_t *app;
 746   u64 *options;
 747
 748   app = application_alloc ();
 749   options = a->options;
 750   /*
 751    * Make sure we support the requested configuration
 752    */
 753   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
 754     seg_type = SSVM_SEGMENT_PRIVATE;
 755
 756   if ((options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 757       && seg_type != SSVM_SEGMENT_MEMFD)
 758     {
 759       clib_warning ("mq eventfds can only be used if socket transport is "
 760                     "used for binary api");
 761       return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 762     }
 763
 764   if (!application_verify_cfg (seg_type))
 765     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 766
 767   if (options[APP_OPTIONS_PREALLOC_FIFO_PAIRS]
 768       && options[APP_OPTIONS_PREALLOC_FIFO_HDRS])
 769     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 770
 771   /* Check that the obvious things are properly set up */
 772   application_verify_cb_fns (a->session_cb_vft);
 773
 774   app->flags = options[APP_OPTIONS_FLAGS];
 775   app->cb_fns = *a->session_cb_vft;
 776   app->ns_index = options[APP_OPTIONS_NAMESPACE];
 777   app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
 778   app->name = vec_dup (a->name);
 779
 780   /* If no scope enabled, default to global */
 781   if (!application_has_global_scope (app)
 782       && !application_has_local_scope (app))
 783     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 784
 785   props = application_segment_manager_properties (app);
 786   segment_manager_props_init (props);
 787   props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
 788   props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
 789   props->prealloc_fifo_hdrs = options[APP_OPTIONS_PREALLOC_FIFO_HDRS];
 790   if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
 791     {
 792       props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
 793       props->add_segment = 1;
 794     }
 795   if (options[APP_OPTIONS_RX_FIFO_SIZE])
 796     props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
 797   if (options[APP_OPTIONS_TX_FIFO_SIZE])
 798     props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
 799   if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
 800     props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
 801   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 802     props->use_mq_eventfd = 1;
 803   if (options[APP_OPTIONS_TLS_ENGINE])
 804     app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
 805   if (options[APP_OPTIONS_MAX_FIFO_SIZE])
 806     props->max_fifo_size = options[APP_OPTIONS_MAX_FIFO_SIZE];
 807   if (options[APP_OPTIONS_HIGH_WATERMARK])
 808     props->high_watermark = options[APP_OPTIONS_HIGH_WATERMARK];
 809   if (options[APP_OPTIONS_LOW_WATERMARK])
 810     props->low_watermark = options[APP_OPTIONS_LOW_WATERMARK];
 811   if (options[APP_OPTIONS_PCT_FIRST_ALLOC])
 812     props->pct_first_alloc = options[APP_OPTIONS_PCT_FIRST_ALLOC];
 813   props->segment_type = seg_type;
 814
 815   /* Add app to lookup by api_client_index table */
 816   if (!application_is_builtin (app))
 817     application_api_table_add (app->app_index, a->api_client_index);
 818   else
 819     application_name_table_add (app);
 820
 821   a->app_index = app->app_index;
 822
 823   APP_DBG ("New app name: %v api index: %u index %u", app->name,
 824            a->api_client_index, app->app_index);
 825
 826   return 0;
 827 }
 828
 829 static void
 830 application_free (application_t * app)
 831 {
 832   app_worker_map_t *wrk_map;
 833   app_worker_t *app_wrk;
 834
 835   /*
 836    * The app event queue allocated in first segment is cleared with
 837    * the segment manager. No need to explicitly free it.
 838    */
 839   APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
 840
 841   if (application_is_proxy (app))
 842     application_remove_proxy (app);
 843
 844   /*
 845    * Free workers
 846    */
 847
 848   /* *INDENT-OFF* */
 849   pool_flush (wrk_map, app->worker_maps, ({
 850     app_wrk = app_worker_get (wrk_map->wrk_index);
 851     app_worker_free (app_wrk);
 852   }));
 853   /* *INDENT-ON* */
 854   pool_free (app->worker_maps);
 855
 856   /*
 857    * Free rx mqs if allocated
 858    */
 859   if (app->rx_mqs)
 860     {
 861       int i;
 862       for (i = 0; i < vec_len (app->rx_mqs); i++)
 863         app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
 864
 865       fifo_segment_cleanup (&app->rx_mqs_segment);
 866       ssvm_delete (&app->rx_mqs_segment.ssvm);
 867       vec_free (app->rx_mqs);
 868     }
 869
 870   /*
 871    * Cleanup remaining state
 872    */
 873   if (application_is_builtin (app))
 874     application_name_table_del (app);
 875   vec_free (app->name);
 876   pool_put (app_main.app_pool, app);
 877 }
 878
 879 static void
 880 application_detach_process (application_t * app, u32 api_client_index)
 881 {
 882   vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
 883   app_worker_map_t *wrk_map;
 884   u32 *wrks = 0, *wrk_index;
 885   app_worker_t *app_wrk;
 886
 887   if (api_client_index == ~0)
 888     {
 889       application_free (app);
 890       return;
 891     }
 892
 893   APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
 894            app->app_index, api_client_index);
 895
 896   /* *INDENT-OFF* */
 897   pool_foreach (wrk_map, app->worker_maps)  {
 898     app_wrk = app_worker_get (wrk_map->wrk_index);
 899     if (app_wrk->api_client_index == api_client_index)
 900       vec_add1 (wrks, app_wrk->wrk_index);
 901   }
 902   /* *INDENT-ON* */
 903
 904   if (!vec_len (wrks))
 905     {
 906       clib_warning ("no workers for app %u api_index %u", app->app_index,
 907                     api_client_index);
 908       return;
 909     }
 910
 911   args->app_index = app->app_index;
 912   args->api_client_index = api_client_index;
 913   vec_foreach (wrk_index, wrks)
 914   {
 915     app_wrk = app_worker_get (wrk_index[0]);
 916     args->wrk_map_index = app_wrk->wrk_map_index;
 917     args->is_add = 0;
 918     vnet_app_worker_add_del (args);
 919   }
 920   vec_free (wrks);
 921 }
 922
 923 app_worker_t *
 924 application_get_worker (application_t * app, u32 wrk_map_index)
 925 {
 926   app_worker_map_t *map;
 927   map = app_worker_map_get (app, wrk_map_index);
 928   if (!map)
 929     return 0;
 930   return app_worker_get (map->wrk_index);
 931 }
 932
 933 app_worker_t *
 934 application_get_default_worker (application_t * app)
 935 {
 936   return application_get_worker (app, 0);
 937 }
 938
 939 u32
 940 application_n_workers (application_t * app)
 941 {
 942   return pool_elts (app->worker_maps);
 943 }
 944
 945 app_worker_t *
 946 application_listener_select_worker (session_t * ls)
 947 {
 948   application_t *app;
 949   app_listener_t *al;
 950
 951   app = application_get (ls->app_index);
 952   al = app_listener_get (app, ls->al_index);
 953   return app_listener_select_worker (app, al);
 954 }
 955
 956 int
 957 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
 958 {
 959   app_worker_map_t *wrk_map;
 960   app_worker_t *app_wrk;
 961   segment_manager_t *sm;
 962   int rv;
 963
 964   app_wrk = app_worker_alloc (app);
 965   wrk_map = app_worker_map_alloc (app);
 966   wrk_map->wrk_index = app_wrk->wrk_index;
 967   app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
 968
 969   /*
 970    * Setup first segment manager
 971    */
 972   sm = segment_manager_alloc ();
 973   sm->app_wrk_index = app_wrk->wrk_index;
 974
 975   if ((rv = segment_manager_init_first (sm)))
 976     {
 977       app_worker_free (app_wrk);
 978       return rv;
 979     }
 980   sm->first_is_protected = 1;
 981
 982   /*
 983    * Setup app worker
 984    */
 985   app_wrk->first_segment_manager = segment_manager_index (sm);
 986   app_wrk->listeners_table = hash_create (0, sizeof (u64));
 987   app_wrk->event_queue = segment_manager_event_queue (sm);
 988   app_wrk->app_is_builtin = application_is_builtin (app);
 989
 990   *wrk = app_wrk;
 991
 992   return 0;
 993 }
 994
 995 int
 996 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
 997 {
 998   fifo_segment_t *fs;
 999   app_worker_map_t *wrk_map;
1000   app_worker_t *app_wrk;
1001   segment_manager_t *sm;
1002   application_t *app;
1003   int rv;
1004
1005   app = application_get (a->app_index);
1006   if (!app)
1007     return VNET_API_ERROR_INVALID_VALUE;
1008
1009   if (a->is_add)
1010     {
1011       if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1012         return rv;
1013
1014       /* Map worker api index to the app */
1015       app_wrk->api_client_index = a->api_client_index;
1016       application_api_table_add (app->app_index, a->api_client_index);
1017
1018       sm = segment_manager_get (app_wrk->first_segment_manager);
1019       fs = segment_manager_get_segment_w_lock (sm, 0);
1020       a->segment = &fs->ssvm;
1021       a->segment_handle = segment_manager_segment_handle (sm, fs);
1022       segment_manager_segment_reader_unlock (sm);
1023       a->evt_q = app_wrk->event_queue;
1024       a->wrk_map_index = app_wrk->wrk_map_index;
1025     }
1026   else
1027     {
1028       wrk_map = app_worker_map_get (app, a->wrk_map_index);
1029       if (!wrk_map)
1030         return VNET_API_ERROR_INVALID_VALUE;
1031
1032       app_wrk = app_worker_get (wrk_map->wrk_index);
1033       if (!app_wrk)
1034         return VNET_API_ERROR_INVALID_VALUE;
1035
1036       application_api_table_del (app_wrk->api_client_index);
1037       app_worker_free (app_wrk);
1038       app_worker_map_free (app, wrk_map);
1039       if (application_n_workers (app) == 0)
1040         application_free (app);
1041     }
1042   return 0;
1043 }
1044
1045 static int
1046 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
1047 {
1048   app_namespace_t *app_ns;
1049   if (vec_len (namespace_id) == 0)
1050     {
1051       /* Use default namespace */
1052       *app_ns_index = 0;
1053       return 0;
1054     }
1055
1056   *app_ns_index = app_namespace_index_from_id (namespace_id);
1057   if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1058     return VNET_API_ERROR_APP_INVALID_NS;
1059   app_ns = app_namespace_get (*app_ns_index);
1060   if (!app_ns)
1061     return VNET_API_ERROR_APP_INVALID_NS;
1062   if (app_ns->ns_secret != secret)
1063     return VNET_API_ERROR_APP_WRONG_NS_SECRET;
1064   return 0;
1065 }
1066
1067 static u8 *
1068 app_name_from_api_index (u32 api_client_index)
1069 {
1070   vl_api_registration_t *regp;
1071   regp = vl_api_client_index_to_registration (api_client_index);
1072   if (regp)
1073     return format (0, "%s", regp->name);
1074
1075   clib_warning ("api client index %u does not have an api registration!",
1076                 api_client_index);
1077   return format (0, "unknown");
1078 }
1079
1080 /**
1081  * Attach application to vpp
1082  *
1083  * Allocates a vpp app, i.e., a structure that keeps back pointers
1084  * to external app and a segment manager for shared memory fifo based
1085  * communication with the external app.
1086  */
1087 int
1088 vnet_application_attach (vnet_app_attach_args_t * a)
1089 {
1090   fifo_segment_t *fs;
1091   application_t *app = 0;
1092   app_worker_t *app_wrk;
1093   segment_manager_t *sm;
1094   u32 app_ns_index = 0;
1095   u8 *app_name = 0;
1096   u64 secret;
1097   int rv;
1098
1099   if (a->api_client_index != APP_INVALID_INDEX)
1100     app = application_lookup (a->api_client_index);
1101   else if (a->name)
1102     app = application_lookup_name (a->name);
1103   else
1104     return VNET_API_ERROR_INVALID_VALUE;
1105
1106   if (app)
1107     return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1108
1109   /* Socket api sets the name and validates namespace prior to attach */
1110   if (!a->use_sock_api)
1111     {
1112       if (a->api_client_index != APP_INVALID_INDEX)
1113         {
1114           app_name = app_name_from_api_index (a->api_client_index);
1115           a->name = app_name;
1116         }
1117
1118       secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1119       if ((rv = app_validate_namespace (a->namespace_id, secret,
1120                                         &app_ns_index)))
1121         return rv;
1122       a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1123     }
1124
1125   if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1126     return rv;
1127
1128   app = application_get (a->app_index);
1129   if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1130     return rv;
1131
1132   a->app_evt_q = app_wrk->event_queue;
1133   app_wrk->api_client_index = a->api_client_index;
1134   sm = segment_manager_get (app_wrk->first_segment_manager);
1135   fs = segment_manager_get_segment_w_lock (sm, 0);
1136
1137   if (application_is_proxy (app))
1138     {
1139       application_setup_proxy (app);
1140       /* The segment manager pool is reallocated because a new listener
1141        * is added. Re-grab segment manager to avoid dangling reference */
1142       sm = segment_manager_get (app_wrk->first_segment_manager);
1143     }
1144
1145   ASSERT (vec_len (fs->ssvm.name) <= 128);
1146   a->segment = &fs->ssvm;
1147   a->segment_handle = segment_manager_segment_handle (sm, fs);
1148
1149   segment_manager_segment_reader_unlock (sm);
1150
1151   if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1152     rv = app_rx_mqs_alloc (app);
1153
1154   vec_free (app_name);
1155   return rv;
1156 }
1157
1158 /**
1159  * Detach application from vpp
1160  */
1161 int
1162 vnet_application_detach (vnet_app_detach_args_t * a)
1163 {
1164   application_t *app;
1165
1166   app = application_get_if_valid (a->app_index);
1167   if (!app)
1168     {
1169       clib_warning ("app not attached");
1170       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1171     }
1172
1173   app_interface_check_thread_and_barrier (vnet_application_detach, a);
1174   application_detach_process (app, a->api_client_index);
1175   return 0;
1176 }
1177
1178
1179 static u8
1180 session_endpoint_in_ns (session_endpoint_t * sep)
1181 {
1182   u8 is_lep = session_endpoint_is_local (sep);
1183   if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1184       && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1185     {
1186       clib_warning ("sw_if_index %u not configured with ip %U",
1187                     sep->sw_if_index, format_ip46_address, &sep->ip,
1188                     sep->is_ip4);
1189       return 0;
1190     }
1191   return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1192 }
1193
1194 static void
1195 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1196                                  application_t * app, u8 is_connect)
1197 {
1198   app_namespace_t *app_ns;
1199   u32 ns_index, fib_index;
1200
1201   ns_index = app->ns_index;
1202
1203   /* App is a transport proto, so fetch the calling app's ns */
1204   if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1205     ns_index = sep->ns_index;
1206
1207   app_ns = app_namespace_get (ns_index);
1208   if (!app_ns)
1209     return;
1210
1211   /* Ask transport and network to bind to/connect using local interface
1212    * that "supports" app's namespace. This will fix our local connection
1213    * endpoint.
1214    */
1215
1216   /* If in default namespace and user requested a fib index use it */
1217   if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1218     fib_index = sep->fib_index;
1219   else
1220     fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1221   sep->peer.fib_index = fib_index;
1222   sep->fib_index = fib_index;
1223
1224   if (!is_connect)
1225     {
1226       sep->sw_if_index = app_ns->sw_if_index;
1227     }
1228   else
1229     {
1230       if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1231           && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1232           && sep->peer.sw_if_index != app_ns->sw_if_index)
1233         clib_warning ("Local sw_if_index different from app ns sw_if_index");
1234
1235       sep->peer.sw_if_index = app_ns->sw_if_index;
1236     }
1237 }
1238
1239 int
1240 vnet_listen (vnet_listen_args_t * a)
1241 {
1242   app_listener_t *app_listener;
1243   app_worker_t *app_wrk;
1244   application_t *app;
1245   int rv;
1246
1247   ASSERT (vlib_thread_is_main_w_barrier ());
1248
1249   app = application_get_if_valid (a->app_index);
1250   if (!app)
1251     return SESSION_E_NOAPP;
1252
1253   app_wrk = application_get_worker (app, a->wrk_map_index);
1254   if (!app_wrk)
1255     return SESSION_E_INVALID_APPWRK;
1256
1257   a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1258
1259   session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1260   if (!session_endpoint_in_ns (&a->sep))
1261     return SESSION_E_INVALID_NS;
1262
1263   /*
1264    * Check if we already have an app listener
1265    */
1266   app_listener = app_listener_lookup (app, &a->sep_ext);
1267   if (app_listener)
1268     {
1269       if (app_listener->app_index != app->app_index)
1270         return SESSION_E_ALREADY_LISTENING;
1271       if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1272         return rv;
1273       a->handle = app_listener_handle (app_listener);
1274       return 0;
1275     }
1276
1277   /*
1278    * Create new app listener
1279    */
1280   if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1281     return rv;
1282
1283   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1284     {
1285       app_listener_cleanup (app_listener);
1286       return rv;
1287     }
1288
1289   a->handle = app_listener_handle (app_listener);
1290   return 0;
1291 }
1292
1293 int
1294 vnet_connect (vnet_connect_args_t * a)
1295 {
1296   app_worker_t *client_wrk;
1297   application_t *client;
1298
1299   ASSERT (vlib_thread_is_main_w_barrier ());
1300
1301   if (session_endpoint_is_zero (&a->sep))
1302     return SESSION_E_INVALID_RMT_IP;
1303
1304   client = application_get (a->app_index);
1305   session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1306   client_wrk = application_get_worker (client, a->wrk_map_index);
1307
1308   /*
1309    * First check the local scope for locally attached destinations.
1310    * If we have local scope, we pass *all* connects through it since we may
1311    * have special policy rules even for non-local destinations, think proxy.
1312    */
1313   if (application_has_local_scope (client))
1314     {
1315       int rv;
1316
1317       a->sep_ext.original_tp = a->sep_ext.transport_proto;
1318       a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1319       rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1320       if (rv <= 0)
1321         return rv;
1322       a->sep_ext.transport_proto = a->sep_ext.original_tp;
1323     }
1324   /*
1325    * Not connecting to a local server, propagate to transport
1326    */
1327   return app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1328 }
1329
1330 int
1331 vnet_unlisten (vnet_unlisten_args_t * a)
1332 {
1333   app_worker_t *app_wrk;
1334   app_listener_t *al;
1335   application_t *app;
1336
1337   ASSERT (vlib_thread_is_main_w_barrier ());
1338
1339   if (!(app = application_get_if_valid (a->app_index)))
1340     return SESSION_E_NOAPP;
1341
1342   if (!(al = app_listener_get_w_handle (a->handle)))
1343     return SESSION_E_NOLISTEN;
1344
1345   if (al->app_index != app->app_index)
1346     {
1347       clib_warning ("app doesn't own handle %llu!", a->handle);
1348       return SESSION_E_OWNER;
1349     }
1350
1351   app_wrk = application_get_worker (app, a->wrk_map_index);
1352   if (!app_wrk)
1353     {
1354       clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1355       return SESSION_E_INVALID_APPWRK;
1356     }
1357
1358   return app_worker_stop_listen (app_wrk, al);
1359 }
1360
1361 int
1362 vnet_disconnect_session (vnet_disconnect_args_t * a)
1363 {
1364   app_worker_t *app_wrk;
1365   session_t *s;
1366
1367   s = session_get_from_handle_if_valid (a->handle);
1368   if (!s)
1369     return SESSION_E_NOSESSION;
1370
1371   app_wrk = app_worker_get (s->app_wrk_index);
1372   if (app_wrk->app_index != a->app_index)
1373     return SESSION_E_OWNER;
1374
1375   /* We're peeking into another's thread pool. Make sure */
1376   ASSERT (s->session_index == session_index_from_handle (a->handle));
1377
1378   session_close (s);
1379   return 0;
1380 }
1381
1382 int
1383 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1384 {
1385   app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1386   app_listener_t *app_listener;
1387   application_t *app;
1388   int rv;
1389
1390   if (!old_wrk)
1391     return SESSION_E_INVALID_APPWRK;
1392
1393   hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1394   if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1395       && s->rx_fifo)
1396     segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1397
1398   app = application_get (old_wrk->app_index);
1399   if (!app)
1400     return SESSION_E_NOAPP;
1401
1402   app_listener = app_listener_get (app, s->al_index);
1403
1404   /* Only remove from lb for now */
1405   app_listener->workers = clib_bitmap_set (app_listener->workers,
1406                                            old_wrk->wrk_map_index, 0);
1407
1408   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1409     return rv;
1410
1411   s->app_wrk_index = app_wrk->wrk_index;
1412
1413   return 0;
1414 }
1415
1416 int
1417 application_is_proxy (application_t * app)
1418 {
1419   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1420 }
1421
1422 int
1423 application_is_builtin (application_t * app)
1424 {
1425   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1426 }
1427
1428 int
1429 application_is_builtin_proxy (application_t * app)
1430 {
1431   return (application_is_proxy (app) && application_is_builtin (app));
1432 }
1433
1434 u8
1435 application_has_local_scope (application_t * app)
1436 {
1437   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1438 }
1439
1440 u8
1441 application_has_global_scope (application_t * app)
1442 {
1443   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1444 }
1445
1446 static clib_error_t *
1447 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1448                                         u8 transport_proto, u8 is_start)
1449 {
1450   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1451   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1452   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1453   transport_connection_t *tc;
1454   app_worker_t *app_wrk;
1455   app_listener_t *al;
1456   session_t *s;
1457   u32 flags;
1458
1459   /* TODO decide if we want proxy to be enabled for all workers */
1460   app_wrk = application_get_default_worker (app);
1461   if (is_start)
1462     {
1463       s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1464       if (!s)
1465         {
1466           sep.is_ip4 = is_ip4;
1467           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1468           sep.sw_if_index = app_ns->sw_if_index;
1469           sep.transport_proto = transport_proto;
1470           sep.app_wrk_index = app_wrk->wrk_index;       /* only default */
1471
1472           /* force global scope listener */
1473           flags = app->flags;
1474           app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1475           app_listener_alloc_and_init (app, &sep, &al);
1476           app->flags = flags;
1477
1478           app_worker_start_listen (app_wrk, al);
1479           s = listen_session_get (al->session_index);
1480           s->flags |= SESSION_F_PROXY;
1481         }
1482     }
1483   else
1484     {
1485       s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1486       ASSERT (s);
1487     }
1488
1489   tc = listen_session_get_transport (s);
1490
1491   if (!ip_is_zero (&tc->lcl_ip, 1))
1492     {
1493       u32 sti;
1494       sep.is_ip4 = is_ip4;
1495       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1496       sep.transport_proto = transport_proto;
1497       sep.port = 0;
1498       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1499       if (is_start)
1500         session_lookup_add_session_endpoint (sti,
1501                                              (session_endpoint_t *) & sep,
1502                                              s->session_index);
1503       else
1504         session_lookup_del_session_endpoint (sti,
1505                                              (session_endpoint_t *) & sep);
1506     }
1507
1508   return 0;
1509 }
1510
1511 static void
1512 application_start_stop_proxy_local_scope (application_t * app,
1513                                           u8 transport_proto, u8 is_start)
1514 {
1515   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1516   app_namespace_t *app_ns;
1517   app_ns = app_namespace_get (app->ns_index);
1518   sep.is_ip4 = 1;
1519   sep.transport_proto = transport_proto;
1520   sep.port = 0;
1521
1522   if (is_start)
1523     {
1524       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1525                                            app->app_index);
1526       sep.is_ip4 = 0;
1527       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1528                                            app->app_index);
1529     }
1530   else
1531     {
1532       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1533       sep.is_ip4 = 0;
1534       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1535     }
1536 }
1537
1538 void
1539 application_start_stop_proxy (application_t * app,
1540                               transport_proto_t transport_proto, u8 is_start)
1541 {
1542   if (application_has_local_scope (app))
1543     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1544
1545   if (application_has_global_scope (app))
1546     {
1547       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1548                                               transport_proto, is_start);
1549       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1550                                               transport_proto, is_start);
1551     }
1552 }
1553
1554 void
1555 application_setup_proxy (application_t * app)
1556 {
1557   u16 transports = app->proxied_transports;
1558   transport_proto_t tp;
1559
1560   ASSERT (application_is_proxy (app));
1561
1562   /* *INDENT-OFF* */
1563   transport_proto_foreach (tp, ({
1564     if (transports & (1 << tp))
1565       application_start_stop_proxy (app, tp, 1);
1566   }));
1567   /* *INDENT-ON* */
1568 }
1569
1570 void
1571 application_remove_proxy (application_t * app)
1572 {
1573   u16 transports = app->proxied_transports;
1574   transport_proto_t tp;
1575
1576   ASSERT (application_is_proxy (app));
1577
1578   /* *INDENT-OFF* */
1579   transport_proto_foreach (tp, ({
1580     if (transports & (1 << tp))
1581       application_start_stop_proxy (app, tp, 0);
1582   }));
1583   /* *INDENT-ON* */
1584 }
1585
1586 segment_manager_props_t *
1587 application_segment_manager_properties (application_t * app)
1588 {
1589   return &app->sm_properties;
1590 }
1591
1592 segment_manager_props_t *
1593 application_get_segment_manager_properties (u32 app_index)
1594 {
1595   application_t *app = application_get (app_index);
1596   return &app->sm_properties;
1597 }
1598
1599 static void
1600 application_format_listeners (application_t * app, int verbose)
1601 {
1602   vlib_main_t *vm = vlib_get_main ();
1603   app_worker_map_t *wrk_map;
1604   app_worker_t *app_wrk;
1605   u32 sm_index;
1606   u64 handle;
1607
1608   if (!app)
1609     {
1610       vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1611                        0, 0, verbose);
1612       return;
1613     }
1614
1615   /* *INDENT-OFF* */
1616   pool_foreach (wrk_map, app->worker_maps)  {
1617     app_wrk = app_worker_get (wrk_map->wrk_index);
1618     if (hash_elts (app_wrk->listeners_table) == 0)
1619       continue;
1620     hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1621       vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1622                        handle, sm_index, verbose);
1623     }));
1624   }
1625   /* *INDENT-ON* */
1626 }
1627
1628 static void
1629 application_format_connects (application_t * app, int verbose)
1630 {
1631   app_worker_map_t *wrk_map;
1632   app_worker_t *app_wrk;
1633
1634   if (!app)
1635     {
1636       app_worker_format_connects (0, verbose);
1637       return;
1638     }
1639
1640   /* *INDENT-OFF* */
1641   pool_foreach (wrk_map, app->worker_maps)  {
1642     app_wrk = app_worker_get (wrk_map->wrk_index);
1643     app_worker_format_connects (app_wrk, verbose);
1644   }
1645   /* *INDENT-ON* */
1646 }
1647
1648 u8 *
1649 format_cert_key_pair (u8 * s, va_list * args)
1650 {
1651   app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1652   int key_len = 0, cert_len = 0;
1653   cert_len = vec_len (ckpair->cert);
1654   key_len = vec_len (ckpair->key);
1655   if (ckpair->cert_key_index == 0)
1656     s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1657   else
1658     s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1659                 cert_len, key_len);
1660   return s;
1661 }
1662
1663 u8 *
1664 format_crypto_engine (u8 * s, va_list * args)
1665 {
1666   u32 engine = va_arg (*args, u32);
1667   switch (engine)
1668     {
1669     case CRYPTO_ENGINE_NONE:
1670       return format (s, "none");
1671     case CRYPTO_ENGINE_MBEDTLS:
1672       return format (s, "mbedtls");
1673     case CRYPTO_ENGINE_OPENSSL:
1674       return format (s, "openssl");
1675     case CRYPTO_ENGINE_PICOTLS:
1676       return format (s, "picotls");
1677     case CRYPTO_ENGINE_VPP:
1678       return format (s, "vpp");
1679     default:
1680       return format (s, "unknown engine");
1681     }
1682   return s;
1683 }
1684
1685 uword
1686 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1687 {
1688   u8 *a = va_arg (*args, u8 *);
1689   if (unformat (input, "mbedtls"))
1690     *a = CRYPTO_ENGINE_MBEDTLS;
1691   else if (unformat (input, "openssl"))
1692     *a = CRYPTO_ENGINE_OPENSSL;
1693   else if (unformat (input, "picotls"))
1694     *a = CRYPTO_ENGINE_PICOTLS;
1695   else if (unformat (input, "vpp"))
1696     *a = CRYPTO_ENGINE_VPP;
1697   else
1698     return 0;
1699   return 1;
1700 }
1701
1702 u8 *
1703 format_crypto_context (u8 * s, va_list * args)
1704 {
1705   crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1706   s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1707               crctx->n_subscribers, crctx->ckpair_index);
1708   s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1709   return s;
1710 }
1711
1712 u8 *
1713 format_application (u8 * s, va_list * args)
1714 {
1715   application_t *app = va_arg (*args, application_t *);
1716   CLIB_UNUSED (int verbose) = va_arg (*args, int);
1717   segment_manager_props_t *props;
1718   const u8 *app_ns_name, *app_name;
1719   app_worker_map_t *wrk_map;
1720   app_worker_t *app_wrk;
1721
1722   if (app == 0)
1723     {
1724       if (!verbose)
1725         s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1726       return s;
1727     }
1728
1729   app_name = app_get_name (app);
1730   app_ns_name = app_namespace_id_from_index (app->ns_index);
1731   props = application_segment_manager_properties (app);
1732   if (!verbose)
1733     {
1734       s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1735                   app_ns_name);
1736       return s;
1737     }
1738
1739   s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1740               app_name, app->app_index, app->ns_index,
1741               format_memory_size, props->add_segment_size);
1742   s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1743               format_memory_size, props->rx_fifo_size,
1744               format_memory_size, props->tx_fifo_size);
1745
1746   /* *INDENT-OFF* */
1747   pool_foreach (wrk_map, app->worker_maps)  {
1748       app_wrk = app_worker_get (wrk_map->wrk_index);
1749       s = format (s, "%U", format_app_worker, app_wrk);
1750   }
1751   /* *INDENT-ON* */
1752
1753   return s;
1754 }
1755
1756 void
1757 application_format_all_listeners (vlib_main_t * vm, int verbose)
1758 {
1759   application_t *app;
1760
1761   if (!pool_elts (app_main.app_pool))
1762     {
1763       vlib_cli_output (vm, "No active server bindings");
1764       return;
1765     }
1766
1767   application_format_listeners (0, verbose);
1768
1769   /* *INDENT-OFF* */
1770   pool_foreach (app, app_main.app_pool)  {
1771     application_format_listeners (app, verbose);
1772   }
1773   /* *INDENT-ON* */
1774 }
1775
1776 void
1777 application_format_all_clients (vlib_main_t * vm, int verbose)
1778 {
1779   application_t *app;
1780
1781   if (!pool_elts (app_main.app_pool))
1782     {
1783       vlib_cli_output (vm, "No active apps");
1784       return;
1785     }
1786
1787   application_format_connects (0, verbose);
1788
1789   /* *INDENT-OFF* */
1790   pool_foreach (app, app_main.app_pool)  {
1791     application_format_connects (app, verbose);
1792   }
1793   /* *INDENT-ON* */
1794 }
1795
1796 static clib_error_t *
1797 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1798                              vlib_cli_command_t * cmd)
1799 {
1800   app_cert_key_pair_t *ckpair;
1801   session_cli_return_if_not_enabled ();
1802
1803   /* *INDENT-OFF* */
1804   pool_foreach (ckpair, app_main.cert_key_pair_store)  {
1805     vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1806   }
1807   /* *INDENT-ON* */
1808   return 0;
1809 }
1810
1811 static inline void
1812 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1813 {
1814   app_worker_map_t *map;
1815   app_worker_t *wrk;
1816   int i;
1817
1818   /* *INDENT-OFF* */
1819   pool_foreach (map, app->worker_maps)  {
1820     wrk = app_worker_get (map->wrk_index);
1821     vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1822                      map->wrk_index, format_svm_msg_q,
1823                      wrk->event_queue);
1824   }
1825   /* *INDENT-ON* */
1826
1827   for (i = 0; i < vec_len (app->rx_mqs); i++)
1828     vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1829                      app->rx_mqs[i].mq);
1830 }
1831
1832 static clib_error_t *
1833 appliction_format_all_app_mq (vlib_main_t * vm)
1834 {
1835   application_t *app;
1836   int i, n_threads;
1837
1838   n_threads = vlib_get_n_threads ();
1839
1840   for (i = 0; i < n_threads; i++)
1841     {
1842       vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1843                        session_main_get_vpp_event_queue (i));
1844     }
1845
1846   /* *INDENT-OFF* */
1847   pool_foreach (app, app_main.app_pool)  {
1848       appliction_format_app_mq (vm, app);
1849   }
1850   /* *INDENT-ON* */
1851   return 0;
1852 }
1853
1854 static clib_error_t *
1855 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1856                      vlib_cli_command_t * cmd)
1857 {
1858   int do_server = 0, do_client = 0, do_mq = 0;
1859   application_t *app;
1860   u32 app_index = ~0;
1861   int verbose = 0;
1862
1863   session_cli_return_if_not_enabled ();
1864
1865   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1866     {
1867       if (unformat (input, "server"))
1868         do_server = 1;
1869       else if (unformat (input, "client"))
1870         do_client = 1;
1871       else if (unformat (input, "mq"))
1872         do_mq = 1;
1873       else if (unformat (input, "%u", &app_index))
1874         ;
1875       else if (unformat (input, "verbose"))
1876         verbose = 1;
1877       else
1878         return clib_error_return (0, "unknown input `%U'",
1879                                   format_unformat_error, input);
1880     }
1881
1882   if (do_mq && app_index != ~0)
1883     {
1884       app = application_get_if_valid (app_index);
1885       if (!app)
1886         return clib_error_return (0, "No app with index %u", app_index);
1887
1888       appliction_format_app_mq (vm, app);
1889       return 0;
1890     }
1891
1892   if (do_mq)
1893     {
1894       appliction_format_all_app_mq (vm);
1895       return 0;
1896     }
1897
1898   if (do_server)
1899     {
1900       application_format_all_listeners (vm, verbose);
1901       return 0;
1902     }
1903
1904   if (do_client)
1905     {
1906       application_format_all_clients (vm, verbose);
1907       return 0;
1908     }
1909
1910   if (app_index != ~0)
1911     {
1912       app = application_get_if_valid (app_index);
1913       if (!app)
1914         return clib_error_return (0, "No app with index %u", app_index);
1915
1916       vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1917       return 0;
1918     }
1919
1920   /* Print app related info */
1921   if (!do_server && !do_client)
1922     {
1923       vlib_cli_output (vm, "%U", format_application, 0, 0);
1924       /* *INDENT-OFF* */
1925       pool_foreach (app, app_main.app_pool)  {
1926         vlib_cli_output (vm, "%U", format_application, app, 0);
1927       }
1928       /* *INDENT-ON* */
1929     }
1930
1931   return 0;
1932 }
1933
1934 /* Certificate store */
1935
1936 static app_cert_key_pair_t *
1937 app_cert_key_pair_alloc ()
1938 {
1939   app_cert_key_pair_t *ckpair;
1940   pool_get (app_main.cert_key_pair_store, ckpair);
1941   clib_memset (ckpair, 0, sizeof (*ckpair));
1942   ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
1943   return ckpair;
1944 }
1945
1946 app_cert_key_pair_t *
1947 app_cert_key_pair_get_if_valid (u32 index)
1948 {
1949   if (pool_is_free_index (app_main.cert_key_pair_store, index))
1950     return 0;
1951   return app_cert_key_pair_get (index);
1952 }
1953
1954 app_cert_key_pair_t *
1955 app_cert_key_pair_get (u32 index)
1956 {
1957   return pool_elt_at_index (app_main.cert_key_pair_store, index);
1958 }
1959
1960 app_cert_key_pair_t *
1961 app_cert_key_pair_get_default ()
1962 {
1963   /* To maintain legacy bapi */
1964   return app_cert_key_pair_get (0);
1965 }
1966
1967 int
1968 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
1969 {
1970   app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
1971   vec_validate (ckpair->cert, a->cert_len - 1);
1972   clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
1973   vec_validate (ckpair->key, a->key_len - 1);
1974   clib_memcpy_fast (ckpair->key, a->key, a->key_len);
1975   a->index = ckpair->cert_key_index;
1976   return 0;
1977 }
1978
1979 int
1980 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
1981 {
1982   app_cert_key_pair_t *ckpair;
1983   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1984     return -1;
1985   if (vec_search (ckpair->app_interests, app_index) != ~0)
1986     vec_add1 (ckpair->app_interests, app_index);
1987   return 0;
1988 }
1989
1990 int
1991 vnet_app_del_cert_key_pair (u32 index)
1992 {
1993   app_cert_key_pair_t *ckpair;
1994   application_t *app;
1995   u32 *app_index;
1996
1997   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1998     return (VNET_API_ERROR_INVALID_VALUE);
1999
2000   vec_foreach (app_index, ckpair->app_interests)
2001   {
2002     if ((app = application_get_if_valid (*app_index))
2003         && app->cb_fns.app_cert_key_pair_delete_callback)
2004       app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2005   }
2006
2007   vec_free (ckpair->cert);
2008   vec_free (ckpair->key);
2009   pool_put (app_main.cert_key_pair_store, ckpair);
2010   return 0;
2011 }
2012
2013 clib_error_t *
2014 application_init (vlib_main_t * vm)
2015 {
2016   app_main_t *am = &app_main;
2017   u32 n_workers;
2018
2019   n_workers = vlib_num_workers ();
2020
2021   /* Index 0 was originally used by legacy apis, maintain as invalid */
2022   (void) app_cert_key_pair_alloc ();
2023   am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2024   am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2025
2026   vec_validate (am->wrk, n_workers);
2027
2028   return 0;
2029 }
2030
2031 /* *INDENT-OFF* */
2032 VLIB_INIT_FUNCTION (application_init);
2033
2034 VLIB_CLI_COMMAND (show_app_command, static) =
2035 {
2036   .path = "show app",
2037   .short_help = "show app [app_id] [server|client] [mq] [verbose]",
2038   .function = show_app_command_fn,
2039 };
2040
2041 VLIB_CLI_COMMAND (show_certificate_command, static) =
2042 {
2043   .path = "show app certificate",
2044   .short_help = "list app certs and keys present in store",
2045   .function = show_certificate_command_fn,
2046 };
2047 /* *INDENT-ON* */
2048
2049 crypto_engine_type_t
2050 app_crypto_engine_type_add (void)
2051 {
2052   return (++app_main.last_crypto_engine);
2053 }
2054
2055 u8
2056 app_crypto_engine_n_types (void)
2057 {
2058   return (app_main.last_crypto_engine + 1);
2059 }
2060
2061 /*
2062  * fd.io coding-style-patch-verification: ON
2063  *
2064  * Local Variables:
2065  * eval: (c-set-style "gnu")
2066  * End:
2067  */