src/vnet/session/session_node.c

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