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: %U", format_session_error, 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   while (n_trace && n_segs)
 573     {
 574       vlib_buffer_t *b = vlib_get_buffer (vm, to_next[0]);
 575       if (PREDICT_TRUE
 576           (vlib_trace_buffer
 577            (vm, node, next_index, b, 1 /* follow_chain */ )))
 578         {
 579           session_queue_trace_t *t =
 580             vlib_add_trace (vm, node, b, sizeof (*t));
 581           t->session_index = s->session_index;
 582           t->server_thread_index = s->thread_index;
 583           n_trace--;
 584         }
 585       to_next++;
 586       n_segs--;
 587     }
 588   vlib_set_trace_count (vm, node, n_trace);
 589 }
 590
 591 always_inline void
 592 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
 593                             vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
 594 {
 595   vlib_buffer_t *chain_b, *prev_b;
 596   u32 chain_bi0, to_deq, left_from_seg;
 597   session_worker_t *wrk;
 598   u16 len_to_deq, n_bytes_read;
 599   u8 *data, j;
 600
 601   wrk = session_main_get_worker (ctx->s->thread_index);
 602   b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 603   b->total_length_not_including_first_buffer = 0;
 604
 605   chain_b = b;
 606   left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
 607                             ctx->left_to_snd);
 608   to_deq = left_from_seg;
 609   for (j = 1; j < ctx->n_bufs_per_seg; j++)
 610     {
 611       prev_b = chain_b;
 612       len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
 613
 614       *n_bufs -= 1;
 615       chain_bi0 = wrk->tx_buffers[*n_bufs];
 616       chain_b = vlib_get_buffer (vm, chain_bi0);
 617       chain_b->current_data = 0;
 618       data = vlib_buffer_get_current (chain_b);
 619       if (peek_data)
 620         {
 621           n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
 622                                         ctx->sp.tx_offset, len_to_deq, data);
 623           ctx->sp.tx_offset += n_bytes_read;
 624         }
 625       else
 626         {
 627           if (ctx->transport_vft->transport_options.tx_type ==
 628               TRANSPORT_TX_DGRAM)
 629             {
 630               svm_fifo_t *f = ctx->s->tx_fifo;
 631               session_dgram_hdr_t *hdr = &ctx->hdr;
 632               u16 deq_now;
 633               deq_now = clib_min (hdr->data_length - hdr->data_offset,
 634                                   len_to_deq);
 635               n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
 636                                             data);
 637               ASSERT (n_bytes_read > 0);
 638
 639               hdr->data_offset += n_bytes_read;
 640               if (hdr->data_offset == hdr->data_length)
 641                 {
 642                   u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
 643                   svm_fifo_dequeue_drop (f, offset);
 644                   if (ctx->left_to_snd > n_bytes_read)
 645                     svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
 646                                    (u8 *) & ctx->hdr);
 647                 }
 648               else if (ctx->left_to_snd == n_bytes_read)
 649                 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
 650                                          sizeof (session_dgram_pre_hdr_t));
 651             }
 652           else
 653             n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
 654                                              len_to_deq, data);
 655         }
 656       ASSERT (n_bytes_read == len_to_deq);
 657       chain_b->current_length = n_bytes_read;
 658       b->total_length_not_including_first_buffer += chain_b->current_length;
 659
 660       /* update previous buffer */
 661       prev_b->next_buffer = chain_bi0;
 662       prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 663
 664       /* update current buffer */
 665       chain_b->next_buffer = 0;
 666
 667       to_deq -= n_bytes_read;
 668       if (to_deq == 0)
 669         break;
 670     }
 671   ASSERT (to_deq == 0
 672           && b->total_length_not_including_first_buffer == left_from_seg);
 673   ctx->left_to_snd -= left_from_seg;
 674 }
 675
 676 always_inline void
 677 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
 678                         vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
 679 {
 680   u32 len_to_deq;
 681   u8 *data0;
 682   int n_bytes_read;
 683
 684   /*
 685    * Start with the first buffer in chain
 686    */
 687   b->error = 0;
 688   b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
 689   b->current_data = 0;
 690
 691   data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
 692   len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
 693
 694   if (peek_data)
 695     {
 696       n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset,
 697                                     len_to_deq, data0);
 698       ASSERT (n_bytes_read > 0);
 699       /* Keep track of progress locally, transport is also supposed to
 700        * increment it independently when pushing the header */
 701       ctx->sp.tx_offset += n_bytes_read;
 702     }
 703   else
 704     {
 705       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
 706         {
 707           session_dgram_hdr_t *hdr = &ctx->hdr;
 708           svm_fifo_t *f = ctx->s->tx_fifo;
 709           u16 deq_now;
 710           u32 offset;
 711
 712           ASSERT (hdr->data_length > hdr->data_offset);
 713           deq_now = clib_min (hdr->data_length - hdr->data_offset,
 714                               len_to_deq);
 715           offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
 716           n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
 717           ASSERT (n_bytes_read > 0);
 718
 719           if (ctx->s->session_state == SESSION_STATE_LISTENING)
 720             {
 721               ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
 722               ctx->tc->rmt_port = hdr->rmt_port;
 723             }
 724           hdr->data_offset += n_bytes_read;
 725           if (hdr->data_offset == hdr->data_length)
 726             {
 727               offset = hdr->data_length + SESSION_CONN_HDR_LEN;
 728               svm_fifo_dequeue_drop (f, offset);
 729               if (ctx->left_to_snd > n_bytes_read)
 730                 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
 731                                (u8 *) & ctx->hdr);
 732             }
 733           else if (ctx->left_to_snd == n_bytes_read)
 734             svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
 735                                      sizeof (session_dgram_pre_hdr_t));
 736         }
 737       else
 738         {
 739           n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
 740                                            len_to_deq, data0);
 741           ASSERT (n_bytes_read > 0);
 742         }
 743     }
 744   b->current_length = n_bytes_read;
 745   ctx->left_to_snd -= n_bytes_read;
 746
 747   /*
 748    * Fill in the remaining buffers in the chain, if any
 749    */
 750   if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
 751     session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
 752 }
 753
 754 always_inline u8
 755 session_tx_not_ready (session_t * s, u8 peek_data)
 756 {
 757   if (peek_data)
 758     {
 759       if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
 760         return 0;
 761       /* Can retransmit for closed sessions but can't send new data if
 762        * session is not ready or closed */
 763       else if (s->session_state < SESSION_STATE_READY)
 764         return 1;
 765       else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
 766         {
 767           /* Allow closed transports to still send custom packets.
 768            * For instance, tcp may want to send acks in time-wait. */
 769           if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
 770               && (s->flags & SESSION_F_CUSTOM_TX))
 771             return 0;
 772           return 2;
 773         }
 774     }
 775   return 0;
 776 }
 777
 778 always_inline transport_connection_t *
 779 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
 780 {
 781   if (peek_data)
 782     {
 783       return ctx->transport_vft->get_connection (ctx->s->connection_index,
 784                                                  ctx->s->thread_index);
 785     }
 786   else
 787     {
 788       if (ctx->s->session_state == SESSION_STATE_LISTENING)
 789         return ctx->transport_vft->get_listener (ctx->s->connection_index);
 790       else
 791         {
 792           return ctx->transport_vft->get_connection (ctx->s->connection_index,
 793                                                      ctx->s->thread_index);
 794         }
 795     }
 796 }
 797
 798 always_inline void
 799 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
 800                                u32 max_segs, u8 peek_data)
 801 {
 802   u32 n_bytes_per_buf, n_bytes_per_seg;
 803
 804   n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
 805   ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
 806
 807   if (peek_data)
 808     {
 809       /* Offset in rx fifo from where to peek data */
 810       if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
 811         {
 812           ctx->max_len_to_snd = 0;
 813           return;
 814         }
 815       ctx->max_dequeue -= ctx->sp.tx_offset;
 816     }
 817   else
 818     {
 819       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
 820         {
 821           u32 len, chain_limit;
 822
 823           if (ctx->max_dequeue <= sizeof (ctx->hdr))
 824             {
 825               ctx->max_len_to_snd = 0;
 826               return;
 827             }
 828
 829           svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
 830                          (u8 *) & ctx->hdr);
 831           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
 832           len = ctx->hdr.data_length - ctx->hdr.data_offset;
 833
 834           /* Process multiple dgrams if smaller than min (buf_space, mss).
 835            * This avoids handling multiple dgrams if they require buffer
 836            * chains */
 837           chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
 838                                   ctx->sp.snd_mss);
 839           if (ctx->hdr.data_length <= chain_limit)
 840             {
 841               u32 first_dgram_len, dgram_len, offset, max_offset;
 842               session_dgram_hdr_t hdr;
 843
 844               ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
 845               offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
 846               first_dgram_len = len;
 847               max_offset = clib_min (ctx->max_dequeue, 16 << 10);
 848
 849               while (offset < max_offset)
 850                 {
 851                   svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
 852                                  (u8 *) & hdr);
 853                   ASSERT (hdr.data_length > hdr.data_offset);
 854                   dgram_len = hdr.data_length - hdr.data_offset;
 855                   if (len + dgram_len > ctx->max_dequeue
 856                       || first_dgram_len != dgram_len)
 857                     break;
 858                   len += dgram_len;
 859                   offset += sizeof (hdr) + hdr.data_length;
 860                 }
 861             }
 862
 863           ctx->max_dequeue = len;
 864         }
 865     }
 866   ASSERT (ctx->max_dequeue > 0);
 867
 868   /* Ensure we're not writing more than transport window allows */
 869   if (ctx->max_dequeue < ctx->sp.snd_space)
 870     {
 871       /* Constrained by tx queue. Try to send only fully formed segments */
 872       ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
 873         (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
 874         ctx->max_dequeue;
 875       /* TODO Nagle ? */
 876     }
 877   else
 878     {
 879       /* Expectation is that snd_space0 is already a multiple of snd_mss */
 880       ctx->max_len_to_snd = ctx->sp.snd_space;
 881     }
 882
 883   /* Check if we're tx constrained by the node */
 884   ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
 885   if (ctx->n_segs_per_evt > max_segs)
 886     {
 887       ctx->n_segs_per_evt = max_segs;
 888       ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
 889     }
 890
 891   ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
 892   if (ctx->n_segs_per_evt > 1)
 893     {
 894       u32 n_bytes_last_seg, n_bufs_last_seg;
 895
 896       n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
 897       n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
 898         - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
 899       ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
 900       n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
 901       ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
 902         + n_bufs_last_seg;
 903     }
 904   else
 905     {
 906       n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
 907       ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
 908       ctx->n_bufs_needed = ctx->n_bufs_per_seg;
 909     }
 910
 911   ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
 912   ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
 913                                      n_bytes_per_buf -
 914                                      TRANSPORT_MAX_HDRS_LEN);
 915 }
 916
 917 always_inline void
 918 session_tx_maybe_reschedule (session_worker_t * wrk,
 919                              session_tx_context_t * ctx,
 920                              session_evt_elt_t * elt)
 921 {
 922   session_t *s = ctx->s;
 923
 924   svm_fifo_unset_event (s->tx_fifo);
 925   if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
 926     if (svm_fifo_set_event (s->tx_fifo))
 927       session_evt_add_head_old (wrk, elt);
 928 }
 929
 930 always_inline int
 931 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
 932                                 vlib_node_runtime_t * node,
 933                                 session_evt_elt_t * elt,
 934                                 int *n_tx_packets, u8 peek_data)
 935 {
 936   u32 n_trace, n_left, pbi, next_index, max_burst;
 937   session_tx_context_t *ctx = &wrk->ctx;
 938   session_main_t *smm = &session_main;
 939   session_event_t *e = &elt->evt;
 940   vlib_main_t *vm = wrk->vm;
 941   transport_proto_t tp;
 942   vlib_buffer_t *pb;
 943   u16 n_bufs, rv;
 944
 945   if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
 946     {
 947       if (rv < 2)
 948         session_evt_add_old (wrk, elt);
 949       return SESSION_TX_NO_DATA;
 950     }
 951
 952   next_index = smm->session_type_to_next[ctx->s->session_type];
 953   max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
 954
 955   tp = session_get_transport_proto (ctx->s);
 956   ctx->transport_vft = transport_protocol_get_vft (tp);
 957   ctx->tc = session_tx_get_transport (ctx, peek_data);
 958
 959   if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
 960     {
 961       if (ctx->transport_vft->flush_data)
 962         ctx->transport_vft->flush_data (ctx->tc);
 963       e->event_type = SESSION_IO_EVT_TX;
 964     }
 965
 966   if (ctx->s->flags & SESSION_F_CUSTOM_TX)
 967     {
 968       u32 n_custom_tx;
 969       ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
 970       ctx->sp.max_burst_size = max_burst;
 971       n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
 972       *n_tx_packets += n_custom_tx;
 973       if (PREDICT_FALSE
 974           (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
 975         return SESSION_TX_OK;
 976       max_burst -= n_custom_tx;
 977       if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
 978         {
 979           session_evt_add_old (wrk, elt);
 980           return SESSION_TX_OK;
 981         }
 982     }
 983
 984   transport_connection_snd_params (ctx->tc, &ctx->sp);
 985
 986   if (!ctx->sp.snd_space)
 987     {
 988       /* If the deschedule flag was set, remove session from scheduler.
 989        * Transport is responsible for rescheduling this session. */
 990       if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
 991         transport_connection_deschedule (ctx->tc);
 992       /* Request to postpone the session, e.g., zero-wnd and transport
 993        * is not currently probing */
 994       else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
 995         session_evt_add_old (wrk, elt);
 996       /* This flow queue is "empty" so it should be re-evaluated before
 997        * the ones that have data to send. */
 998       else
 999         session_evt_add_head_old (wrk, elt);
1000
1001       return SESSION_TX_NO_DATA;
1002     }
1003
1004   if (transport_connection_is_tx_paced (ctx->tc))
1005     {
1006       u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1007       if (snd_space < TRANSPORT_PACER_MIN_BURST)
1008         {
1009           session_evt_add_head_old (wrk, elt);
1010           return SESSION_TX_NO_DATA;
1011         }
1012       snd_space = clib_min (ctx->sp.snd_space, snd_space);
1013       ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1014         snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1015     }
1016
1017   /* Check how much we can pull. */
1018   session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1019
1020   if (PREDICT_FALSE (!ctx->max_len_to_snd))
1021     {
1022       transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1023       session_tx_maybe_reschedule (wrk, ctx, elt);
1024       return SESSION_TX_NO_DATA;
1025     }
1026
1027   vec_validate_aligned (wrk->tx_buffers, ctx->n_bufs_needed - 1,
1028                         CLIB_CACHE_LINE_BYTES);
1029   n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, ctx->n_bufs_needed);
1030   if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1031     {
1032       if (n_bufs)
1033         vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1034       session_evt_add_head_old (wrk, elt);
1035       vlib_node_increment_counter (wrk->vm, node->node_index,
1036                                    SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1037       return SESSION_TX_NO_BUFFERS;
1038     }
1039
1040   transport_connection_update_tx_bytes (ctx->tc, ctx->max_len_to_snd);
1041
1042   ctx->left_to_snd = ctx->max_len_to_snd;
1043   n_left = ctx->n_segs_per_evt;
1044
1045   while (n_left >= 4)
1046     {
1047       vlib_buffer_t *b0, *b1;
1048       u32 bi0, bi1;
1049
1050       pbi = wrk->tx_buffers[n_bufs - 3];
1051       pb = vlib_get_buffer (vm, pbi);
1052       vlib_prefetch_buffer_header (pb, STORE);
1053       pbi = wrk->tx_buffers[n_bufs - 4];
1054       pb = vlib_get_buffer (vm, pbi);
1055       vlib_prefetch_buffer_header (pb, STORE);
1056
1057       bi0 = wrk->tx_buffers[--n_bufs];
1058       bi1 = wrk->tx_buffers[--n_bufs];
1059
1060       b0 = vlib_get_buffer (vm, bi0);
1061       b1 = vlib_get_buffer (vm, bi1);
1062
1063       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1064       session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
1065
1066       ctx->transport_vft->push_header (ctx->tc, b0);
1067       ctx->transport_vft->push_header (ctx->tc, b1);
1068
1069       n_left -= 2;
1070
1071       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
1072       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
1073
1074       vec_add1 (wrk->pending_tx_buffers, bi0);
1075       vec_add1 (wrk->pending_tx_buffers, bi1);
1076       vec_add1 (wrk->pending_tx_nexts, next_index);
1077       vec_add1 (wrk->pending_tx_nexts, next_index);
1078     }
1079   while (n_left)
1080     {
1081       vlib_buffer_t *b0;
1082       u32 bi0;
1083
1084       if (n_left > 1)
1085         {
1086           pbi = wrk->tx_buffers[n_bufs - 2];
1087           pb = vlib_get_buffer (vm, pbi);
1088           vlib_prefetch_buffer_header (pb, STORE);
1089         }
1090
1091       bi0 = wrk->tx_buffers[--n_bufs];
1092       b0 = vlib_get_buffer (vm, bi0);
1093       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1094
1095       /* Ask transport to push header after current_length and
1096        * total_length_not_including_first_buffer are updated */
1097       ctx->transport_vft->push_header (ctx->tc, b0);
1098
1099       n_left -= 1;
1100
1101       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
1102
1103       vec_add1 (wrk->pending_tx_buffers, bi0);
1104       vec_add1 (wrk->pending_tx_nexts, next_index);
1105     }
1106
1107   if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1108     session_tx_trace_frame (vm, node, next_index, wrk->pending_tx_buffers,
1109                             ctx->n_segs_per_evt, ctx->s, n_trace);
1110
1111   if (PREDICT_FALSE (n_bufs))
1112     vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1113
1114   *n_tx_packets += ctx->n_segs_per_evt;
1115
1116   SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1117                ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
1118
1119   ASSERT (ctx->left_to_snd == 0);
1120
1121   /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1122    * check if application enqueued more data and reschedule accordingly */
1123   if (ctx->max_len_to_snd < ctx->max_dequeue)
1124     session_evt_add_old (wrk, elt);
1125   else
1126     session_tx_maybe_reschedule (wrk, ctx, elt);
1127
1128   if (!peek_data)
1129     {
1130       if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, ctx->max_len_to_snd))
1131         session_dequeue_notify (ctx->s);
1132     }
1133   return SESSION_TX_OK;
1134 }
1135
1136 int
1137 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1138                               vlib_node_runtime_t * node,
1139                               session_evt_elt_t * e, int *n_tx_packets)
1140 {
1141   return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1142 }
1143
1144 int
1145 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1146                                  vlib_node_runtime_t * node,
1147                                  session_evt_elt_t * e, int *n_tx_packets)
1148 {
1149   return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1150 }
1151
1152 int
1153 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1154                                   vlib_node_runtime_t * node,
1155                                   session_evt_elt_t * elt, int *n_tx_packets)
1156 {
1157   transport_send_params_t *sp = &wrk->ctx.sp;
1158   session_t *s = wrk->ctx.s;
1159   u32 n_packets;
1160
1161   if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1162     return 0;
1163
1164   /* Clear custom-tx flag used to request reschedule for tx */
1165   s->flags &= ~SESSION_F_CUSTOM_TX;
1166
1167   sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1168                                  TRANSPORT_PACER_MAX_BURST_PKTS);
1169
1170   n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1171   *n_tx_packets += n_packets;
1172
1173   if (s->flags & SESSION_F_CUSTOM_TX)
1174     {
1175       session_evt_add_old (wrk, elt);
1176     }
1177   else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1178     {
1179       svm_fifo_unset_event (s->tx_fifo);
1180       if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1181         if (svm_fifo_set_event (s->tx_fifo))
1182           session_evt_add_head_old (wrk, elt);
1183     }
1184
1185   return n_packets;
1186 }
1187
1188 always_inline session_t *
1189 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1190 {
1191   if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1192     return 0;
1193
1194   ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1195   return pool_elt_at_index (wrk->sessions, e->session_index);
1196 }
1197
1198 always_inline void
1199 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1200 {
1201   clib_llist_index_t ei;
1202   void (*fp) (void *);
1203   session_event_t *e;
1204   session_t *s;
1205
1206   ei = clib_llist_entry_index (wrk->event_elts, elt);
1207   e = &elt->evt;
1208
1209   switch (e->event_type)
1210     {
1211     case SESSION_CTRL_EVT_RPC:
1212       fp = e->rpc_args.fp;
1213       (*fp) (e->rpc_args.arg);
1214       break;
1215     case SESSION_CTRL_EVT_CLOSE:
1216       s = session_get_from_handle_if_valid (e->session_handle);
1217       if (PREDICT_FALSE (!s))
1218         break;
1219       session_transport_close (s);
1220       break;
1221     case SESSION_CTRL_EVT_RESET:
1222       s = session_get_from_handle_if_valid (e->session_handle);
1223       if (PREDICT_FALSE (!s))
1224         break;
1225       session_transport_reset (s);
1226       break;
1227     case SESSION_CTRL_EVT_LISTEN:
1228       session_mq_listen_handler (session_evt_ctrl_data (wrk, elt));
1229       break;
1230     case SESSION_CTRL_EVT_LISTEN_URI:
1231       session_mq_listen_uri_handler (session_evt_ctrl_data (wrk, elt));
1232       break;
1233     case SESSION_CTRL_EVT_UNLISTEN:
1234       session_mq_unlisten_handler (session_evt_ctrl_data (wrk, elt));
1235       break;
1236     case SESSION_CTRL_EVT_CONNECT:
1237       session_mq_connect_handler (session_evt_ctrl_data (wrk, elt));
1238       break;
1239     case SESSION_CTRL_EVT_CONNECT_URI:
1240       session_mq_connect_uri_handler (session_evt_ctrl_data (wrk, elt));
1241       break;
1242     case SESSION_CTRL_EVT_DISCONNECT:
1243       session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1244       break;
1245     case SESSION_CTRL_EVT_DISCONNECTED:
1246       session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1247       break;
1248     case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1249       session_mq_accepted_reply_handler (session_evt_ctrl_data (wrk, elt));
1250       break;
1251     case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1252       session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1253                                                                     elt));
1254       break;
1255     case SESSION_CTRL_EVT_RESET_REPLY:
1256       session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1257       break;
1258     case SESSION_CTRL_EVT_WORKER_UPDATE:
1259       session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1260       break;
1261     case SESSION_CTRL_EVT_APP_DETACH:
1262       app_mq_detach_handler (session_evt_ctrl_data (wrk, elt));
1263       break;
1264     case SESSION_CTRL_EVT_APP_WRK_RPC:
1265       session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1266       break;
1267     default:
1268       clib_warning ("unhandled event type %d", e->event_type);
1269     }
1270
1271   /* Regrab elements in case pool moved */
1272   elt = pool_elt_at_index (wrk->event_elts, ei);
1273   if (!clib_llist_elt_is_linked (elt, evt_list))
1274     {
1275       e = &elt->evt;
1276       if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1277         session_evt_ctrl_data_free (wrk, elt);
1278       session_evt_elt_free (wrk, elt);
1279     }
1280   SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1281 }
1282
1283 always_inline void
1284 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1285                            session_evt_elt_t * elt, int *n_tx_packets)
1286 {
1287   session_main_t *smm = &session_main;
1288   app_worker_t *app_wrk;
1289   clib_llist_index_t ei;
1290   session_event_t *e;
1291   session_t *s;
1292
1293   ei = clib_llist_entry_index (wrk->event_elts, elt);
1294   e = &elt->evt;
1295
1296   switch (e->event_type)
1297     {
1298     case SESSION_IO_EVT_TX_FLUSH:
1299     case SESSION_IO_EVT_TX:
1300       s = session_event_get_session (wrk, e);
1301       if (PREDICT_FALSE (!s))
1302         break;
1303       CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
1304       wrk->ctx.s = s;
1305       /* Spray packets in per session type frames, since they go to
1306        * different nodes */
1307       (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1308       break;
1309     case SESSION_IO_EVT_RX:
1310       s = session_event_get_session (wrk, e);
1311       if (!s)
1312         break;
1313       transport_app_rx_evt (session_get_transport_proto (s),
1314                             s->connection_index, s->thread_index);
1315       break;
1316     case SESSION_IO_EVT_BUILTIN_RX:
1317       s = session_event_get_session (wrk, e);
1318       if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1319         break;
1320       svm_fifo_unset_event (s->rx_fifo);
1321       app_wrk = app_worker_get (s->app_wrk_index);
1322       app_worker_builtin_rx (app_wrk, s);
1323       break;
1324     case SESSION_IO_EVT_BUILTIN_TX:
1325       s = session_get_from_handle_if_valid (e->session_handle);
1326       wrk->ctx.s = s;
1327       if (PREDICT_TRUE (s != 0))
1328         session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
1329       break;
1330     default:
1331       clib_warning ("unhandled event type %d", e->event_type);
1332     }
1333
1334   SESSION_EVT (SESSION_IO_EVT_COUNTS, e->event_type, 1, wrk);
1335
1336   /* Regrab elements in case pool moved */
1337   elt = pool_elt_at_index (wrk->event_elts, ei);
1338   if (!clib_llist_elt_is_linked (elt, evt_list))
1339     session_evt_elt_free (wrk, elt);
1340 }
1341
1342 /* *INDENT-OFF* */
1343 static const u32 session_evt_msg_sizes[] = {
1344 #define _(symc, sym)                                                    \
1345   [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1346   foreach_session_ctrl_evt
1347 #undef _
1348 };
1349 /* *INDENT-ON* */
1350
1351 always_inline void
1352 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1353 {
1354   session_evt_elt_t *elt;
1355
1356   if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1357     {
1358       elt = session_evt_alloc_ctrl (wrk);
1359       if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1360         {
1361           elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1362           elt->evt.event_type = evt->event_type;
1363           clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1364                             session_evt_msg_sizes[evt->event_type]);
1365         }
1366       else
1367         {
1368           /* Internal control events fit into io events footprint */
1369           clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1370         }
1371     }
1372   else
1373     {
1374       elt = session_evt_alloc_new (wrk);
1375       clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1376     }
1377 }
1378
1379 static void
1380 session_flush_pending_tx_buffers (session_worker_t * wrk,
1381                                   vlib_node_runtime_t * node)
1382 {
1383   vlib_buffer_enqueue_to_next (wrk->vm, node, wrk->pending_tx_buffers,
1384                                wrk->pending_tx_nexts,
1385                                vec_len (wrk->pending_tx_nexts));
1386   vec_reset_length (wrk->pending_tx_buffers);
1387   vec_reset_length (wrk->pending_tx_nexts);
1388 }
1389
1390 static uword
1391 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1392                        vlib_frame_t * frame)
1393 {
1394   session_main_t *smm = vnet_get_session_main ();
1395   u32 thread_index = vm->thread_index, n_to_dequeue;
1396   session_worker_t *wrk = &smm->wrk[thread_index];
1397   session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1398   clib_llist_index_t ei, next_ei, old_ti;
1399   svm_msg_q_msg_t _msg, *msg = &_msg;
1400   int i = 0, n_tx_packets;
1401   session_event_t *evt;
1402   svm_msg_q_t *mq;
1403
1404   SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1405
1406   wrk->last_vlib_time = vlib_time_now (vm);
1407   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1408
1409   /*
1410    *  Update transport time
1411    */
1412   transport_update_time (wrk->last_vlib_time, thread_index);
1413   n_tx_packets = vec_len (wrk->pending_tx_buffers);
1414   SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1415
1416   /*
1417    *  Dequeue and handle new events
1418    */
1419
1420   /* Try to dequeue what is available. Don't wait for lock.
1421    * XXX: we may need priorities here */
1422   mq = wrk->vpp_event_queue;
1423   n_to_dequeue = svm_msg_q_size (mq);
1424   if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
1425     {
1426       for (i = 0; i < n_to_dequeue; i++)
1427         {
1428           svm_msg_q_sub_w_lock (mq, msg);
1429           evt = svm_msg_q_msg_data (mq, msg);
1430           session_evt_add_to_list (wrk, evt);
1431           svm_msg_q_free_msg (mq, msg);
1432         }
1433       svm_msg_q_unlock (mq);
1434     }
1435
1436   SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_to_dequeue, !i);
1437
1438   /*
1439    * Handle control events
1440    */
1441
1442   ctrl_he = pool_elt_at_index (wrk->event_elts, wrk->ctrl_head);
1443
1444   /* *INDENT-OFF* */
1445   clib_llist_foreach_safe (wrk->event_elts, evt_list, ctrl_he, elt, ({
1446     clib_llist_remove (wrk->event_elts, evt_list, elt);
1447     session_event_dispatch_ctrl (wrk, elt);
1448   }));
1449   /* *INDENT-ON* */
1450
1451   SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1452
1453   /*
1454    * Handle the new io events.
1455    */
1456
1457   new_he = pool_elt_at_index (wrk->event_elts, wrk->new_head);
1458   old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1459   old_ti = clib_llist_prev_index (old_he, evt_list);
1460
1461   ei = clib_llist_next_index (new_he, evt_list);
1462   while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
1463     {
1464       elt = pool_elt_at_index (wrk->event_elts, ei);
1465       ei = clib_llist_next_index (elt, evt_list);
1466       clib_llist_remove (wrk->event_elts, evt_list, elt);
1467       session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1468     }
1469
1470   SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1471
1472   /*
1473    * Handle the old io events, if we had any prior to processing the new ones
1474    */
1475
1476   if (old_ti != wrk->old_head)
1477     {
1478       old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1479       ei = clib_llist_next_index (old_he, evt_list);
1480
1481       while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
1482         {
1483           elt = pool_elt_at_index (wrk->event_elts, ei);
1484           next_ei = clib_llist_next_index (elt, evt_list);
1485           clib_llist_remove (wrk->event_elts, evt_list, elt);
1486
1487           session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1488
1489           if (ei == old_ti)
1490             break;
1491
1492           ei = next_ei;
1493         };
1494     }
1495
1496   SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
1497
1498   if (vec_len (wrk->pending_tx_buffers))
1499     session_flush_pending_tx_buffers (wrk, node);
1500
1501   vlib_node_increment_counter (vm, session_queue_node.index,
1502                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
1503
1504   SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1505
1506   return n_tx_packets;
1507 }
1508
1509 /* *INDENT-OFF* */
1510 VLIB_REGISTER_NODE (session_queue_node) =
1511 {
1512   .function = session_queue_node_fn,
1513   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1514   .name = "session-queue",
1515   .format_trace = format_session_queue_trace,
1516   .type = VLIB_NODE_TYPE_INPUT,
1517   .n_errors = ARRAY_LEN (session_queue_error_strings),
1518   .error_strings = session_queue_error_strings,
1519   .state = VLIB_NODE_STATE_DISABLED,
1520 };
1521 /* *INDENT-ON* */
1522
1523 static clib_error_t *
1524 session_queue_exit (vlib_main_t * vm)
1525 {
1526   if (vec_len (vlib_mains) < 2)
1527     return 0;
1528
1529   /*
1530    * Shut off (especially) worker-thread session nodes.
1531    * Otherwise, vpp can crash as the main thread unmaps the
1532    * API segment.
1533    */
1534   vlib_worker_thread_barrier_sync (vm);
1535   session_node_enable_disable (0 /* is_enable */ );
1536   vlib_worker_thread_barrier_release (vm);
1537   return 0;
1538 }
1539
1540 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1541
1542 static uword
1543 session_queue_run_on_main (vlib_main_t * vm)
1544 {
1545   vlib_node_runtime_t *node;
1546
1547   node = vlib_node_get_runtime (vm, session_queue_node.index);
1548   return session_queue_node_fn (vm, node, 0);
1549 }
1550
1551 static uword
1552 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1553                        vlib_frame_t * f)
1554 {
1555   uword *event_data = 0;
1556   f64 timeout = 1.0;
1557   uword event_type;
1558
1559   while (1)
1560     {
1561       vlib_process_wait_for_event_or_clock (vm, timeout);
1562       event_type = vlib_process_get_events (vm, (uword **) & event_data);
1563
1564       switch (event_type)
1565         {
1566         case SESSION_Q_PROCESS_RUN_ON_MAIN:
1567           /* Run session queue node on main thread */
1568           session_queue_run_on_main (vm);
1569           break;
1570         case SESSION_Q_PROCESS_STOP:
1571           vlib_node_set_state (vm, session_queue_process_node.index,
1572                                VLIB_NODE_STATE_DISABLED);
1573           timeout = 100000.0;
1574           break;
1575         case ~0:
1576           /* Timed out. Run on main to ensure all events are handled */
1577           session_queue_run_on_main (vm);
1578           break;
1579         }
1580       vec_reset_length (event_data);
1581     }
1582   return 0;
1583 }
1584
1585 /* *INDENT-OFF* */
1586 VLIB_REGISTER_NODE (session_queue_process_node) =
1587 {
1588   .function = session_queue_process,
1589   .type = VLIB_NODE_TYPE_PROCESS,
1590   .name = "session-queue-process",
1591   .state = VLIB_NODE_STATE_DISABLED,
1592 };
1593 /* *INDENT-ON* */
1594
1595 static_always_inline uword
1596 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1597                                 vlib_frame_t * frame)
1598 {
1599   session_main_t *sm = &session_main;
1600   if (!sm->wrk[0].vpp_event_queue)
1601     return 0;
1602   node = vlib_node_get_runtime (vm, session_queue_node.index);
1603   return session_queue_node_fn (vm, node, frame);
1604 }
1605
1606 /* *INDENT-OFF* */
1607 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1608 {
1609   .function = session_queue_pre_input_inline,
1610   .type = VLIB_NODE_TYPE_PRE_INPUT,
1611   .name = "session-queue-main",
1612   .state = VLIB_NODE_STATE_DISABLED,
1613 };
1614 /* *INDENT-ON* */
1615
1616 /*
1617  * fd.io coding-style-patch-verification: ON
1618  *
1619  * Local Variables:
1620  * eval: (c-set-style "gnu")
1621  * End:
1622  */