src/vnet/session/session_node.c

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