src/vnet/session/session.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  * @file
  17  * @brief Session and session manager
  18  */
  19
  20 #include <vnet/session/session.h>
  21 #include <vnet/session/session_debug.h>
  22 #include <vnet/session/application.h>
  23 #include <vlibmemory/api.h>
  24 #include <vnet/dpo/load_balance.h>
  25 #include <vnet/fib/ip4_fib.h>
  26
  27 session_manager_main_t session_manager_main;
  28 extern transport_proto_vft_t *tp_vfts;
  29
  30 static void
  31 session_send_evt_to_thread (u64 session_handle, fifo_event_type_t evt_type,
  32                             u32 thread_index, void *fp, void *rpc_args)
  33 {
  34   u32 tries = 0;
  35   session_fifo_event_t evt = { {0}, };
  36   svm_queue_t *q;
  37
  38   evt.event_type = evt_type;
  39   if (evt_type == FIFO_EVENT_RPC)
  40     {
  41       evt.rpc_args.fp = fp;
  42       evt.rpc_args.arg = rpc_args;
  43     }
  44   else
  45     evt.session_handle = session_handle;
  46
  47   q = session_manager_get_vpp_event_queue (thread_index);
  48   while (svm_queue_add (q, (u8 *) & evt, 1))
  49     {
  50       if (tries++ == 3)
  51         {
  52           SESSION_DBG ("failed to enqueue evt");
  53           break;
  54         }
  55     }
  56 }
  57
  58 void
  59 session_send_session_evt_to_thread (u64 session_handle,
  60                                     fifo_event_type_t evt_type,
  61                                     u32 thread_index)
  62 {
  63   session_send_evt_to_thread (session_handle, evt_type, thread_index, 0, 0);
  64 }
  65
  66 void
  67 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
  68 {
  69   if (thread_index != vlib_get_thread_index ())
  70     session_send_evt_to_thread (0, FIFO_EVENT_RPC, thread_index, fp,
  71                                 rpc_args);
  72   else
  73     {
  74       void (*fnp) (void *) = fp;
  75       fnp (rpc_args);
  76     }
  77 }
  78
  79 stream_session_t *
  80 session_alloc (u32 thread_index)
  81 {
  82   session_manager_main_t *smm = &session_manager_main;
  83   stream_session_t *s;
  84   u8 will_expand = 0;
  85   pool_get_aligned_will_expand (smm->sessions[thread_index], will_expand,
  86                                 CLIB_CACHE_LINE_BYTES);
  87   /* If we have peekers, let them finish */
  88   if (PREDICT_FALSE (will_expand))
  89     {
  90       clib_spinlock_lock_if_init (&smm->peekers_write_locks[thread_index]);
  91       pool_get_aligned (session_manager_main.sessions[thread_index], s,
  92                         CLIB_CACHE_LINE_BYTES);
  93       clib_spinlock_unlock_if_init (&smm->peekers_write_locks[thread_index]);
  94     }
  95   else
  96     {
  97       pool_get_aligned (session_manager_main.sessions[thread_index], s,
  98                         CLIB_CACHE_LINE_BYTES);
  99     }
 100   memset (s, 0, sizeof (*s));
 101   s->session_index = s - session_manager_main.sessions[thread_index];
 102   s->thread_index = thread_index;
 103   return s;
 104 }
 105
 106 static void
 107 session_free (stream_session_t * s)
 108 {
 109   pool_put (session_manager_main.sessions[s->thread_index], s);
 110   if (CLIB_DEBUG)
 111     memset (s, 0xFA, sizeof (*s));
 112 }
 113
 114 static int
 115 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
 116 {
 117   svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
 118   u32 fifo_segment_index;
 119   int rv;
 120
 121   if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
 122                                                  &server_tx_fifo,
 123                                                  &fifo_segment_index)))
 124     return rv;
 125   /* Initialize backpointers */
 126   server_rx_fifo->master_session_index = s->session_index;
 127   server_rx_fifo->master_thread_index = s->thread_index;
 128
 129   server_tx_fifo->master_session_index = s->session_index;
 130   server_tx_fifo->master_thread_index = s->thread_index;
 131
 132   s->server_rx_fifo = server_rx_fifo;
 133   s->server_tx_fifo = server_tx_fifo;
 134   s->svm_segment_index = fifo_segment_index;
 135   return 0;
 136 }
 137
 138 static stream_session_t *
 139 session_alloc_for_connection (transport_connection_t * tc)
 140 {
 141   stream_session_t *s;
 142   u32 thread_index = tc->thread_index;
 143
 144   ASSERT (thread_index == vlib_get_thread_index ());
 145
 146   s = session_alloc (thread_index);
 147   s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
 148   s->session_state = SESSION_STATE_CONNECTING;
 149   s->enqueue_epoch = ~0;
 150
 151   /* Attach transport to session and vice versa */
 152   s->connection_index = tc->c_index;
 153   tc->s_index = s->session_index;
 154   return s;
 155 }
 156
 157 static int
 158 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
 159                         u8 alloc_fifos, stream_session_t ** ret_s)
 160 {
 161   stream_session_t *s;
 162   int rv;
 163
 164   s = session_alloc_for_connection (tc);
 165   if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
 166     {
 167       session_free (s);
 168       *ret_s = 0;
 169       return rv;
 170     }
 171
 172   /* Add to the main lookup table */
 173   session_lookup_add_connection (tc, session_handle (s));
 174
 175   *ret_s = s;
 176   return 0;
 177 }
 178
 179 /**
 180  * Discards bytes from buffer chain
 181  *
 182  * It discards n_bytes_to_drop starting at first buffer after chain_b
 183  */
 184 always_inline void
 185 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
 186                                      vlib_buffer_t ** chain_b,
 187                                      u32 n_bytes_to_drop)
 188 {
 189   vlib_buffer_t *next = *chain_b;
 190   u32 to_drop = n_bytes_to_drop;
 191   ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
 192   while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
 193     {
 194       next = vlib_get_buffer (vm, next->next_buffer);
 195       if (next->current_length > to_drop)
 196         {
 197           vlib_buffer_advance (next, to_drop);
 198           to_drop = 0;
 199         }
 200       else
 201         {
 202           to_drop -= next->current_length;
 203           next->current_length = 0;
 204         }
 205     }
 206   *chain_b = next;
 207
 208   if (to_drop == 0)
 209     b->total_length_not_including_first_buffer -= n_bytes_to_drop;
 210 }
 211
 212 /**
 213  * Enqueue buffer chain tail
 214  */
 215 always_inline int
 216 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
 217                             u32 offset, u8 is_in_order)
 218 {
 219   vlib_buffer_t *chain_b;
 220   u32 chain_bi, len, diff;
 221   vlib_main_t *vm = vlib_get_main ();
 222   u8 *data;
 223   u32 written = 0;
 224   int rv = 0;
 225
 226   if (is_in_order && offset)
 227     {
 228       diff = offset - b->current_length;
 229       if (diff > b->total_length_not_including_first_buffer)
 230         return 0;
 231       chain_b = b;
 232       session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
 233       chain_bi = vlib_get_buffer_index (vm, chain_b);
 234     }
 235   else
 236     chain_bi = b->next_buffer;
 237
 238   do
 239     {
 240       chain_b = vlib_get_buffer (vm, chain_bi);
 241       data = vlib_buffer_get_current (chain_b);
 242       len = chain_b->current_length;
 243       if (!len)
 244         continue;
 245       if (is_in_order)
 246         {
 247           rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
 248           if (rv == len)
 249             {
 250               written += rv;
 251             }
 252           else if (rv < len)
 253             {
 254               return (rv > 0) ? (written + rv) : written;
 255             }
 256           else if (rv > len)
 257             {
 258               written += rv;
 259
 260               /* written more than what was left in chain */
 261               if (written > b->total_length_not_including_first_buffer)
 262                 return written;
 263
 264               /* drop the bytes that have already been delivered */
 265               session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
 266             }
 267         }
 268       else
 269         {
 270           rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
 271                                              data);
 272           if (rv)
 273             {
 274               clib_warning ("failed to enqueue multi-buffer seg");
 275               return -1;
 276             }
 277           offset += len;
 278         }
 279     }
 280   while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
 281           ? chain_b->next_buffer : 0));
 282
 283   if (is_in_order)
 284     return written;
 285
 286   return 0;
 287 }
 288
 289 /*
 290  * Enqueue data for delivery to session peer. Does not notify peer of enqueue
 291  * event but on request can queue notification events for later delivery by
 292  * calling stream_server_flush_enqueue_events().
 293  *
 294  * @param tc Transport connection which is to be enqueued data
 295  * @param b Buffer to be enqueued
 296  * @param offset Offset at which to start enqueueing if out-of-order
 297  * @param queue_event Flag to indicate if peer is to be notified or if event
 298  *                    is to be queued. The former is useful when more data is
 299  *                    enqueued and only one event is to be generated.
 300  * @param is_in_order Flag to indicate if data is in order
 301  * @return Number of bytes enqueued or a negative value if enqueueing failed.
 302  */
 303 int
 304 session_enqueue_stream_connection (transport_connection_t * tc,
 305                                    vlib_buffer_t * b, u32 offset,
 306                                    u8 queue_event, u8 is_in_order)
 307 {
 308   stream_session_t *s;
 309   int enqueued = 0, rv, in_order_off;
 310
 311   s = session_get (tc->s_index, tc->thread_index);
 312
 313   if (is_in_order)
 314     {
 315       enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
 316                                           b->current_length,
 317                                           vlib_buffer_get_current (b));
 318       if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
 319                          && enqueued >= 0))
 320         {
 321           in_order_off = enqueued > b->current_length ? enqueued : 0;
 322           rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
 323           if (rv > 0)
 324             enqueued += rv;
 325         }
 326     }
 327   else
 328     {
 329       rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
 330                                          b->current_length,
 331                                          vlib_buffer_get_current (b));
 332       if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
 333         session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
 334       /* if something was enqueued, report even this as success for ooo
 335        * segment handling */
 336       return rv;
 337     }
 338
 339   if (queue_event)
 340     {
 341       /* Queue RX event on this fifo. Eventually these will need to be flushed
 342        * by calling stream_server_flush_enqueue_events () */
 343       session_manager_main_t *smm = vnet_get_session_manager_main ();
 344       u32 thread_index = s->thread_index;
 345       u32 enqueue_epoch = smm->current_enqueue_epoch[tc->proto][thread_index];
 346
 347       if (s->enqueue_epoch != enqueue_epoch)
 348         {
 349           s->enqueue_epoch = enqueue_epoch;
 350           vec_add1 (smm->session_to_enqueue[tc->proto][thread_index],
 351                     s - smm->sessions[thread_index]);
 352         }
 353     }
 354
 355   return enqueued;
 356 }
 357
 358 int
 359 session_enqueue_dgram_connection (stream_session_t * s, vlib_buffer_t * b,
 360                                   u8 proto, u8 queue_event)
 361 {
 362   int enqueued = 0, rv, in_order_off;
 363
 364   if (svm_fifo_max_enqueue (s->server_rx_fifo) < b->current_length)
 365     return -1;
 366   enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
 367                                       vlib_buffer_get_current (b));
 368   if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
 369     {
 370       in_order_off = enqueued > b->current_length ? enqueued : 0;
 371       rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
 372       if (rv > 0)
 373         enqueued += rv;
 374     }
 375   if (queue_event)
 376     {
 377       /* Queue RX event on this fifo. Eventually these will need to be flushed
 378        * by calling stream_server_flush_enqueue_events () */
 379       session_manager_main_t *smm = vnet_get_session_manager_main ();
 380       u32 thread_index = s->thread_index;
 381       u32 enqueue_epoch = smm->current_enqueue_epoch[proto][thread_index];
 382
 383       if (s->enqueue_epoch != enqueue_epoch)
 384         {
 385           s->enqueue_epoch = enqueue_epoch;
 386           vec_add1 (smm->session_to_enqueue[proto][thread_index],
 387                     s - smm->sessions[thread_index]);
 388         }
 389     }
 390   return enqueued;
 391 }
 392
 393 /** Check if we have space in rx fifo to push more bytes */
 394 u8
 395 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
 396                          u16 data_len)
 397 {
 398   stream_session_t *s = session_get (tc->s_index, thread_index);
 399
 400   if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
 401     return 1;
 402
 403   if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
 404     return 1;
 405
 406   return 0;
 407 }
 408
 409 u32
 410 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc)
 411 {
 412   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 413   if (!s->server_tx_fifo)
 414     return 0;
 415   return svm_fifo_max_dequeue (s->server_tx_fifo);
 416 }
 417
 418 int
 419 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
 420                            u32 offset, u32 max_bytes)
 421 {
 422   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 423   return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
 424 }
 425
 426 u32
 427 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
 428 {
 429   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 430   return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
 431 }
 432
 433 /**
 434  * Notify session peer that new data has been enqueued.
 435  *
 436  * @param s Stream session for which the event is to be generated.
 437  * @param block Flag to indicate if call should block if event queue is full.
 438  *
 439  * @return 0 on succes or negative number if failed to send notification.
 440  */
 441 static int
 442 session_enqueue_notify (stream_session_t * s, u8 block)
 443 {
 444   application_t *app;
 445   session_fifo_event_t evt;
 446   svm_queue_t *q;
 447
 448   if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
 449     {
 450       /* Session is closed so app will never clean up. Flush rx fifo */
 451       u32 to_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
 452       if (to_dequeue)
 453         svm_fifo_dequeue_drop (s->server_rx_fifo, to_dequeue);
 454       return 0;
 455     }
 456
 457   /* Get session's server */
 458   app = application_get_if_valid (s->app_index);
 459
 460   if (PREDICT_FALSE (app == 0))
 461     {
 462       clib_warning ("invalid s->app_index = %d", s->app_index);
 463       return 0;
 464     }
 465
 466   /* Built-in server? Hand event to the callback... */
 467   if (app->cb_fns.builtin_server_rx_callback)
 468     return app->cb_fns.builtin_server_rx_callback (s);
 469
 470   /* If no event, send one */
 471   if (svm_fifo_set_event (s->server_rx_fifo))
 472     {
 473       /* Fabricate event */
 474       evt.fifo = s->server_rx_fifo;
 475       evt.event_type = FIFO_EVENT_APP_RX;
 476
 477       /* Add event to server's event queue */
 478       q = app->event_queue;
 479
 480       /* Based on request block (or not) for lack of space */
 481       if (block || PREDICT_TRUE (q->cursize < q->maxsize))
 482         svm_queue_add (app->event_queue, (u8 *) & evt,
 483                        0 /* do wait for mutex */ );
 484       else
 485         {
 486           clib_warning ("fifo full");
 487           return -1;
 488         }
 489     }
 490
 491   /* *INDENT-OFF* */
 492   SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
 493       ed->data[0] = evt.event_type;
 494       ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
 495   }));
 496   /* *INDENT-ON* */
 497
 498   return 0;
 499 }
 500
 501 /**
 502  * Flushes queue of sessions that are to be notified of new data
 503  * enqueued events.
 504  *
 505  * @param thread_index Thread index for which the flush is to be performed.
 506  * @return 0 on success or a positive number indicating the number of
 507  *         failures due to API queue being full.
 508  */
 509 int
 510 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
 511 {
 512   session_manager_main_t *smm = &session_manager_main;
 513   u32 *indices;
 514   stream_session_t *s;
 515   int i, errors = 0;
 516
 517   indices = smm->session_to_enqueue[transport_proto][thread_index];
 518
 519   for (i = 0; i < vec_len (indices); i++)
 520     {
 521       s = session_get_if_valid (indices[i], thread_index);
 522       if (s == 0 || session_enqueue_notify (s, 0 /* don't block */ ))
 523         errors++;
 524     }
 525
 526   vec_reset_length (indices);
 527   smm->session_to_enqueue[transport_proto][thread_index] = indices;
 528   smm->current_enqueue_epoch[transport_proto][thread_index]++;
 529
 530   return errors;
 531 }
 532
 533 /**
 534  * Init fifo tail and head pointers
 535  *
 536  * Useful if transport uses absolute offsets for tracking ooo segments.
 537  */
 538 void
 539 stream_session_init_fifos_pointers (transport_connection_t * tc,
 540                                     u32 rx_pointer, u32 tx_pointer)
 541 {
 542   stream_session_t *s;
 543   s = session_get (tc->s_index, tc->thread_index);
 544   svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
 545   svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
 546 }
 547
 548 int
 549 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
 550 {
 551   application_t *app;
 552   stream_session_t *new_s = 0;
 553   u64 handle;
 554   u32 opaque = 0;
 555   int error = 0;
 556   segment_manager_t *sm;
 557   u8 alloc_fifos;
 558
 559   /*
 560    * Find connection handle and cleanup half-open table
 561    */
 562   handle = session_lookup_half_open_handle (tc);
 563   if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
 564     {
 565       SESSION_DBG ("half-open was removed!");
 566       return -1;
 567     }
 568   session_lookup_del_half_open (tc);
 569
 570   /* Get the app's index from the handle we stored when opening connection
 571    * and the opaque (api_context for external apps) from transport session
 572    * index */
 573   app = application_get_if_valid (handle >> 32);
 574   if (!app)
 575     return -1;
 576   opaque = tc->s_index;
 577
 578   /*
 579    * Allocate new session with fifos (svm segments are allocated if needed)
 580    */
 581   if (!is_fail)
 582     {
 583       sm = application_get_connect_segment_manager (app);
 584       alloc_fifos = !application_is_builtin_proxy (app);
 585       if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
 586         {
 587           is_fail = 1;
 588           error = -1;
 589         }
 590       else
 591         new_s->app_index = app->index;
 592     }
 593
 594   /*
 595    * Notify client application
 596    */
 597   if (app->cb_fns.session_connected_callback (app->index, opaque, new_s,
 598                                               is_fail))
 599     {
 600       SESSION_DBG ("failed to notify app");
 601       if (!is_fail)
 602         stream_session_disconnect (new_s);
 603     }
 604   else
 605     {
 606       if (!is_fail)
 607         new_s->session_state = SESSION_STATE_READY;
 608     }
 609
 610   return error;
 611 }
 612
 613 typedef struct _session_switch_pool_args
 614 {
 615   u32 session_index;
 616   u32 thread_index;
 617   u32 new_thread_index;
 618   u32 new_session_index;
 619 } session_switch_pool_args_t;
 620
 621 static void
 622 session_switch_pool (void *cb_args)
 623 {
 624   session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
 625   transport_proto_t tp;
 626   stream_session_t *s;
 627   ASSERT (args->thread_index == vlib_get_thread_index ());
 628   s = session_get (args->session_index, args->thread_index);
 629   s->server_tx_fifo->master_session_index = args->new_session_index;
 630   s->server_tx_fifo->master_thread_index = args->new_thread_index;
 631   tp = session_get_transport_proto (s);
 632   tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
 633   session_free (s);
 634   clib_mem_free (cb_args);
 635 }
 636
 637 /**
 638  * Move dgram session to the right thread
 639  */
 640 int
 641 session_dgram_connect_notify (transport_connection_t * tc,
 642                               u32 old_thread_index,
 643                               stream_session_t ** new_session)
 644 {
 645   stream_session_t *new_s;
 646   session_switch_pool_args_t *rpc_args;
 647
 648   /*
 649    * Clone half-open session to the right thread.
 650    */
 651   new_s = session_clone_safe (tc->s_index, old_thread_index);
 652   new_s->connection_index = tc->c_index;
 653   new_s->server_rx_fifo->master_session_index = new_s->session_index;
 654   new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
 655   new_s->session_state = SESSION_STATE_READY;
 656   session_lookup_add_connection (tc, session_handle (new_s));
 657
 658   /*
 659    * Ask thread owning the old session to clean it up and make us the tx
 660    * fifo owner
 661    */
 662   rpc_args = clib_mem_alloc (sizeof (*rpc_args));
 663   rpc_args->new_session_index = new_s->session_index;
 664   rpc_args->new_thread_index = new_s->thread_index;
 665   rpc_args->session_index = tc->s_index;
 666   rpc_args->thread_index = old_thread_index;
 667   session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
 668                                   rpc_args);
 669
 670   tc->s_index = new_s->session_index;
 671   new_s->connection_index = tc->c_index;
 672   *new_session = new_s;
 673   return 0;
 674 }
 675
 676 void
 677 stream_session_accept_notify (transport_connection_t * tc)
 678 {
 679   application_t *server;
 680   stream_session_t *s;
 681
 682   s = session_get (tc->s_index, tc->thread_index);
 683   server = application_get (s->app_index);
 684   server->cb_fns.session_accept_callback (s);
 685 }
 686
 687 /**
 688  * Notification from transport that connection is being closed.
 689  *
 690  * A disconnect is sent to application but state is not removed. Once
 691  * disconnect is acknowledged by application, session disconnect is called.
 692  * Ultimately this leads to close being called on transport (passive close).
 693  */
 694 void
 695 stream_session_disconnect_notify (transport_connection_t * tc)
 696 {
 697   application_t *server;
 698   stream_session_t *s;
 699
 700   s = session_get (tc->s_index, tc->thread_index);
 701   server = application_get (s->app_index);
 702   server->cb_fns.session_disconnect_callback (s);
 703 }
 704
 705 /**
 706  * Cleans up session and lookup table.
 707  */
 708 void
 709 stream_session_delete (stream_session_t * s)
 710 {
 711   int rv;
 712
 713   /* Delete from the main lookup table. */
 714   if ((rv = session_lookup_del_session (s)))
 715     clib_warning ("hash delete error, rv %d", rv);
 716
 717   /* Cleanup fifo segments */
 718   segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
 719                                  s->server_tx_fifo);
 720   session_free (s);
 721 }
 722
 723 /**
 724  * Notification from transport that connection is being deleted
 725  *
 726  * This removes the session if it is still valid. It should be called only on
 727  * previously fully established sessions. For instance failed connects should
 728  * call stream_session_connect_notify and indicate that the connect has
 729  * failed.
 730  */
 731 void
 732 stream_session_delete_notify (transport_connection_t * tc)
 733 {
 734   stream_session_t *s;
 735
 736   /* App might've been removed already */
 737   s = session_get_if_valid (tc->s_index, tc->thread_index);
 738   if (!s)
 739     return;
 740   stream_session_delete (s);
 741 }
 742
 743 /**
 744  * Notify application that connection has been reset.
 745  */
 746 void
 747 stream_session_reset_notify (transport_connection_t * tc)
 748 {
 749   stream_session_t *s;
 750   application_t *app;
 751   s = session_get (tc->s_index, tc->thread_index);
 752
 753   app = application_get (s->app_index);
 754   app->cb_fns.session_reset_callback (s);
 755 }
 756
 757 /**
 758  * Accept a stream session. Optionally ping the server by callback.
 759  */
 760 int
 761 stream_session_accept (transport_connection_t * tc, u32 listener_index,
 762                        u8 notify)
 763 {
 764   application_t *server;
 765   stream_session_t *s, *listener;
 766   segment_manager_t *sm;
 767   session_type_t sst;
 768   int rv;
 769
 770   sst = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
 771
 772   /* Find the server */
 773   listener = listen_session_get (sst, listener_index);
 774   server = application_get (listener->app_index);
 775
 776   sm = application_get_listen_segment_manager (server, listener);
 777   if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
 778     return rv;
 779
 780   s->app_index = server->index;
 781   s->listener_index = listener_index;
 782   s->session_state = SESSION_STATE_ACCEPTING;
 783
 784   /* Shoulder-tap the server */
 785   if (notify)
 786     {
 787       server->cb_fns.session_accept_callback (s);
 788     }
 789
 790   return 0;
 791 }
 792
 793 /**
 794  * Ask transport to open connection to remote transport endpoint.
 795  *
 796  * Stores handle for matching request with reply since the call can be
 797  * asynchronous. For instance, for TCP the 3-way handshake must complete
 798  * before reply comes. Session is only created once connection is established.
 799  *
 800  * @param app_index Index of the application requesting the connect
 801  * @param st Session type requested.
 802  * @param tep Remote transport endpoint
 803  * @param opaque Opaque data (typically, api_context) the application expects
 804  *               on open completion.
 805  */
 806 int
 807 session_open (u32 app_index, session_endpoint_t * rmt, u32 opaque)
 808 {
 809   transport_connection_t *tc;
 810   transport_endpoint_t *tep;
 811   segment_manager_t *sm;
 812   stream_session_t *s;
 813   application_t *app;
 814   int rv;
 815   u64 handle;
 816
 817   tep = session_endpoint_to_transport (rmt);
 818   rv = tp_vfts[rmt->transport_proto].open (tep);
 819   if (rv < 0)
 820     {
 821       SESSION_DBG ("Transport failed to open connection.");
 822       return VNET_API_ERROR_SESSION_CONNECT;
 823     }
 824
 825   tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
 826
 827   /* If transport offers a stream service, only allocate session once the
 828    * connection has been established.
 829    */
 830   if (transport_is_stream (rmt->transport_proto))
 831     {
 832       /* Add connection to half-open table and save app and tc index. The
 833        * latter is needed to help establish the connection while the former
 834        * is needed when the connect notify comes and we have to notify the
 835        * external app
 836        */
 837       handle = (((u64) app_index) << 32) | (u64) tc->c_index;
 838       session_lookup_add_half_open (tc, handle);
 839
 840       /* Store api_context (opaque) for when the reply comes. Not the nicest
 841        * thing but better than allocating a separate half-open pool.
 842        */
 843       tc->s_index = opaque;
 844     }
 845   /* For dgram type of service, allocate session and fifos now.
 846    */
 847   else
 848     {
 849       app = application_get (app_index);
 850       sm = application_get_connect_segment_manager (app);
 851
 852       if (session_alloc_and_init (sm, tc, 1, &s))
 853         return -1;
 854       s->app_index = app->index;
 855       s->session_state = SESSION_STATE_CONNECTING_READY;
 856
 857       /* Tell the app about the new event fifo for this session */
 858       app->cb_fns.session_connected_callback (app->index, opaque, s, 0);
 859     }
 860   return 0;
 861 }
 862
 863 /**
 864  * Ask transport to listen on local transport endpoint.
 865  *
 866  * @param s Session for which listen will be called. Note that unlike
 867  *          established sessions, listen sessions are not associated to a
 868  *          thread.
 869  * @param tep Local endpoint to be listened on.
 870  */
 871 int
 872 stream_session_listen (stream_session_t * s, session_endpoint_t * sep)
 873 {
 874   transport_connection_t *tc;
 875   u32 tci;
 876
 877   /* Transport bind/listen  */
 878   tci = tp_vfts[sep->transport_proto].bind (s->session_index,
 879                                             session_endpoint_to_transport
 880                                             (sep));
 881
 882   if (tci == (u32) ~ 0)
 883     return -1;
 884
 885   /* Attach transport to session */
 886   s->connection_index = tci;
 887   tc = tp_vfts[sep->transport_proto].get_listener (tci);
 888
 889   /* Weird but handle it ... */
 890   if (tc == 0)
 891     return -1;
 892
 893   /* Add to the main lookup table */
 894   session_lookup_add_connection (tc, s->session_index);
 895   return 0;
 896 }
 897
 898 /**
 899  * Ask transport to stop listening on local transport endpoint.
 900  *
 901  * @param s Session to stop listening on. It must be in state LISTENING.
 902  */
 903 int
 904 stream_session_stop_listen (stream_session_t * s)
 905 {
 906   transport_proto_t tp = session_get_transport_proto (s);
 907   transport_connection_t *tc;
 908   if (s->session_state != SESSION_STATE_LISTENING)
 909     {
 910       clib_warning ("not a listening session");
 911       return -1;
 912     }
 913
 914   tc = tp_vfts[tp].get_listener (s->connection_index);
 915   if (!tc)
 916     {
 917       clib_warning ("no transport");
 918       return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
 919     }
 920
 921   session_lookup_del_connection (tc);
 922   tp_vfts[tp].unbind (s->connection_index);
 923   return 0;
 924 }
 925
 926 /**
 927  * Disconnect session and propagate to transport. This should eventually
 928  * result in a delete notification that allows us to cleanup session state.
 929  * Called for both active/passive disconnects.
 930  *
 931  * Should be called from the session's thread.
 932  */
 933 void
 934 stream_session_disconnect (stream_session_t * s)
 935 {
 936   s->session_state = SESSION_STATE_CLOSED;
 937   tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
 938                                                   s->thread_index);
 939 }
 940
 941 /**
 942  * Cleanup transport and session state.
 943  *
 944  * Notify transport of the cleanup, wait for a delete notify to actually
 945  * remove the session state.
 946  */
 947 void
 948 stream_session_cleanup (stream_session_t * s)
 949 {
 950   int rv;
 951
 952   s->session_state = SESSION_STATE_CLOSED;
 953
 954   /* Delete from the main lookup table to avoid more enqueues */
 955   rv = session_lookup_del_session (s);
 956   if (rv)
 957     clib_warning ("hash delete error, rv %d", rv);
 958
 959   tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
 960                                                     s->thread_index);
 961 }
 962
 963 /**
 964  * Allocate event queues in the shared-memory segment
 965  *
 966  * That can either be a newly created memfd segment, that will need to be
 967  * mapped by all stack users, or the binary api's svm region. The latter is
 968  * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
 969  * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
 970  * vpp uses api svm region for event queues.
 971  */
 972 void
 973 session_vpp_event_queues_allocate (session_manager_main_t * smm)
 974 {
 975   u32 evt_q_length = 2048, evt_size = sizeof (session_fifo_event_t);
 976   ssvm_private_t *eqs = &smm->evt_qs_segment;
 977   api_main_t *am = &api_main;
 978   u64 eqs_size = 64 << 20;
 979   pid_t vpp_pid = getpid ();
 980   void *oldheap;
 981   int i;
 982
 983   if (smm->configured_event_queue_length)
 984     evt_q_length = smm->configured_event_queue_length;
 985
 986   if (smm->evt_qs_use_memfd_seg)
 987     {
 988       if (smm->evt_qs_segment_size)
 989         eqs_size = smm->evt_qs_segment_size;
 990
 991       eqs->ssvm_size = eqs_size;
 992       eqs->i_am_master = 1;
 993       eqs->my_pid = vpp_pid;
 994       eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
 995       eqs->requested_va = smm->session_baseva;
 996
 997       ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD);
 998     }
 999
1000   if (smm->evt_qs_use_memfd_seg)
1001     oldheap = ssvm_push_heap (eqs->sh);
1002   else
1003     oldheap = svm_push_data_heap (am->vlib_rp);
1004
1005   for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1006     {
1007       smm->vpp_event_queues[i] = svm_queue_init (evt_q_length, evt_size,
1008                                                  vpp_pid, 0);
1009     }
1010
1011   if (smm->evt_qs_use_memfd_seg)
1012     ssvm_pop_heap (oldheap);
1013   else
1014     svm_pop_heap (oldheap);
1015 }
1016
1017 ssvm_private_t *
1018 session_manager_get_evt_q_segment (void)
1019 {
1020   session_manager_main_t *smm = &session_manager_main;
1021   if (smm->evt_qs_use_memfd_seg)
1022     return &smm->evt_qs_segment;
1023   return 0;
1024 }
1025
1026 /**
1027  * Initialize session layer for given transport proto and ip version
1028  *
1029  * Allocates per session type (transport proto + ip version) data structures
1030  * and adds arc from session queue node to session type output node.
1031  */
1032 void
1033 session_register_transport (transport_proto_t transport_proto,
1034                             const transport_proto_vft_t * vft, u8 is_ip4,
1035                             u32 output_node)
1036 {
1037   session_manager_main_t *smm = &session_manager_main;
1038   session_type_t session_type;
1039   u32 next_index = ~0;
1040
1041   session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1042
1043   vec_validate (smm->session_type_to_next, session_type);
1044   vec_validate (smm->listen_sessions, session_type);
1045   vec_validate (smm->session_tx_fns, session_type);
1046
1047   /* *INDENT-OFF* */
1048   foreach_vlib_main (({
1049     next_index = vlib_node_add_next (this_vlib_main, session_queue_node.index,
1050                                      output_node);
1051   }));
1052   /* *INDENT-ON* */
1053
1054   smm->session_type_to_next[session_type] = next_index;
1055   session_manager_set_transport_rx_fn (session_type,
1056                                        vft->tx_fifo_offset != 0);
1057 }
1058
1059 transport_connection_t *
1060 session_get_transport (stream_session_t * s)
1061 {
1062   transport_proto_t tp;
1063   if (s->session_state != SESSION_STATE_LISTENING)
1064     {
1065       tp = session_get_transport_proto (s);
1066       return tp_vfts[tp].get_connection (s->connection_index,
1067                                          s->thread_index);
1068     }
1069   return 0;
1070 }
1071
1072 transport_connection_t *
1073 listen_session_get_transport (stream_session_t * s)
1074 {
1075   transport_proto_t tp = session_get_transport_proto (s);
1076   return tp_vfts[tp].get_listener (s->connection_index);
1077 }
1078
1079 int
1080 listen_session_get_local_session_endpoint (stream_session_t * listener,
1081                                            session_endpoint_t * sep)
1082 {
1083   transport_proto_t tp = session_get_transport_proto (listener);
1084   transport_connection_t *tc;
1085   tc = tp_vfts[tp].get_listener (listener->connection_index);
1086   if (!tc)
1087     {
1088       clib_warning ("no transport");
1089       return -1;
1090     }
1091
1092   /* N.B. The ip should not be copied because this is the local endpoint */
1093   sep->port = tc->lcl_port;
1094   sep->transport_proto = tc->proto;
1095   sep->is_ip4 = tc->is_ip4;
1096   return 0;
1097 }
1098
1099 static clib_error_t *
1100 session_manager_main_enable (vlib_main_t * vm)
1101 {
1102   session_manager_main_t *smm = &session_manager_main;
1103   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1104   u32 num_threads;
1105   u32 preallocated_sessions_per_worker;
1106   int i, j;
1107
1108   num_threads = 1 /* main thread */  + vtm->n_threads;
1109
1110   if (num_threads < 1)
1111     return clib_error_return (0, "n_thread_stacks not set");
1112
1113   /* configure per-thread ** vectors */
1114   vec_validate (smm->sessions, num_threads - 1);
1115   vec_validate (smm->tx_buffers, num_threads - 1);
1116   vec_validate (smm->pending_event_vector, num_threads - 1);
1117   vec_validate (smm->pending_disconnects, num_threads - 1);
1118   vec_validate (smm->free_event_vector, num_threads - 1);
1119   vec_validate (smm->vpp_event_queues, num_threads - 1);
1120   vec_validate (smm->session_peekers, num_threads - 1);
1121   vec_validate (smm->peekers_readers_locks, num_threads - 1);
1122   vec_validate (smm->peekers_write_locks, num_threads - 1);
1123
1124   for (i = 0; i < TRANSPORT_N_PROTO; i++)
1125     for (j = 0; j < num_threads; j++)
1126       {
1127         vec_validate (smm->session_to_enqueue[i], num_threads - 1);
1128         vec_validate (smm->current_enqueue_epoch[i], num_threads - 1);
1129       }
1130
1131   for (i = 0; i < num_threads; i++)
1132     {
1133       vec_validate (smm->free_event_vector[i], 0);
1134       _vec_len (smm->free_event_vector[i]) = 0;
1135       vec_validate (smm->pending_event_vector[i], 0);
1136       _vec_len (smm->pending_event_vector[i]) = 0;
1137       vec_validate (smm->pending_disconnects[i], 0);
1138       _vec_len (smm->pending_disconnects[i]) = 0;
1139       if (num_threads > 1)
1140         {
1141           clib_spinlock_init (&smm->peekers_readers_locks[i]);
1142           clib_spinlock_init (&smm->peekers_write_locks[i]);
1143         }
1144     }
1145
1146 #if SESSION_DBG
1147   vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1148 #endif
1149
1150   /* Allocate vpp event queues segment and queue */
1151   session_vpp_event_queues_allocate (smm);
1152
1153   /* Initialize fifo segment main baseva and timeout */
1154   svm_fifo_segment_init (smm->session_baseva + smm->evt_qs_segment_size,
1155                          smm->segment_timeout);
1156
1157   /* Preallocate sessions */
1158   if (smm->preallocated_sessions)
1159     {
1160       if (num_threads == 1)
1161         {
1162           pool_init_fixed (smm->sessions[0], smm->preallocated_sessions);
1163         }
1164       else
1165         {
1166           int j;
1167           preallocated_sessions_per_worker =
1168             (1.1 * (f64) smm->preallocated_sessions /
1169              (f64) (num_threads - 1));
1170
1171           for (j = 1; j < num_threads; j++)
1172             {
1173               pool_init_fixed (smm->sessions[j],
1174                                preallocated_sessions_per_worker);
1175             }
1176         }
1177     }
1178
1179   session_lookup_init ();
1180   app_namespaces_init ();
1181   transport_init ();
1182
1183   smm->is_enabled = 1;
1184
1185   /* Enable transports */
1186   transport_enable_disable (vm, 1);
1187
1188   return 0;
1189 }
1190
1191 void
1192 session_node_enable_disable (u8 is_en)
1193 {
1194   u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1195   /* *INDENT-OFF* */
1196   foreach_vlib_main (({
1197     vlib_node_set_state (this_vlib_main, session_queue_node.index,
1198                          state);
1199   }));
1200   /* *INDENT-ON* */
1201 }
1202
1203 clib_error_t *
1204 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1205 {
1206   clib_error_t *error = 0;
1207   if (is_en)
1208     {
1209       if (session_manager_main.is_enabled)
1210         return 0;
1211
1212       session_node_enable_disable (is_en);
1213       error = session_manager_main_enable (vm);
1214     }
1215   else
1216     {
1217       session_manager_main.is_enabled = 0;
1218       session_node_enable_disable (is_en);
1219     }
1220
1221   return error;
1222 }
1223
1224 clib_error_t *
1225 session_manager_main_init (vlib_main_t * vm)
1226 {
1227   session_manager_main_t *smm = &session_manager_main;
1228   smm->session_baseva = 0x200000000ULL;
1229   smm->segment_timeout = 20;
1230   smm->evt_qs_segment_size = 64 << 20;
1231   smm->is_enabled = 0;
1232   return 0;
1233 }
1234
1235 VLIB_INIT_FUNCTION (session_manager_main_init);
1236
1237 static clib_error_t *
1238 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1239 {
1240   session_manager_main_t *smm = &session_manager_main;
1241   u32 nitems;
1242   uword tmp;
1243
1244   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1245     {
1246       if (unformat (input, "event-queue-length %d", &nitems))
1247         {
1248           if (nitems >= 2048)
1249             smm->configured_event_queue_length = nitems;
1250           else
1251             clib_warning ("event queue length %d too small, ignored", nitems);
1252         }
1253       else if (unformat (input, "preallocated-sessions %d",
1254                          &smm->preallocated_sessions))
1255         ;
1256       else if (unformat (input, "v4-session-table-buckets %d",
1257                          &smm->configured_v4_session_table_buckets))
1258         ;
1259       else if (unformat (input, "v4-halfopen-table-buckets %d",
1260                          &smm->configured_v4_halfopen_table_buckets))
1261         ;
1262       else if (unformat (input, "v6-session-table-buckets %d",
1263                          &smm->configured_v6_session_table_buckets))
1264         ;
1265       else if (unformat (input, "v6-halfopen-table-buckets %d",
1266                          &smm->configured_v6_halfopen_table_buckets))
1267         ;
1268       else if (unformat (input, "v4-session-table-memory %U",
1269                          unformat_memory_size, &tmp))
1270         {
1271           if (tmp >= 0x100000000)
1272             return clib_error_return (0, "memory size %llx (%lld) too large",
1273                                       tmp, tmp);
1274           smm->configured_v4_session_table_memory = tmp;
1275         }
1276       else if (unformat (input, "v4-halfopen-table-memory %U",
1277                          unformat_memory_size, &tmp))
1278         {
1279           if (tmp >= 0x100000000)
1280             return clib_error_return (0, "memory size %llx (%lld) too large",
1281                                       tmp, tmp);
1282           smm->configured_v4_halfopen_table_memory = tmp;
1283         }
1284       else if (unformat (input, "v6-session-table-memory %U",
1285                          unformat_memory_size, &tmp))
1286         {
1287           if (tmp >= 0x100000000)
1288             return clib_error_return (0, "memory size %llx (%lld) too large",
1289                                       tmp, tmp);
1290           smm->configured_v6_session_table_memory = tmp;
1291         }
1292       else if (unformat (input, "v6-halfopen-table-memory %U",
1293                          unformat_memory_size, &tmp))
1294         {
1295           if (tmp >= 0x100000000)
1296             return clib_error_return (0, "memory size %llx (%lld) too large",
1297                                       tmp, tmp);
1298           smm->configured_v6_halfopen_table_memory = tmp;
1299         }
1300       else if (unformat (input, "local-endpoints-table-memory %U",
1301                          unformat_memory_size, &tmp))
1302         {
1303           if (tmp >= 0x100000000)
1304             return clib_error_return (0, "memory size %llx (%lld) too large",
1305                                       tmp, tmp);
1306           smm->local_endpoints_table_memory = tmp;
1307         }
1308       else if (unformat (input, "local-endpoints-table-buckets %d",
1309                          &smm->local_endpoints_table_buckets))
1310         ;
1311       else if (unformat (input, "evt_qs_memfd_seg"))
1312         smm->evt_qs_use_memfd_seg = 1;
1313       else
1314         return clib_error_return (0, "unknown input `%U'",
1315                                   format_unformat_error, input);
1316     }
1317   return 0;
1318 }
1319
1320 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1321
1322 /*
1323  * fd.io coding-style-patch-verification: ON
1324  *
1325  * Local Variables:
1326  * eval: (c-set-style "gnu")
1327  * End:
1328  */