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, *evt_q_segment;
 605   vnet_app_attach_args_t _a, *a = &_a;
 606   u8 fd_flags = 0, ctrl_thread;
 607   vl_api_registration_t *reg;
 608   svm_msg_q_t *ctrl_mq;
 609
 610   reg = vl_api_client_index_to_registration (mp->client_index);
 611   if (!reg)
 612     return;
 613
 614   if (!session_main_is_enabled () || appns_sapi_enabled ())
 615     {
 616       rv = VNET_API_ERROR_FEATURE_DISABLED;
 617       goto done;
 618     }
 619   /* Only support binary api with socket transport */
 620   if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 621     {
 622       rv = VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 623       goto done;
 624     }
 625
 626   STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
 627                  sizeof (mp->options),
 628                  "Out of options, fix api message definition");
 629
 630   clib_memset (a, 0, sizeof (*a));
 631   a->api_client_index = mp->client_index;
 632   a->options = mp->options;
 633   a->session_cb_vft = &session_mq_cb_vft;
 634   a->namespace_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
 635
 636   if ((rv = vnet_application_attach (a)))
 637     {
 638       clib_warning ("attach returned: %d", rv);
 639       vec_free (a->namespace_id);
 640       goto done;
 641     }
 642   vec_free (a->namespace_id);
 643
 644   /* Send event queues segment */
 645   if ((evt_q_segment = session_main_get_evt_q_segment ()))
 646     {
 647       fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
 648       fds[n_fds] = evt_q_segment->fd;
 649       n_fds += 1;
 650     }
 651   /* Send fifo segment fd if needed */
 652   if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
 653     {
 654       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
 655       fds[n_fds] = a->segment->fd;
 656       n_fds += 1;
 657     }
 658   if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 659     {
 660       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
 661       fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
 662       n_fds += 1;
 663     }
 664
 665 done:
 666   /* *INDENT-OFF* */
 667   REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
 668     if (!rv)
 669       {
 670         ctrl_thread = vlib_num_workers () ? 1 : 0;
 671         ctrl_mq = session_main_get_vpp_event_queue (ctrl_thread);
 672         segp = a->segment;
 673         rmp->app_index = clib_host_to_net_u32 (a->app_index);
 674         rmp->app_mq = pointer_to_uword (a->app_evt_q);
 675         rmp->vpp_ctrl_mq = pointer_to_uword (ctrl_mq);
 676         rmp->vpp_ctrl_mq_thread = ctrl_thread;
 677         rmp->n_fds = n_fds;
 678         rmp->fd_flags = fd_flags;
 679         if (vec_len (segp->name))
 680           {
 681             vl_api_vec_to_api_string (segp->name, &rmp->segment_name);
 682           }
 683         rmp->segment_size = segp->ssvm_size;
 684         rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
 685       }
 686   }));
 687   /* *INDENT-ON* */
 688
 689   if (n_fds)
 690     session_send_fds (reg, fds, n_fds);
 691 }
 692
 693 static void
 694 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
 695 {
 696   int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
 697   vl_api_app_worker_add_del_reply_t *rmp;
 698   vl_api_registration_t *reg;
 699   application_t *app;
 700   u8 fd_flags = 0;
 701
 702   if (!session_main_is_enabled () || appns_sapi_enabled ())
 703     {
 704       rv = VNET_API_ERROR_FEATURE_DISABLED;
 705       goto done;
 706     }
 707
 708   reg = vl_api_client_index_to_registration (mp->client_index);
 709   if (!reg)
 710     return;
 711
 712   app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
 713   if (!app)
 714     {
 715       rv = VNET_API_ERROR_INVALID_VALUE;
 716       goto done;
 717     }
 718
 719   vnet_app_worker_add_del_args_t args = {
 720     .app_index = app->app_index,
 721     .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
 722     .api_client_index = mp->client_index,
 723     .is_add = mp->is_add
 724   };
 725   rv = vnet_app_worker_add_del (&args);
 726   if (rv)
 727     {
 728       clib_warning ("app worker add/del returned: %d", rv);
 729       goto done;
 730     }
 731
 732   if (!mp->is_add)
 733     goto done;
 734
 735   /* Send fifo segment fd if needed */
 736   if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
 737     {
 738       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
 739       fds[n_fds] = args.segment->fd;
 740       n_fds += 1;
 741     }
 742   if (application_segment_manager_properties (app)->use_mq_eventfd)
 743     {
 744       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
 745       fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
 746       n_fds += 1;
 747     }
 748
 749   /* *INDENT-OFF* */
 750 done:
 751   REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
 752     rmp->is_add = mp->is_add;
 753     rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
 754     rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
 755     if (!rv && mp->is_add)
 756       {
 757         if (vec_len (args.segment->name))
 758           {
 759             vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name);
 760           }
 761         rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
 762         rmp->n_fds = n_fds;
 763         rmp->fd_flags = fd_flags;
 764       }
 765   }));
 766   /* *INDENT-ON* */
 767
 768   if (n_fds)
 769     session_send_fds (reg, fds, n_fds);
 770 }
 771
 772 static void
 773 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
 774 {
 775   vl_api_application_detach_reply_t *rmp;
 776   int rv = VNET_API_ERROR_INVALID_VALUE_2;
 777   vnet_app_detach_args_t _a, *a = &_a;
 778   application_t *app;
 779
 780   if (!session_main_is_enabled () || appns_sapi_enabled ())
 781     {
 782       rv = VNET_API_ERROR_FEATURE_DISABLED;
 783       goto done;
 784     }
 785
 786   app = application_lookup (mp->client_index);
 787   if (app)
 788     {
 789       a->app_index = app->app_index;
 790       a->api_client_index = mp->client_index;
 791       rv = vnet_application_detach (a);
 792     }
 793
 794 done:
 795   REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
 796 }
 797
 798 static void
 799 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
 800 {
 801   vl_api_app_namespace_add_del_reply_t *rmp;
 802   u32 appns_index = 0;
 803   u8 *ns_id = 0;
 804   int rv = 0;
 805   if (session_main_is_enabled () == 0)
 806     {
 807       rv = VNET_API_ERROR_FEATURE_DISABLED;
 808       goto done;
 809     }
 810
 811   ns_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
 812
 813   vnet_app_namespace_add_del_args_t args = {
 814     .ns_id = ns_id,
 815     .secret = clib_net_to_host_u64 (mp->secret),
 816     .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
 817     .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
 818     .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
 819     .is_add = 1
 820   };
 821   rv = vnet_app_namespace_add_del (&args);
 822   if (!rv)
 823     {
 824       appns_index = app_namespace_index_from_id (ns_id);
 825       if (appns_index == APP_NAMESPACE_INVALID_INDEX)
 826         {
 827           clib_warning ("app ns lookup failed");
 828           rv = VNET_API_ERROR_UNSPECIFIED;
 829         }
 830     }
 831   vec_free (ns_id);
 832
 833   /* *INDENT-OFF* */
 834 done:
 835   REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
 836     if (!rv)
 837       rmp->appns_index = clib_host_to_net_u32 (appns_index);
 838   }));
 839   /* *INDENT-ON* */
 840 }
 841
 842 static void
 843 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
 844 {
 845   vl_api_session_rule_add_del_reply_t *rmp;
 846   session_rule_add_del_args_t args;
 847   session_rule_table_add_del_args_t *table_args = &args.table_args;
 848   int rv = 0;
 849
 850   clib_memset (&args, 0, sizeof (args));
 851
 852   ip_prefix_decode (&mp->lcl, &table_args->lcl);
 853   ip_prefix_decode (&mp->rmt, &table_args->rmt);
 854
 855   table_args->lcl_port = mp->lcl_port;
 856   table_args->rmt_port = mp->rmt_port;
 857   table_args->action_index = clib_net_to_host_u32 (mp->action_index);
 858   table_args->is_add = mp->is_add;
 859   mp->tag[sizeof (mp->tag) - 1] = 0;
 860   table_args->tag = format (0, "%s", mp->tag);
 861   args.appns_index = clib_net_to_host_u32 (mp->appns_index);
 862   args.scope = mp->scope;
 863   args.transport_proto =
 864     api_session_transport_proto_decode (&mp->transport_proto) ==
 865     TRANSPORT_PROTO_UDP ? 1 : 0;
 866
 867   rv = vnet_session_rule_add_del (&args);
 868   if (rv)
 869     clib_warning ("rule add del returned: %d", rv);
 870   vec_free (table_args->tag);
 871   REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
 872 }
 873
 874 static void
 875 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
 876                             u8 transport_proto, u32 appns_index, u8 * tag,
 877                             vl_api_registration_t * reg, u32 context)
 878 {
 879   vl_api_session_rules_details_t *rmp = 0;
 880   session_mask_or_match_4_t *match =
 881     (session_mask_or_match_4_t *) & rule->match;
 882   session_mask_or_match_4_t *mask =
 883     (session_mask_or_match_4_t *) & rule->mask;
 884   fib_prefix_t lcl, rmt;
 885
 886   rmp = vl_msg_api_alloc (sizeof (*rmp));
 887   clib_memset (rmp, 0, sizeof (*rmp));
 888   rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
 889   rmp->context = context;
 890
 891   clib_memset (&lcl, 0, sizeof (lcl));
 892   clib_memset (&rmt, 0, sizeof (rmt));
 893   ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
 894   ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
 895   lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
 896   rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
 897
 898   ip_prefix_encode (&lcl, &rmp->lcl);
 899   ip_prefix_encode (&rmt, &rmp->rmt);
 900   rmp->lcl_port = match->lcl_port;
 901   rmp->rmt_port = match->rmt_port;
 902   rmp->action_index = clib_host_to_net_u32 (rule->action_index);
 903   rmp->scope =
 904     is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
 905   rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
 906   rmp->appns_index = clib_host_to_net_u32 (appns_index);
 907   if (tag)
 908     {
 909       clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
 910       rmp->tag[vec_len (tag)] = 0;
 911     }
 912
 913   vl_api_send_msg (reg, (u8 *) rmp);
 914 }
 915
 916 static void
 917 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
 918                             u8 transport_proto, u32 appns_index, u8 * tag,
 919                             vl_api_registration_t * reg, u32 context)
 920 {
 921   vl_api_session_rules_details_t *rmp = 0;
 922   session_mask_or_match_6_t *match =
 923     (session_mask_or_match_6_t *) & rule->match;
 924   session_mask_or_match_6_t *mask =
 925     (session_mask_or_match_6_t *) & rule->mask;
 926   fib_prefix_t lcl, rmt;
 927
 928   rmp = vl_msg_api_alloc (sizeof (*rmp));
 929   clib_memset (rmp, 0, sizeof (*rmp));
 930   rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
 931   rmp->context = context;
 932
 933   clib_memset (&lcl, 0, sizeof (lcl));
 934   clib_memset (&rmt, 0, sizeof (rmt));
 935   ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
 936   ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
 937   lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
 938   rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
 939
 940   ip_prefix_encode (&lcl, &rmp->lcl);
 941   ip_prefix_encode (&rmt, &rmp->rmt);
 942   rmp->lcl_port = match->lcl_port;
 943   rmp->rmt_port = match->rmt_port;
 944   rmp->action_index = clib_host_to_net_u32 (rule->action_index);
 945   rmp->scope =
 946     is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
 947   rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
 948   rmp->appns_index = clib_host_to_net_u32 (appns_index);
 949   if (tag)
 950     {
 951       clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
 952       rmp->tag[vec_len (tag)] = 0;
 953     }
 954
 955   vl_api_send_msg (reg, (u8 *) rmp);
 956 }
 957
 958 static void
 959 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
 960                                   u8 tp, u8 is_local, u32 appns_index,
 961                                   vl_api_registration_t * reg, u32 context)
 962 {
 963   mma_rule_16_t *rule16;
 964   mma_rule_40_t *rule40;
 965   mma_rules_table_16_t *srt16;
 966   mma_rules_table_40_t *srt40;
 967   u32 ri;
 968
 969   if (is_local || fib_proto == FIB_PROTOCOL_IP4)
 970     {
 971       u8 *tag = 0;
 972       /* *INDENT-OFF* */
 973       srt16 = &srt->session_rules_tables_16;
 974       pool_foreach (rule16, srt16->rules)  {
 975         ri = mma_rules_table_rule_index_16 (srt16, rule16);
 976         tag = session_rules_table_rule_tag (srt, ri, 1);
 977         send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
 978                                     reg, context);
 979       }
 980       /* *INDENT-ON* */
 981     }
 982   if (is_local || fib_proto == FIB_PROTOCOL_IP6)
 983     {
 984       u8 *tag = 0;
 985       /* *INDENT-OFF* */
 986       srt40 = &srt->session_rules_tables_40;
 987       pool_foreach (rule40, srt40->rules)  {
 988         ri = mma_rules_table_rule_index_40 (srt40, rule40);
 989         tag = session_rules_table_rule_tag (srt, ri, 1);
 990         send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
 991                                     reg, context);
 992       }
 993       /* *INDENT-ON* */
 994     }
 995 }
 996
 997 static void
 998 vl_api_session_rules_dump_t_handler (vl_api_session_rules_dump_t * mp)
 999 {
1000   vl_api_registration_t *reg;
1001   session_table_t *st;
1002   u8 tp;
1003
1004   reg = vl_api_client_index_to_registration (mp->client_index);
1005   if (!reg)
1006     return;
1007
1008   /* *INDENT-OFF* */
1009   session_table_foreach (st, ({
1010     for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1011       {
1012         send_session_rules_table_details (&st->session_rules[tp],
1013                                           st->active_fib_proto, tp,
1014                                           st->is_local, st->appns_index, reg,
1015                                           mp->context);
1016       }
1017   }));
1018   /* *INDENT-ON* */
1019 }
1020
1021 static void
1022 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1023 {
1024   vl_api_app_add_cert_key_pair_reply_t *rmp;
1025   vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1026   u32 certkey_len, key_len, cert_len;
1027   int rv = 0;
1028   if (session_main_is_enabled () == 0)
1029     {
1030       rv = VNET_API_ERROR_FEATURE_DISABLED;
1031       goto done;
1032     }
1033
1034   cert_len = clib_net_to_host_u16 (mp->cert_len);
1035   if (cert_len > 10000)
1036     {
1037       rv = VNET_API_ERROR_INVALID_VALUE;
1038       goto done;
1039     }
1040
1041   certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1042   if (certkey_len < cert_len)
1043     {
1044       rv = VNET_API_ERROR_INVALID_VALUE;
1045       goto done;
1046     }
1047
1048   key_len = certkey_len - cert_len;
1049   if (key_len > 10000)
1050     {
1051       rv = VNET_API_ERROR_INVALID_VALUE;
1052       goto done;
1053     }
1054
1055   clib_memset (a, 0, sizeof (*a));
1056   vec_validate (a->cert, cert_len);
1057   vec_validate (a->key, key_len);
1058   clib_memcpy_fast (a->cert, mp->certkey, cert_len);
1059   clib_memcpy_fast (a->key, mp->certkey + cert_len, key_len);
1060   rv = vnet_app_add_cert_key_pair (a);
1061   vec_free (a->cert);
1062   vec_free (a->key);
1063
1064 done:
1065   /* *INDENT-OFF* */
1066   REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1067     if (!rv)
1068       rmp->index = clib_host_to_net_u32 (a->index);
1069   }));
1070   /* *INDENT-ON* */
1071 }
1072
1073 static void
1074 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1075 {
1076   vl_api_app_del_cert_key_pair_reply_t *rmp;
1077   u32 ckpair_index;
1078   int rv = 0;
1079   if (session_main_is_enabled () == 0)
1080     {
1081       rv = VNET_API_ERROR_FEATURE_DISABLED;
1082       goto done;
1083     }
1084   ckpair_index = clib_net_to_host_u32 (mp->index);
1085   rv = vnet_app_del_cert_key_pair (ckpair_index);
1086
1087 done:
1088   REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1089 }
1090
1091 /* ### WILL BE DEPRECATED POST 20.01 ### */
1092 static void
1093 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1094                                            mp)
1095 {
1096   vl_api_application_tls_cert_add_reply_t *rmp;
1097   app_cert_key_pair_t *ckpair;
1098   application_t *app;
1099   u32 cert_len;
1100   int rv = 0;
1101   if (session_main_is_enabled () == 0)
1102     {
1103       rv = VNET_API_ERROR_FEATURE_DISABLED;
1104       goto done;
1105     }
1106   if (!(app = application_lookup (mp->client_index)))
1107     {
1108       rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1109       goto done;
1110     }
1111   cert_len = clib_net_to_host_u16 (mp->cert_len);
1112   if (cert_len > 10000)
1113     {
1114       rv = VNET_API_ERROR_INVALID_VALUE;
1115       goto done;
1116     }
1117   ckpair = app_cert_key_pair_get_default ();
1118   vec_validate (ckpair->cert, cert_len);
1119   clib_memcpy_fast (ckpair->cert, mp->cert, cert_len);
1120
1121 done:
1122   REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1123 }
1124
1125 /* ### WILL BE DEPRECATED POST 20.01 ### */
1126 static void
1127 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1128                                           mp)
1129 {
1130   vl_api_application_tls_key_add_reply_t *rmp;
1131   app_cert_key_pair_t *ckpair;
1132   application_t *app;
1133   u32 key_len;
1134   int rv = 0;
1135   if (session_main_is_enabled () == 0)
1136     {
1137       rv = VNET_API_ERROR_FEATURE_DISABLED;
1138       goto done;
1139     }
1140   if (!(app = application_lookup (mp->client_index)))
1141     {
1142       rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1143       goto done;
1144     }
1145   key_len = clib_net_to_host_u16 (mp->key_len);
1146   if (key_len > 10000)
1147     {
1148       rv = VNET_API_ERROR_INVALID_VALUE;
1149       goto done;
1150     }
1151   ckpair = app_cert_key_pair_get_default ();
1152   vec_validate (ckpair->key, key_len);
1153   clib_memcpy_fast (ckpair->key, mp->key, key_len);
1154 done:
1155   REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1156 }
1157
1158 static clib_error_t *
1159 application_reaper_cb (u32 client_index)
1160 {
1161   application_t *app = application_lookup (client_index);
1162   vnet_app_detach_args_t _a, *a = &_a;
1163   if (app)
1164     {
1165       a->app_index = app->app_index;
1166       a->api_client_index = client_index;
1167       vnet_application_detach (a);
1168     }
1169   return 0;
1170 }
1171
1172 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1173
1174 #define vl_msg_name_crc_list
1175 #include <vnet/vnet_all_api_h.h>
1176 #undef vl_msg_name_crc_list
1177
1178 static void
1179 setup_message_id_table (api_main_t * am)
1180 {
1181 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1182   foreach_vl_msg_name_crc_session;
1183 #undef _
1184 }
1185
1186 /*
1187  * session_api_hookup
1188  * Add uri's API message handlers to the table.
1189  * vlib has already mapped shared memory and
1190  * added the client registration handlers.
1191  * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1192  */
1193 static clib_error_t *
1194 session_api_hookup (vlib_main_t * vm)
1195 {
1196   api_main_t *am = vlibapi_get_main ();
1197
1198 #define _(N,n)                                                  \
1199     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
1200                            vl_api_##n##_t_handler,              \
1201                            vl_noop_handler,                     \
1202                            vl_api_##n##_t_endian,               \
1203                            vl_api_##n##_t_print,                \
1204                            sizeof(vl_api_##n##_t), 1);
1205   foreach_session_api_msg;
1206 #undef _
1207
1208   /*
1209    * Set up the (msg_name, crc, message-id) table
1210    */
1211   setup_message_id_table (am);
1212
1213   return 0;
1214 }
1215
1216 VLIB_API_INIT_FUNCTION (session_api_hookup);
1217
1218 /*
1219  * Socket api functions
1220  */
1221
1222 static void
1223 sapi_send_fds (app_worker_t * app_wrk, int *fds, int n_fds)
1224 {
1225   app_sapi_msg_t smsg = { 0 };
1226   app_namespace_t *app_ns;
1227   application_t *app;
1228   clib_socket_t *cs;
1229   u32 cs_index;
1230
1231   app = application_get (app_wrk->app_index);
1232   app_ns = app_namespace_get (app->ns_index);
1233   cs_index = appns_sapi_handle_sock_index (app_wrk->api_client_index);
1234   cs = appns_sapi_get_socket (app_ns, cs_index);
1235   if (PREDICT_FALSE (!cs))
1236     return;
1237
1238   /* There's no payload for the message only the type */
1239   smsg.type = APP_SAPI_MSG_TYPE_SEND_FDS;
1240   clib_socket_sendmsg (cs, &smsg, sizeof (smsg), fds, n_fds);
1241 }
1242
1243 static int
1244 mq_send_add_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1245 {
1246   int fds[SESSION_N_FD_TYPE], n_fds = 0;
1247   svm_msg_q_msg_t _msg, *msg = &_msg;
1248   session_app_add_segment_msg_t *mp;
1249   app_worker_t *app_wrk;
1250   session_event_t *evt;
1251   svm_msg_q_t *app_mq;
1252   fifo_segment_t *fs;
1253   ssvm_private_t *sp;
1254   u8 fd_flags = 0;
1255
1256   app_wrk = app_worker_get (app_wrk_index);
1257
1258   fs = segment_manager_get_segment_w_handle (segment_handle);
1259   sp = &fs->ssvm;
1260   ASSERT (ssvm_type (sp) == SSVM_SEGMENT_MEMFD);
1261
1262   fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1263   fds[n_fds] = sp->fd;
1264   n_fds += 1;
1265
1266   app_mq = app_wrk->event_queue;
1267   if (mq_try_lock_and_alloc_msg (app_mq, msg))
1268     return -1;
1269
1270   /*
1271    * Send the fd over api socket
1272    */
1273   sapi_send_fds (app_wrk, fds, n_fds);
1274
1275   /*
1276    * Send the actual message over mq
1277    */
1278   evt = svm_msg_q_msg_data (app_mq, msg);
1279   clib_memset (evt, 0, sizeof (*evt));
1280   evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
1281   mp = (session_app_add_segment_msg_t *) evt->data;
1282   clib_memset (mp, 0, sizeof (*mp));
1283   mp->segment_size = sp->ssvm_size;
1284   mp->fd_flags = fd_flags;
1285   mp->segment_handle = segment_handle;
1286   strncpy ((char *) mp->segment_name, (char *) sp->name,
1287            sizeof (mp->segment_name) - 1);
1288
1289   svm_msg_q_add_and_unlock (app_mq, msg);
1290
1291   return 0;
1292 }
1293
1294 static int
1295 mq_send_del_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1296 {
1297   svm_msg_q_msg_t _msg, *msg = &_msg;
1298   session_app_del_segment_msg_t *mp;
1299   app_worker_t *app_wrk;
1300   session_event_t *evt;
1301   svm_msg_q_t *app_mq;
1302
1303   app_wrk = app_worker_get (app_wrk_index);
1304
1305   app_mq = app_wrk->event_queue;
1306   if (mq_try_lock_and_alloc_msg (app_mq, msg))
1307     return -1;
1308
1309   evt = svm_msg_q_msg_data (app_mq, msg);
1310   clib_memset (evt, 0, sizeof (*evt));
1311   evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
1312   mp = (session_app_del_segment_msg_t *) evt->data;
1313   clib_memset (mp, 0, sizeof (*mp));
1314   mp->segment_handle = segment_handle;
1315   svm_msg_q_add_and_unlock (app_mq, msg);
1316
1317   return 0;
1318 }
1319
1320 static session_cb_vft_t session_mq_sapi_cb_vft = {
1321   .session_accept_callback = mq_send_session_accepted_cb,
1322   .session_disconnect_callback = mq_send_session_disconnected_cb,
1323   .session_connected_callback = mq_send_session_connected_cb,
1324   .session_reset_callback = mq_send_session_reset_cb,
1325   .session_migrate_callback = mq_send_session_migrate_cb,
1326   .session_cleanup_callback = mq_send_session_cleanup_cb,
1327   .add_segment_callback = mq_send_add_segment_sapi_cb,
1328   .del_segment_callback = mq_send_del_segment_sapi_cb,
1329 };
1330
1331 static void
1332 session_api_attach_handler (app_namespace_t * app_ns, clib_socket_t * cs,
1333                             app_sapi_attach_msg_t * mp)
1334 {
1335   int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1336   vnet_app_attach_args_t _a, *a = &_a;
1337   app_sapi_attach_reply_msg_t *rmp;
1338   ssvm_private_t *evt_q_segment;
1339   u8 fd_flags = 0, ctrl_thread;
1340   app_ns_api_handle_t *handle;
1341   app_sapi_msg_t msg = { 0 };
1342   app_worker_t *app_wrk;
1343   svm_msg_q_t *ctrl_mq;
1344   application_t *app;
1345
1346   /* Make sure name is null terminated */
1347   mp->name[63] = 0;
1348
1349   clib_memset (a, 0, sizeof (*a));
1350   a->api_client_index = appns_sapi_socket_handle (app_ns, cs);
1351   a->name = format (0, "%s", (char *) mp->name);
1352   a->options = mp->options;
1353   a->session_cb_vft = &session_mq_sapi_cb_vft;
1354   a->use_sock_api = 1;
1355   a->options[APP_OPTIONS_NAMESPACE] = app_namespace_index (app_ns);
1356
1357   if ((rv = vnet_application_attach (a)))
1358     {
1359       clib_warning ("attach returned: %d", rv);
1360       goto done;
1361     }
1362
1363   /* Send event queues segment */
1364   if ((evt_q_segment = session_main_get_evt_q_segment ()))
1365     {
1366       fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
1367       fds[n_fds] = evt_q_segment->fd;
1368       n_fds += 1;
1369     }
1370   /* Send fifo segment fd if needed */
1371   if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
1372     {
1373       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1374       fds[n_fds] = a->segment->fd;
1375       n_fds += 1;
1376     }
1377   if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
1378     {
1379       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1380       fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
1381       n_fds += 1;
1382     }
1383
1384 done:
1385
1386   msg.type = APP_SAPI_MSG_TYPE_ATTACH_REPLY;
1387   rmp = &msg.attach_reply;
1388   rmp->retval = rv;
1389   if (!rv)
1390     {
1391       ctrl_thread = vlib_num_workers ()? 1 : 0;
1392       ctrl_mq = session_main_get_vpp_event_queue (ctrl_thread);
1393       rmp->app_index = a->app_index;
1394       rmp->app_mq = pointer_to_uword (a->app_evt_q);
1395       rmp->vpp_ctrl_mq = pointer_to_uword (ctrl_mq);
1396       rmp->vpp_ctrl_mq_thread = ctrl_thread;
1397       rmp->n_fds = n_fds;
1398       rmp->fd_flags = fd_flags;
1399       /* No segment name and size since we only support memfds
1400        * in this configuration */
1401       rmp->segment_handle = a->segment_handle;
1402       rmp->api_client_handle = a->api_client_index;
1403
1404       /* Update app index for socket */
1405       handle = (app_ns_api_handle_t *) & cs->private_data;
1406       app = application_get (a->app_index);
1407       app_wrk = application_get_worker (app, 0);
1408       handle->aah_app_wrk_index = app_wrk->wrk_index;
1409     }
1410
1411   clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1412   vec_free (a->name);
1413 }
1414
1415 static void
1416 sapi_socket_close_w_handle (u32 api_handle)
1417 {
1418   app_namespace_t *app_ns = app_namespace_get (api_handle >> 16);
1419   u16 sock_index = api_handle & 0xffff;
1420   app_ns_api_handle_t *handle;
1421   clib_socket_t *cs;
1422   clib_file_t *cf;
1423
1424   cs = appns_sapi_get_socket (app_ns, sock_index);
1425   if (!cs)
1426     return;
1427
1428   handle = (app_ns_api_handle_t *) & cs->private_data;
1429   cf = clib_file_get (&file_main, handle->aah_file_index);
1430   clib_file_del (&file_main, cf);
1431
1432   clib_socket_close (cs);
1433   appns_sapi_free_socket (app_ns, cs);
1434 }
1435
1436 static void
1437 sapi_add_del_worker_handler (app_namespace_t * app_ns,
1438                              clib_socket_t * cs,
1439                              app_sapi_worker_add_del_msg_t * mp)
1440 {
1441   int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1442   app_sapi_worker_add_del_reply_msg_t *rmp;
1443   app_ns_api_handle_t *handle;
1444   app_sapi_msg_t msg = { 0 };
1445   app_worker_t *app_wrk;
1446   u32 sapi_handle = -1;
1447   application_t *app;
1448   u8 fd_flags = 0;
1449
1450   app = application_get_if_valid (mp->app_index);
1451   if (!app)
1452     {
1453       rv = VNET_API_ERROR_INVALID_VALUE;
1454       goto done;
1455     }
1456
1457   sapi_handle = appns_sapi_socket_handle (app_ns, cs);
1458
1459   vnet_app_worker_add_del_args_t args = {
1460     .app_index = app->app_index,
1461     .wrk_map_index = mp->wrk_index,
1462     .api_client_index = sapi_handle,
1463     .is_add = mp->is_add
1464   };
1465   rv = vnet_app_worker_add_del (&args);
1466   if (rv)
1467     {
1468       clib_warning ("app worker add/del returned: %d", rv);
1469       goto done;
1470     }
1471
1472   if (!mp->is_add)
1473     {
1474       sapi_socket_close_w_handle (sapi_handle);
1475       goto done;
1476     }
1477
1478   /* Send fifo segment fd if needed */
1479   if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1480     {
1481       fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1482       fds[n_fds] = args.segment->fd;
1483       n_fds += 1;
1484     }
1485   if (application_segment_manager_properties (app)->use_mq_eventfd)
1486     {
1487       fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1488       fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
1489       n_fds += 1;
1490     }
1491
1492 done:
1493
1494   msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY;
1495   rmp = &msg.worker_add_del_reply;
1496   rmp->retval = rv;
1497   rmp->is_add = mp->is_add;
1498   rmp->api_client_handle = sapi_handle;
1499   rmp->wrk_index = args.wrk_map_index;
1500   rmp->segment_handle = args.segment_handle;
1501   if (!rv && mp->is_add)
1502     {
1503       /* No segment name and size. This supports only memfds */
1504       rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
1505       rmp->n_fds = n_fds;
1506       rmp->fd_flags = fd_flags;
1507
1508       /* Update app index for socket */
1509       handle = (app_ns_api_handle_t *) & cs->private_data;
1510       app_wrk = application_get_worker (app, args.wrk_map_index);
1511       handle->aah_app_wrk_index = app_wrk->wrk_index;
1512     }
1513
1514   clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1515 }
1516
1517 static void
1518 sapi_socket_detach (app_namespace_t * app_ns, clib_socket_t * cs)
1519 {
1520   app_ns_api_handle_t *handle;
1521   app_worker_t *app_wrk;
1522   u32 api_client_handle;
1523
1524   api_client_handle = appns_sapi_socket_handle (app_ns, cs);
1525   sapi_socket_close_w_handle (api_client_handle);
1526
1527   /* Cleanup everything because app worker closed socket or crashed */
1528   handle = (app_ns_api_handle_t *) & cs->private_data;
1529   app_wrk = app_worker_get (handle->aah_app_wrk_index);
1530
1531   vnet_app_worker_add_del_args_t args = {
1532     .app_index = app_wrk->app_index,
1533     .wrk_map_index = app_wrk->wrk_map_index,
1534     .api_client_index = api_client_handle,
1535     .is_add = 0
1536   };
1537   /* Send rpc to main thread for worker barrier */
1538   vlib_rpc_call_main_thread (vnet_app_worker_add_del, (u8 *) & args,
1539                              sizeof (args));
1540 }
1541
1542 static clib_error_t *
1543 sapi_sock_read_ready (clib_file_t * cf)
1544 {
1545   app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1546   vlib_main_t *vm = vlib_get_main ();
1547   app_sapi_msg_t msg = { 0 };
1548   app_namespace_t *app_ns;
1549   clib_error_t *err = 0;
1550   clib_socket_t *cs;
1551
1552   app_ns = app_namespace_get (handle->aah_app_ns_index);
1553   cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1554   if (!cs)
1555     goto error;
1556
1557   err = clib_socket_recvmsg (cs, &msg, sizeof (msg), 0, 0);
1558   if (err)
1559     {
1560       clib_error_free (err);
1561       sapi_socket_detach (app_ns, cs);
1562       goto error;
1563     }
1564
1565   handle = (app_ns_api_handle_t *) & cs->private_data;
1566
1567   vlib_worker_thread_barrier_sync (vm);
1568
1569   switch (msg.type)
1570     {
1571     case APP_SAPI_MSG_TYPE_ATTACH:
1572       session_api_attach_handler (app_ns, cs, &msg.attach);
1573       break;
1574     case APP_SAPI_MSG_TYPE_ADD_DEL_WORKER:
1575       sapi_add_del_worker_handler (app_ns, cs, &msg.worker_add_del);
1576       break;
1577     default:
1578       clib_warning ("app wrk %u unknown message type: %u",
1579                     handle->aah_app_wrk_index, msg.type);
1580       break;
1581     }
1582
1583   vlib_worker_thread_barrier_release (vm);
1584
1585 error:
1586   return 0;
1587 }
1588
1589 static clib_error_t *
1590 sapi_sock_write_ready (clib_file_t * cf)
1591 {
1592   app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1593   clib_warning ("called for app ns %u", handle->aah_app_ns_index);
1594   return 0;
1595 }
1596
1597 static clib_error_t *
1598 sapi_sock_error (clib_file_t * cf)
1599 {
1600   app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1601   app_namespace_t *app_ns;
1602   clib_socket_t *cs;
1603
1604   app_ns = app_namespace_get (handle->aah_app_ns_index);
1605   cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1606   if (!cs)
1607     return 0;
1608
1609   sapi_socket_detach (app_ns, cs);
1610   return 0;
1611 }
1612
1613 static clib_error_t *
1614 sapi_sock_accept_ready (clib_file_t * scf)
1615 {
1616   app_ns_api_handle_t handle = *(app_ns_api_handle_t *) & scf->private_data;
1617   app_namespace_t *app_ns;
1618   clib_file_t cf = { 0 };
1619   clib_error_t *err = 0;
1620   clib_socket_t *ccs, *scs;
1621
1622   /* Listener files point to namespace */
1623   app_ns = app_namespace_get (handle.aah_app_ns_index);
1624
1625   /*
1626    * Initialize client socket
1627    */
1628   ccs = appns_sapi_alloc_socket (app_ns);
1629
1630   /* Grab server socket after client is initialized  */
1631   scs = appns_sapi_get_socket (app_ns, handle.aah_sock_index);
1632   if (!scs)
1633     goto error;
1634
1635   err = clib_socket_accept (scs, ccs);
1636   if (err)
1637     {
1638       clib_error_report (err);
1639       goto error;
1640     }
1641
1642   cf.read_function = sapi_sock_read_ready;
1643   cf.write_function = sapi_sock_write_ready;
1644   cf.error_function = sapi_sock_error;
1645   cf.file_descriptor = ccs->fd;
1646   /* File points to app namespace and socket */
1647   handle.aah_sock_index = appns_sapi_socket_index (app_ns, ccs);
1648   cf.private_data = handle.as_u64;
1649   cf.description = format (0, "app sock conn fd: %d", ccs->fd);
1650
1651   /* Poll until we get an attach message. Socket points to file and
1652    * application that owns the socket */
1653   handle.aah_app_wrk_index = APP_INVALID_INDEX;
1654   handle.aah_file_index = clib_file_add (&file_main, &cf);
1655   ccs->private_data = handle.as_u64;
1656
1657   return err;
1658
1659 error:
1660   appns_sapi_free_socket (app_ns, ccs);
1661   return err;
1662 }
1663
1664 int
1665 appns_sapi_add_ns_socket (app_namespace_t * app_ns)
1666 {
1667   char *subdir = "/app_ns_sockets/";
1668   app_ns_api_handle_t *handle;
1669   clib_file_t cf = { 0 };
1670   struct stat file_stat;
1671   clib_error_t *err;
1672   clib_socket_t *cs;
1673   u8 *dir = 0;
1674   int rv = 0;
1675
1676   vec_add (dir, vlib_unix_get_runtime_dir (),
1677            strlen (vlib_unix_get_runtime_dir ()));
1678   vec_add (dir, (u8 *) subdir, strlen (subdir));
1679
1680   err = vlib_unix_recursive_mkdir ((char *) dir);
1681   if (err)
1682     {
1683       clib_error_report (err);
1684       rv = -1;
1685       goto error;
1686     }
1687
1688   app_ns->sock_name = format (0, "%v%v%c", dir, app_ns->ns_id, 0);
1689
1690   /*
1691    * Create and initialize socket to listen on
1692    */
1693   cs = appns_sapi_alloc_socket (app_ns);
1694   cs->config = (char *) app_ns->sock_name;
1695   cs->flags = CLIB_SOCKET_F_IS_SERVER |
1696     CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1697     CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1698
1699   if ((err = clib_socket_init (cs)))
1700     {
1701       clib_error_report (err);
1702       rv = -1;
1703       goto error;
1704     }
1705
1706   if (stat ((char *) app_ns->sock_name, &file_stat) == -1)
1707     {
1708       rv = -1;
1709       goto error;
1710     }
1711
1712   /*
1713    * Start polling it
1714    */
1715   cf.read_function = sapi_sock_accept_ready;
1716   cf.file_descriptor = cs->fd;
1717   /* File points to namespace */
1718   handle = (app_ns_api_handle_t *) & cf.private_data;
1719   handle->aah_app_ns_index = app_namespace_index (app_ns);
1720   handle->aah_sock_index = appns_sapi_socket_index (app_ns, cs);
1721   cf.description = format (0, "app sock listener: %s", app_ns->sock_name);
1722
1723   /* Socket points to clib file index */
1724   handle = (app_ns_api_handle_t *) & cs->private_data;
1725   handle->aah_file_index = clib_file_add (&file_main, &cf);
1726   handle->aah_app_wrk_index = APP_INVALID_INDEX;
1727
1728 error:
1729   vec_free (dir);
1730   return rv;
1731 }
1732
1733 /*
1734  * fd.io coding-style-patch-verification: ON
1735  *
1736  * Local Variables:
1737  * eval: (c-set-style "gnu")
1738  * End:
1739  */