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