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