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