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