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