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 <vlibmemory/api.h>
  22 #include <vnet/dpo/load_balance.h>
  23 #include <vnet/fib/ip4_fib.h>
  24 #include <vnet/session/application.h>
  25 #include <vnet/tcp/tcp.h>
  26 #include <vnet/session/session_debug.h>
  27
  28 /**
  29  * Per-type vector of transport protocol virtual function tables
  30  */
  31 static transport_proto_vft_t *tp_vfts;
  32
  33 session_manager_main_t session_manager_main;
  34
  35 /*
  36  * Session lookup key; (src-ip, dst-ip, src-port, dst-port, session-type)
  37  * Value: (owner thread index << 32 | session_index);
  38  */
  39 void
  40 stream_session_table_add_for_tc (transport_connection_t * tc, u64 value)
  41 {
  42   session_manager_main_t *smm = &session_manager_main;
  43   session_kv4_t kv4;
  44   session_kv6_t kv6;
  45
  46   switch (tc->proto)
  47     {
  48     case SESSION_TYPE_IP4_UDP:
  49     case SESSION_TYPE_IP4_TCP:
  50       make_v4_ss_kv_from_tc (&kv4, tc);
  51       kv4.value = value;
  52       clib_bihash_add_del_16_8 (&smm->v4_session_hash, &kv4, 1 /* is_add */ );
  53       break;
  54     case SESSION_TYPE_IP6_UDP:
  55     case SESSION_TYPE_IP6_TCP:
  56       make_v6_ss_kv_from_tc (&kv6, tc);
  57       kv6.value = value;
  58       clib_bihash_add_del_48_8 (&smm->v6_session_hash, &kv6, 1 /* is_add */ );
  59       break;
  60     default:
  61       clib_warning ("Session type not supported");
  62       ASSERT (0);
  63     }
  64 }
  65
  66 void
  67 stream_session_table_add (session_manager_main_t * smm, stream_session_t * s,
  68                           u64 value)
  69 {
  70   transport_connection_t *tc;
  71
  72   tc = tp_vfts[s->session_type].get_connection (s->connection_index,
  73                                                 s->thread_index);
  74   stream_session_table_add_for_tc (tc, value);
  75 }
  76
  77 static void
  78 stream_session_half_open_table_add (session_type_t sst,
  79                                     transport_connection_t * tc, u64 value)
  80 {
  81   session_manager_main_t *smm = &session_manager_main;
  82   session_kv4_t kv4;
  83   session_kv6_t kv6;
  84
  85   switch (sst)
  86     {
  87     case SESSION_TYPE_IP4_UDP:
  88     case SESSION_TYPE_IP4_TCP:
  89       make_v4_ss_kv_from_tc (&kv4, tc);
  90       kv4.value = value;
  91       clib_bihash_add_del_16_8 (&smm->v4_half_open_hash, &kv4,
  92                                 1 /* is_add */ );
  93       break;
  94     case SESSION_TYPE_IP6_UDP:
  95     case SESSION_TYPE_IP6_TCP:
  96       make_v6_ss_kv_from_tc (&kv6, tc);
  97       kv6.value = value;
  98       clib_bihash_add_del_48_8 (&smm->v6_half_open_hash, &kv6,
  99                                 1 /* is_add */ );
 100       break;
 101     default:
 102       clib_warning ("Session type not supported");
 103       ASSERT (0);
 104     }
 105 }
 106
 107 int
 108 stream_session_table_del_for_tc (transport_connection_t * tc)
 109 {
 110   session_manager_main_t *smm = &session_manager_main;
 111   session_kv4_t kv4;
 112   session_kv6_t kv6;
 113   switch (tc->proto)
 114     {
 115     case SESSION_TYPE_IP4_UDP:
 116     case SESSION_TYPE_IP4_TCP:
 117       make_v4_ss_kv_from_tc (&kv4, tc);
 118       return clib_bihash_add_del_16_8 (&smm->v4_session_hash, &kv4,
 119                                        0 /* is_add */ );
 120       break;
 121     case SESSION_TYPE_IP6_UDP:
 122     case SESSION_TYPE_IP6_TCP:
 123       make_v6_ss_kv_from_tc (&kv6, tc);
 124       return clib_bihash_add_del_48_8 (&smm->v6_session_hash, &kv6,
 125                                        0 /* is_add */ );
 126       break;
 127     default:
 128       clib_warning ("Session type not supported");
 129       ASSERT (0);
 130     }
 131
 132   return 0;
 133 }
 134
 135 static int
 136 stream_session_table_del (session_manager_main_t * smm, stream_session_t * s)
 137 {
 138   transport_connection_t *ts;
 139
 140   ts = tp_vfts[s->session_type].get_connection (s->connection_index,
 141                                                 s->thread_index);
 142   return stream_session_table_del_for_tc (ts);
 143 }
 144
 145 static void
 146 stream_session_half_open_table_del (session_manager_main_t * smm, u8 sst,
 147                                     transport_connection_t * tc)
 148 {
 149   session_kv4_t kv4;
 150   session_kv6_t kv6;
 151
 152   switch (sst)
 153     {
 154     case SESSION_TYPE_IP4_UDP:
 155     case SESSION_TYPE_IP4_TCP:
 156       make_v4_ss_kv_from_tc (&kv4, tc);
 157       clib_bihash_add_del_16_8 (&smm->v4_half_open_hash, &kv4,
 158                                 0 /* is_add */ );
 159       break;
 160     case SESSION_TYPE_IP6_UDP:
 161     case SESSION_TYPE_IP6_TCP:
 162       make_v6_ss_kv_from_tc (&kv6, tc);
 163       clib_bihash_add_del_48_8 (&smm->v6_half_open_hash, &kv6,
 164                                 0 /* is_add */ );
 165       break;
 166     default:
 167       clib_warning ("Session type not supported");
 168       ASSERT (0);
 169     }
 170 }
 171
 172 stream_session_t *
 173 stream_session_lookup_listener4 (ip4_address_t * lcl, u16 lcl_port, u8 proto)
 174 {
 175   session_manager_main_t *smm = &session_manager_main;
 176   session_kv4_t kv4;
 177   int rv;
 178
 179   make_v4_listener_kv (&kv4, lcl, lcl_port, proto);
 180   rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
 181   if (rv == 0)
 182     return pool_elt_at_index (smm->listen_sessions[proto], (u32) kv4.value);
 183
 184   /* Zero out the lcl ip */
 185   kv4.key[0] = 0;
 186   rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
 187   if (rv == 0)
 188     return pool_elt_at_index (smm->listen_sessions[proto], kv4.value);
 189
 190   return 0;
 191 }
 192
 193 /** Looks up a session based on the 5-tuple passed as argument.
 194  *
 195  * First it tries to find an established session, if this fails, it tries
 196  * finding a listener session if this fails, it tries a lookup with a
 197  * wildcarded local source (listener bound to all interfaces)
 198  */
 199 stream_session_t *
 200 stream_session_lookup4 (ip4_address_t * lcl, ip4_address_t * rmt,
 201                         u16 lcl_port, u16 rmt_port, u8 proto,
 202                         u32 my_thread_index)
 203 {
 204   session_manager_main_t *smm = &session_manager_main;
 205   session_kv4_t kv4;
 206   int rv;
 207
 208   /* Lookup session amongst established ones */
 209   make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
 210   rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
 211   if (rv == 0)
 212     return stream_session_get_tsi (kv4.value, my_thread_index);
 213
 214   /* If nothing is found, check if any listener is available */
 215   return stream_session_lookup_listener4 (lcl, lcl_port, proto);
 216 }
 217
 218 stream_session_t *
 219 stream_session_lookup_listener6 (ip6_address_t * lcl, u16 lcl_port, u8 proto)
 220 {
 221   session_manager_main_t *smm = &session_manager_main;
 222   session_kv6_t kv6;
 223   int rv;
 224
 225   make_v6_listener_kv (&kv6, lcl, lcl_port, proto);
 226   rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
 227   if (rv == 0)
 228     return pool_elt_at_index (smm->listen_sessions[proto], kv6.value);
 229
 230   /* Zero out the lcl ip */
 231   kv6.key[0] = kv6.key[1] = 0;
 232   rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
 233   if (rv == 0)
 234     return pool_elt_at_index (smm->listen_sessions[proto], kv6.value);
 235
 236   return 0;
 237 }
 238
 239 /* Looks up a session based on the 5-tuple passed as argument.
 240  * First it tries to find an established session, if this fails, it tries
 241  * finding a listener session if this fails, it tries a lookup with a
 242  * wildcarded local source (listener bound to all interfaces) */
 243 stream_session_t *
 244 stream_session_lookup6 (ip6_address_t * lcl, ip6_address_t * rmt,
 245                         u16 lcl_port, u16 rmt_port, u8 proto,
 246                         u32 my_thread_index)
 247 {
 248   session_manager_main_t *smm = vnet_get_session_manager_main ();
 249   session_kv6_t kv6;
 250   int rv;
 251
 252   make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
 253   rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
 254   if (rv == 0)
 255     return stream_session_get_tsi (kv6.value, my_thread_index);
 256
 257   /* If nothing is found, check if any listener is available */
 258   return stream_session_lookup_listener6 (lcl, lcl_port, proto);
 259 }
 260
 261 stream_session_t *
 262 stream_session_lookup_listener (ip46_address_t * lcl, u16 lcl_port, u8 proto)
 263 {
 264   switch (proto)
 265     {
 266     case SESSION_TYPE_IP4_UDP:
 267     case SESSION_TYPE_IP4_TCP:
 268       return stream_session_lookup_listener4 (&lcl->ip4, lcl_port, proto);
 269       break;
 270     case SESSION_TYPE_IP6_UDP:
 271     case SESSION_TYPE_IP6_TCP:
 272       return stream_session_lookup_listener6 (&lcl->ip6, lcl_port, proto);
 273       break;
 274     }
 275   return 0;
 276 }
 277
 278 static u64
 279 stream_session_half_open_lookup (session_manager_main_t * smm,
 280                                  ip46_address_t * lcl, ip46_address_t * rmt,
 281                                  u16 lcl_port, u16 rmt_port, u8 proto)
 282 {
 283   session_kv4_t kv4;
 284   session_kv6_t kv6;
 285   int rv;
 286
 287   switch (proto)
 288     {
 289     case SESSION_TYPE_IP4_UDP:
 290     case SESSION_TYPE_IP4_TCP:
 291       make_v4_ss_kv (&kv4, &lcl->ip4, &rmt->ip4, lcl_port, rmt_port, proto);
 292       rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
 293
 294       if (rv == 0)
 295         return kv4.value;
 296
 297       return (u64) ~ 0;
 298       break;
 299     case SESSION_TYPE_IP6_UDP:
 300     case SESSION_TYPE_IP6_TCP:
 301       make_v6_ss_kv (&kv6, &lcl->ip6, &rmt->ip6, lcl_port, rmt_port, proto);
 302       rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
 303
 304       if (rv == 0)
 305         return kv6.value;
 306
 307       return (u64) ~ 0;
 308       break;
 309     }
 310   return 0;
 311 }
 312
 313 transport_connection_t *
 314 stream_session_lookup_transport4 (ip4_address_t * lcl, ip4_address_t * rmt,
 315                                   u16 lcl_port, u16 rmt_port, u8 proto,
 316                                   u32 my_thread_index)
 317 {
 318   session_manager_main_t *smm = &session_manager_main;
 319   session_kv4_t kv4;
 320   stream_session_t *s;
 321   int rv;
 322
 323   /* Lookup session amongst established ones */
 324   make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
 325   rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
 326   if (rv == 0)
 327     {
 328       s = stream_session_get_tsi (kv4.value, my_thread_index);
 329
 330       return tp_vfts[s->session_type].get_connection (s->connection_index,
 331                                                       my_thread_index);
 332     }
 333
 334   /* If nothing is found, check if any listener is available */
 335   s = stream_session_lookup_listener4 (lcl, lcl_port, proto);
 336   if (s)
 337     return tp_vfts[s->session_type].get_listener (s->connection_index);
 338
 339   /* Finally, try half-open connections */
 340   rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
 341   if (rv == 0)
 342     return tp_vfts[proto].get_half_open (kv4.value & 0xFFFFFFFF);
 343
 344   return 0;
 345 }
 346
 347 transport_connection_t *
 348 stream_session_lookup_transport6 (ip6_address_t * lcl, ip6_address_t * rmt,
 349                                   u16 lcl_port, u16 rmt_port, u8 proto,
 350                                   u32 my_thread_index)
 351 {
 352   session_manager_main_t *smm = &session_manager_main;
 353   stream_session_t *s;
 354   session_kv6_t kv6;
 355   int rv;
 356
 357   make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
 358   rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
 359   if (rv == 0)
 360     {
 361       s = stream_session_get_tsi (kv6.value, my_thread_index);
 362
 363       return tp_vfts[s->session_type].get_connection (s->connection_index,
 364                                                       my_thread_index);
 365     }
 366
 367   /* If nothing is found, check if any listener is available */
 368   s = stream_session_lookup_listener6 (lcl, lcl_port, proto);
 369   if (s)
 370     return tp_vfts[s->session_type].get_listener (s->connection_index);
 371
 372   /* Finally, try half-open connections */
 373   rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
 374   if (rv == 0)
 375     return tp_vfts[proto].get_half_open (kv6.value & 0xFFFFFFFF);
 376
 377   return 0;
 378 }
 379
 380 int
 381 stream_session_create_i (segment_manager_t * sm, transport_connection_t * tc,
 382                          stream_session_t ** ret_s)
 383 {
 384   session_manager_main_t *smm = &session_manager_main;
 385   svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
 386   u32 fifo_segment_index;
 387   u32 pool_index;
 388   stream_session_t *s;
 389   u64 value;
 390   u32 thread_index = tc->thread_index;
 391   int rv;
 392
 393   if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
 394                                                  &server_tx_fifo,
 395                                                  &fifo_segment_index)))
 396     return rv;
 397
 398   /* Create the session */
 399   pool_get (smm->sessions[thread_index], s);
 400   memset (s, 0, sizeof (*s));
 401
 402   /* Initialize backpointers */
 403   pool_index = s - smm->sessions[thread_index];
 404   server_rx_fifo->master_session_index = pool_index;
 405   server_rx_fifo->master_thread_index = thread_index;
 406
 407   server_tx_fifo->master_session_index = pool_index;
 408   server_tx_fifo->master_thread_index = thread_index;
 409
 410   s->server_rx_fifo = server_rx_fifo;
 411   s->server_tx_fifo = server_tx_fifo;
 412
 413   /* Initialize state machine, such as it is... */
 414   s->session_type = tc->proto;
 415   s->session_state = SESSION_STATE_CONNECTING;
 416   s->svm_segment_index = fifo_segment_index;
 417   s->thread_index = thread_index;
 418   s->session_index = pool_index;
 419
 420   /* Attach transport to session */
 421   s->connection_index = tc->c_index;
 422
 423   /* Attach session to transport */
 424   tc->s_index = s->session_index;
 425
 426   /* Add to the main lookup table */
 427   value = (((u64) thread_index) << 32) | (u64) s->session_index;
 428   stream_session_table_add_for_tc (tc, value);
 429
 430   *ret_s = s;
 431
 432   return 0;
 433 }
 434
 435 /*
 436  * Enqueue data for delivery to session peer. Does not notify peer of enqueue
 437  * event but on request can queue notification events for later delivery by
 438  * calling stream_server_flush_enqueue_events().
 439  *
 440  * @param tc Transport connection which is to be enqueued data
 441  * @param data Data to be enqueued
 442  * @param len Length of data to be enqueued
 443  * @param queue_event Flag to indicate if peer is to be notified or if event
 444  *                    is to be queued. The former is useful when more data is
 445  *                    enqueued and only one event is to be generated.
 446  * @return Number of bytes enqueued or a negative value if enqueueing failed.
 447  */
 448 int
 449 stream_session_enqueue_data (transport_connection_t * tc, u8 * data, u16 len,
 450                              u8 queue_event)
 451 {
 452   stream_session_t *s;
 453   int enqueued;
 454
 455   s = stream_session_get (tc->s_index, tc->thread_index);
 456
 457   /* Make sure there's enough space left. We might've filled the pipes */
 458   if (PREDICT_FALSE (len > svm_fifo_max_enqueue (s->server_rx_fifo)))
 459     return -1;
 460
 461   enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
 462
 463   if (queue_event)
 464     {
 465       /* Queue RX event on this fifo. Eventually these will need to be flushed
 466        * by calling stream_server_flush_enqueue_events () */
 467       session_manager_main_t *smm = vnet_get_session_manager_main ();
 468       u32 thread_index = s->thread_index;
 469       u32 my_enqueue_epoch = smm->current_enqueue_epoch[thread_index];
 470
 471       if (s->enqueue_epoch != my_enqueue_epoch)
 472         {
 473           s->enqueue_epoch = my_enqueue_epoch;
 474           vec_add1 (smm->session_indices_to_enqueue_by_thread[thread_index],
 475                     s - smm->sessions[thread_index]);
 476         }
 477     }
 478
 479   return enqueued;
 480 }
 481
 482 /** Check if we have space in rx fifo to push more bytes */
 483 u8
 484 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
 485                          u16 data_len)
 486 {
 487   stream_session_t *s = stream_session_get (tc->c_index, thread_index);
 488
 489   if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
 490     return 1;
 491
 492   if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
 493     return 1;
 494
 495   return 0;
 496 }
 497
 498 u32
 499 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
 500                            u32 offset, u32 max_bytes)
 501 {
 502   stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
 503   return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
 504 }
 505
 506 u32
 507 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
 508 {
 509   stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
 510   return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
 511 }
 512
 513 /**
 514  * Notify session peer that new data has been enqueued.
 515  *
 516  * @param s Stream session for which the event is to be generated.
 517  * @param block Flag to indicate if call should block if event queue is full.
 518  *
 519  * @return 0 on succes or negative number if failed to send notification.
 520  */
 521 static int
 522 stream_session_enqueue_notify (stream_session_t * s, u8 block)
 523 {
 524   application_t *app;
 525   session_fifo_event_t evt;
 526   unix_shared_memory_queue_t *q;
 527   static u32 serial_number;
 528
 529   if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
 530     return 0;
 531
 532   /* Get session's server */
 533   app = application_get (s->app_index);
 534
 535   /* Built-in server? Hand event to the callback... */
 536   if (app->cb_fns.builtin_server_rx_callback)
 537     return app->cb_fns.builtin_server_rx_callback (s);
 538
 539   /* If no event, send one */
 540   if (svm_fifo_set_event (s->server_rx_fifo))
 541     {
 542       /* Fabricate event */
 543       evt.fifo = s->server_rx_fifo;
 544       evt.event_type = FIFO_EVENT_APP_RX;
 545       evt.event_id = serial_number++;
 546
 547       /* Add event to server's event queue */
 548       q = app->event_queue;
 549
 550       /* Based on request block (or not) for lack of space */
 551       if (block || PREDICT_TRUE (q->cursize < q->maxsize))
 552         unix_shared_memory_queue_add (app->event_queue, (u8 *) & evt,
 553                                       0 /* do wait for mutex */ );
 554       else
 555         {
 556           clib_warning ("fifo full");
 557           return -1;
 558         }
 559     }
 560
 561   /* *INDENT-OFF* */
 562   SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
 563       ed->data[0] = evt.event_id;
 564       ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
 565   }));
 566   /* *INDENT-ON* */
 567
 568   return 0;
 569 }
 570
 571 /**
 572  * Flushes queue of sessions that are to be notified of new data
 573  * enqueued events.
 574  *
 575  * @param thread_index Thread index for which the flush is to be performed.
 576  * @return 0 on success or a positive number indicating the number of
 577  *         failures due to API queue being full.
 578  */
 579 int
 580 session_manager_flush_enqueue_events (u32 thread_index)
 581 {
 582   session_manager_main_t *smm = &session_manager_main;
 583   u32 *session_indices_to_enqueue;
 584   int i, errors = 0;
 585
 586   session_indices_to_enqueue =
 587     smm->session_indices_to_enqueue_by_thread[thread_index];
 588
 589   for (i = 0; i < vec_len (session_indices_to_enqueue); i++)
 590     {
 591       stream_session_t *s0;
 592
 593       /* Get session */
 594       s0 = stream_session_get (session_indices_to_enqueue[i], thread_index);
 595       if (stream_session_enqueue_notify (s0, 0 /* don't block */ ))
 596         {
 597           errors++;
 598         }
 599     }
 600
 601   vec_reset_length (session_indices_to_enqueue);
 602
 603   smm->session_indices_to_enqueue_by_thread[thread_index] =
 604     session_indices_to_enqueue;
 605
 606   /* Increment enqueue epoch for next round */
 607   smm->current_enqueue_epoch[thread_index]++;
 608
 609   return errors;
 610 }
 611
 612 void
 613 stream_session_connect_notify (transport_connection_t * tc, u8 sst,
 614                                u8 is_fail)
 615 {
 616   session_manager_main_t *smm = &session_manager_main;
 617   application_t *app;
 618   stream_session_t *new_s = 0;
 619   u64 handle;
 620   u32 api_context = 0;
 621
 622   handle = stream_session_half_open_lookup (smm, &tc->lcl_ip, &tc->rmt_ip,
 623                                             tc->lcl_port, tc->rmt_port,
 624                                             tc->proto);
 625   if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
 626     {
 627       clib_warning ("This can't be good!");
 628       return;
 629     }
 630
 631   /* Get the app's index from the handle we stored when opening connection */
 632   app = application_get (handle >> 32);
 633   api_context = tc->s_index;
 634
 635   if (!is_fail)
 636     {
 637       segment_manager_t *sm;
 638       sm = application_get_connect_segment_manager (app);
 639
 640       /* Create new session (svm segments are allocated if needed) */
 641       if (stream_session_create_i (sm, tc, &new_s))
 642         return;
 643
 644       new_s->app_index = app->index;
 645     }
 646
 647   /* Notify client */
 648   app->cb_fns.session_connected_callback (app->index, api_context, new_s,
 649                                           is_fail);
 650
 651   /* Cleanup session lookup */
 652   stream_session_half_open_table_del (smm, sst, tc);
 653 }
 654
 655 void
 656 stream_session_accept_notify (transport_connection_t * tc)
 657 {
 658   application_t *server;
 659   stream_session_t *s;
 660
 661   s = stream_session_get (tc->s_index, tc->thread_index);
 662   server = application_get (s->app_index);
 663   server->cb_fns.session_accept_callback (s);
 664 }
 665
 666 /**
 667  * Notification from transport that connection is being closed.
 668  *
 669  * A disconnect is sent to application but state is not removed. Once
 670  * disconnect is acknowledged by application, session disconnect is called.
 671  * Ultimately this leads to close being called on transport (passive close).
 672  */
 673 void
 674 stream_session_disconnect_notify (transport_connection_t * tc)
 675 {
 676   application_t *server;
 677   stream_session_t *s;
 678
 679   s = stream_session_get (tc->s_index, tc->thread_index);
 680   server = application_get (s->app_index);
 681   server->cb_fns.session_disconnect_callback (s);
 682 }
 683
 684 /**
 685  * Cleans up session and associated app if needed.
 686  */
 687 void
 688 stream_session_delete (stream_session_t * s)
 689 {
 690   session_manager_main_t *smm = vnet_get_session_manager_main ();
 691
 692   /* Delete from the main lookup table. */
 693   stream_session_table_del (smm, s);
 694
 695   /* Cleanup fifo segments */
 696   segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
 697                                  s->server_tx_fifo);
 698
 699   pool_put (smm->sessions[s->thread_index], s);
 700 }
 701
 702 /**
 703  * Notification from transport that connection is being deleted
 704  *
 705  * This should be called only on previously fully established sessions. For
 706  * instance failed connects should call stream_session_connect_notify and
 707  * indicate that the connect has failed.
 708  */
 709 void
 710 stream_session_delete_notify (transport_connection_t * tc)
 711 {
 712   stream_session_t *s;
 713
 714   /* App might've been removed already */
 715   s = stream_session_get_if_valid (tc->s_index, tc->thread_index);
 716   if (!s)
 717     {
 718       return;
 719     }
 720   stream_session_delete (s);
 721 }
 722
 723 /**
 724  * Notify application that connection has been reset.
 725  */
 726 void
 727 stream_session_reset_notify (transport_connection_t * tc)
 728 {
 729   stream_session_t *s;
 730   application_t *app;
 731   s = stream_session_get (tc->s_index, tc->thread_index);
 732
 733   app = application_get (s->app_index);
 734   app->cb_fns.session_reset_callback (s);
 735 }
 736
 737 /**
 738  * Accept a stream session. Optionally ping the server by callback.
 739  */
 740 int
 741 stream_session_accept (transport_connection_t * tc, u32 listener_index,
 742                        u8 sst, u8 notify)
 743 {
 744   application_t *server;
 745   stream_session_t *s, *listener;
 746   segment_manager_t *sm;
 747
 748   int rv;
 749
 750   /* Find the server */
 751   listener = listen_session_get (sst, listener_index);
 752   server = application_get (listener->app_index);
 753
 754   sm = application_get_listen_segment_manager (server, listener);
 755   if ((rv = stream_session_create_i (sm, tc, &s)))
 756     return rv;
 757
 758   s->app_index = server->index;
 759   s->listener_index = listener_index;
 760
 761   /* Shoulder-tap the server */
 762   if (notify)
 763     {
 764       server->cb_fns.session_accept_callback (s);
 765     }
 766
 767   return 0;
 768 }
 769
 770 /**
 771  * Ask transport to open connection to remote transport endpoint.
 772  *
 773  * Stores handle for matching request with reply since the call can be
 774  * asynchronous. For instance, for TCP the 3-way handshake must complete
 775  * before reply comes. Session is only created once connection is established.
 776  *
 777  * @param app_index Index of the application requesting the connect
 778  * @param st Session type requested.
 779  * @param tep Remote transport endpoint
 780  * @param res Resulting transport connection .
 781  */
 782 int
 783 stream_session_open (u32 app_index, session_type_t st,
 784                      transport_endpoint_t * tep,
 785                      transport_connection_t ** res)
 786 {
 787   transport_connection_t *tc;
 788   int rv;
 789   u64 handle;
 790
 791   rv = tp_vfts[st].open (&tep->ip, tep->port);
 792   if (rv < 0)
 793     {
 794       clib_warning ("Transport failed to open connection.");
 795       return VNET_API_ERROR_SESSION_CONNECT_FAIL;
 796     }
 797
 798   tc = tp_vfts[st].get_half_open ((u32) rv);
 799
 800   /* Save app and tc index. The latter is needed to help establish the
 801    * connection while the former is needed when the connect notify comes
 802    * and we have to notify the external app */
 803   handle = (((u64) app_index) << 32) | (u64) tc->c_index;
 804
 805   /* Add to the half-open lookup table */
 806   stream_session_half_open_table_add (st, tc, handle);
 807
 808   *res = tc;
 809
 810   return 0;
 811 }
 812
 813 /**
 814  * Ask transport to listen on local transport endpoint.
 815  *
 816  * @param s Session for which listen will be called. Note that unlike
 817  *          established sessions, listen sessions are not associated to a
 818  *          thread.
 819  * @param tep Local endpoint to be listened on.
 820  */
 821 int
 822 stream_session_listen (stream_session_t * s, transport_endpoint_t * tep)
 823 {
 824   transport_connection_t *tc;
 825   u32 tci;
 826
 827   /* Transport bind/listen  */
 828   tci = tp_vfts[s->session_type].bind (s->session_index, &tep->ip, tep->port);
 829
 830   if (tci == (u32) ~ 0)
 831     return -1;
 832
 833   /* Attach transport to session */
 834   s->connection_index = tci;
 835   tc = tp_vfts[s->session_type].get_listener (tci);
 836
 837   /* Weird but handle it ... */
 838   if (tc == 0)
 839     return -1;
 840
 841   /* Add to the main lookup table */
 842   stream_session_table_add_for_tc (tc, s->session_index);
 843
 844   return 0;
 845 }
 846
 847 /**
 848  * Ask transport to stop listening on local transport endpoint.
 849  *
 850  * @param s Session to stop listening on. It must be in state LISTENING.
 851  */
 852 int
 853 stream_session_stop_listen (stream_session_t * s)
 854 {
 855   transport_connection_t *tc;
 856
 857   if (s->session_state != SESSION_STATE_LISTENING)
 858     {
 859       clib_warning ("not a listening session");
 860       return -1;
 861     }
 862
 863   tc = tp_vfts[s->session_type].get_listener (s->connection_index);
 864   if (!tc)
 865     {
 866       clib_warning ("no transport");
 867       return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
 868     }
 869
 870   stream_session_table_del_for_tc (tc);
 871   tp_vfts[s->session_type].unbind (s->connection_index);
 872   return 0;
 873 }
 874
 875 void
 876 session_send_session_evt_to_thread (u64 session_handle,
 877                                     fifo_event_type_t evt_type,
 878                                     u32 thread_index)
 879 {
 880   static u16 serial_number = 0;
 881   session_fifo_event_t evt;
 882   unix_shared_memory_queue_t *q;
 883
 884   /* Fabricate event */
 885   evt.session_handle = session_handle;
 886   evt.event_type = evt_type;
 887   evt.event_id = serial_number++;
 888
 889   q = session_manager_get_vpp_event_queue (thread_index);
 890
 891   /* Based on request block (or not) for lack of space */
 892   if (PREDICT_TRUE (q->cursize < q->maxsize))
 893     unix_shared_memory_queue_add (q, (u8 *) & evt,
 894                                   0 /* do wait for mutex */ );
 895   else
 896     {
 897       clib_warning ("queue full");
 898       return;
 899     }
 900 }
 901
 902 /**
 903  * Disconnect session and propagate to transport. This should eventually
 904  * result in a delete notification that allows us to cleanup session state.
 905  * Called for both active/passive disconnects.
 906  *
 907  * Should be called from the session's thread.
 908  */
 909 void
 910 stream_session_disconnect (stream_session_t * s)
 911 {
 912   s->session_state = SESSION_STATE_CLOSED;
 913   tp_vfts[s->session_type].close (s->connection_index, s->thread_index);
 914 }
 915
 916 /**
 917  * Cleanup transport and session state.
 918  *
 919  * Notify transport of the cleanup, wait for a delete notify to actually
 920  * remove the session state.
 921  */
 922 void
 923 stream_session_cleanup (stream_session_t * s)
 924 {
 925   session_manager_main_t *smm = &session_manager_main;
 926   int rv;
 927
 928   s->session_state = SESSION_STATE_CLOSED;
 929
 930   /* Delete from the main lookup table to avoid more enqueues */
 931   rv = stream_session_table_del (smm, s);
 932   if (rv)
 933     clib_warning ("hash delete error, rv %d", rv);
 934
 935   tp_vfts[s->session_type].cleanup (s->connection_index, s->thread_index);
 936 }
 937
 938 void
 939 session_register_transport (u8 type, const transport_proto_vft_t * vft)
 940 {
 941   session_manager_main_t *smm = vnet_get_session_manager_main ();
 942
 943   vec_validate (tp_vfts, type);
 944   tp_vfts[type] = *vft;
 945
 946   /* If an offset function is provided, then peek instead of dequeue */
 947   smm->session_tx_fns[type] =
 948     (vft->tx_fifo_offset) ? session_tx_fifo_peek_and_snd :
 949     session_tx_fifo_dequeue_and_snd;
 950 }
 951
 952 transport_proto_vft_t *
 953 session_get_transport_vft (u8 type)
 954 {
 955   if (type >= vec_len (tp_vfts))
 956     return 0;
 957   return &tp_vfts[type];
 958 }
 959
 960 /**
 961  * Allocate vpp event queue (once) per worker thread
 962  */
 963 void
 964 session_vpp_event_queue_allocate (session_manager_main_t * smm,
 965                                   u32 thread_index)
 966 {
 967   api_main_t *am = &api_main;
 968   void *oldheap;
 969
 970   if (smm->vpp_event_queues[thread_index] == 0)
 971     {
 972       /* Allocate event fifo in the /vpe-api shared-memory segment */
 973       oldheap = svm_push_data_heap (am->vlib_rp);
 974
 975       smm->vpp_event_queues[thread_index] =
 976         unix_shared_memory_queue_init (2048 /* nels $$$$ config */ ,
 977                                        sizeof (session_fifo_event_t),
 978                                        0 /* consumer pid */ ,
 979                                        0
 980                                        /* (do not) send signal when queue non-empty */
 981         );
 982
 983       svm_pop_heap (oldheap);
 984     }
 985 }
 986
 987 static clib_error_t *
 988 session_manager_main_enable (vlib_main_t * vm)
 989 {
 990   session_manager_main_t *smm = &session_manager_main;
 991   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 992   u32 num_threads;
 993   int i;
 994
 995   num_threads = 1 /* main thread */  + vtm->n_threads;
 996
 997   if (num_threads < 1)
 998     return clib_error_return (0, "n_thread_stacks not set");
 999
1000   /* $$$ config parameters */
1001   svm_fifo_segment_init (0x200000000ULL /* first segment base VA */ ,
1002                          20 /* timeout in seconds */ );
1003
1004   /* configure per-thread ** vectors */
1005   vec_validate (smm->sessions, num_threads - 1);
1006   vec_validate (smm->session_indices_to_enqueue_by_thread, num_threads - 1);
1007   vec_validate (smm->tx_buffers, num_threads - 1);
1008   vec_validate (smm->fifo_events, num_threads - 1);
1009   vec_validate (smm->evts_partially_read, num_threads - 1);
1010   vec_validate (smm->current_enqueue_epoch, num_threads - 1);
1011   vec_validate (smm->vpp_event_queues, num_threads - 1);
1012
1013 #if SESSION_DBG
1014   vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1015 #endif
1016
1017   /* Allocate vpp event queues */
1018   for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1019     session_vpp_event_queue_allocate (smm, i);
1020
1021   /* $$$$ preallocate hack config parameter */
1022   for (i = 0; i < 200000; i++)
1023     {
1024       stream_session_t *ss;
1025       pool_get (smm->sessions[0], ss);
1026       memset (ss, 0, sizeof (*ss));
1027     }
1028
1029   for (i = 0; i < 200000; i++)
1030     pool_put_index (smm->sessions[0], i);
1031
1032   clib_bihash_init_16_8 (&smm->v4_session_hash, "v4 session table",
1033                          200000 /* $$$$ config parameter nbuckets */ ,
1034                          (64 << 20) /*$$$ config parameter table size */ );
1035   clib_bihash_init_48_8 (&smm->v6_session_hash, "v6 session table",
1036                          200000 /* $$$$ config parameter nbuckets */ ,
1037                          (64 << 20) /*$$$ config parameter table size */ );
1038
1039   clib_bihash_init_16_8 (&smm->v4_half_open_hash, "v4 half-open table",
1040                          200000 /* $$$$ config parameter nbuckets */ ,
1041                          (64 << 20) /*$$$ config parameter table size */ );
1042   clib_bihash_init_48_8 (&smm->v6_half_open_hash, "v6 half-open table",
1043                          200000 /* $$$$ config parameter nbuckets */ ,
1044                          (64 << 20) /*$$$ config parameter table size */ );
1045
1046   smm->is_enabled = 1;
1047
1048   /* Enable TCP transport */
1049   vnet_tcp_enable_disable (vm, 1);
1050
1051   return 0;
1052 }
1053
1054 void
1055 session_node_enable_disable (u8 is_en)
1056 {
1057   u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1058   /* *INDENT-OFF* */
1059   foreach_vlib_main (({
1060     vlib_node_set_state (this_vlib_main, session_queue_node.index,
1061                          state);
1062   }));
1063   /* *INDENT-ON* */
1064 }
1065
1066 clib_error_t *
1067 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1068 {
1069   if (is_en)
1070     {
1071       if (session_manager_main.is_enabled)
1072         return 0;
1073
1074       session_node_enable_disable (is_en);
1075
1076       return session_manager_main_enable (vm);
1077     }
1078   else
1079     {
1080       session_manager_main.is_enabled = 0;
1081       session_node_enable_disable (is_en);
1082     }
1083
1084   return 0;
1085 }
1086
1087 clib_error_t *
1088 session_manager_main_init (vlib_main_t * vm)
1089 {
1090   session_manager_main_t *smm = &session_manager_main;
1091
1092   smm->vlib_main = vm;
1093   smm->vnet_main = vnet_get_main ();
1094   smm->is_enabled = 0;
1095
1096   return 0;
1097 }
1098
1099 VLIB_INIT_FUNCTION (session_manager_main_init)
1100 /*
1101  * fd.io coding-style-patch-verification: ON
1102  *
1103  * Local Variables:
1104  * eval: (c-set-style "gnu")
1105  * End:
1106  */