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