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