src/vnet/session/session_api.c

   1 /*
   2  * Copyright (c) 2015-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/vnet.h>
  17 #include <vlibmemory/api.h>
  18 #include <vnet/session/application.h>
  19 #include <vnet/session/application_interface.h>
  20 #include <vnet/session/application_local.h>
  21 #include <vnet/session/session_rules_table.h>
  22 #include <vnet/session/session_table.h>
  23 #include <vnet/session/session.h>
  24
  25 #include <vnet/ip/ip_types_api.h>
  26
  27 #include <vnet/vnet_msg_enum.h>
  28
  29 #define vl_typedefs             /* define message structures */
  30 #include <vnet/vnet_all_api_h.h>
  31 #undef vl_typedefs
  32
  33 #define vl_endianfun            /* define message structures */
  34 #include <vnet/vnet_all_api_h.h>
  35 #undef vl_endianfun
  36
  37 /* instantiate all the print functions we know about */
  38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  39 #define vl_printfun
  40 #include <vnet/vnet_all_api_h.h>
  41 #undef vl_printfun
  42
  43 #include <vlibapi/api_helper_macros.h>
  44
  45 #define foreach_session_api_msg                                         \
  46 _(APP_ATTACH, app_attach)                                               \
  47 _(APPLICATION_DETACH, application_detach)                               \
  48 _(SESSION_ENABLE_DISABLE, session_enable_disable)                       \
  49 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del)                         \
  50 _(SESSION_RULE_ADD_DEL, session_rule_add_del)                           \
  51 _(SESSION_RULES_DUMP, session_rules_dump)                               \
  52 _(APPLICATION_TLS_CERT_ADD, application_tls_cert_add)                   \
  53 _(APPLICATION_TLS_KEY_ADD, application_tls_key_add)                     \
  54 _(APP_ADD_CERT_KEY_PAIR, app_add_cert_key_pair)                         \
  55 _(APP_DEL_CERT_KEY_PAIR, app_del_cert_key_pair)                         \
  56 _(APP_WORKER_ADD_DEL, app_worker_add_del)                               \
  57
  58 static transport_proto_t
  59 api_session_transport_proto_decode (const vl_api_transport_proto_t * api_tp)
  60 {
  61   switch (*api_tp)
  62     {
  63     case TRANSPORT_PROTO_API_TCP:
  64       return TRANSPORT_PROTO_TCP;
  65     case TRANSPORT_PROTO_API_UDP:
  66       return TRANSPORT_PROTO_UDP;
  67     case TRANSPORT_PROTO_API_TLS:
  68       return TRANSPORT_PROTO_TLS;
  69     case TRANSPORT_PROTO_API_QUIC:
  70       return TRANSPORT_PROTO_QUIC;
  71     default:
  72       return TRANSPORT_PROTO_NONE;
  73     }
  74 }
  75
  76 static vl_api_transport_proto_t
  77 api_session_transport_proto_encode (const transport_proto_t tp)
  78 {
  79   switch (tp)
  80     {
  81     case TRANSPORT_PROTO_TCP:
  82       return TRANSPORT_PROTO_API_TCP;
  83     case TRANSPORT_PROTO_UDP:
  84       return TRANSPORT_PROTO_API_UDP;
  85     case TRANSPORT_PROTO_TLS:
  86       return TRANSPORT_PROTO_API_TLS;
  87     case TRANSPORT_PROTO_QUIC:
  88       return TRANSPORT_PROTO_API_QUIC;
  89     default:
  90       return TRANSPORT_PROTO_API_NONE;
  91     }
  92 }
  93
  94 static int
  95 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
  96 {
  97   clib_error_t *error;
  98   if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
  99     return SESSION_E_BAPI_NO_FD;
 100   error = vl_api_send_fd_msg (reg, fds, n_fds);
 101   if (error)
 102     {
 103       clib_error_report (error);
 104       return SESSION_E_BAPI_SEND_FD;
 105     }
 106   return 0;
 107 }
 108
 109 static int
 110 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
 111 {
 112   int rv;
 113   u8 try = 0;
 114   while (try < 100)
 115     {
 116       rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
 117                                                 SESSION_MQ_CTRL_EVT_RING,
 118                                                 SVM_Q_NOWAIT, msg);
 119       if (!rv)
 120         return 0;
 121       try++;
 122       usleep (1);
 123     }
 124   clib_warning ("failed to alloc msg");
 125   return -1;
 126 }
 127
 128 static int
 129 mq_send_session_accepted_cb (session_t * s)
 130 {
 131   app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
 132   svm_msg_q_msg_t _msg, *msg = &_msg;
 133   svm_msg_q_t *app_mq;
 134   fifo_segment_t *eq_seg;
 135   session_t *listener;
 136   session_accepted_msg_t *mp;
 137   session_event_t *evt;
 138   application_t *app;
 139
 140   app = application_get (app_wrk->app_index);
 141   app_mq = app_wrk->event_queue;
 142   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 143     return SESSION_E_MQ_MSG_ALLOC;
 144
 145   evt = svm_msg_q_msg_data (app_mq, msg);
 146   clib_memset (evt, 0, sizeof (*evt));
 147   evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
 148   mp = (session_accepted_msg_t *) evt->data;
 149   clib_memset (mp, 0, sizeof (*mp));
 150   mp->context = app->app_index;
 151   mp->server_rx_fifo = pointer_to_uword (s->rx_fifo->shr);
 152   mp->server_tx_fifo = pointer_to_uword (s->tx_fifo->shr);
 153   mp->segment_handle = session_segment_handle (s);
 154   mp->flags = s->flags;
 155
 156   eq_seg = session_main_get_evt_q_segment ();
 157
 158   if (session_has_transport (s))
 159     {
 160       listener = listen_session_get_from_handle (s->listener_handle);
 161       mp->listener_handle = app_listen_session_handle (listener);
 162       if (application_is_proxy (app))
 163         {
 164           listener =
 165             app_worker_first_listener (app_wrk, session_get_fib_proto (s),
 166                                        session_get_transport_proto (s));
 167           if (listener)
 168             mp->listener_handle = listen_session_get_handle (listener);
 169         }
 170       mp->vpp_event_queue_address =
 171         fifo_segment_msg_q_offset (eq_seg, s->thread_index);
 172       mp->mq_index = s->thread_index;
 173       mp->handle = session_handle (s);
 174
 175       session_get_endpoint (s, &mp->rmt, 0 /* is_lcl */ );
 176     }
 177   else
 178     {
 179       ct_connection_t *ct;
 180
 181       ct = (ct_connection_t *) session_get_transport (s);
 182       listener = listen_session_get_from_handle (s->listener_handle);
 183       mp->listener_handle = app_listen_session_handle (listener);
 184       mp->rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
 185       mp->rmt.port = ct->c_rmt_port;
 186       mp->handle = session_handle (s);
 187       mp->vpp_event_queue_address =
 188         fifo_segment_msg_q_offset (eq_seg, s->thread_index);
 189       mp->mq_index = s->thread_index;
 190     }
 191   svm_msg_q_add_and_unlock (app_mq, msg);
 192
 193   return 0;
 194 }
 195
 196 static inline void
 197 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
 198                            session_evt_type_t evt_type)
 199 {
 200   svm_msg_q_msg_t _msg, *msg = &_msg;
 201   session_disconnected_msg_t *mp;
 202   svm_msg_q_t *app_mq;
 203   session_event_t *evt;
 204
 205   app_mq = app_wrk->event_queue;
 206   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 207     return;
 208   evt = svm_msg_q_msg_data (app_mq, msg);
 209   clib_memset (evt, 0, sizeof (*evt));
 210   evt->event_type = evt_type;
 211   mp = (session_disconnected_msg_t *) evt->data;
 212   mp->handle = sh;
 213   mp->context = app_wrk->api_client_index;
 214   svm_msg_q_add_and_unlock (app_mq, msg);
 215 }
 216
 217 static inline void
 218 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
 219                              svm_fifo_t * f, session_evt_type_t evt_type)
 220 {
 221   app_worker_t *app_wrk;
 222   application_t *app;
 223   int i;
 224
 225   app = application_get (app_index);
 226   if (!app)
 227     return;
 228
 229   for (i = 0; i < f->shr->n_subscribers; i++)
 230     {
 231       if (!(app_wrk = application_get_worker (app, f->shr->subscribers[i])))
 232         continue;
 233       mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
 234     }
 235 }
 236
 237 static void
 238 mq_send_session_disconnected_cb (session_t * s)
 239 {
 240   app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
 241   session_handle_t sh = session_handle (s);
 242
 243   mq_send_session_close_evt (app_wrk, session_handle (s),
 244                              SESSION_CTRL_EVT_DISCONNECTED);
 245
 246   if (svm_fifo_n_subscribers (s->rx_fifo))
 247     mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
 248                                  SESSION_CTRL_EVT_DISCONNECTED);
 249 }
 250
 251 static void
 252 mq_send_session_reset_cb (session_t * s)
 253 {
 254   app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
 255   session_handle_t sh = session_handle (s);
 256
 257   mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
 258
 259   if (svm_fifo_n_subscribers (s->rx_fifo))
 260     mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
 261                                  SESSION_CTRL_EVT_RESET);
 262 }
 263
 264 int
 265 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
 266                               session_t * s, session_error_t err)
 267 {
 268   svm_msg_q_msg_t _msg, *msg = &_msg;
 269   session_connected_msg_t *mp;
 270   svm_msg_q_t *app_mq;
 271   transport_connection_t *tc;
 272   fifo_segment_t *eq_seg;
 273   app_worker_t *app_wrk;
 274   session_event_t *evt;
 275
 276   app_wrk = app_worker_get (app_wrk_index);
 277   app_mq = app_wrk->event_queue;
 278   if (!app_mq)
 279     {
 280       clib_warning ("app %u with api index: %u not attached",
 281                     app_wrk->app_index, app_wrk->api_client_index);
 282       return -1;
 283     }
 284
 285   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 286     return SESSION_E_MQ_MSG_ALLOC;
 287
 288   evt = svm_msg_q_msg_data (app_mq, msg);
 289   clib_memset (evt, 0, sizeof (*evt));
 290   evt->event_type = SESSION_CTRL_EVT_CONNECTED;
 291   mp = (session_connected_msg_t *) evt->data;
 292   clib_memset (mp, 0, sizeof (*mp));
 293   mp->context = api_context;
 294
 295   if (err)
 296     goto done;
 297
 298   eq_seg = session_main_get_evt_q_segment ();
 299
 300   if (session_has_transport (s))
 301     {
 302       tc = session_get_transport (s);
 303       if (!tc)
 304         {
 305           clib_warning ("failed to retrieve transport!");
 306           err = SESSION_E_REFUSED;
 307           goto done;
 308         }
 309
 310       mp->handle = session_handle (s);
 311       mp->vpp_event_queue_address =
 312         fifo_segment_msg_q_offset (eq_seg, s->thread_index);
 313
 314       session_get_endpoint (s, &mp->lcl, 1 /* is_lcl */ );
 315
 316       mp->server_rx_fifo = pointer_to_uword (s->rx_fifo->shr);
 317       mp->server_tx_fifo = pointer_to_uword (s->tx_fifo->shr);
 318       mp->segment_handle = session_segment_handle (s);
 319     }
 320   else
 321     {
 322       ct_connection_t *cct;
 323       session_t *ss;
 324
 325       cct = (ct_connection_t *) session_get_transport (s);
 326       mp->handle = session_handle (s);
 327       mp->lcl.port = cct->c_lcl_port;
 328       mp->lcl.is_ip4 = cct->c_is_ip4;
 329       mp->vpp_event_queue_address =
 330         fifo_segment_msg_q_offset (eq_seg, s->thread_index);
 331       mp->server_rx_fifo = pointer_to_uword (s->rx_fifo->shr);
 332       mp->server_tx_fifo = pointer_to_uword (s->tx_fifo->shr);
 333       mp->segment_handle = session_segment_handle (s);
 334       ss = ct_session_get_peer (s);
 335       mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo->shr);
 336       mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo->shr);
 337       mp->ct_segment_handle = session_segment_handle (ss);
 338     }
 339
 340 done:
 341   mp->retval = err;
 342
 343   svm_msg_q_add_and_unlock (app_mq, msg);
 344   return 0;
 345 }
 346
 347 int
 348 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
 349                           session_handle_t handle, int rv)
 350 {
 351   svm_msg_q_msg_t _msg, *msg = &_msg;
 352   svm_msg_q_t *app_mq;
 353   transport_endpoint_t tep;
 354   session_bound_msg_t *mp;
 355   fifo_segment_t *eq_seg;
 356   app_worker_t *app_wrk;
 357   session_event_t *evt;
 358   app_listener_t *al;
 359   session_t *ls = 0;
 360   app_wrk = app_worker_get (app_wrk_index);
 361   app_mq = app_wrk->event_queue;
 362   if (!app_mq)
 363     {
 364       clib_warning ("app %u with api index: %u not attached",
 365                     app_wrk->app_index, app_wrk->api_client_index);
 366       return -1;
 367     }
 368
 369   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 370     return SESSION_E_MQ_MSG_ALLOC;
 371
 372   evt = svm_msg_q_msg_data (app_mq, msg);
 373   clib_memset (evt, 0, sizeof (*evt));
 374   evt->event_type = SESSION_CTRL_EVT_BOUND;
 375   mp = (session_bound_msg_t *) evt->data;
 376   mp->context = api_context;
 377
 378   if (rv)
 379     goto done;
 380
 381   mp->handle = handle;
 382   al = app_listener_get_w_handle (handle);
 383   if (al->session_index != SESSION_INVALID_INDEX)
 384     ls = app_listener_get_session (al);
 385   else
 386     ls = app_listener_get_local_session (al);
 387
 388   session_get_endpoint (ls, &tep, 1 /* is_lcl */ );
 389   mp->lcl_port = tep.port;
 390   mp->lcl_is_ip4 = tep.is_ip4;
 391   clib_memcpy_fast (mp->lcl_ip, &tep.ip, sizeof (tep.ip));
 392
 393   eq_seg = session_main_get_evt_q_segment ();
 394   mp->vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, ls->thread_index);
 395
 396   if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
 397     {
 398       mp->rx_fifo = pointer_to_uword (ls->rx_fifo->shr);
 399       mp->tx_fifo = pointer_to_uword (ls->tx_fifo->shr);
 400       mp->segment_handle = session_segment_handle (ls);
 401     }
 402
 403 done:
 404   mp->retval = rv;
 405   svm_msg_q_add_and_unlock (app_mq, msg);
 406   return 0;
 407 }
 408
 409 void
 410 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
 411                         u32 context, int rv)
 412 {
 413   svm_msg_q_msg_t _msg, *msg = &_msg;
 414   session_unlisten_reply_msg_t *ump;
 415   svm_msg_q_t *app_mq;
 416   session_event_t *evt;
 417
 418   app_mq = app_wrk->event_queue;
 419   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 420     return;
 421
 422   evt = svm_msg_q_msg_data (app_mq, msg);
 423   clib_memset (evt, 0, sizeof (*evt));
 424   evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
 425   ump = (session_unlisten_reply_msg_t *) evt->data;
 426   ump->context = context;
 427   ump->handle = sh;
 428   ump->retval = rv;
 429   svm_msg_q_add_and_unlock (app_mq, msg);
 430 }
 431
 432 static void
 433 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
 434 {
 435   svm_msg_q_msg_t _msg, *msg = &_msg;
 436   session_migrated_msg_t *mp;
 437   fifo_segment_t *eq_seg;
 438   app_worker_t *app_wrk;
 439   session_event_t *evt;
 440   svm_msg_q_t *app_mq;
 441   u32 thread_index;
 442
 443   thread_index = session_thread_from_handle (new_sh);
 444   eq_seg = session_main_get_evt_q_segment ();
 445
 446   app_wrk = app_worker_get (s->app_wrk_index);
 447   app_mq = app_wrk->event_queue;
 448   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 449     return;
 450
 451   evt = svm_msg_q_msg_data (app_mq, msg);
 452   clib_memset (evt, 0, sizeof (*evt));
 453   evt->event_type = SESSION_CTRL_EVT_MIGRATED;
 454   mp = (session_migrated_msg_t *) evt->data;
 455   mp->handle = session_handle (s);
 456   mp->new_handle = new_sh;
 457   mp->vpp_thread_index = thread_index;
 458   mp->vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, thread_index);
 459   mp->segment_handle = session_segment_handle (s);
 460   svm_msg_q_add_and_unlock (app_mq, msg);
 461 }
 462
 463 static int
 464 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
 465 {
 466   int fds[SESSION_N_FD_TYPE], n_fds = 0;
 467   svm_msg_q_msg_t _msg, *msg = &_msg;
 468   session_app_add_segment_msg_t *mp;
 469   vl_api_registration_t *reg;
 470   app_worker_t *app_wrk;
 471   session_event_t *evt;
 472   svm_msg_q_t *app_mq;
 473   fifo_segment_t *fs;
 474   ssvm_private_t *sp;
 475   u8 fd_flags = 0;
 476
 477   app_wrk = app_worker_get (app_wrk_index);
 478
 479   reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
 480   if (!reg)
 481     {
 482       clib_warning ("no api registration for client: %u",
 483                     app_wrk->api_client_index);
 484       return -1;
 485     }
 486
 487   fs = segment_manager_get_segment_w_handle (segment_handle);
 488   sp = &fs->ssvm;
 489   if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
 490     {
 491       if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 492         {
 493           clib_warning ("can't send memfd fd");
 494           return -1;
 495         }
 496
 497       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
 498       fds[n_fds] = sp->fd;
 499       n_fds += 1;
 500     }
 501
 502   app_mq = app_wrk->event_queue;
 503   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 504     return -1;
 505
 506   if (n_fds)
 507     session_send_fds (reg, fds, n_fds);
 508
 509   evt = svm_msg_q_msg_data (app_mq, msg);
 510   clib_memset (evt, 0, sizeof (*evt));
 511   evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
 512   mp = (session_app_add_segment_msg_t *) evt->data;
 513   clib_memset (mp, 0, sizeof (*mp));
 514   mp->segment_size = sp->ssvm_size;
 515   mp->fd_flags = fd_flags;
 516   mp->segment_handle = segment_handle;
 517   strncpy ((char *) mp->segment_name, (char *) sp->name,
 518            sizeof (mp->segment_name) - 1);
 519
 520   svm_msg_q_add_and_unlock (app_mq, msg);
 521
 522   return 0;
 523 }
 524
 525 static int
 526 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
 527 {
 528   svm_msg_q_msg_t _msg, *msg = &_msg;
 529   session_app_del_segment_msg_t *mp;
 530   vl_api_registration_t *reg;
 531   app_worker_t *app_wrk;
 532   session_event_t *evt;
 533   svm_msg_q_t *app_mq;
 534
 535   app_wrk = app_worker_get (app_wrk_index);
 536   reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
 537   if (!reg)
 538     {
 539       clib_warning ("no registration: %u", app_wrk->api_client_index);
 540       return -1;
 541     }
 542
 543   app_mq = app_wrk->event_queue;
 544   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 545     return -1;
 546
 547   evt = svm_msg_q_msg_data (app_mq, msg);
 548   clib_memset (evt, 0, sizeof (*evt));
 549   evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
 550   mp = (session_app_del_segment_msg_t *) evt->data;
 551   clib_memset (mp, 0, sizeof (*mp));
 552   mp->segment_handle = segment_handle;
 553   svm_msg_q_add_and_unlock (app_mq, msg);
 554
 555   return 0;
 556 }
 557
 558 static void
 559 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
 560 {
 561   svm_msg_q_msg_t _msg, *msg = &_msg;
 562   session_cleanup_msg_t *mp;
 563   svm_msg_q_t *app_mq;
 564   session_event_t *evt;
 565   app_worker_t *app_wrk;
 566
 567   /* Propagate transport cleanup notifications only if app didn't close */
 568   if (ntf == SESSION_CLEANUP_TRANSPORT
 569       && s->session_state != SESSION_STATE_TRANSPORT_DELETED)
 570     return;
 571
 572   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
 573   if (!app_wrk)
 574     return;
 575
 576   app_mq = app_wrk->event_queue;
 577   if (mq_try_lock_and_alloc_msg (app_mq, msg))
 578     return;
 579
 580   evt = svm_msg_q_msg_data (app_mq, msg);
 581   clib_memset (evt, 0, sizeof (*evt));
 582   evt->event_type = SESSION_CTRL_EVT_CLEANUP;
 583   mp = (session_cleanup_msg_t *) evt->data;
 584   mp->handle = session_handle (s);
 585   mp->type = ntf;
 586   svm_msg_q_add_and_unlock (app_mq, msg);
 587 }
 588
 589 static session_cb_vft_t session_mq_cb_vft = {
 590   .session_accept_callback = mq_send_session_accepted_cb,
 591   .session_disconnect_callback = mq_send_session_disconnected_cb,
 592   .session_connected_callback = mq_send_session_connected_cb,
 593   .session_reset_callback = mq_send_session_reset_cb,
 594   .session_migrate_callback = mq_send_session_migrate_cb,
 595   .session_cleanup_callback = mq_send_session_cleanup_cb,
 596   .add_segment_callback = mq_send_add_segment_cb,
 597   .del_segment_callback = mq_send_del_segment_cb,
 598 };
 599
 600 static void
 601 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
 602 {
 603   vl_api_session_enable_disable_reply_t *rmp;
 604   vlib_main_t *vm = vlib_get_main ();
 605   int rv = 0;
 606
 607   vnet_session_enable_disable (vm, mp->is_enable);
 608   REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
 609 }
 610
 611 static void
 612 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
 613 {
 614   int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
 615   vl_api_app_attach_reply_t *rmp;
 616   fifo_segment_t *segp, *evt_q_segment = 0;
 617   vnet_app_attach_args_t _a, *a = &_a;
 618   u8 fd_flags = 0, ctrl_thread;
 619   vl_api_registration_t *reg;
 620
 621   reg = vl_api_client_index_to_registration (mp->client_index);
 622   if (!reg)
 623     return;
 624
 625   if (!session_main_is_enabled () || appns_sapi_enabled ())
 626     {
 627       rv = VNET_API_ERROR_FEATURE_DISABLED;
 628       goto done;
 629     }
 630   /* Only support binary api with socket transport */
 631   if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 632     {
 633       rv = VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 634       goto done;
 635     }
 636
 637   STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
 638                  sizeof (mp->options),
 639                  "Out of options, fix api message definition");
 640
 641   clib_memset (a, 0, sizeof (*a));
 642   a->api_client_index = mp->client_index;
 643   a->options = mp->options;
 644   a->session_cb_vft = &session_mq_cb_vft;
 645   a->namespace_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
 646
 647   if ((rv = vnet_application_attach (a)))
 648     {
 649       clib_warning ("attach returned: %d", rv);
 650       vec_free (a->namespace_id);
 651       goto done;
 652     }
 653   vec_free (a->namespace_id);
 654
 655   /* Send event queues segment */
 656   if ((evt_q_segment = session_main_get_evt_q_segment ()))
 657     {
 658       fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
 659       fds[n_fds] = evt_q_segment->ssvm.fd;
 660       n_fds += 1;
 661     }
 662   /* Send fifo segment fd if needed */
 663   if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
 664     {
 665       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
 666       fds[n_fds] = a->segment->fd;
 667       n_fds += 1;
 668     }
 669   if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 670     {
 671       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
 672       fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
 673       n_fds += 1;
 674     }
 675
 676 done:
 677   /* *INDENT-OFF* */
 678   REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
 679     if (!rv)
 680       {
 681         ctrl_thread = vlib_num_workers () ? 1 : 0;
 682         segp = (fifo_segment_t *) a->segment;
 683         rmp->app_index = clib_host_to_net_u32 (a->app_index);
 684         rmp->app_mq = fifo_segment_msg_q_offset (segp, 0);
 685         rmp->vpp_ctrl_mq =
 686           fifo_segment_msg_q_offset (evt_q_segment, ctrl_thread);
 687         rmp->vpp_ctrl_mq_thread = ctrl_thread;
 688         rmp->n_fds = n_fds;
 689         rmp->fd_flags = fd_flags;
 690         if (vec_len (segp->ssvm.name))
 691           {
 692             vl_api_vec_to_api_string (segp->ssvm.name, &rmp->segment_name);
 693           }
 694         rmp->segment_size = segp->ssvm.ssvm_size;
 695         rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
 696       }
 697   }));
 698   /* *INDENT-ON* */
 699
 700   if (n_fds)
 701     session_send_fds (reg, fds, n_fds);
 702 }
 703
 704 static void
 705 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
 706 {
 707   int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
 708   vl_api_app_worker_add_del_reply_t *rmp;
 709   vl_api_registration_t *reg;
 710   application_t *app;
 711   u8 fd_flags = 0;
 712
 713   if (!session_main_is_enabled () || appns_sapi_enabled ())
 714     {
 715       rv = VNET_API_ERROR_FEATURE_DISABLED;
 716       goto done;
 717     }
 718
 719   reg = vl_api_client_index_to_registration (mp->client_index);
 720   if (!reg)
 721     return;
 722
 723   app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
 724   if (!app)
 725     {
 726       rv = VNET_API_ERROR_INVALID_VALUE;
 727       goto done;
 728     }
 729
 730   vnet_app_worker_add_del_args_t args = {
 731     .app_index = app->app_index,
 732     .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
 733     .api_client_index = mp->client_index,
 734     .is_add = mp->is_add
 735   };
 736   rv = vnet_app_worker_add_del (&args);
 737   if (rv)
 738     {
 739       clib_warning ("app worker add/del returned: %d", rv);
 740       goto done;
 741     }
 742
 743   if (!mp->is_add)
 744     goto done;
 745
 746   /* Send fifo segment fd if needed */
 747   if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
 748     {
 749       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
 750       fds[n_fds] = args.segment->fd;
 751       n_fds += 1;
 752     }
 753   if (application_segment_manager_properties (app)->use_mq_eventfd)
 754     {
 755       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
 756       fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
 757       n_fds += 1;
 758     }
 759
 760   /* *INDENT-OFF* */
 761 done:
 762   REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
 763     rmp->is_add = mp->is_add;
 764     rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
 765     rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
 766     if (!rv && mp->is_add)
 767       {
 768         rmp->app_event_queue_address =
 769           fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
 770         rmp->n_fds = n_fds;
 771         rmp->fd_flags = fd_flags;
 772         if (vec_len (args.segment->name))
 773           {
 774             vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name);
 775           }
 776       }
 777   }));
 778   /* *INDENT-ON* */
 779
 780   if (n_fds)
 781     session_send_fds (reg, fds, n_fds);
 782 }
 783
 784 static void
 785 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
 786 {
 787   vl_api_application_detach_reply_t *rmp;
 788   int rv = VNET_API_ERROR_INVALID_VALUE_2;
 789   vnet_app_detach_args_t _a, *a = &_a;
 790   application_t *app;
 791
 792   if (!session_main_is_enabled () || appns_sapi_enabled ())
 793     {
 794       rv = VNET_API_ERROR_FEATURE_DISABLED;
 795       goto done;
 796     }
 797
 798   app = application_lookup (mp->client_index);
 799   if (app)
 800     {
 801       a->app_index = app->app_index;
 802       a->api_client_index = mp->client_index;
 803       rv = vnet_application_detach (a);
 804     }
 805
 806 done:
 807   REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
 808 }
 809
 810 static void
 811 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
 812 {
 813   vl_api_app_namespace_add_del_reply_t *rmp;
 814   u32 appns_index = 0;
 815   u8 *ns_id = 0;
 816   int rv = 0;
 817   if (session_main_is_enabled () == 0)
 818     {
 819       rv = VNET_API_ERROR_FEATURE_DISABLED;
 820       goto done;
 821     }
 822
 823   ns_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
 824
 825   vnet_app_namespace_add_del_args_t args = {
 826     .ns_id = ns_id,
 827     .secret = clib_net_to_host_u64 (mp->secret),
 828     .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
 829     .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
 830     .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
 831     .is_add = 1
 832   };
 833   rv = vnet_app_namespace_add_del (&args);
 834   if (!rv)
 835     {
 836       appns_index = app_namespace_index_from_id (ns_id);
 837       if (appns_index == APP_NAMESPACE_INVALID_INDEX)
 838         {
 839           clib_warning ("app ns lookup failed");
 840           rv = VNET_API_ERROR_UNSPECIFIED;
 841         }
 842     }
 843   vec_free (ns_id);
 844
 845   /* *INDENT-OFF* */
 846 done:
 847   REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
 848     if (!rv)
 849       rmp->appns_index = clib_host_to_net_u32 (appns_index);
 850   }));
 851   /* *INDENT-ON* */
 852 }
 853
 854 static void
 855 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
 856 {
 857   vl_api_session_rule_add_del_reply_t *rmp;
 858   session_rule_add_del_args_t args;
 859   session_rule_table_add_del_args_t *table_args = &args.table_args;
 860   int rv = 0;
 861
 862   clib_memset (&args, 0, sizeof (args));
 863
 864   ip_prefix_decode (&mp->lcl, &table_args->lcl);
 865   ip_prefix_decode (&mp->rmt, &table_args->rmt);
 866
 867   table_args->lcl_port = mp->lcl_port;
 868   table_args->rmt_port = mp->rmt_port;
 869   table_args->action_index = clib_net_to_host_u32 (mp->action_index);
 870   table_args->is_add = mp->is_add;
 871   mp->tag[sizeof (mp->tag) - 1] = 0;
 872   table_args->tag = format (0, "%s", mp->tag);
 873   args.appns_index = clib_net_to_host_u32 (mp->appns_index);
 874   args.scope = mp->scope;
 875   args.transport_proto =
 876     api_session_transport_proto_decode (&mp->transport_proto) ==
 877     TRANSPORT_PROTO_UDP ? 1 : 0;
 878
 879   rv = vnet_session_rule_add_del (&args);
 880   if (rv)
 881     clib_warning ("rule add del returned: %d", rv);
 882   vec_free (table_args->tag);
 883   REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
 884 }
 885
 886 static void
 887 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
 888                             u8 transport_proto, u32 appns_index, u8 * tag,
 889                             vl_api_registration_t * reg, u32 context)
 890 {
 891   vl_api_session_rules_details_t *rmp = 0;
 892   session_mask_or_match_4_t *match =
 893     (session_mask_or_match_4_t *) & rule->match;
 894   session_mask_or_match_4_t *mask =
 895     (session_mask_or_match_4_t *) & rule->mask;
 896   fib_prefix_t lcl, rmt;
 897
 898   rmp = vl_msg_api_alloc (sizeof (*rmp));
 899   clib_memset (rmp, 0, sizeof (*rmp));
 900   rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
 901   rmp->context = context;
 902
 903   clib_memset (&lcl, 0, sizeof (lcl));
 904   clib_memset (&rmt, 0, sizeof (rmt));
 905   ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
 906   ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
 907   lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
 908   rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
 909
 910   ip_prefix_encode (&lcl, &rmp->lcl);
 911   ip_prefix_encode (&rmt, &rmp->rmt);
 912   rmp->lcl_port = match->lcl_port;
 913   rmp->rmt_port = match->rmt_port;
 914   rmp->action_index = clib_host_to_net_u32 (rule->action_index);
 915   rmp->scope =
 916     is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
 917   rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
 918   rmp->appns_index = clib_host_to_net_u32 (appns_index);
 919   if (tag)
 920     {
 921       clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
 922       rmp->tag[vec_len (tag)] = 0;
 923     }
 924
 925   vl_api_send_msg (reg, (u8 *) rmp);
 926 }
 927
 928 static void
 929 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
 930                             u8 transport_proto, u32 appns_index, u8 * tag,
 931                             vl_api_registration_t * reg, u32 context)
 932 {
 933   vl_api_session_rules_details_t *rmp = 0;
 934   session_mask_or_match_6_t *match =
 935     (session_mask_or_match_6_t *) & rule->match;
 936   session_mask_or_match_6_t *mask =
 937     (session_mask_or_match_6_t *) & rule->mask;
 938   fib_prefix_t lcl, rmt;
 939
 940   rmp = vl_msg_api_alloc (sizeof (*rmp));
 941   clib_memset (rmp, 0, sizeof (*rmp));
 942   rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
 943   rmp->context = context;
 944
 945   clib_memset (&lcl, 0, sizeof (lcl));
 946   clib_memset (&rmt, 0, sizeof (rmt));
 947   ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
 948   ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
 949   lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
 950   rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
 951
 952   ip_prefix_encode (&lcl, &rmp->lcl);
 953   ip_prefix_encode (&rmt, &rmp->rmt);
 954   rmp->lcl_port = match->lcl_port;
 955   rmp->rmt_port = match->rmt_port;
 956   rmp->action_index = clib_host_to_net_u32 (rule->action_index);
 957   rmp->scope =
 958     is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
 959   rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
 960   rmp->appns_index = clib_host_to_net_u32 (appns_index);
 961   if (tag)
 962     {
 963       clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
 964       rmp->tag[vec_len (tag)] = 0;
 965     }
 966
 967   vl_api_send_msg (reg, (u8 *) rmp);
 968 }
 969
 970 static void
 971 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
 972                                   u8 tp, u8 is_local, u32 appns_index,
 973                                   vl_api_registration_t * reg, u32 context)
 974 {
 975   mma_rule_16_t *rule16;
 976   mma_rule_40_t *rule40;
 977   mma_rules_table_16_t *srt16;
 978   mma_rules_table_40_t *srt40;
 979   u32 ri;
 980
 981   if (is_local || fib_proto == FIB_PROTOCOL_IP4)
 982     {
 983       u8 *tag = 0;
 984       /* *INDENT-OFF* */
 985       srt16 = &srt->session_rules_tables_16;
 986       pool_foreach (rule16, srt16->rules)  {
 987         ri = mma_rules_table_rule_index_16 (srt16, rule16);
 988         tag = session_rules_table_rule_tag (srt, ri, 1);
 989         send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
 990                                     reg, context);
 991       }
 992       /* *INDENT-ON* */
 993     }
 994   if (is_local || fib_proto == FIB_PROTOCOL_IP6)
 995     {
 996       u8 *tag = 0;
 997       /* *INDENT-OFF* */
 998       srt40 = &srt->session_rules_tables_40;
 999       pool_foreach (rule40, srt40->rules)  {
1000         ri = mma_rules_table_rule_index_40 (srt40, rule40);
1001         tag = session_rules_table_rule_tag (srt, ri, 1);
1002         send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1003                                     reg, context);
1004       }
1005       /* *INDENT-ON* */
1006     }
1007 }
1008
1009 static void
1010 vl_api_session_rules_dump_t_handler (vl_api_session_rules_dump_t * mp)
1011 {
1012   vl_api_registration_t *reg;
1013   session_table_t *st;
1014   u8 tp;
1015
1016   reg = vl_api_client_index_to_registration (mp->client_index);
1017   if (!reg)
1018     return;
1019
1020   /* *INDENT-OFF* */
1021   session_table_foreach (st, ({
1022     for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1023       {
1024         send_session_rules_table_details (&st->session_rules[tp],
1025                                           st->active_fib_proto, tp,
1026                                           st->is_local, st->appns_index, reg,
1027                                           mp->context);
1028       }
1029   }));
1030   /* *INDENT-ON* */
1031 }
1032
1033 static void
1034 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1035 {
1036   vl_api_app_add_cert_key_pair_reply_t *rmp;
1037   vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1038   u32 certkey_len, key_len, cert_len;
1039   int rv = 0;
1040   if (session_main_is_enabled () == 0)
1041     {
1042       rv = VNET_API_ERROR_FEATURE_DISABLED;
1043       goto done;
1044     }
1045
1046   cert_len = clib_net_to_host_u16 (mp->cert_len);
1047   if (cert_len > 10000)
1048     {
1049       rv = VNET_API_ERROR_INVALID_VALUE;
1050       goto done;
1051     }
1052
1053   certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1054   if (certkey_len < cert_len)
1055     {
1056       rv = VNET_API_ERROR_INVALID_VALUE;
1057       goto done;
1058     }
1059
1060   key_len = certkey_len - cert_len;
1061   if (key_len > 10000)
1062     {
1063       rv = VNET_API_ERROR_INVALID_VALUE;
1064       goto done;
1065     }
1066
1067   clib_memset (a, 0, sizeof (*a));
1068   vec_validate (a->cert, cert_len);
1069   vec_validate (a->key, key_len);
1070   clib_memcpy_fast (a->cert, mp->certkey, cert_len);
1071   clib_memcpy_fast (a->key, mp->certkey + cert_len, key_len);
1072   rv = vnet_app_add_cert_key_pair (a);
1073   vec_free (a->cert);
1074   vec_free (a->key);
1075
1076 done:
1077   /* *INDENT-OFF* */
1078   REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1079     if (!rv)
1080       rmp->index = clib_host_to_net_u32 (a->index);
1081   }));
1082   /* *INDENT-ON* */
1083 }
1084
1085 static void
1086 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1087 {
1088   vl_api_app_del_cert_key_pair_reply_t *rmp;
1089   u32 ckpair_index;
1090   int rv = 0;
1091   if (session_main_is_enabled () == 0)
1092     {
1093       rv = VNET_API_ERROR_FEATURE_DISABLED;
1094       goto done;
1095     }
1096   ckpair_index = clib_net_to_host_u32 (mp->index);
1097   rv = vnet_app_del_cert_key_pair (ckpair_index);
1098
1099 done:
1100   REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1101 }
1102
1103 /* ### WILL BE DEPRECATED POST 20.01 ### */
1104 static void
1105 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1106                                            mp)
1107 {
1108   vl_api_application_tls_cert_add_reply_t *rmp;
1109   app_cert_key_pair_t *ckpair;
1110   application_t *app;
1111   u32 cert_len;
1112   int rv = 0;
1113   if (session_main_is_enabled () == 0)
1114     {
1115       rv = VNET_API_ERROR_FEATURE_DISABLED;
1116       goto done;
1117     }
1118   if (!(app = application_lookup (mp->client_index)))
1119     {
1120       rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1121       goto done;
1122     }
1123   cert_len = clib_net_to_host_u16 (mp->cert_len);
1124   if (cert_len > 10000)
1125     {
1126       rv = VNET_API_ERROR_INVALID_VALUE;
1127       goto done;
1128     }
1129   ckpair = app_cert_key_pair_get_default ();
1130   vec_validate (ckpair->cert, cert_len);
1131   clib_memcpy_fast (ckpair->cert, mp->cert, cert_len);
1132
1133 done:
1134   REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1135 }
1136
1137 /* ### WILL BE DEPRECATED POST 20.01 ### */
1138 static void
1139 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1140                                           mp)
1141 {
1142   vl_api_application_tls_key_add_reply_t *rmp;
1143   app_cert_key_pair_t *ckpair;
1144   application_t *app;
1145   u32 key_len;
1146   int rv = 0;
1147   if (session_main_is_enabled () == 0)
1148     {
1149       rv = VNET_API_ERROR_FEATURE_DISABLED;
1150       goto done;
1151     }
1152   if (!(app = application_lookup (mp->client_index)))
1153     {
1154       rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1155       goto done;
1156     }
1157   key_len = clib_net_to_host_u16 (mp->key_len);
1158   if (key_len > 10000)
1159     {
1160       rv = VNET_API_ERROR_INVALID_VALUE;
1161       goto done;
1162     }
1163   ckpair = app_cert_key_pair_get_default ();
1164   vec_validate (ckpair->key, key_len);
1165   clib_memcpy_fast (ckpair->key, mp->key, key_len);
1166 done:
1167   REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1168 }
1169
1170 static clib_error_t *
1171 application_reaper_cb (u32 client_index)
1172 {
1173   application_t *app = application_lookup (client_index);
1174   vnet_app_detach_args_t _a, *a = &_a;
1175   if (app)
1176     {
1177       a->app_index = app->app_index;
1178       a->api_client_index = client_index;
1179       vnet_application_detach (a);
1180     }
1181   return 0;
1182 }
1183
1184 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1185
1186 #define vl_msg_name_crc_list
1187 #include <vnet/vnet_all_api_h.h>
1188 #undef vl_msg_name_crc_list
1189
1190 static void
1191 setup_message_id_table (api_main_t * am)
1192 {
1193 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1194   foreach_vl_msg_name_crc_session;
1195 #undef _
1196 }
1197
1198 /*
1199  * session_api_hookup
1200  * Add uri's API message handlers to the table.
1201  * vlib has already mapped shared memory and
1202  * added the client registration handlers.
1203  * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1204  */
1205 static clib_error_t *
1206 session_api_hookup (vlib_main_t * vm)
1207 {
1208   api_main_t *am = vlibapi_get_main ();
1209
1210 #define _(N,n)                                                  \
1211     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
1212                            vl_api_##n##_t_handler,              \
1213                            vl_noop_handler,                     \
1214                            vl_api_##n##_t_endian,               \
1215                            vl_api_##n##_t_print,                \
1216                            sizeof(vl_api_##n##_t), 1);
1217   foreach_session_api_msg;
1218 #undef _
1219
1220   /*
1221    * Set up the (msg_name, crc, message-id) table
1222    */
1223   setup_message_id_table (am);
1224
1225   return 0;
1226 }
1227
1228 VLIB_API_INIT_FUNCTION (session_api_hookup);
1229
1230 /*
1231  * Socket api functions
1232  */
1233
1234 static void
1235 sapi_send_fds (app_worker_t * app_wrk, int *fds, int n_fds)
1236 {
1237   app_sapi_msg_t smsg = { 0 };
1238   app_namespace_t *app_ns;
1239   application_t *app;
1240   clib_socket_t *cs;
1241   u32 cs_index;
1242
1243   app = application_get (app_wrk->app_index);
1244   app_ns = app_namespace_get (app->ns_index);
1245   cs_index = appns_sapi_handle_sock_index (app_wrk->api_client_index);
1246   cs = appns_sapi_get_socket (app_ns, cs_index);
1247   if (PREDICT_FALSE (!cs))
1248     return;
1249
1250   /* There's no payload for the message only the type */
1251   smsg.type = APP_SAPI_MSG_TYPE_SEND_FDS;
1252   clib_socket_sendmsg (cs, &smsg, sizeof (smsg), fds, n_fds);
1253 }
1254
1255 static int
1256 mq_send_add_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1257 {
1258   int fds[SESSION_N_FD_TYPE], n_fds = 0;
1259   svm_msg_q_msg_t _msg, *msg = &_msg;
1260   session_app_add_segment_msg_t *mp;
1261   app_worker_t *app_wrk;
1262   session_event_t *evt;
1263   svm_msg_q_t *app_mq;
1264   fifo_segment_t *fs;
1265   ssvm_private_t *sp;
1266   u8 fd_flags = 0;
1267
1268   app_wrk = app_worker_get (app_wrk_index);
1269
1270   fs = segment_manager_get_segment_w_handle (segment_handle);
1271   sp = &fs->ssvm;
1272   ASSERT (ssvm_type (sp) == SSVM_SEGMENT_MEMFD);
1273
1274   fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1275   fds[n_fds] = sp->fd;
1276   n_fds += 1;
1277
1278   app_mq = app_wrk->event_queue;
1279   if (mq_try_lock_and_alloc_msg (app_mq, msg))
1280     return -1;
1281
1282   /*
1283    * Send the fd over api socket
1284    */
1285   sapi_send_fds (app_wrk, fds, n_fds);
1286
1287   /*
1288    * Send the actual message over mq
1289    */
1290   evt = svm_msg_q_msg_data (app_mq, msg);
1291   clib_memset (evt, 0, sizeof (*evt));
1292   evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
1293   mp = (session_app_add_segment_msg_t *) evt->data;
1294   clib_memset (mp, 0, sizeof (*mp));
1295   mp->segment_size = sp->ssvm_size;
1296   mp->fd_flags = fd_flags;
1297   mp->segment_handle = segment_handle;
1298   strncpy ((char *) mp->segment_name, (char *) sp->name,
1299            sizeof (mp->segment_name) - 1);
1300
1301   svm_msg_q_add_and_unlock (app_mq, msg);
1302
1303   return 0;
1304 }
1305
1306 static int
1307 mq_send_del_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1308 {
1309   svm_msg_q_msg_t _msg, *msg = &_msg;
1310   session_app_del_segment_msg_t *mp;
1311   app_worker_t *app_wrk;
1312   session_event_t *evt;
1313   svm_msg_q_t *app_mq;
1314
1315   app_wrk = app_worker_get (app_wrk_index);
1316
1317   app_mq = app_wrk->event_queue;
1318   if (mq_try_lock_and_alloc_msg (app_mq, msg))
1319     return -1;
1320
1321   evt = svm_msg_q_msg_data (app_mq, msg);
1322   clib_memset (evt, 0, sizeof (*evt));
1323   evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
1324   mp = (session_app_del_segment_msg_t *) evt->data;
1325   clib_memset (mp, 0, sizeof (*mp));
1326   mp->segment_handle = segment_handle;
1327   svm_msg_q_add_and_unlock (app_mq, msg);
1328
1329   return 0;
1330 }
1331
1332 static session_cb_vft_t session_mq_sapi_cb_vft = {
1333   .session_accept_callback = mq_send_session_accepted_cb,
1334   .session_disconnect_callback = mq_send_session_disconnected_cb,
1335   .session_connected_callback = mq_send_session_connected_cb,
1336   .session_reset_callback = mq_send_session_reset_cb,
1337   .session_migrate_callback = mq_send_session_migrate_cb,
1338   .session_cleanup_callback = mq_send_session_cleanup_cb,
1339   .add_segment_callback = mq_send_add_segment_sapi_cb,
1340   .del_segment_callback = mq_send_del_segment_sapi_cb,
1341 };
1342
1343 static void
1344 session_api_attach_handler (app_namespace_t * app_ns, clib_socket_t * cs,
1345                             app_sapi_attach_msg_t * mp)
1346 {
1347   int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1348   vnet_app_attach_args_t _a, *a = &_a;
1349   app_sapi_attach_reply_msg_t *rmp;
1350   fifo_segment_t *evt_q_segment;
1351   u8 fd_flags = 0, ctrl_thread;
1352   app_ns_api_handle_t *handle;
1353   app_sapi_msg_t msg = { 0 };
1354   app_worker_t *app_wrk;
1355   application_t *app;
1356
1357   /* Make sure name is null terminated */
1358   mp->name[63] = 0;
1359
1360   clib_memset (a, 0, sizeof (*a));
1361   a->api_client_index = appns_sapi_socket_handle (app_ns, cs);
1362   a->name = format (0, "%s", (char *) mp->name);
1363   a->options = mp->options;
1364   a->session_cb_vft = &session_mq_sapi_cb_vft;
1365   a->use_sock_api = 1;
1366   a->options[APP_OPTIONS_NAMESPACE] = app_namespace_index (app_ns);
1367
1368   if ((rv = vnet_application_attach (a)))
1369     {
1370       clib_warning ("attach returned: %d", rv);
1371       goto done;
1372     }
1373
1374   /* Send event queues segment */
1375   if ((evt_q_segment = session_main_get_evt_q_segment ()))
1376     {
1377       fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
1378       fds[n_fds] = evt_q_segment->ssvm.fd;
1379       n_fds += 1;
1380     }
1381   /* Send fifo segment fd if needed */
1382   if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
1383     {
1384       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1385       fds[n_fds] = a->segment->fd;
1386       n_fds += 1;
1387     }
1388   if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
1389     {
1390       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1391       fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
1392       n_fds += 1;
1393     }
1394
1395 done:
1396
1397   msg.type = APP_SAPI_MSG_TYPE_ATTACH_REPLY;
1398   rmp = &msg.attach_reply;
1399   rmp->retval = rv;
1400   if (!rv)
1401     {
1402       ctrl_thread = vlib_num_workers ()? 1 : 0;
1403       rmp->app_index = a->app_index;
1404       rmp->app_mq =
1405         fifo_segment_msg_q_offset ((fifo_segment_t *) a->segment, 0);
1406       rmp->vpp_ctrl_mq =
1407         fifo_segment_msg_q_offset (evt_q_segment, ctrl_thread);
1408       rmp->vpp_ctrl_mq_thread = ctrl_thread;
1409       rmp->n_fds = n_fds;
1410       rmp->fd_flags = fd_flags;
1411       /* No segment name and size since we only support memfds
1412        * in this configuration */
1413       rmp->segment_handle = a->segment_handle;
1414       rmp->api_client_handle = a->api_client_index;
1415
1416       /* Update app index for socket */
1417       handle = (app_ns_api_handle_t *) & cs->private_data;
1418       app = application_get (a->app_index);
1419       app_wrk = application_get_worker (app, 0);
1420       handle->aah_app_wrk_index = app_wrk->wrk_index;
1421     }
1422
1423   clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1424   vec_free (a->name);
1425 }
1426
1427 static void
1428 sapi_socket_close_w_handle (u32 api_handle)
1429 {
1430   app_namespace_t *app_ns = app_namespace_get (api_handle >> 16);
1431   u16 sock_index = api_handle & 0xffff;
1432   app_ns_api_handle_t *handle;
1433   clib_socket_t *cs;
1434   clib_file_t *cf;
1435
1436   cs = appns_sapi_get_socket (app_ns, sock_index);
1437   if (!cs)
1438     return;
1439
1440   handle = (app_ns_api_handle_t *) & cs->private_data;
1441   cf = clib_file_get (&file_main, handle->aah_file_index);
1442   clib_file_del (&file_main, cf);
1443
1444   clib_socket_close (cs);
1445   appns_sapi_free_socket (app_ns, cs);
1446 }
1447
1448 static void
1449 sapi_add_del_worker_handler (app_namespace_t * app_ns,
1450                              clib_socket_t * cs,
1451                              app_sapi_worker_add_del_msg_t * mp)
1452 {
1453   int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1454   app_sapi_worker_add_del_reply_msg_t *rmp;
1455   app_ns_api_handle_t *handle;
1456   app_sapi_msg_t msg = { 0 };
1457   app_worker_t *app_wrk;
1458   u32 sapi_handle = -1;
1459   application_t *app;
1460   u8 fd_flags = 0;
1461
1462   app = application_get_if_valid (mp->app_index);
1463   if (!app)
1464     {
1465       rv = VNET_API_ERROR_INVALID_VALUE;
1466       goto done;
1467     }
1468
1469   sapi_handle = appns_sapi_socket_handle (app_ns, cs);
1470
1471   vnet_app_worker_add_del_args_t args = {
1472     .app_index = app->app_index,
1473     .wrk_map_index = mp->wrk_index,
1474     .api_client_index = sapi_handle,
1475     .is_add = mp->is_add
1476   };
1477   rv = vnet_app_worker_add_del (&args);
1478   if (rv)
1479     {
1480       clib_warning ("app worker add/del returned: %d", rv);
1481       goto done;
1482     }
1483
1484   if (!mp->is_add)
1485     {
1486       sapi_socket_close_w_handle (sapi_handle);
1487       goto done;
1488     }
1489
1490   /* Send fifo segment fd if needed */
1491   if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1492     {
1493       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1494       fds[n_fds] = args.segment->fd;
1495       n_fds += 1;
1496     }
1497   if (application_segment_manager_properties (app)->use_mq_eventfd)
1498     {
1499       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1500       fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
1501       n_fds += 1;
1502     }
1503
1504 done:
1505
1506   msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY;
1507   rmp = &msg.worker_add_del_reply;
1508   rmp->retval = rv;
1509   rmp->is_add = mp->is_add;
1510   rmp->api_client_handle = sapi_handle;
1511   rmp->wrk_index = args.wrk_map_index;
1512   rmp->segment_handle = args.segment_handle;
1513   if (!rv && mp->is_add)
1514     {
1515       /* No segment name and size. This supports only memfds */
1516       rmp->app_event_queue_address =
1517         fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
1518       rmp->n_fds = n_fds;
1519       rmp->fd_flags = fd_flags;
1520
1521       /* Update app index for socket */
1522       handle = (app_ns_api_handle_t *) & cs->private_data;
1523       app_wrk = application_get_worker (app, args.wrk_map_index);
1524       handle->aah_app_wrk_index = app_wrk->wrk_index;
1525     }
1526
1527   clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1528 }
1529
1530 static void
1531 sapi_socket_detach (app_namespace_t * app_ns, clib_socket_t * cs)
1532 {
1533   app_ns_api_handle_t *handle;
1534   app_worker_t *app_wrk;
1535   u32 api_client_handle;
1536
1537   api_client_handle = appns_sapi_socket_handle (app_ns, cs);
1538   sapi_socket_close_w_handle (api_client_handle);
1539
1540   /* Cleanup everything because app worker closed socket or crashed */
1541   handle = (app_ns_api_handle_t *) & cs->private_data;
1542   app_wrk = app_worker_get (handle->aah_app_wrk_index);
1543
1544   vnet_app_worker_add_del_args_t args = {
1545     .app_index = app_wrk->app_index,
1546     .wrk_map_index = app_wrk->wrk_map_index,
1547     .api_client_index = api_client_handle,
1548     .is_add = 0
1549   };
1550   /* Send rpc to main thread for worker barrier */
1551   vlib_rpc_call_main_thread (vnet_app_worker_add_del, (u8 *) & args,
1552                              sizeof (args));
1553 }
1554
1555 static clib_error_t *
1556 sapi_sock_read_ready (clib_file_t * cf)
1557 {
1558   app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1559   vlib_main_t *vm = vlib_get_main ();
1560   app_sapi_msg_t msg = { 0 };
1561   app_namespace_t *app_ns;
1562   clib_error_t *err = 0;
1563   clib_socket_t *cs;
1564
1565   app_ns = app_namespace_get (handle->aah_app_ns_index);
1566   cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1567   if (!cs)
1568     goto error;
1569
1570   err = clib_socket_recvmsg (cs, &msg, sizeof (msg), 0, 0);
1571   if (err)
1572     {
1573       clib_error_free (err);
1574       sapi_socket_detach (app_ns, cs);
1575       goto error;
1576     }
1577
1578   handle = (app_ns_api_handle_t *) & cs->private_data;
1579
1580   vlib_worker_thread_barrier_sync (vm);
1581
1582   switch (msg.type)
1583     {
1584     case APP_SAPI_MSG_TYPE_ATTACH:
1585       session_api_attach_handler (app_ns, cs, &msg.attach);
1586       break;
1587     case APP_SAPI_MSG_TYPE_ADD_DEL_WORKER:
1588       sapi_add_del_worker_handler (app_ns, cs, &msg.worker_add_del);
1589       break;
1590     default:
1591       clib_warning ("app wrk %u unknown message type: %u",
1592                     handle->aah_app_wrk_index, msg.type);
1593       break;
1594     }
1595
1596   vlib_worker_thread_barrier_release (vm);
1597
1598 error:
1599   return 0;
1600 }
1601
1602 static clib_error_t *
1603 sapi_sock_write_ready (clib_file_t * cf)
1604 {
1605   app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1606   clib_warning ("called for app ns %u", handle->aah_app_ns_index);
1607   return 0;
1608 }
1609
1610 static clib_error_t *
1611 sapi_sock_error (clib_file_t * cf)
1612 {
1613   app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1614   app_namespace_t *app_ns;
1615   clib_socket_t *cs;
1616
1617   app_ns = app_namespace_get (handle->aah_app_ns_index);
1618   cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1619   if (!cs)
1620     return 0;
1621
1622   sapi_socket_detach (app_ns, cs);
1623   return 0;
1624 }
1625
1626 static clib_error_t *
1627 sapi_sock_accept_ready (clib_file_t * scf)
1628 {
1629   app_ns_api_handle_t handle = *(app_ns_api_handle_t *) & scf->private_data;
1630   app_namespace_t *app_ns;
1631   clib_file_t cf = { 0 };
1632   clib_error_t *err = 0;
1633   clib_socket_t *ccs, *scs;
1634
1635   /* Listener files point to namespace */
1636   app_ns = app_namespace_get (handle.aah_app_ns_index);
1637
1638   /*
1639    * Initialize client socket
1640    */
1641   ccs = appns_sapi_alloc_socket (app_ns);
1642
1643   /* Grab server socket after client is initialized  */
1644   scs = appns_sapi_get_socket (app_ns, handle.aah_sock_index);
1645   if (!scs)
1646     goto error;
1647
1648   err = clib_socket_accept (scs, ccs);
1649   if (err)
1650     {
1651       clib_error_report (err);
1652       goto error;
1653     }
1654
1655   cf.read_function = sapi_sock_read_ready;
1656   cf.write_function = sapi_sock_write_ready;
1657   cf.error_function = sapi_sock_error;
1658   cf.file_descriptor = ccs->fd;
1659   /* File points to app namespace and socket */
1660   handle.aah_sock_index = appns_sapi_socket_index (app_ns, ccs);
1661   cf.private_data = handle.as_u64;
1662   cf.description = format (0, "app sock conn fd: %d", ccs->fd);
1663
1664   /* Poll until we get an attach message. Socket points to file and
1665    * application that owns the socket */
1666   handle.aah_app_wrk_index = APP_INVALID_INDEX;
1667   handle.aah_file_index = clib_file_add (&file_main, &cf);
1668   ccs->private_data = handle.as_u64;
1669
1670   return err;
1671
1672 error:
1673   appns_sapi_free_socket (app_ns, ccs);
1674   return err;
1675 }
1676
1677 int
1678 appns_sapi_add_ns_socket (app_namespace_t * app_ns)
1679 {
1680   char *subdir = "/app_ns_sockets/";
1681   app_ns_api_handle_t *handle;
1682   clib_file_t cf = { 0 };
1683   struct stat file_stat;
1684   clib_error_t *err;
1685   clib_socket_t *cs;
1686   u8 *dir = 0;
1687   int rv = 0;
1688
1689   vec_add (dir, vlib_unix_get_runtime_dir (),
1690            strlen (vlib_unix_get_runtime_dir ()));
1691   vec_add (dir, (u8 *) subdir, strlen (subdir));
1692
1693   err = vlib_unix_recursive_mkdir ((char *) dir);
1694   if (err)
1695     {
1696       clib_error_report (err);
1697       rv = -1;
1698       goto error;
1699     }
1700
1701   app_ns->sock_name = format (0, "%v%v%c", dir, app_ns->ns_id, 0);
1702
1703   /*
1704    * Create and initialize socket to listen on
1705    */
1706   cs = appns_sapi_alloc_socket (app_ns);
1707   cs->config = (char *) app_ns->sock_name;
1708   cs->flags = CLIB_SOCKET_F_IS_SERVER |
1709     CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1710     CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1711
1712   if ((err = clib_socket_init (cs)))
1713     {
1714       clib_error_report (err);
1715       rv = -1;
1716       goto error;
1717     }
1718
1719   if (stat ((char *) app_ns->sock_name, &file_stat) == -1)
1720     {
1721       rv = -1;
1722       goto error;
1723     }
1724
1725   /*
1726    * Start polling it
1727    */
1728   cf.read_function = sapi_sock_accept_ready;
1729   cf.file_descriptor = cs->fd;
1730   /* File points to namespace */
1731   handle = (app_ns_api_handle_t *) & cf.private_data;
1732   handle->aah_app_ns_index = app_namespace_index (app_ns);
1733   handle->aah_sock_index = appns_sapi_socket_index (app_ns, cs);
1734   cf.description = format (0, "app sock listener: %s", app_ns->sock_name);
1735
1736   /* Socket points to clib file index */
1737   handle = (app_ns_api_handle_t *) & cs->private_data;
1738   handle->aah_file_index = clib_file_add (&file_main, &cf);
1739   handle->aah_app_wrk_index = APP_INVALID_INDEX;
1740
1741 error:
1742   vec_free (dir);
1743   return rv;
1744 }
1745
1746 /*
1747  * fd.io coding-style-patch-verification: ON
1748  *
1749  * Local Variables:
1750  * eval: (c-set-style "gnu")
1751  * End:
1752  */