src/vnet/session/session_node.c

   1 /*
   2  * Copyright (c) 2017 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/session_debug.h>
  25 #include <svm/queue.h>
  26
  27 static void
  28 session_mq_accepted_reply_handler (void *data)
  29 {
  30   session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
  31   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
  32   stream_session_state_t old_state;
  33   app_worker_t *app_wrk;
  34   local_session_t *ls;
  35   stream_session_t *s;
  36
  37   /* Server isn't interested, kill the session */
  38   if (mp->retval)
  39     {
  40       a->app_index = mp->context;
  41       a->handle = mp->handle;
  42       vnet_disconnect_session (a);
  43       return;
  44     }
  45
  46   if (session_handle_is_local (mp->handle))
  47     {
  48       ls = application_get_local_session_from_handle (mp->handle);
  49       if (!ls)
  50         {
  51           clib_warning ("unknown local handle 0x%lx", mp->handle);
  52           return;
  53         }
  54       app_wrk = app_worker_get (ls->app_wrk_index);
  55       if (app_wrk->app_index != mp->context)
  56         {
  57           clib_warning ("server %u doesn't own local handle 0x%lx",
  58                         mp->context, mp->handle);
  59           return;
  60         }
  61       if (application_local_session_connect_notify (ls))
  62         return;
  63       ls->session_state = SESSION_STATE_READY;
  64     }
  65   else
  66     {
  67       s = session_get_from_handle_if_valid (mp->handle);
  68       if (!s)
  69         return;
  70
  71       app_wrk = app_worker_get (s->app_wrk_index);
  72       if (app_wrk->app_index != mp->context)
  73         {
  74           clib_warning ("app doesn't own session");
  75           return;
  76         }
  77
  78       old_state = s->session_state;
  79       s->session_state = SESSION_STATE_READY;
  80       if (!svm_fifo_is_empty (s->server_rx_fifo))
  81         app_worker_lock_and_send_event (app_wrk, s, FIFO_EVENT_APP_RX);
  82
  83       /* Closed while waiting for app to reply. Resend disconnect */
  84       if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
  85         {
  86           application_t *app = application_get (app_wrk->app_index);
  87           app->cb_fns.session_disconnect_callback (s);
  88           s->session_state = old_state;
  89           return;
  90         }
  91     }
  92 }
  93
  94 static void
  95 session_mq_reset_reply_handler (void *data)
  96 {
  97   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
  98   session_reset_reply_msg_t *mp;
  99   app_worker_t *app_wrk;
 100   stream_session_t *s;
 101   application_t *app;
 102   u32 index, thread_index;
 103
 104   mp = (session_reset_reply_msg_t *) data;
 105   app = application_lookup (mp->context);
 106   if (!app)
 107     return;
 108
 109   session_parse_handle (mp->handle, &index, &thread_index);
 110   s = session_get_if_valid (index, thread_index);
 111
 112   /* Session was already closed or already cleaned up */
 113   if (!s || s->session_state != SESSION_STATE_TRANSPORT_CLOSING)
 114     return;
 115
 116   app_wrk = app_worker_get (s->app_wrk_index);
 117   if (!app_wrk || app_wrk->app_index != app->app_index)
 118     {
 119       clib_warning ("App % does not own handle 0x%lx!", app->app_index,
 120                     mp->handle);
 121       return;
 122     }
 123
 124   /* Client objected to resetting the session, log and continue */
 125   if (mp->retval)
 126     {
 127       clib_warning ("client retval %d", mp->retval);
 128       return;
 129     }
 130
 131   /* This comes as a response to a reset, transport only waiting for
 132    * confirmation to remove connection state, no need to disconnect */
 133   a->handle = mp->handle;
 134   a->app_index = app->app_index;
 135   vnet_disconnect_session (a);
 136 }
 137
 138 static void
 139 session_mq_disconnected_handler (void *data)
 140 {
 141   session_disconnected_reply_msg_t *rmp;
 142   vnet_disconnect_args_t _a, *a = &_a;
 143   svm_msg_q_msg_t _msg, *msg = &_msg;
 144   session_disconnected_msg_t *mp;
 145   app_worker_t *app_wrk;
 146   session_event_t *evt;
 147   stream_session_t *s;
 148   application_t *app;
 149   int rv = 0;
 150
 151   mp = (session_disconnected_msg_t *) data;
 152   if (!(s = session_get_from_handle_if_valid (mp->handle)))
 153     {
 154       clib_warning ("could not disconnect handle %llu", mp->handle);
 155       return;
 156     }
 157   app_wrk = app_worker_get (s->app_wrk_index);
 158   app = application_lookup (mp->client_index);
 159   if (!(app_wrk && app && app->app_index == app_wrk->app_index))
 160     {
 161       clib_warning ("could not disconnect session: %llu app: %u",
 162                     mp->handle, mp->client_index);
 163       return;
 164     }
 165
 166   a->handle = mp->handle;
 167   a->app_index = app_wrk->wrk_index;
 168   rv = vnet_disconnect_session (a);
 169
 170   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
 171                                        SESSION_MQ_CTRL_EVT_RING,
 172                                        SVM_Q_WAIT, msg);
 173   svm_msg_q_unlock (app_wrk->event_queue);
 174   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
 175   clib_memset (evt, 0, sizeof (*evt));
 176   evt->event_type = SESSION_CTRL_EVT_DISCONNECTED;
 177   rmp = (session_disconnected_reply_msg_t *) evt->data;
 178   rmp->handle = mp->handle;
 179   rmp->context = mp->context;
 180   rmp->retval = rv;
 181   svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
 182 }
 183
 184 static void
 185 session_mq_disconnected_reply_handler (void *data)
 186 {
 187   session_disconnected_reply_msg_t *mp;
 188   vnet_disconnect_args_t _a, *a = &_a;
 189   application_t *app;
 190
 191   mp = (session_disconnected_reply_msg_t *) data;
 192
 193   /* Client objected to disconnecting the session, log and continue */
 194   if (mp->retval)
 195     {
 196       clib_warning ("client retval %d", mp->retval);
 197       return;
 198     }
 199
 200   /* Disconnect has been confirmed. Confirm close to transport */
 201   app = application_lookup (mp->context);
 202   if (app)
 203     {
 204       a->handle = mp->handle;
 205       a->app_index = app->app_index;
 206       vnet_disconnect_session (a);
 207     }
 208 }
 209
 210 vlib_node_registration_t session_queue_node;
 211
 212 typedef struct
 213 {
 214   u32 session_index;
 215   u32 server_thread_index;
 216 } session_queue_trace_t;
 217
 218 /* packet trace format function */
 219 static u8 *
 220 format_session_queue_trace (u8 * s, va_list * args)
 221 {
 222   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
 223   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
 224   session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
 225
 226   s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
 227               t->session_index, t->server_thread_index);
 228   return s;
 229 }
 230
 231 #define foreach_session_queue_error             \
 232 _(TX, "Packets transmitted")                    \
 233 _(TIMER, "Timer events")                        \
 234 _(NO_BUFFER, "Out of buffers")
 235
 236 typedef enum
 237 {
 238 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
 239   foreach_session_queue_error
 240 #undef _
 241     SESSION_QUEUE_N_ERROR,
 242 } session_queue_error_t;
 243
 244 static char *session_queue_error_strings[] = {
 245 #define _(sym,string) string,
 246   foreach_session_queue_error
 247 #undef _
 248 };
 249
 250 enum
 251 {
 252   SESSION_TX_NO_BUFFERS = -2,
 253   SESSION_TX_NO_DATA,
 254   SESSION_TX_OK
 255 };
 256
 257 static void
 258 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
 259                         u32 next_index, u32 * to_next, u16 n_segs,
 260                         stream_session_t * s, u32 n_trace)
 261 {
 262   session_queue_trace_t *t;
 263   vlib_buffer_t *b;
 264   int i;
 265
 266   for (i = 0; i < clib_min (n_trace, n_segs); i++)
 267     {
 268       b = vlib_get_buffer (vm, to_next[i - n_segs]);
 269       vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
 270       t = vlib_add_trace (vm, node, b, sizeof (*t));
 271       t->session_index = s->session_index;
 272       t->server_thread_index = s->thread_index;
 273     }
 274   vlib_set_trace_count (vm, node, n_trace - i);
 275 }
 276
 277 always_inline void
 278 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
 279                             vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
 280 {
 281   vlib_buffer_t *chain_b, *prev_b;
 282   u32 chain_bi0, to_deq, left_from_seg;
 283   session_manager_worker_t *wrk;
 284   u16 len_to_deq, n_bytes_read;
 285   u8 *data, j;
 286
 287   wrk = session_manager_get_worker (ctx->s->thread_index);
 288   b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 289   b->total_length_not_including_first_buffer = 0;
 290
 291   chain_b = b;
 292   left_from_seg = clib_min (ctx->snd_mss - b->current_length,
 293                             ctx->left_to_snd);
 294   to_deq = left_from_seg;
 295   for (j = 1; j < ctx->n_bufs_per_seg; j++)
 296     {
 297       prev_b = chain_b;
 298       len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
 299
 300       *n_bufs -= 1;
 301       chain_bi0 = wrk->tx_buffers[*n_bufs];
 302       _vec_len (wrk->tx_buffers) = *n_bufs;
 303
 304       chain_b = vlib_get_buffer (vm, chain_bi0);
 305       chain_b->current_data = 0;
 306       data = vlib_buffer_get_current (chain_b);
 307       if (peek_data)
 308         {
 309           n_bytes_read = svm_fifo_peek (ctx->s->server_tx_fifo,
 310                                         ctx->tx_offset, len_to_deq, data);
 311           ctx->tx_offset += n_bytes_read;
 312         }
 313       else
 314         {
 315           if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
 316             {
 317               svm_fifo_t *f = ctx->s->server_tx_fifo;
 318               session_dgram_hdr_t *hdr = &ctx->hdr;
 319               u16 deq_now;
 320               deq_now = clib_min (hdr->data_length - hdr->data_offset,
 321                                   len_to_deq);
 322               n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
 323                                             data);
 324               ASSERT (n_bytes_read > 0);
 325
 326               hdr->data_offset += n_bytes_read;
 327               if (hdr->data_offset == hdr->data_length)
 328                 {
 329                   u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
 330                   svm_fifo_dequeue_drop (f, offset);
 331                 }
 332             }
 333           else
 334             n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->server_tx_fifo,
 335                                                     len_to_deq, data);
 336         }
 337       ASSERT (n_bytes_read == len_to_deq);
 338       chain_b->current_length = n_bytes_read;
 339       b->total_length_not_including_first_buffer += chain_b->current_length;
 340
 341       /* update previous buffer */
 342       prev_b->next_buffer = chain_bi0;
 343       prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 344
 345       /* update current buffer */
 346       chain_b->next_buffer = 0;
 347
 348       to_deq -= n_bytes_read;
 349       if (to_deq == 0)
 350         break;
 351     }
 352   ASSERT (to_deq == 0
 353           && b->total_length_not_including_first_buffer == left_from_seg);
 354   ctx->left_to_snd -= left_from_seg;
 355 }
 356
 357 always_inline int
 358 session_output_try_get_buffers (vlib_main_t * vm,
 359                                 session_manager_worker_t * wrk,
 360                                 u32 thread_index, u16 * n_bufs, u32 wanted)
 361 {
 362   u32 n_alloc;
 363   vec_validate_aligned (wrk->tx_buffers, wanted - 1, CLIB_CACHE_LINE_BYTES);
 364   n_alloc = vlib_buffer_alloc (vm, &wrk->tx_buffers[*n_bufs],
 365                                wanted - *n_bufs);
 366   *n_bufs += n_alloc;
 367   _vec_len (wrk->tx_buffers) = *n_bufs;
 368   return n_alloc;
 369 }
 370
 371 always_inline void
 372 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
 373                         vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
 374 {
 375   u32 len_to_deq;
 376   u8 *data0;
 377   int n_bytes_read;
 378
 379   /*
 380    * Start with the first buffer in chain
 381    */
 382   b->error = 0;
 383   b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
 384   b->current_data = 0;
 385
 386   data0 = vlib_buffer_make_headroom (b, MAX_HDRS_LEN);
 387   len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
 388
 389   if (peek_data)
 390     {
 391       n_bytes_read = svm_fifo_peek (ctx->s->server_tx_fifo, ctx->tx_offset,
 392                                     len_to_deq, data0);
 393       ASSERT (n_bytes_read > 0);
 394       /* Keep track of progress locally, transport is also supposed to
 395        * increment it independently when pushing the header */
 396       ctx->tx_offset += n_bytes_read;
 397     }
 398   else
 399     {
 400       if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
 401         {
 402           session_dgram_hdr_t *hdr = &ctx->hdr;
 403           svm_fifo_t *f = ctx->s->server_tx_fifo;
 404           u16 deq_now;
 405           u32 offset;
 406
 407           ASSERT (hdr->data_length > hdr->data_offset);
 408           deq_now = clib_min (hdr->data_length - hdr->data_offset,
 409                               len_to_deq);
 410           offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
 411           n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
 412           ASSERT (n_bytes_read > 0);
 413
 414           if (ctx->s->session_state == SESSION_STATE_LISTENING)
 415             {
 416               ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
 417               ctx->tc->rmt_port = hdr->rmt_port;
 418             }
 419           hdr->data_offset += n_bytes_read;
 420           if (hdr->data_offset == hdr->data_length)
 421             {
 422               offset = hdr->data_length + SESSION_CONN_HDR_LEN;
 423               svm_fifo_dequeue_drop (f, offset);
 424             }
 425         }
 426       else
 427         {
 428           n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->server_tx_fifo,
 429                                                   len_to_deq, data0);
 430           ASSERT (n_bytes_read > 0);
 431         }
 432     }
 433   b->current_length = n_bytes_read;
 434   ctx->left_to_snd -= n_bytes_read;
 435
 436   /*
 437    * Fill in the remaining buffers in the chain, if any
 438    */
 439   if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
 440     session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
 441
 442   /* *INDENT-OFF* */
 443   SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
 444         ed->data[0] = FIFO_EVENT_APP_TX;
 445         ed->data[1] = ctx->max_dequeue;
 446         ed->data[2] = len_to_deq;
 447         ed->data[3] = ctx->left_to_snd;
 448   }));
 449   /* *INDENT-ON* */
 450 }
 451
 452 always_inline u8
 453 session_tx_not_ready (stream_session_t * s, u8 peek_data)
 454 {
 455   if (peek_data)
 456     {
 457       /* Can retransmit for closed sessions but can't send new data if
 458        * session is not ready or closed */
 459       if (s->session_state < SESSION_STATE_READY)
 460         return 1;
 461       if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
 462         return 2;
 463     }
 464   return 0;
 465 }
 466
 467 always_inline transport_connection_t *
 468 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
 469 {
 470   if (peek_data)
 471     {
 472       return ctx->transport_vft->get_connection (ctx->s->connection_index,
 473                                                  ctx->s->thread_index);
 474     }
 475   else
 476     {
 477       if (ctx->s->session_state == SESSION_STATE_LISTENING)
 478         return ctx->transport_vft->get_listener (ctx->s->connection_index);
 479       else
 480         {
 481           return ctx->transport_vft->get_connection (ctx->s->connection_index,
 482                                                      ctx->s->thread_index);
 483         }
 484     }
 485 }
 486
 487 always_inline void
 488 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
 489                                u32 max_segs, u8 peek_data)
 490 {
 491   u32 n_bytes_per_buf, n_bytes_per_seg;
 492   ctx->max_dequeue = svm_fifo_max_dequeue (ctx->s->server_tx_fifo);
 493   if (peek_data)
 494     {
 495       /* Offset in rx fifo from where to peek data */
 496       ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
 497       if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
 498         {
 499           ctx->max_len_to_snd = 0;
 500           return;
 501         }
 502       ctx->max_dequeue -= ctx->tx_offset;
 503     }
 504   else
 505     {
 506       if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
 507         {
 508           if (ctx->max_dequeue <= sizeof (ctx->hdr))
 509             {
 510               ctx->max_len_to_snd = 0;
 511               return;
 512             }
 513           svm_fifo_peek (ctx->s->server_tx_fifo, 0, sizeof (ctx->hdr),
 514                          (u8 *) & ctx->hdr);
 515           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
 516           ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
 517         }
 518     }
 519   ASSERT (ctx->max_dequeue > 0);
 520
 521   /* Ensure we're not writing more than transport window allows */
 522   if (ctx->max_dequeue < ctx->snd_space)
 523     {
 524       /* Constrained by tx queue. Try to send only fully formed segments */
 525       ctx->max_len_to_snd =
 526         (ctx->max_dequeue > ctx->snd_mss) ?
 527         ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
 528       /* TODO Nagle ? */
 529     }
 530   else
 531     {
 532       /* Expectation is that snd_space0 is already a multiple of snd_mss */
 533       ctx->max_len_to_snd = ctx->snd_space;
 534     }
 535
 536   /* Check if we're tx constrained by the node */
 537   ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
 538   if (ctx->n_segs_per_evt > max_segs)
 539     {
 540       ctx->n_segs_per_evt = max_segs;
 541       ctx->max_len_to_snd = max_segs * ctx->snd_mss;
 542     }
 543
 544   n_bytes_per_buf = VLIB_BUFFER_DATA_SIZE;
 545   ASSERT (n_bytes_per_buf > MAX_HDRS_LEN);
 546   n_bytes_per_seg = MAX_HDRS_LEN + ctx->snd_mss;
 547   ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
 548   ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
 549   ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
 550                                      n_bytes_per_buf - MAX_HDRS_LEN);
 551 }
 552
 553 always_inline int
 554 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
 555                                 session_event_t * e,
 556                                 stream_session_t * s, int *n_tx_packets,
 557                                 u8 peek_data)
 558 {
 559   u32 next_index, next0, next1, *to_next, n_left_to_next;
 560   u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
 561   u32 thread_index = s->thread_index, n_left, pbi;
 562   session_manager_main_t *smm = &session_manager_main;
 563   session_manager_worker_t *wrk = &smm->wrk[thread_index];
 564   session_tx_context_t *ctx = &wrk->ctx;
 565   transport_proto_t tp;
 566   vlib_buffer_t *pb;
 567   u16 n_bufs, rv;
 568
 569   if (PREDICT_FALSE ((rv = session_tx_not_ready (s, peek_data))))
 570     {
 571       if (rv < 2)
 572         vec_add1 (wrk->pending_event_vector, *e);
 573       return SESSION_TX_NO_DATA;
 574     }
 575
 576   next_index = smm->session_type_to_next[s->session_type];
 577   next0 = next1 = next_index;
 578
 579   tp = session_get_transport_proto (s);
 580   ctx->s = s;
 581   ctx->transport_vft = transport_protocol_get_vft (tp);
 582   ctx->tc = session_tx_get_transport (ctx, peek_data);
 583   ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
 584
 585   if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
 586     {
 587       if (ctx->transport_vft->flush_data)
 588         ctx->transport_vft->flush_data (ctx->tc);
 589     }
 590
 591   ctx->snd_space = transport_connection_snd_space (ctx->tc,
 592                                                    vm->clib_time.
 593                                                    last_cpu_time,
 594                                                    ctx->snd_mss);
 595   if (ctx->snd_space == 0 || ctx->snd_mss == 0)
 596     {
 597       vec_add1 (wrk->pending_event_vector, *e);
 598       return SESSION_TX_NO_DATA;
 599     }
 600
 601   /* Allow enqueuing of a new event */
 602   svm_fifo_unset_event (s->server_tx_fifo);
 603
 604   /* Check how much we can pull. */
 605   session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
 606                                  peek_data);
 607
 608   if (PREDICT_FALSE (!ctx->max_len_to_snd))
 609     return SESSION_TX_NO_DATA;
 610
 611   n_bufs = vec_len (wrk->tx_buffers);
 612   n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
 613
 614   /*
 615    * Make sure we have at least one full frame of buffers ready
 616    */
 617   if (n_bufs < n_bufs_needed)
 618     {
 619       session_output_try_get_buffers (vm, wrk, thread_index, &n_bufs,
 620                                       ctx->n_bufs_per_seg * VLIB_FRAME_SIZE);
 621       if (PREDICT_FALSE (n_bufs < n_bufs_needed))
 622         {
 623           vec_add1 (wrk->pending_event_vector, *e);
 624           return SESSION_TX_NO_BUFFERS;
 625         }
 626     }
 627
 628   /*
 629    * Write until we fill up a frame
 630    */
 631   vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 632   if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
 633     {
 634       ctx->n_segs_per_evt = n_left_to_next;
 635       ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
 636     }
 637   ctx->left_to_snd = ctx->max_len_to_snd;
 638   n_left = ctx->n_segs_per_evt;
 639
 640   while (n_left >= 4)
 641     {
 642       vlib_buffer_t *b0, *b1;
 643       u32 bi0, bi1;
 644
 645       pbi = wrk->tx_buffers[n_bufs - 3];
 646       pb = vlib_get_buffer (vm, pbi);
 647       vlib_prefetch_buffer_header (pb, STORE);
 648       pbi = wrk->tx_buffers[n_bufs - 4];
 649       pb = vlib_get_buffer (vm, pbi);
 650       vlib_prefetch_buffer_header (pb, STORE);
 651
 652       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
 653       to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
 654
 655       b0 = vlib_get_buffer (vm, bi0);
 656       b1 = vlib_get_buffer (vm, bi1);
 657
 658       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
 659       session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
 660
 661       ctx->transport_vft->push_header (ctx->tc, b0);
 662       ctx->transport_vft->push_header (ctx->tc, b1);
 663
 664       to_next += 2;
 665       n_left_to_next -= 2;
 666       n_left -= 2;
 667
 668       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
 669       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
 670
 671       vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
 672                                        n_left_to_next, bi0, bi1, next0,
 673                                        next1);
 674     }
 675   while (n_left)
 676     {
 677       vlib_buffer_t *b0;
 678       u32 bi0;
 679
 680       if (n_left > 1)
 681         {
 682           pbi = wrk->tx_buffers[n_bufs - 2];
 683           pb = vlib_get_buffer (vm, pbi);
 684           vlib_prefetch_buffer_header (pb, STORE);
 685         }
 686
 687       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
 688       b0 = vlib_get_buffer (vm, bi0);
 689       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
 690
 691       /* Ask transport to push header after current_length and
 692        * total_length_not_including_first_buffer are updated */
 693       ctx->transport_vft->push_header (ctx->tc, b0);
 694
 695       to_next += 1;
 696       n_left_to_next -= 1;
 697       n_left -= 1;
 698
 699       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
 700
 701       vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 702                                        n_left_to_next, bi0, next0);
 703     }
 704
 705   if (PREDICT_FALSE (n_trace > 0))
 706     session_tx_trace_frame (vm, node, next_index, to_next,
 707                             ctx->n_segs_per_evt, s, n_trace);
 708
 709   _vec_len (wrk->tx_buffers) = n_bufs;
 710   *n_tx_packets += ctx->n_segs_per_evt;
 711   transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
 712   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 713
 714   /* If we couldn't dequeue all bytes mark as partially read */
 715   ASSERT (ctx->left_to_snd == 0);
 716   if (ctx->max_len_to_snd < ctx->max_dequeue)
 717     if (svm_fifo_set_event (s->server_tx_fifo))
 718       vec_add1 (wrk->pending_event_vector, *e);
 719
 720   if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
 721     {
 722       /* Fix dgram pre header */
 723       if (ctx->max_len_to_snd < ctx->max_dequeue)
 724         svm_fifo_overwrite_head (s->server_tx_fifo, (u8 *) & ctx->hdr,
 725                                  sizeof (session_dgram_pre_hdr_t));
 726       /* More data needs to be read */
 727       else if (svm_fifo_max_dequeue (s->server_tx_fifo) > 0)
 728         if (svm_fifo_set_event (s->server_tx_fifo))
 729           vec_add1 (wrk->pending_event_vector, *e);
 730     }
 731   return SESSION_TX_OK;
 732 }
 733
 734 int
 735 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
 736                               session_event_t * e,
 737                               stream_session_t * s, int *n_tx_pkts)
 738 {
 739   return session_tx_fifo_read_and_snd_i (vm, node, e, s, n_tx_pkts, 1);
 740 }
 741
 742 int
 743 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
 744                                  session_event_t * e,
 745                                  stream_session_t * s, int *n_tx_pkts)
 746 {
 747   return session_tx_fifo_read_and_snd_i (vm, node, e, s, n_tx_pkts, 0);
 748 }
 749
 750 int
 751 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
 752                                   vlib_node_runtime_t * node,
 753                                   session_event_t * e,
 754                                   stream_session_t * s, int *n_tx_pkts)
 755 {
 756   application_t *app;
 757   if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
 758     return 0;
 759   app = application_get (s->t_app_index);
 760   svm_fifo_unset_event (s->server_tx_fifo);
 761   return app->cb_fns.builtin_app_tx_callback (s);
 762 }
 763
 764 always_inline stream_session_t *
 765 session_event_get_session (session_event_t * e, u8 thread_index)
 766 {
 767   return session_get_if_valid (e->fifo->master_session_index, thread_index);
 768 }
 769
 770 static void
 771 session_update_dispatch_period (session_manager_worker_t * wrk, f64 now,
 772                                 u32 thread_index)
 773 {
 774   if (wrk->last_tx_packets)
 775     {
 776       f64 sample = now - wrk->last_vlib_time;
 777       wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
 778     }
 779   wrk->last_vlib_time = now;
 780 }
 781
 782 static uword
 783 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 784                        vlib_frame_t * frame)
 785 {
 786   session_manager_main_t *smm = vnet_get_session_manager_main ();
 787   u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
 788   session_manager_worker_t *wrk = &smm->wrk[thread_index];
 789   session_event_t *e, *fifo_events;
 790   svm_msg_q_msg_t _msg, *msg = &_msg;
 791   f64 now = vlib_time_now (vm);
 792   int n_tx_packets = 0, i, rv;
 793   app_worker_t *app_wrk;
 794   application_t *app;
 795   svm_msg_q_t *mq;
 796   void (*fp) (void *);
 797
 798   SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, thread_index);
 799
 800   /*
 801    *  Update transport time
 802    */
 803   session_update_dispatch_period (wrk, now, thread_index);
 804   transport_update_time (now, thread_index);
 805
 806   SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
 807
 808   /* Make sure postponed events are handled first */
 809   fifo_events = wrk->free_event_vector;
 810   vec_append (fifo_events, wrk->postponed_event_vector);
 811   _vec_len (wrk->postponed_event_vector) = 0;
 812
 813   /* Try to dequeue what is available. Don't wait for lock.
 814    * XXX: we may need priorities here */
 815   mq = wrk->vpp_event_queue;
 816   n_to_dequeue = svm_msg_q_size (mq);
 817   if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
 818     {
 819       for (i = 0; i < n_to_dequeue; i++)
 820         {
 821           vec_add2 (fifo_events, e, 1);
 822           svm_msg_q_sub_w_lock (mq, msg);
 823           /* Works because reply messages are smaller than a session evt.
 824            * If we ever need to support bigger messages this needs to be
 825            * fixed */
 826           clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), sizeof (*e));
 827           svm_msg_q_free_msg (mq, msg);
 828         }
 829       svm_msg_q_unlock (mq);
 830     }
 831
 832   vec_append (fifo_events, wrk->pending_event_vector);
 833   vec_append (fifo_events, wrk->pending_disconnects);
 834
 835   _vec_len (wrk->pending_event_vector) = 0;
 836   _vec_len (wrk->pending_disconnects) = 0;
 837
 838   n_events = vec_len (fifo_events);
 839   if (PREDICT_FALSE (!n_events))
 840     return 0;
 841
 842   for (i = 0; i < n_events; i++)
 843     {
 844       stream_session_t *s;      /* $$$ prefetch 1 ahead maybe */
 845       session_event_t *e;
 846       u8 want_tx_evt;
 847
 848       e = &fifo_events[i];
 849       switch (e->event_type)
 850         {
 851         case SESSION_IO_EVT_TX_FLUSH:
 852         case FIFO_EVENT_APP_TX:
 853           /* Don't try to send more that one frame per dispatch cycle */
 854           if (n_tx_packets == VLIB_FRAME_SIZE)
 855             {
 856               vec_add1 (wrk->postponed_event_vector, *e);
 857               break;
 858             }
 859
 860           s = session_event_get_session (e, thread_index);
 861           if (PREDICT_FALSE (!s))
 862             {
 863               clib_warning ("session was freed!");
 864               continue;
 865             }
 866
 867           want_tx_evt = svm_fifo_want_tx_evt (s->server_tx_fifo);
 868           /* Spray packets in per session type frames, since they go to
 869            * different nodes */
 870           rv = (smm->session_tx_fns[s->session_type]) (vm, node, e, s,
 871                                                        &n_tx_packets);
 872           if (PREDICT_TRUE (rv == SESSION_TX_OK))
 873             {
 874               if (PREDICT_FALSE (want_tx_evt))
 875                 {
 876                   svm_fifo_set_want_tx_evt (s->server_tx_fifo, 0);
 877                   session_dequeue_notify (s);
 878                 }
 879             }
 880           else if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
 881             {
 882               vlib_node_increment_counter (vm, node->node_index,
 883                                            SESSION_QUEUE_ERROR_NO_BUFFER, 1);
 884               continue;
 885             }
 886           break;
 887         case FIFO_EVENT_DISCONNECT:
 888           s = session_get_from_handle_if_valid (e->session_handle);
 889           if (PREDICT_FALSE (!s))
 890             break;
 891
 892           /* Make sure session disconnects run after the pending list is
 893            * drained, i.e., postpone if the first time. If not the first
 894            * and the tx queue is still not empty, try to wait for some
 895            * dispatch cycles */
 896           if (!e->postponed
 897               || (e->postponed < 200
 898                   && svm_fifo_max_dequeue (s->server_tx_fifo)))
 899             {
 900               e->postponed += 1;
 901               vec_add1 (wrk->pending_disconnects, *e);
 902               continue;
 903             }
 904
 905           session_transport_close (s);
 906           break;
 907         case FIFO_EVENT_BUILTIN_RX:
 908           s = session_event_get_session (e, thread_index);
 909           if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
 910             continue;
 911           svm_fifo_unset_event (s->server_rx_fifo);
 912           app_wrk = app_worker_get (s->app_wrk_index);
 913           app = application_get (app_wrk->app_index);
 914           app->cb_fns.builtin_app_rx_callback (s);
 915           break;
 916         case FIFO_EVENT_BUILTIN_TX:
 917           s = session_get_from_handle_if_valid (e->session_handle);
 918           if (PREDICT_TRUE (s != 0))
 919             session_tx_fifo_dequeue_internal (vm, node, e, s, &n_tx_packets);
 920           break;
 921         case FIFO_EVENT_RPC:
 922           fp = e->rpc_args.fp;
 923           (*fp) (e->rpc_args.arg);
 924           break;
 925         case SESSION_CTRL_EVT_DISCONNECTED:
 926           session_mq_disconnected_handler (e->data);
 927           break;
 928         case SESSION_CTRL_EVT_ACCEPTED_REPLY:
 929           session_mq_accepted_reply_handler (e->data);
 930           break;
 931         case SESSION_CTRL_EVT_CONNECTED_REPLY:
 932           break;
 933         case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
 934           session_mq_disconnected_reply_handler (e->data);
 935           break;
 936         case SESSION_CTRL_EVT_RESET_REPLY:
 937           session_mq_reset_reply_handler (e->data);
 938           break;
 939         default:
 940           clib_warning ("unhandled event type %d", e->event_type);
 941         }
 942     }
 943
 944   _vec_len (fifo_events) = 0;
 945   wrk->free_event_vector = fifo_events;
 946   wrk->last_tx_packets = n_tx_packets;
 947
 948   vlib_node_increment_counter (vm, session_queue_node.index,
 949                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
 950
 951   SESSION_EVT_DBG (SESSION_EVT_DISPATCH_END, smm, thread_index);
 952
 953   return n_tx_packets;
 954 }
 955
 956 /* *INDENT-OFF* */
 957 VLIB_REGISTER_NODE (session_queue_node) =
 958 {
 959   .function = session_queue_node_fn,
 960   .name = "session-queue",
 961   .format_trace = format_session_queue_trace,
 962   .type = VLIB_NODE_TYPE_INPUT,
 963   .n_errors = ARRAY_LEN (session_queue_error_strings),
 964   .error_strings = session_queue_error_strings,
 965   .state = VLIB_NODE_STATE_DISABLED,
 966 };
 967 /* *INDENT-ON* */
 968
 969 void
 970 dump_thread_0_event_queue (void)
 971 {
 972   session_manager_main_t *smm = vnet_get_session_manager_main ();
 973   vlib_main_t *vm = &vlib_global_main;
 974   u32 my_thread_index = vm->thread_index;
 975   session_event_t _e, *e = &_e;
 976   svm_msg_q_ring_t *ring;
 977   stream_session_t *s0;
 978   svm_msg_q_msg_t *msg;
 979   svm_msg_q_t *mq;
 980   int i, index;
 981
 982   mq = smm->wrk[my_thread_index].vpp_event_queue;
 983   index = mq->q->head;
 984
 985   for (i = 0; i < mq->q->cursize; i++)
 986     {
 987       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
 988       ring = svm_msg_q_ring (mq, msg->ring_index);
 989       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
 990
 991       switch (e->event_type)
 992         {
 993         case FIFO_EVENT_APP_TX:
 994           s0 = session_event_get_session (e, my_thread_index);
 995           fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
 996           break;
 997
 998         case FIFO_EVENT_DISCONNECT:
 999           s0 = session_get_from_handle (e->session_handle);
1000           fformat (stdout, "[%04d] disconnect session %d\n", i,
1001                    s0->session_index);
1002           break;
1003
1004         case FIFO_EVENT_BUILTIN_RX:
1005           s0 = session_event_get_session (e, my_thread_index);
1006           fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1007           break;
1008
1009         case FIFO_EVENT_RPC:
1010           fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1011                    i, (u64) (uword) (e->rpc_args.fp),
1012                    (u64) (uword) (e->rpc_args.arg));
1013           break;
1014
1015         default:
1016           fformat (stdout, "[%04d] unhandled event type %d\n",
1017                    i, e->event_type);
1018           break;
1019         }
1020
1021       index++;
1022
1023       if (index == mq->q->maxsize)
1024         index = 0;
1025     }
1026 }
1027
1028 static u8
1029 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1030 {
1031   stream_session_t *s;
1032   switch (e->event_type)
1033     {
1034     case FIFO_EVENT_APP_RX:
1035     case FIFO_EVENT_APP_TX:
1036     case FIFO_EVENT_BUILTIN_RX:
1037       if (e->fifo == f)
1038         return 1;
1039       break;
1040     case FIFO_EVENT_DISCONNECT:
1041       break;
1042     case FIFO_EVENT_RPC:
1043       s = session_get_from_handle (e->session_handle);
1044       if (!s)
1045         {
1046           clib_warning ("session has event but doesn't exist!");
1047           break;
1048         }
1049       if (s->server_rx_fifo == f || s->server_tx_fifo == f)
1050         return 1;
1051       break;
1052     default:
1053       break;
1054     }
1055   return 0;
1056 }
1057
1058 u8
1059 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1060 {
1061   session_event_t *pending_event_vector, *evt;
1062   session_manager_worker_t *wrk;
1063   int i, index, found = 0;
1064   svm_msg_q_msg_t *msg;
1065   svm_msg_q_ring_t *ring;
1066   svm_msg_q_t *mq;
1067   u8 thread_index;
1068
1069   ASSERT (e);
1070   thread_index = f->master_thread_index;
1071   wrk = session_manager_get_worker (thread_index);
1072
1073   /*
1074    * Search evt queue
1075    */
1076   mq = wrk->vpp_event_queue;
1077   index = mq->q->head;
1078   for (i = 0; i < mq->q->cursize; i++)
1079     {
1080       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1081       ring = svm_msg_q_ring (mq, msg->ring_index);
1082       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1083       found = session_node_cmp_event (e, f);
1084       if (found)
1085         return 1;
1086       if (++index == mq->q->maxsize)
1087         index = 0;
1088     }
1089   /*
1090    * Search pending events vector
1091    */
1092   pending_event_vector = wrk->pending_event_vector;
1093   vec_foreach (evt, pending_event_vector)
1094   {
1095     found = session_node_cmp_event (evt, f);
1096     if (found)
1097       {
1098         clib_memcpy_fast (e, evt, sizeof (*evt));
1099         break;
1100       }
1101   }
1102   return found;
1103 }
1104
1105 static clib_error_t *
1106 session_queue_exit (vlib_main_t * vm)
1107 {
1108   if (vec_len (vlib_mains) < 2)
1109     return 0;
1110
1111   /*
1112    * Shut off (especially) worker-thread session nodes.
1113    * Otherwise, vpp can crash as the main thread unmaps the
1114    * API segment.
1115    */
1116   vlib_worker_thread_barrier_sync (vm);
1117   session_node_enable_disable (0 /* is_enable */ );
1118   vlib_worker_thread_barrier_release (vm);
1119   return 0;
1120 }
1121
1122 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1123
1124 static uword
1125 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1126                        vlib_frame_t * f)
1127 {
1128   f64 now, timeout = 1.0;
1129   uword *event_data = 0;
1130   uword event_type;
1131
1132   while (1)
1133     {
1134       vlib_process_wait_for_event_or_clock (vm, timeout);
1135       now = vlib_time_now (vm);
1136       event_type = vlib_process_get_events (vm, (uword **) & event_data);
1137
1138       switch (event_type)
1139         {
1140         case SESSION_Q_PROCESS_FLUSH_FRAMES:
1141           /* Flush the frames by updating all transports times */
1142           transport_update_time (now, 0);
1143           break;
1144         case SESSION_Q_PROCESS_STOP:
1145           timeout = 100000.0;
1146           break;
1147         case ~0:
1148           /* Timed out. Update time for all transports to trigger all
1149            * outstanding retransmits. */
1150           transport_update_time (now, 0);
1151           break;
1152         }
1153       vec_reset_length (event_data);
1154     }
1155   return 0;
1156 }
1157
1158 /* *INDENT-OFF* */
1159 VLIB_REGISTER_NODE (session_queue_process_node) =
1160 {
1161   .function = session_queue_process,
1162   .type = VLIB_NODE_TYPE_PROCESS,
1163   .name = "session-queue-process",
1164   .state = VLIB_NODE_STATE_DISABLED,
1165 };
1166 /* *INDENT-ON* */
1167
1168
1169 /*
1170  * fd.io coding-style-patch-verification: ON
1171  *
1172  * Local Variables:
1173  * eval: (c-set-style "gnu")
1174  * End:
1175  */