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