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