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