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