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