src/vnet/session/session_api.c

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