src/vnet/session/session_node.c

   1 /*
   2  * Copyright (c) 2017-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 <math.h>
  17 #include <vlib/vlib.h>
  18 #include <vnet/vnet.h>
  19 #include <vppinfra/elog.h>
  20 #include <vnet/session/transport.h>
  21 #include <vnet/session/session.h>
  22 #include <vnet/session/application.h>
  23 #include <vnet/session/application_interface.h>
  24 #include <vnet/session/application_local.h>
  25 #include <vnet/session/session_debug.h>
  26 #include <svm/queue.h>
  27
  28 #define app_check_thread_and_barrier(_fn, _arg)                         \
  29   if (!vlib_thread_is_main_w_barrier ())                                \
  30     {                                                                   \
  31      vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg));       \
  32       return;                                                           \
  33    }
  34
  35 static void
  36 session_mq_listen_handler (void *data)
  37 {
  38   session_listen_msg_t *mp = (session_listen_msg_t *) data;
  39   vnet_listen_args_t _a, *a = &_a;
  40   app_worker_t *app_wrk;
  41   application_t *app;
  42   int rv;
  43
  44   app_check_thread_and_barrier (session_mq_listen_handler, mp);
  45
  46   app = application_lookup (mp->client_index);
  47   if (!app)
  48     return;
  49
  50   clib_memset (a, 0, sizeof (*a));
  51   a->sep.is_ip4 = mp->is_ip4;
  52   ip_copy (&a->sep.ip, &mp->ip, mp->is_ip4);
  53   a->sep.port = mp->port;
  54   a->sep.fib_index = mp->vrf;
  55   a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
  56   a->sep.transport_proto = mp->proto;
  57   a->sep_ext.ckpair_index = mp->ckpair_index;
  58   a->sep_ext.crypto_engine = mp->crypto_engine;
  59   a->app_index = app->app_index;
  60   a->wrk_map_index = mp->wrk_index;
  61   a->sep_ext.transport_flags = mp->flags;
  62
  63   if ((rv = vnet_listen (a)))
  64     clib_warning ("listen returned: %d", rv);
  65
  66   app_wrk = application_get_worker (app, mp->wrk_index);
  67   mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
  68   return;
  69 }
  70
  71 static void
  72 session_mq_listen_uri_handler (void *data)
  73 {
  74   session_listen_uri_msg_t *mp = (session_listen_uri_msg_t *) data;
  75   vnet_listen_args_t _a, *a = &_a;
  76   app_worker_t *app_wrk;
  77   application_t *app;
  78   int rv;
  79
  80   app_check_thread_and_barrier (session_mq_listen_uri_handler, mp);
  81
  82   app = application_lookup (mp->client_index);
  83   if (!app)
  84     return;
  85
  86   clib_memset (a, 0, sizeof (*a));
  87   a->uri = (char *) mp->uri;
  88   a->app_index = app->app_index;
  89   rv = vnet_bind_uri (a);
  90
  91   app_wrk = application_get_worker (app, 0);
  92   mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
  93 }
  94
  95 static void
  96 session_mq_connect_handler (void *data)
  97 {
  98   session_connect_msg_t *mp = (session_connect_msg_t *) data;
  99   vnet_connect_args_t _a, *a = &_a;
 100   app_worker_t *app_wrk;
 101   application_t *app;
 102   int rv;
 103
 104   app_check_thread_and_barrier (session_mq_connect_handler, mp);
 105
 106   app = application_lookup (mp->client_index);
 107   if (!app)
 108     return;
 109
 110   clib_memset (a, 0, sizeof (*a));
 111   a->sep.is_ip4 = mp->is_ip4;
 112   clib_memcpy_fast (&a->sep.ip, &mp->ip, sizeof (mp->ip));
 113   a->sep.port = mp->port;
 114   a->sep.transport_proto = mp->proto;
 115   a->sep.peer.fib_index = mp->vrf;
 116   clib_memcpy_fast (&a->sep.peer.ip, &mp->lcl_ip, sizeof (mp->lcl_ip));
 117   if (mp->is_ip4)
 118     {
 119       ip46_address_mask_ip4 (&a->sep.ip);
 120       ip46_address_mask_ip4 (&a->sep.peer.ip);
 121     }
 122   a->sep.peer.port = mp->lcl_port;
 123   a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
 124   a->sep_ext.parent_handle = mp->parent_handle;
 125   a->sep_ext.ckpair_index = mp->ckpair_index;
 126   a->sep_ext.crypto_engine = mp->crypto_engine;
 127   a->sep_ext.transport_flags = mp->flags;
 128   if (mp->hostname_len)
 129     {
 130       vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
 131       clib_memcpy_fast (a->sep_ext.hostname, mp->hostname, mp->hostname_len);
 132     }
 133   a->api_context = mp->context;
 134   a->app_index = app->app_index;
 135   a->wrk_map_index = mp->wrk_index;
 136
 137   if ((rv = vnet_connect (a)))
 138     {
 139       clib_warning ("connect returned: %U", format_session_error, rv);
 140       app_wrk = application_get_worker (app, mp->wrk_index);
 141       mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
 142     }
 143
 144   vec_free (a->sep_ext.hostname);
 145 }
 146
 147 static void
 148 session_mq_connect_uri_handler (void *data)
 149 {
 150   session_connect_uri_msg_t *mp = (session_connect_uri_msg_t *) data;
 151   vnet_connect_args_t _a, *a = &_a;
 152   app_worker_t *app_wrk;
 153   application_t *app;
 154   int rv;
 155
 156   app_check_thread_and_barrier (session_mq_connect_uri_handler, mp);
 157
 158   app = application_lookup (mp->client_index);
 159   if (!app)
 160     return;
 161
 162   clib_memset (a, 0, sizeof (*a));
 163   a->uri = (char *) mp->uri;
 164   a->api_context = mp->context;
 165   a->app_index = app->app_index;
 166   if ((rv = vnet_connect_uri (a)))
 167     {
 168       clib_warning ("connect_uri returned: %d", rv);
 169       app_wrk = application_get_worker (app, 0 /* default wrk only */ );
 170       mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
 171     }
 172 }
 173
 174 static void
 175 session_mq_disconnect_handler (void *data)
 176 {
 177   session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
 178   vnet_disconnect_args_t _a, *a = &_a;
 179   application_t *app;
 180
 181   app = application_lookup (mp->client_index);
 182   if (!app)
 183     return;
 184
 185   a->app_index = app->app_index;
 186   a->handle = mp->handle;
 187   vnet_disconnect_session (a);
 188 }
 189
 190 static void
 191 app_mq_detach_handler (void *data)
 192 {
 193   session_app_detach_msg_t *mp = (session_app_detach_msg_t *) data;
 194   vnet_app_detach_args_t _a, *a = &_a;
 195   application_t *app;
 196
 197   app_check_thread_and_barrier (app_mq_detach_handler, mp);
 198
 199   app = application_lookup (mp->client_index);
 200   if (!app)
 201     return;
 202
 203   a->app_index = app->app_index;
 204   a->api_client_index = mp->client_index;
 205   vnet_application_detach (a);
 206 }
 207
 208 static void
 209 session_mq_unlisten_handler (void *data)
 210 {
 211   session_unlisten_msg_t *mp = (session_unlisten_msg_t *) data;
 212   vnet_unlisten_args_t _a, *a = &_a;
 213   app_worker_t *app_wrk;
 214   application_t *app;
 215   int rv;
 216
 217   app_check_thread_and_barrier (session_mq_unlisten_handler, mp);
 218
 219   app = application_lookup (mp->client_index);
 220   if (!app)
 221     return;
 222
 223   clib_memset (a, 0, sizeof (*a));
 224   a->app_index = app->app_index;
 225   a->handle = mp->handle;
 226   a->wrk_map_index = mp->wrk_index;
 227   if ((rv = vnet_unlisten (a)))
 228     clib_warning ("unlisten returned: %d", rv);
 229
 230   app_wrk = application_get_worker (app, a->wrk_map_index);
 231   if (!app_wrk)
 232     return;
 233
 234   mq_send_unlisten_reply (app_wrk, mp->handle, mp->context, rv);
 235 }
 236
 237 static void
 238 session_mq_accepted_reply_handler (void *data)
 239 {
 240   session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
 241   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
 242   session_state_t old_state;
 243   app_worker_t *app_wrk;
 244   session_t *s;
 245
 246   /* Server isn't interested, kill the session */
 247   if (mp->retval)
 248     {
 249       a->app_index = mp->context;
 250       a->handle = mp->handle;
 251       vnet_disconnect_session (a);
 252       return;
 253     }
 254
 255   /* Mail this back from the main thread. We're not polling in main
 256    * thread so we're using other workers for notifications. */
 257   if (vlib_num_workers () && vlib_get_thread_index () != 0
 258       && session_thread_from_handle (mp->handle) == 0)
 259     {
 260       vlib_rpc_call_main_thread (session_mq_accepted_reply_handler,
 261                                  (u8 *) mp, sizeof (*mp));
 262       return;
 263     }
 264
 265   s = session_get_from_handle_if_valid (mp->handle);
 266   if (!s)
 267     return;
 268
 269   app_wrk = app_worker_get (s->app_wrk_index);
 270   if (app_wrk->app_index != mp->context)
 271     {
 272       clib_warning ("app doesn't own session");
 273       return;
 274     }
 275
 276   if (!session_has_transport (s))
 277     {
 278       s->session_state = SESSION_STATE_READY;
 279       if (ct_session_connect_notify (s))
 280         return;
 281     }
 282   else
 283     {
 284       old_state = s->session_state;
 285       s->session_state = SESSION_STATE_READY;
 286
 287       if (!svm_fifo_is_empty_prod (s->rx_fifo))
 288         app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
 289
 290       /* Closed while waiting for app to reply. Resend disconnect */
 291       if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
 292         {
 293           app_worker_close_notify (app_wrk, s);
 294           s->session_state = old_state;
 295           return;
 296         }
 297     }
 298 }
 299
 300 static void
 301 session_mq_reset_reply_handler (void *data)
 302 {
 303   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
 304   session_reset_reply_msg_t *mp;
 305   app_worker_t *app_wrk;
 306   session_t *s;
 307   application_t *app;
 308   u32 index, thread_index;
 309
 310   mp = (session_reset_reply_msg_t *) data;
 311   app = application_lookup (mp->context);
 312   if (!app)
 313     return;
 314
 315   session_parse_handle (mp->handle, &index, &thread_index);
 316   s = session_get_if_valid (index, thread_index);
 317
 318   /* No session or not the right session */
 319   if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
 320     return;
 321
 322   app_wrk = app_worker_get (s->app_wrk_index);
 323   if (!app_wrk || app_wrk->app_index != app->app_index)
 324     {
 325       clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
 326                     mp->handle);
 327       return;
 328     }
 329
 330   /* Client objected to resetting the session, log and continue */
 331   if (mp->retval)
 332     {
 333       clib_warning ("client retval %d", mp->retval);
 334       return;
 335     }
 336
 337   /* This comes as a response to a reset, transport only waiting for
 338    * confirmation to remove connection state, no need to disconnect */
 339   a->handle = mp->handle;
 340   a->app_index = app->app_index;
 341   vnet_disconnect_session (a);
 342 }
 343
 344 static void
 345 session_mq_disconnected_handler (void *data)
 346 {
 347   session_disconnected_reply_msg_t *rmp;
 348   vnet_disconnect_args_t _a, *a = &_a;
 349   svm_msg_q_msg_t _msg, *msg = &_msg;
 350   session_disconnected_msg_t *mp;
 351   app_worker_t *app_wrk;
 352   session_event_t *evt;
 353   session_t *s;
 354   application_t *app;
 355   int rv = 0;
 356
 357   mp = (session_disconnected_msg_t *) data;
 358   if (!(s = session_get_from_handle_if_valid (mp->handle)))
 359     {
 360       clib_warning ("could not disconnect handle %llu", mp->handle);
 361       return;
 362     }
 363   app_wrk = app_worker_get (s->app_wrk_index);
 364   app = application_lookup (mp->client_index);
 365   if (!(app_wrk && app && app->app_index == app_wrk->app_index))
 366     {
 367       clib_warning ("could not disconnect session: %llu app: %u",
 368                     mp->handle, mp->client_index);
 369       return;
 370     }
 371
 372   a->handle = mp->handle;
 373   a->app_index = app_wrk->wrk_index;
 374   rv = vnet_disconnect_session (a);
 375
 376   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
 377                                        SESSION_MQ_CTRL_EVT_RING,
 378                                        SVM_Q_WAIT, msg);
 379   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
 380   clib_memset (evt, 0, sizeof (*evt));
 381   evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
 382   rmp = (session_disconnected_reply_msg_t *) evt->data;
 383   rmp->handle = mp->handle;
 384   rmp->context = mp->context;
 385   rmp->retval = rv;
 386   svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
 387 }
 388
 389 static void
 390 session_mq_disconnected_reply_handler (void *data)
 391 {
 392   session_disconnected_reply_msg_t *mp;
 393   vnet_disconnect_args_t _a, *a = &_a;
 394   application_t *app;
 395
 396   mp = (session_disconnected_reply_msg_t *) data;
 397
 398   /* Client objected to disconnecting the session, log and continue */
 399   if (mp->retval)
 400     {
 401       clib_warning ("client retval %d", mp->retval);
 402       return;
 403     }
 404
 405   /* Disconnect has been confirmed. Confirm close to transport */
 406   app = application_lookup (mp->context);
 407   if (app)
 408     {
 409       a->handle = mp->handle;
 410       a->app_index = app->app_index;
 411       vnet_disconnect_session (a);
 412     }
 413 }
 414
 415 static void
 416 session_mq_worker_update_handler (void *data)
 417 {
 418   session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
 419   session_worker_update_reply_msg_t *rmp;
 420   svm_msg_q_msg_t _msg, *msg = &_msg;
 421   app_worker_t *app_wrk;
 422   u32 owner_app_wrk_map;
 423   session_event_t *evt;
 424   session_t *s;
 425   application_t *app;
 426
 427   app = application_lookup (mp->client_index);
 428   if (!app)
 429     return;
 430   if (!(s = session_get_from_handle_if_valid (mp->handle)))
 431     {
 432       clib_warning ("invalid handle %llu", mp->handle);
 433       return;
 434     }
 435   app_wrk = app_worker_get (s->app_wrk_index);
 436   if (app_wrk->app_index != app->app_index)
 437     {
 438       clib_warning ("app %u does not own session %llu", app->app_index,
 439                     mp->handle);
 440       return;
 441     }
 442   owner_app_wrk_map = app_wrk->wrk_map_index;
 443   app_wrk = application_get_worker (app, mp->wrk_index);
 444
 445   /* This needs to come from the new owner */
 446   if (mp->req_wrk_index == owner_app_wrk_map)
 447     {
 448       session_req_worker_update_msg_t *wump;
 449
 450       svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
 451                                            SESSION_MQ_CTRL_EVT_RING,
 452                                            SVM_Q_WAIT, msg);
 453       evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
 454       clib_memset (evt, 0, sizeof (*evt));
 455       evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
 456       wump = (session_req_worker_update_msg_t *) evt->data;
 457       wump->session_handle = mp->handle;
 458       svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
 459       return;
 460     }
 461
 462   app_worker_own_session (app_wrk, s);
 463
 464   /*
 465    * Send reply
 466    */
 467   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
 468                                        SESSION_MQ_CTRL_EVT_RING,
 469                                        SVM_Q_WAIT, msg);
 470   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
 471   clib_memset (evt, 0, sizeof (*evt));
 472   evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
 473   rmp = (session_worker_update_reply_msg_t *) evt->data;
 474   rmp->handle = mp->handle;
 475   rmp->rx_fifo = pointer_to_uword (s->rx_fifo);
 476   rmp->tx_fifo = pointer_to_uword (s->tx_fifo);
 477   rmp->segment_handle = session_segment_handle (s);
 478   svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
 479
 480   /*
 481    * Retransmit messages that may have been lost
 482    */
 483   if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
 484     session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 485
 486   if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
 487     app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
 488
 489   if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
 490     app_worker_close_notify (app_wrk, s);
 491 }
 492
 493 static void
 494 session_mq_app_wrk_rpc_handler (void *data)
 495 {
 496   session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
 497   svm_msg_q_msg_t _msg, *msg = &_msg;
 498   session_app_wrk_rpc_msg_t *rmp;
 499   app_worker_t *app_wrk;
 500   session_event_t *evt;
 501   application_t *app;
 502
 503   app = application_lookup (mp->client_index);
 504   if (!app)
 505     return;
 506
 507   app_wrk = application_get_worker (app, mp->wrk_index);
 508
 509   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
 510                                        SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
 511                                        msg);
 512   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
 513   clib_memset (evt, 0, sizeof (*evt));
 514   evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
 515   rmp = (session_app_wrk_rpc_msg_t *) evt->data;
 516   clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
 517   svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
 518 }
 519
 520 vlib_node_registration_t session_queue_node;
 521
 522 typedef struct
 523 {
 524   u32 session_index;
 525   u32 server_thread_index;
 526 } session_queue_trace_t;
 527
 528 /* packet trace format function */
 529 static u8 *
 530 format_session_queue_trace (u8 * s, va_list * args)
 531 {
 532   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
 533   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
 534   session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
 535
 536   s = format (s, "session index %d thread index %d",
 537               t->session_index, t->server_thread_index);
 538   return s;
 539 }
 540
 541 #define foreach_session_queue_error             \
 542 _(TX, "Packets transmitted")                    \
 543 _(TIMER, "Timer events")                        \
 544 _(NO_BUFFER, "Out of buffers")
 545
 546 typedef enum
 547 {
 548 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
 549   foreach_session_queue_error
 550 #undef _
 551     SESSION_QUEUE_N_ERROR,
 552 } session_queue_error_t;
 553
 554 static char *session_queue_error_strings[] = {
 555 #define _(sym,string) string,
 556   foreach_session_queue_error
 557 #undef _
 558 };
 559
 560 enum
 561 {
 562   SESSION_TX_NO_BUFFERS = -2,
 563   SESSION_TX_NO_DATA,
 564   SESSION_TX_OK
 565 };
 566
 567 static void
 568 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
 569                         u32 next_index, u32 * to_next, u16 n_segs,
 570                         session_t * s, u32 n_trace)
 571 {
 572   session_queue_trace_t *t;
 573   vlib_buffer_t *b;
 574   int i;
 575
 576   for (i = 0; i < clib_min (n_trace, n_segs); i++)
 577     {
 578       b = vlib_get_buffer (vm, to_next[i]);
 579       vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
 580       t = vlib_add_trace (vm, node, b, sizeof (*t));
 581       t->session_index = s->session_index;
 582       t->server_thread_index = s->thread_index;
 583     }
 584   vlib_set_trace_count (vm, node, n_trace - i);
 585 }
 586
 587 always_inline void
 588 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
 589                             vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
 590 {
 591   vlib_buffer_t *chain_b, *prev_b;
 592   u32 chain_bi0, to_deq, left_from_seg;
 593   session_worker_t *wrk;
 594   u16 len_to_deq, n_bytes_read;
 595   u8 *data, j;
 596
 597   wrk = session_main_get_worker (ctx->s->thread_index);
 598   b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 599   b->total_length_not_including_first_buffer = 0;
 600
 601   chain_b = b;
 602   left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
 603                             ctx->left_to_snd);
 604   to_deq = left_from_seg;
 605   for (j = 1; j < ctx->n_bufs_per_seg; j++)
 606     {
 607       prev_b = chain_b;
 608       len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
 609
 610       *n_bufs -= 1;
 611       chain_bi0 = wrk->tx_buffers[*n_bufs];
 612       chain_b = vlib_get_buffer (vm, chain_bi0);
 613       chain_b->current_data = 0;
 614       data = vlib_buffer_get_current (chain_b);
 615       if (peek_data)
 616         {
 617           n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
 618                                         ctx->sp.tx_offset, len_to_deq, data);
 619           ctx->sp.tx_offset += n_bytes_read;
 620         }
 621       else
 622         {
 623           if (ctx->transport_vft->transport_options.tx_type ==
 624               TRANSPORT_TX_DGRAM)
 625             {
 626               svm_fifo_t *f = ctx->s->tx_fifo;
 627               session_dgram_hdr_t *hdr = &ctx->hdr;
 628               u16 deq_now;
 629               deq_now = clib_min (hdr->data_length - hdr->data_offset,
 630                                   len_to_deq);
 631               n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
 632                                             data);
 633               ASSERT (n_bytes_read > 0);
 634
 635               hdr->data_offset += n_bytes_read;
 636               if (hdr->data_offset == hdr->data_length)
 637                 {
 638                   u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
 639                   svm_fifo_dequeue_drop (f, offset);
 640                   if (ctx->left_to_snd > n_bytes_read)
 641                     svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
 642                                    (u8 *) & ctx->hdr);
 643                 }
 644               else if (ctx->left_to_snd == n_bytes_read)
 645                 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
 646                                          sizeof (session_dgram_pre_hdr_t));
 647             }
 648           else
 649             n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
 650                                              len_to_deq, data);
 651         }
 652       ASSERT (n_bytes_read == len_to_deq);
 653       chain_b->current_length = n_bytes_read;
 654       b->total_length_not_including_first_buffer += chain_b->current_length;
 655
 656       /* update previous buffer */
 657       prev_b->next_buffer = chain_bi0;
 658       prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 659
 660       /* update current buffer */
 661       chain_b->next_buffer = 0;
 662
 663       to_deq -= n_bytes_read;
 664       if (to_deq == 0)
 665         break;
 666     }
 667   ASSERT (to_deq == 0
 668           && b->total_length_not_including_first_buffer == left_from_seg);
 669   ctx->left_to_snd -= left_from_seg;
 670 }
 671
 672 always_inline void
 673 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
 674                         vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
 675 {
 676   u32 len_to_deq;
 677   u8 *data0;
 678   int n_bytes_read;
 679
 680   /*
 681    * Start with the first buffer in chain
 682    */
 683   b->error = 0;
 684   b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
 685   b->current_data = 0;
 686
 687   data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
 688   len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
 689
 690   if (peek_data)
 691     {
 692       n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset,
 693                                     len_to_deq, data0);
 694       ASSERT (n_bytes_read > 0);
 695       /* Keep track of progress locally, transport is also supposed to
 696        * increment it independently when pushing the header */
 697       ctx->sp.tx_offset += n_bytes_read;
 698     }
 699   else
 700     {
 701       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
 702         {
 703           session_dgram_hdr_t *hdr = &ctx->hdr;
 704           svm_fifo_t *f = ctx->s->tx_fifo;
 705           u16 deq_now;
 706           u32 offset;
 707
 708           ASSERT (hdr->data_length > hdr->data_offset);
 709           deq_now = clib_min (hdr->data_length - hdr->data_offset,
 710                               len_to_deq);
 711           offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
 712           n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
 713           ASSERT (n_bytes_read > 0);
 714
 715           if (ctx->s->session_state == SESSION_STATE_LISTENING)
 716             {
 717               ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
 718               ctx->tc->rmt_port = hdr->rmt_port;
 719             }
 720           hdr->data_offset += n_bytes_read;
 721           if (hdr->data_offset == hdr->data_length)
 722             {
 723               offset = hdr->data_length + SESSION_CONN_HDR_LEN;
 724               svm_fifo_dequeue_drop (f, offset);
 725               if (ctx->left_to_snd > n_bytes_read)
 726                 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
 727                                (u8 *) & ctx->hdr);
 728             }
 729           else if (ctx->left_to_snd == n_bytes_read)
 730             svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
 731                                      sizeof (session_dgram_pre_hdr_t));
 732         }
 733       else
 734         {
 735           n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
 736                                            len_to_deq, data0);
 737           ASSERT (n_bytes_read > 0);
 738         }
 739     }
 740   b->current_length = n_bytes_read;
 741   ctx->left_to_snd -= n_bytes_read;
 742
 743   /*
 744    * Fill in the remaining buffers in the chain, if any
 745    */
 746   if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
 747     session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
 748 }
 749
 750 always_inline u8
 751 session_tx_not_ready (session_t * s, u8 peek_data)
 752 {
 753   if (peek_data)
 754     {
 755       if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
 756         return 0;
 757       /* Can retransmit for closed sessions but can't send new data if
 758        * session is not ready or closed */
 759       else if (s->session_state < SESSION_STATE_READY)
 760         return 1;
 761       else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
 762         {
 763           /* Allow closed transports to still send custom packets.
 764            * For instance, tcp may want to send acks in time-wait. */
 765           if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
 766               && (s->flags & SESSION_F_CUSTOM_TX))
 767             return 0;
 768           return 2;
 769         }
 770     }
 771   return 0;
 772 }
 773
 774 always_inline transport_connection_t *
 775 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
 776 {
 777   if (peek_data)
 778     {
 779       return ctx->transport_vft->get_connection (ctx->s->connection_index,
 780                                                  ctx->s->thread_index);
 781     }
 782   else
 783     {
 784       if (ctx->s->session_state == SESSION_STATE_LISTENING)
 785         return ctx->transport_vft->get_listener (ctx->s->connection_index);
 786       else
 787         {
 788           return ctx->transport_vft->get_connection (ctx->s->connection_index,
 789                                                      ctx->s->thread_index);
 790         }
 791     }
 792 }
 793
 794 always_inline void
 795 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
 796                                u32 max_segs, u8 peek_data)
 797 {
 798   u32 n_bytes_per_buf, n_bytes_per_seg;
 799
 800   n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
 801   ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
 802
 803   if (peek_data)
 804     {
 805       /* Offset in rx fifo from where to peek data */
 806       if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
 807         {
 808           ctx->max_len_to_snd = 0;
 809           return;
 810         }
 811       ctx->max_dequeue -= ctx->sp.tx_offset;
 812     }
 813   else
 814     {
 815       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
 816         {
 817           u32 len, chain_limit;
 818
 819           if (ctx->max_dequeue <= sizeof (ctx->hdr))
 820             {
 821               ctx->max_len_to_snd = 0;
 822               return;
 823             }
 824
 825           svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
 826                          (u8 *) & ctx->hdr);
 827           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
 828           len = ctx->hdr.data_length - ctx->hdr.data_offset;
 829
 830           /* Process multiple dgrams if smaller than min (buf_space, mss).
 831            * This avoids handling multiple dgrams if they require buffer
 832            * chains */
 833           chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
 834                                   ctx->sp.snd_mss);
 835           if (ctx->hdr.data_length <= chain_limit)
 836             {
 837               u32 first_dgram_len, dgram_len, offset, max_offset;
 838               session_dgram_hdr_t hdr;
 839
 840               ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
 841               offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
 842               first_dgram_len = len;
 843               max_offset = clib_min (ctx->max_dequeue, 16 << 10);
 844
 845               while (offset < max_offset)
 846                 {
 847                   svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
 848                                  (u8 *) & hdr);
 849                   ASSERT (hdr.data_length > hdr.data_offset);
 850                   dgram_len = hdr.data_length - hdr.data_offset;
 851                   if (len + dgram_len > ctx->max_dequeue
 852                       || first_dgram_len != dgram_len)
 853                     break;
 854                   len += dgram_len;
 855                   offset += sizeof (hdr) + hdr.data_length;
 856                 }
 857             }
 858
 859           ctx->max_dequeue = len;
 860         }
 861     }
 862   ASSERT (ctx->max_dequeue > 0);
 863
 864   /* Ensure we're not writing more than transport window allows */
 865   if (ctx->max_dequeue < ctx->sp.snd_space)
 866     {
 867       /* Constrained by tx queue. Try to send only fully formed segments */
 868       ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
 869         (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
 870         ctx->max_dequeue;
 871       /* TODO Nagle ? */
 872     }
 873   else
 874     {
 875       /* Expectation is that snd_space0 is already a multiple of snd_mss */
 876       ctx->max_len_to_snd = ctx->sp.snd_space;
 877     }
 878
 879   /* Check if we're tx constrained by the node */
 880   ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
 881   if (ctx->n_segs_per_evt > max_segs)
 882     {
 883       ctx->n_segs_per_evt = max_segs;
 884       ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
 885     }
 886
 887   ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
 888   if (ctx->n_segs_per_evt > 1)
 889     {
 890       u32 n_bytes_last_seg, n_bufs_last_seg;
 891
 892       n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
 893       n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
 894         - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
 895       ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
 896       n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
 897       ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
 898         + n_bufs_last_seg;
 899     }
 900   else
 901     {
 902       n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
 903       ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
 904       ctx->n_bufs_needed = ctx->n_bufs_per_seg;
 905     }
 906
 907   ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
 908   ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
 909                                      n_bytes_per_buf -
 910                                      TRANSPORT_MAX_HDRS_LEN);
 911 }
 912
 913 always_inline void
 914 session_tx_maybe_reschedule (session_worker_t * wrk,
 915                              session_tx_context_t * ctx,
 916                              session_evt_elt_t * elt)
 917 {
 918   session_t *s = ctx->s;
 919
 920   svm_fifo_unset_event (s->tx_fifo);
 921   if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
 922     if (svm_fifo_set_event (s->tx_fifo))
 923       session_evt_add_head_old (wrk, elt);
 924 }
 925
 926 always_inline int
 927 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
 928                                 vlib_node_runtime_t * node,
 929                                 session_evt_elt_t * elt,
 930                                 int *n_tx_packets, u8 peek_data)
 931 {
 932   u32 n_trace, n_left, pbi, next_index, max_burst;
 933   session_tx_context_t *ctx = &wrk->ctx;
 934   session_main_t *smm = &session_main;
 935   session_event_t *e = &elt->evt;
 936   vlib_main_t *vm = wrk->vm;
 937   transport_proto_t tp;
 938   vlib_buffer_t *pb;
 939   u16 n_bufs, rv;
 940
 941   if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
 942     {
 943       if (rv < 2)
 944         session_evt_add_old (wrk, elt);
 945       return SESSION_TX_NO_DATA;
 946     }
 947
 948   next_index = smm->session_type_to_next[ctx->s->session_type];
 949   max_burst = VLIB_FRAME_SIZE - *n_tx_packets;
 950
 951   tp = session_get_transport_proto (ctx->s);
 952   ctx->transport_vft = transport_protocol_get_vft (tp);
 953   ctx->tc = session_tx_get_transport (ctx, peek_data);
 954
 955   if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
 956     {
 957       if (ctx->transport_vft->flush_data)
 958         ctx->transport_vft->flush_data (ctx->tc);
 959       e->event_type = SESSION_IO_EVT_TX;
 960     }
 961
 962   if (ctx->s->flags & SESSION_F_CUSTOM_TX)
 963     {
 964       u32 n_custom_tx;
 965       ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
 966       ctx->sp.max_burst_size = max_burst;
 967       n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
 968       *n_tx_packets += n_custom_tx;
 969       if (PREDICT_FALSE
 970           (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
 971         return SESSION_TX_OK;
 972       max_burst -= n_custom_tx;
 973       if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
 974         {
 975           session_evt_add_old (wrk, elt);
 976           return SESSION_TX_OK;
 977         }
 978     }
 979
 980   transport_connection_snd_params (ctx->tc, &ctx->sp);
 981
 982   if (!ctx->sp.snd_space)
 983     {
 984       /* If the deschedule flag was set, remove session from scheduler.
 985        * Transport is responsible for rescheduling this session. */
 986       if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
 987         transport_connection_deschedule (ctx->tc);
 988       /* Request to postpone the session, e.g., zero-wnd and transport
 989        * is not currently probing */
 990       else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
 991         session_evt_add_old (wrk, elt);
 992       /* This flow queue is "empty" so it should be re-evaluated before
 993        * the ones that have data to send. */
 994       else
 995         session_evt_add_head_old (wrk, elt);
 996
 997       return SESSION_TX_NO_DATA;
 998     }
 999
1000   if (transport_connection_is_tx_paced (ctx->tc))
1001     {
1002       u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1003       if (snd_space < TRANSPORT_PACER_MIN_BURST)
1004         {
1005           session_evt_add_head_old (wrk, elt);
1006           return SESSION_TX_NO_DATA;
1007         }
1008       snd_space = clib_min (ctx->sp.snd_space, snd_space);
1009       ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1010         snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1011     }
1012
1013   /* Check how much we can pull. */
1014   session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1015
1016   if (PREDICT_FALSE (!ctx->max_len_to_snd))
1017     {
1018       transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1019       session_tx_maybe_reschedule (wrk, ctx, elt);
1020       return SESSION_TX_NO_DATA;
1021     }
1022
1023   vec_validate_aligned (wrk->tx_buffers, ctx->n_bufs_needed - 1,
1024                         CLIB_CACHE_LINE_BYTES);
1025   n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, ctx->n_bufs_needed);
1026   if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1027     {
1028       if (n_bufs)
1029         vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1030       session_evt_add_head_old (wrk, elt);
1031       vlib_node_increment_counter (wrk->vm, node->node_index,
1032                                    SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1033       return SESSION_TX_NO_BUFFERS;
1034     }
1035
1036   transport_connection_update_tx_bytes (ctx->tc, ctx->max_len_to_snd);
1037
1038   ctx->left_to_snd = ctx->max_len_to_snd;
1039   n_left = ctx->n_segs_per_evt;
1040
1041   while (n_left >= 4)
1042     {
1043       vlib_buffer_t *b0, *b1;
1044       u32 bi0, bi1;
1045
1046       pbi = wrk->tx_buffers[n_bufs - 3];
1047       pb = vlib_get_buffer (vm, pbi);
1048       vlib_prefetch_buffer_header (pb, STORE);
1049       pbi = wrk->tx_buffers[n_bufs - 4];
1050       pb = vlib_get_buffer (vm, pbi);
1051       vlib_prefetch_buffer_header (pb, STORE);
1052
1053       bi0 = wrk->tx_buffers[--n_bufs];
1054       bi1 = wrk->tx_buffers[--n_bufs];
1055
1056       b0 = vlib_get_buffer (vm, bi0);
1057       b1 = vlib_get_buffer (vm, bi1);
1058
1059       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1060       session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
1061
1062       ctx->transport_vft->push_header (ctx->tc, b0);
1063       ctx->transport_vft->push_header (ctx->tc, b1);
1064
1065       n_left -= 2;
1066
1067       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
1068       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
1069
1070       vec_add1 (wrk->pending_tx_buffers, bi0);
1071       vec_add1 (wrk->pending_tx_buffers, bi1);
1072       vec_add1 (wrk->pending_tx_nexts, next_index);
1073       vec_add1 (wrk->pending_tx_nexts, next_index);
1074     }
1075   while (n_left)
1076     {
1077       vlib_buffer_t *b0;
1078       u32 bi0;
1079
1080       if (n_left > 1)
1081         {
1082           pbi = wrk->tx_buffers[n_bufs - 2];
1083           pb = vlib_get_buffer (vm, pbi);
1084           vlib_prefetch_buffer_header (pb, STORE);
1085         }
1086
1087       bi0 = wrk->tx_buffers[--n_bufs];
1088       b0 = vlib_get_buffer (vm, bi0);
1089       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1090
1091       /* Ask transport to push header after current_length and
1092        * total_length_not_including_first_buffer are updated */
1093       ctx->transport_vft->push_header (ctx->tc, b0);
1094
1095       n_left -= 1;
1096
1097       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
1098
1099       vec_add1 (wrk->pending_tx_buffers, bi0);
1100       vec_add1 (wrk->pending_tx_nexts, next_index);
1101     }
1102
1103   if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1104     session_tx_trace_frame (vm, node, next_index, wrk->pending_tx_buffers,
1105                             ctx->n_segs_per_evt, ctx->s, n_trace);
1106
1107   if (PREDICT_FALSE (n_bufs))
1108     vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1109
1110   *n_tx_packets += ctx->n_segs_per_evt;
1111
1112   SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1113                ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
1114
1115   ASSERT (ctx->left_to_snd == 0);
1116
1117   /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1118    * check if application enqueued more data and reschedule accordingly */
1119   if (ctx->max_len_to_snd < ctx->max_dequeue)
1120     session_evt_add_old (wrk, elt);
1121   else
1122     session_tx_maybe_reschedule (wrk, ctx, elt);
1123
1124   if (!peek_data)
1125     {
1126       if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, ctx->max_len_to_snd))
1127         session_dequeue_notify (ctx->s);
1128     }
1129   return SESSION_TX_OK;
1130 }
1131
1132 int
1133 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1134                               vlib_node_runtime_t * node,
1135                               session_evt_elt_t * e, int *n_tx_packets)
1136 {
1137   return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1138 }
1139
1140 int
1141 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1142                                  vlib_node_runtime_t * node,
1143                                  session_evt_elt_t * e, int *n_tx_packets)
1144 {
1145   return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1146 }
1147
1148 int
1149 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1150                                   vlib_node_runtime_t * node,
1151                                   session_evt_elt_t * elt, int *n_tx_packets)
1152 {
1153   transport_send_params_t *sp = &wrk->ctx.sp;
1154   session_t *s = wrk->ctx.s;
1155   u32 n_packets;
1156
1157   if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1158     return 0;
1159
1160   /* Clear custom-tx flag used to request reschedule for tx */
1161   s->flags &= ~SESSION_F_CUSTOM_TX;
1162
1163   sp->max_burst_size = clib_min (VLIB_FRAME_SIZE - *n_tx_packets,
1164                                  TRANSPORT_PACER_MAX_BURST_PKTS);
1165
1166   n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1167   *n_tx_packets += n_packets;
1168
1169   if (s->flags & SESSION_F_CUSTOM_TX)
1170     {
1171       session_evt_add_old (wrk, elt);
1172     }
1173   else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1174     {
1175       svm_fifo_unset_event (s->tx_fifo);
1176       if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1177         if (svm_fifo_set_event (s->tx_fifo))
1178           session_evt_add_head_old (wrk, elt);
1179     }
1180
1181   return n_packets;
1182 }
1183
1184 always_inline session_t *
1185 session_event_get_session (session_event_t * e, u8 thread_index)
1186 {
1187   return session_get_if_valid (e->session_index, thread_index);
1188 }
1189
1190 always_inline void
1191 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1192 {
1193   clib_llist_index_t ei;
1194   void (*fp) (void *);
1195   session_event_t *e;
1196   session_t *s;
1197
1198   ei = clib_llist_entry_index (wrk->event_elts, elt);
1199   e = &elt->evt;
1200
1201   switch (e->event_type)
1202     {
1203     case SESSION_CTRL_EVT_RPC:
1204       fp = e->rpc_args.fp;
1205       (*fp) (e->rpc_args.arg);
1206       break;
1207     case SESSION_CTRL_EVT_CLOSE:
1208       s = session_get_from_handle_if_valid (e->session_handle);
1209       if (PREDICT_FALSE (!s))
1210         break;
1211       session_transport_close (s);
1212       break;
1213     case SESSION_CTRL_EVT_RESET:
1214       s = session_get_from_handle_if_valid (e->session_handle);
1215       if (PREDICT_FALSE (!s))
1216         break;
1217       session_transport_reset (s);
1218       break;
1219     case SESSION_CTRL_EVT_LISTEN:
1220       session_mq_listen_handler (session_evt_ctrl_data (wrk, elt));
1221       break;
1222     case SESSION_CTRL_EVT_LISTEN_URI:
1223       session_mq_listen_uri_handler (session_evt_ctrl_data (wrk, elt));
1224       break;
1225     case SESSION_CTRL_EVT_UNLISTEN:
1226       session_mq_unlisten_handler (session_evt_ctrl_data (wrk, elt));
1227       break;
1228     case SESSION_CTRL_EVT_CONNECT:
1229       session_mq_connect_handler (session_evt_ctrl_data (wrk, elt));
1230       break;
1231     case SESSION_CTRL_EVT_CONNECT_URI:
1232       session_mq_connect_uri_handler (session_evt_ctrl_data (wrk, elt));
1233       break;
1234     case SESSION_CTRL_EVT_DISCONNECT:
1235       session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1236       break;
1237     case SESSION_CTRL_EVT_DISCONNECTED:
1238       session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1239       break;
1240     case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1241       session_mq_accepted_reply_handler (session_evt_ctrl_data (wrk, elt));
1242       break;
1243     case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1244       session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1245                                                                     elt));
1246       break;
1247     case SESSION_CTRL_EVT_RESET_REPLY:
1248       session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1249       break;
1250     case SESSION_CTRL_EVT_WORKER_UPDATE:
1251       session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1252       break;
1253     case SESSION_CTRL_EVT_APP_DETACH:
1254       app_mq_detach_handler (session_evt_ctrl_data (wrk, elt));
1255       break;
1256     case SESSION_CTRL_EVT_APP_WRK_RPC:
1257       session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1258       break;
1259     default:
1260       clib_warning ("unhandled event type %d", e->event_type);
1261     }
1262
1263   /* Regrab elements in case pool moved */
1264   elt = pool_elt_at_index (wrk->event_elts, ei);
1265   if (!clib_llist_elt_is_linked (elt, evt_list))
1266     {
1267       e = &elt->evt;
1268       if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1269         session_evt_ctrl_data_free (wrk, elt);
1270       session_evt_elt_free (wrk, elt);
1271     }
1272   SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1273 }
1274
1275 always_inline void
1276 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1277                            session_evt_elt_t * elt, u32 thread_index,
1278                            int *n_tx_packets)
1279 {
1280   session_main_t *smm = &session_main;
1281   app_worker_t *app_wrk;
1282   clib_llist_index_t ei;
1283   session_event_t *e;
1284   session_t *s;
1285
1286   ei = clib_llist_entry_index (wrk->event_elts, elt);
1287   e = &elt->evt;
1288
1289   switch (e->event_type)
1290     {
1291     case SESSION_IO_EVT_TX_FLUSH:
1292     case SESSION_IO_EVT_TX:
1293       s = session_event_get_session (e, thread_index);
1294       if (PREDICT_FALSE (!s))
1295         break;
1296       CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
1297       wrk->ctx.s = s;
1298       /* Spray packets in per session type frames, since they go to
1299        * different nodes */
1300       (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1301       break;
1302     case SESSION_IO_EVT_RX:
1303       s = session_event_get_session (e, thread_index);
1304       if (!s)
1305         break;
1306       transport_app_rx_evt (session_get_transport_proto (s),
1307                             s->connection_index, s->thread_index);
1308       break;
1309     case SESSION_IO_EVT_BUILTIN_RX:
1310       s = session_event_get_session (e, thread_index);
1311       if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1312         break;
1313       svm_fifo_unset_event (s->rx_fifo);
1314       app_wrk = app_worker_get (s->app_wrk_index);
1315       app_worker_builtin_rx (app_wrk, s);
1316       break;
1317     case SESSION_IO_EVT_BUILTIN_TX:
1318       s = session_get_from_handle_if_valid (e->session_handle);
1319       wrk->ctx.s = s;
1320       if (PREDICT_TRUE (s != 0))
1321         session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
1322       break;
1323     default:
1324       clib_warning ("unhandled event type %d", e->event_type);
1325     }
1326
1327   SESSION_EVT (SESSION_IO_EVT_COUNTS, e->event_type, 1, wrk);
1328
1329   /* Regrab elements in case pool moved */
1330   elt = pool_elt_at_index (wrk->event_elts, ei);
1331   if (!clib_llist_elt_is_linked (elt, evt_list))
1332     session_evt_elt_free (wrk, elt);
1333 }
1334
1335 /* *INDENT-OFF* */
1336 static const u32 session_evt_msg_sizes[] = {
1337 #define _(symc, sym)                                                    \
1338   [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1339   foreach_session_ctrl_evt
1340 #undef _
1341 };
1342 /* *INDENT-ON* */
1343
1344 always_inline void
1345 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1346 {
1347   session_evt_elt_t *elt;
1348
1349   if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1350     {
1351       elt = session_evt_alloc_ctrl (wrk);
1352       if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1353         {
1354           elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1355           elt->evt.event_type = evt->event_type;
1356           clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1357                             session_evt_msg_sizes[evt->event_type]);
1358         }
1359       else
1360         {
1361           /* Internal control events fit into io events footprint */
1362           clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1363         }
1364     }
1365   else
1366     {
1367       elt = session_evt_alloc_new (wrk);
1368       clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1369     }
1370 }
1371
1372 static void
1373 session_flush_pending_tx_buffers (session_worker_t * wrk,
1374                                   vlib_node_runtime_t * node)
1375 {
1376   vlib_buffer_enqueue_to_next (wrk->vm, node, wrk->pending_tx_buffers,
1377                                wrk->pending_tx_nexts,
1378                                vec_len (wrk->pending_tx_nexts));
1379   vec_reset_length (wrk->pending_tx_buffers);
1380   vec_reset_length (wrk->pending_tx_nexts);
1381 }
1382
1383 static uword
1384 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1385                        vlib_frame_t * frame)
1386 {
1387   session_main_t *smm = vnet_get_session_main ();
1388   u32 thread_index = vm->thread_index, n_to_dequeue;
1389   session_worker_t *wrk = &smm->wrk[thread_index];
1390   session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1391   clib_llist_index_t ei, next_ei, old_ti;
1392   svm_msg_q_msg_t _msg, *msg = &_msg;
1393   int i = 0, n_tx_packets;
1394   session_event_t *evt;
1395   svm_msg_q_t *mq;
1396
1397   SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1398
1399   wrk->last_vlib_time = vlib_time_now (vm);
1400   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1401
1402   /*
1403    *  Update transport time
1404    */
1405   transport_update_time (wrk->last_vlib_time, thread_index);
1406   n_tx_packets = vec_len (wrk->pending_tx_buffers);
1407   SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1408
1409   /*
1410    *  Dequeue and handle new events
1411    */
1412
1413   /* Try to dequeue what is available. Don't wait for lock.
1414    * XXX: we may need priorities here */
1415   mq = wrk->vpp_event_queue;
1416   n_to_dequeue = svm_msg_q_size (mq);
1417   if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
1418     {
1419       for (i = 0; i < n_to_dequeue; i++)
1420         {
1421           svm_msg_q_sub_w_lock (mq, msg);
1422           evt = svm_msg_q_msg_data (mq, msg);
1423           session_evt_add_to_list (wrk, evt);
1424           svm_msg_q_free_msg (mq, msg);
1425         }
1426       svm_msg_q_unlock (mq);
1427     }
1428
1429   SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_to_dequeue, !i);
1430
1431   /*
1432    * Handle control events
1433    */
1434
1435   ctrl_he = pool_elt_at_index (wrk->event_elts, wrk->ctrl_head);
1436
1437   /* *INDENT-OFF* */
1438   clib_llist_foreach_safe (wrk->event_elts, evt_list, ctrl_he, elt, ({
1439     clib_llist_remove (wrk->event_elts, evt_list, elt);
1440     session_event_dispatch_ctrl (wrk, elt);
1441   }));
1442   /* *INDENT-ON* */
1443
1444   SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1445
1446   /*
1447    * Handle the new io events.
1448    */
1449
1450   new_he = pool_elt_at_index (wrk->event_elts, wrk->new_head);
1451   old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1452   old_ti = clib_llist_prev_index (old_he, evt_list);
1453
1454   ei = clib_llist_next_index (new_he, evt_list);
1455   while (ei != wrk->new_head && n_tx_packets < VLIB_FRAME_SIZE)
1456     {
1457       elt = pool_elt_at_index (wrk->event_elts, ei);
1458       ei = clib_llist_next_index (elt, evt_list);
1459       clib_llist_remove (wrk->event_elts, evt_list, elt);
1460       session_event_dispatch_io (wrk, node, elt, thread_index, &n_tx_packets);
1461     }
1462
1463   SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1464
1465   /*
1466    * Handle the old io events, if we had any prior to processing the new ones
1467    */
1468
1469   if (old_ti != wrk->old_head)
1470     {
1471       old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1472       ei = clib_llist_next_index (old_he, evt_list);
1473
1474       while (n_tx_packets < VLIB_FRAME_SIZE)
1475         {
1476           elt = pool_elt_at_index (wrk->event_elts, ei);
1477           next_ei = clib_llist_next_index (elt, evt_list);
1478           clib_llist_remove (wrk->event_elts, evt_list, elt);
1479
1480           session_event_dispatch_io (wrk, node, elt, thread_index,
1481                                      &n_tx_packets);
1482
1483           if (ei == old_ti)
1484             break;
1485
1486           ei = next_ei;
1487         };
1488     }
1489
1490   SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
1491
1492   if (vec_len (wrk->pending_tx_buffers))
1493     session_flush_pending_tx_buffers (wrk, node);
1494
1495   vlib_node_increment_counter (vm, session_queue_node.index,
1496                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
1497
1498   SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1499
1500   return n_tx_packets;
1501 }
1502
1503 /* *INDENT-OFF* */
1504 VLIB_REGISTER_NODE (session_queue_node) =
1505 {
1506   .function = session_queue_node_fn,
1507   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1508   .name = "session-queue",
1509   .format_trace = format_session_queue_trace,
1510   .type = VLIB_NODE_TYPE_INPUT,
1511   .n_errors = ARRAY_LEN (session_queue_error_strings),
1512   .error_strings = session_queue_error_strings,
1513   .state = VLIB_NODE_STATE_DISABLED,
1514 };
1515 /* *INDENT-ON* */
1516
1517 static clib_error_t *
1518 session_queue_exit (vlib_main_t * vm)
1519 {
1520   if (vec_len (vlib_mains) < 2)
1521     return 0;
1522
1523   /*
1524    * Shut off (especially) worker-thread session nodes.
1525    * Otherwise, vpp can crash as the main thread unmaps the
1526    * API segment.
1527    */
1528   vlib_worker_thread_barrier_sync (vm);
1529   session_node_enable_disable (0 /* is_enable */ );
1530   vlib_worker_thread_barrier_release (vm);
1531   return 0;
1532 }
1533
1534 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1535
1536 static uword
1537 session_queue_run_on_main (vlib_main_t * vm)
1538 {
1539   vlib_node_runtime_t *node;
1540
1541   node = vlib_node_get_runtime (vm, session_queue_node.index);
1542   return session_queue_node_fn (vm, node, 0);
1543 }
1544
1545 static uword
1546 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1547                        vlib_frame_t * f)
1548 {
1549   uword *event_data = 0;
1550   f64 timeout = 1.0;
1551   uword event_type;
1552
1553   while (1)
1554     {
1555       vlib_process_wait_for_event_or_clock (vm, timeout);
1556       event_type = vlib_process_get_events (vm, (uword **) & event_data);
1557
1558       switch (event_type)
1559         {
1560         case SESSION_Q_PROCESS_RUN_ON_MAIN:
1561           /* Run session queue node on main thread */
1562           session_queue_run_on_main (vm);
1563           break;
1564         case SESSION_Q_PROCESS_STOP:
1565           timeout = 100000.0;
1566           break;
1567         case ~0:
1568           /* Timed out. Run on main to ensure all events are handled */
1569           session_queue_run_on_main (vm);
1570           break;
1571         }
1572       vec_reset_length (event_data);
1573     }
1574   return 0;
1575 }
1576
1577 /* *INDENT-OFF* */
1578 VLIB_REGISTER_NODE (session_queue_process_node) =
1579 {
1580   .function = session_queue_process,
1581   .type = VLIB_NODE_TYPE_PROCESS,
1582   .name = "session-queue-process",
1583   .state = VLIB_NODE_STATE_DISABLED,
1584 };
1585 /* *INDENT-ON* */
1586
1587 static_always_inline uword
1588 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1589                                 vlib_frame_t * frame)
1590 {
1591   session_main_t *sm = &session_main;
1592   if (!sm->wrk[0].vpp_event_queue)
1593     return 0;
1594   node = vlib_node_get_runtime (vm, session_queue_node.index);
1595   return session_queue_node_fn (vm, node, frame);
1596 }
1597
1598 /* *INDENT-OFF* */
1599 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1600 {
1601   .function = session_queue_pre_input_inline,
1602   .type = VLIB_NODE_TYPE_PRE_INPUT,
1603   .name = "session-queue-main",
1604   .state = VLIB_NODE_STATE_DISABLED,
1605 };
1606 /* *INDENT-ON* */
1607
1608 /*
1609  * fd.io coding-style-patch-verification: ON
1610  *
1611  * Local Variables:
1612  * eval: (c-set-style "gnu")
1613  * End:
1614  */