src/vnet/session/session.h

   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 #ifndef __included_session_h__
  16 #define __included_session_h__
  17
  18 #include <vnet/session/stream_session.h>
  19 #include <vnet/session/session_lookup.h>
  20 #include <vnet/session/transport_interface.h>
  21 #include <vlibmemory/unix_shared_memory_queue.h>
  22 #include <vnet/session/session_debug.h>
  23 #include <vnet/session/segment_manager.h>
  24
  25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
  26 #define INVALID_INDEX ((u32)~0)
  27 #define SESSION_PROXY_LISTENER_INDEX ((u32)~0 - 1)
  28
  29 /* TODO decide how much since we have pre-data as well */
  30 #define MAX_HDRS_LEN    100     /* Max number of bytes for headers */
  31
  32 typedef enum
  33 {
  34   FIFO_EVENT_APP_RX,
  35   FIFO_EVENT_APP_TX,
  36   FIFO_EVENT_TIMEOUT,
  37   FIFO_EVENT_DISCONNECT,
  38   FIFO_EVENT_BUILTIN_RX,
  39   FIFO_EVENT_RPC,
  40 } fifo_event_type_t;
  41
  42 static inline const char *
  43 fifo_event_type_str (fifo_event_type_t et)
  44 {
  45   switch (et)
  46     {
  47     case FIFO_EVENT_APP_RX:
  48       return "FIFO_EVENT_APP_RX";
  49     case FIFO_EVENT_APP_TX:
  50       return "FIFO_EVENT_APP_TX";
  51     case FIFO_EVENT_TIMEOUT:
  52       return "FIFO_EVENT_TIMEOUT";
  53     case FIFO_EVENT_DISCONNECT:
  54       return "FIFO_EVENT_DISCONNECT";
  55     case FIFO_EVENT_BUILTIN_RX:
  56       return "FIFO_EVENT_BUILTIN_RX";
  57     case FIFO_EVENT_RPC:
  58       return "FIFO_EVENT_RPC";
  59     default:
  60       return "UNKNOWN FIFO EVENT";
  61     }
  62 }
  63
  64 #define foreach_session_input_error                                     \
  65 _(NO_SESSION, "No session drops")                                       \
  66 _(NO_LISTENER, "No listener for dst port drops")                        \
  67 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  68 _(NOT_READY, "Session not ready packets")                               \
  69 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  70 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  71 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  72 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
  73 _(NO_SPACE, "Couldn't allocate a fifo pair")
  74
  75 typedef enum
  76 {
  77 #define _(sym,str) SESSION_ERROR_##sym,
  78   foreach_session_input_error
  79 #undef _
  80     SESSION_N_ERROR,
  81 } session_error_t;
  82
  83 typedef struct
  84 {
  85   void *fp;
  86   void *arg;
  87 } rpc_args_t;
  88
  89 /* *INDENT-OFF* */
  90 typedef CLIB_PACKED (struct {
  91   union
  92     {
  93       svm_fifo_t * fifo;
  94       u64 session_handle;
  95       rpc_args_t rpc_args;
  96     };
  97   u8 event_type;
  98   u8 postponed;
  99 }) session_fifo_event_t;
 100 /* *INDENT-ON* */
 101
 102 /* Forward definition */
 103 typedef struct _session_manager_main session_manager_main_t;
 104
 105 typedef int
 106   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
 107                         session_manager_main_t * smm,
 108                         session_fifo_event_t * e0, stream_session_t * s0,
 109                         u32 thread_index, int *n_tx_pkts);
 110
 111 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 112 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 113
 114 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e);
 115
 116 struct _session_manager_main
 117 {
 118   /** Per worker thread session pools */
 119   stream_session_t **sessions;
 120
 121   /** Per worker-thread count of threads peeking into the session pool */
 122   u32 *session_peekers;
 123
 124   /** Per worker-thread rw peekers locks */
 125   clib_spinlock_t *peekers_readers_locks;
 126   clib_spinlock_t *peekers_write_locks;
 127
 128   /** Pool of listen sessions. Same type as stream sessions to ease lookups */
 129   stream_session_t **listen_sessions;
 130
 131   /** Per-proto, per-worker enqueue epoch counters */
 132   u32 *current_enqueue_epoch[TRANSPORT_N_PROTO];
 133
 134   /** Per-proto, per-worker thread vector of sessions to enqueue */
 135   u32 **session_to_enqueue[TRANSPORT_N_PROTO];
 136
 137   /** per-worker tx buffer free lists */
 138   u32 **tx_buffers;
 139
 140   /** Per worker-thread vector of partially read events */
 141   session_fifo_event_t **free_event_vector;
 142
 143   /** per-worker active event vectors */
 144   session_fifo_event_t **pending_event_vector;
 145
 146   /** per-worker postponed disconnects */
 147   session_fifo_event_t **pending_disconnects;
 148
 149   /** vpp fifo event queue */
 150   unix_shared_memory_queue_t **vpp_event_queues;
 151
 152   /** Unique segment name counter */
 153   u32 unique_segment_name_counter;
 154
 155   /** Per transport rx function that can either dequeue or peek */
 156   session_fifo_rx_fn **session_tx_fns;
 157
 158   /** Per session type output nodes. Could optimize to group nodes by
 159    * fib but lookup would then require session type parsing in session node.
 160    * Trade memory for speed, for now */
 161   u32 *session_type_to_next;
 162
 163   /** Session manager is enabled */
 164   u8 is_enabled;
 165
 166   /** vpp fifo event queue configured length */
 167   u32 configured_event_queue_length;
 168
 169   /*
 170    * Config parameters
 171    */
 172
 173   /** session table size parameters */
 174   u32 configured_v4_session_table_buckets;
 175   u32 configured_v4_session_table_memory;
 176   u32 configured_v4_halfopen_table_buckets;
 177   u32 configured_v4_halfopen_table_memory;
 178   u32 configured_v6_session_table_buckets;
 179   u32 configured_v6_session_table_memory;
 180   u32 configured_v6_halfopen_table_buckets;
 181   u32 configured_v6_halfopen_table_memory;
 182
 183   /** Transport table (preallocation) size parameters */
 184   u32 local_endpoints_table_memory;
 185   u32 local_endpoints_table_buckets;
 186
 187   /** Preallocate session config parameter */
 188   u32 preallocated_sessions;
 189
 190 #if SESSION_DBG
 191   /**
 192    * last event poll time by thread
 193    * Debug only. Will cause false cache-line sharing as-is
 194    */
 195   f64 *last_event_poll_by_thread;
 196 #endif
 197
 198 };
 199
 200 extern session_manager_main_t session_manager_main;
 201 extern vlib_node_registration_t session_queue_node;
 202
 203 /*
 204  * Session manager function
 205  */
 206 always_inline session_manager_main_t *
 207 vnet_get_session_manager_main ()
 208 {
 209   return &session_manager_main;
 210 }
 211
 212 always_inline u8
 213 stream_session_is_valid (u32 si, u8 thread_index)
 214 {
 215   stream_session_t *s;
 216   s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 217   if (s->thread_index != thread_index || s->session_index != si
 218       /* || s->server_rx_fifo->master_session_index != si
 219          || s->server_tx_fifo->master_session_index != si
 220          || s->server_rx_fifo->master_thread_index != thread_index
 221          || s->server_tx_fifo->master_thread_index != thread_index */ )
 222     return 0;
 223   return 1;
 224 }
 225
 226 stream_session_t *session_alloc (u32 thread_index);
 227
 228 always_inline stream_session_t *
 229 session_get (u32 si, u32 thread_index)
 230 {
 231   ASSERT (stream_session_is_valid (si, thread_index));
 232   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 233 }
 234
 235 always_inline stream_session_t *
 236 session_get_if_valid (u64 si, u32 thread_index)
 237 {
 238   if (thread_index >= vec_len (session_manager_main.sessions))
 239     return 0;
 240
 241   if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
 242     return 0;
 243
 244   ASSERT (stream_session_is_valid (si, thread_index));
 245   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 246 }
 247
 248 always_inline u64
 249 session_handle (stream_session_t * s)
 250 {
 251   return ((u64) s->thread_index << 32) | (u64) s->session_index;
 252 }
 253
 254 always_inline u32
 255 session_index_from_handle (u64 handle)
 256 {
 257   return handle & 0xFFFFFFFF;
 258 }
 259
 260 always_inline u32
 261 session_thread_from_handle (u64 handle)
 262 {
 263   return handle >> 32;
 264 }
 265
 266 always_inline void
 267 session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
 268 {
 269   *index = session_index_from_handle (handle);
 270   *thread_index = session_thread_from_handle (handle);
 271 }
 272
 273 always_inline stream_session_t *
 274 session_get_from_handle (u64 handle)
 275 {
 276   session_manager_main_t *smm = &session_manager_main;
 277   return
 278     pool_elt_at_index (smm->sessions[session_thread_from_handle (handle)],
 279                        session_index_from_handle (handle));
 280 }
 281
 282 always_inline transport_proto_t
 283 session_get_transport_proto (stream_session_t * s)
 284 {
 285   return (s->session_type >> 1);
 286 }
 287
 288 always_inline session_type_t
 289 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
 290 {
 291   return (proto << 1 | is_ip4);
 292 }
 293
 294 /**
 295  * Acquires a lock that blocks a session pool from expanding.
 296  *
 297  * This is typically used for safely peeking into other threads'
 298  * pools in order to clone elements. Lock should be dropped as soon
 299  * as possible by calling @ref session_pool_remove_peeker.
 300  *
 301  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 302  * it may lead to free elt bitmap expansion/contraction!
 303  */
 304 always_inline void
 305 session_pool_add_peeker (u32 thread_index)
 306 {
 307   session_manager_main_t *smm = &session_manager_main;
 308   if (thread_index == vlib_get_thread_index ())
 309     return;
 310   clib_spinlock_lock_if_init (&smm->peekers_readers_locks[thread_index]);
 311   smm->session_peekers[thread_index] += 1;
 312   if (smm->session_peekers[thread_index] == 1)
 313     clib_spinlock_lock_if_init (&smm->peekers_write_locks[thread_index]);
 314   clib_spinlock_unlock_if_init (&smm->peekers_readers_locks[thread_index]);
 315 }
 316
 317 always_inline void
 318 session_pool_remove_peeker (u32 thread_index)
 319 {
 320   session_manager_main_t *smm = &session_manager_main;
 321   if (thread_index == vlib_get_thread_index ())
 322     return;
 323   ASSERT (session_manager_main.session_peekers[thread_index] > 0);
 324   clib_spinlock_lock_if_init (&smm->peekers_readers_locks[thread_index]);
 325   smm->session_peekers[thread_index] -= 1;
 326   if (smm->session_peekers[thread_index] == 0)
 327     clib_spinlock_unlock_if_init (&smm->peekers_write_locks[thread_index]);
 328   clib_spinlock_unlock_if_init (&smm->peekers_readers_locks[thread_index]);
 329 }
 330
 331 /**
 332  * Get session from handle and 'lock' pool resize if not in same thread
 333  *
 334  * Caller should drop the peek 'lock' as soon as possible.
 335  */
 336 always_inline stream_session_t *
 337 session_get_from_handle_safe (u64 handle)
 338 {
 339   session_manager_main_t *smm = &session_manager_main;
 340   u32 thread_index = session_thread_from_handle (handle);
 341   if (thread_index == vlib_get_thread_index ())
 342     {
 343       return pool_elt_at_index (smm->sessions[thread_index],
 344                                 session_index_from_handle (handle));
 345     }
 346   else
 347     {
 348       session_pool_add_peeker (thread_index);
 349       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 350       return smm->sessions[thread_index] + session_index_from_handle (handle);
 351     }
 352 }
 353
 354 always_inline stream_session_t *
 355 stream_session_listener_get (u8 sst, u64 si)
 356 {
 357   return pool_elt_at_index (session_manager_main.listen_sessions[sst], si);
 358 }
 359
 360 always_inline u32
 361 stream_session_get_index (stream_session_t * s)
 362 {
 363   if (s->session_state == SESSION_STATE_LISTENING)
 364     return s - session_manager_main.listen_sessions[s->session_type];
 365
 366   return s - session_manager_main.sessions[s->thread_index];
 367 }
 368
 369 always_inline u32
 370 stream_session_max_rx_enqueue (transport_connection_t * tc)
 371 {
 372   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 373   return svm_fifo_max_enqueue (s->server_rx_fifo);
 374 }
 375
 376 always_inline u32
 377 stream_session_rx_fifo_size (transport_connection_t * tc)
 378 {
 379   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 380   return s->server_rx_fifo->nitems;
 381 }
 382
 383 always_inline u32
 384 session_get_index (stream_session_t * s)
 385 {
 386   return (s - session_manager_main.sessions[s->thread_index]);
 387 }
 388
 389 always_inline stream_session_t *
 390 session_clone_safe (u32 session_index, u32 thread_index)
 391 {
 392   stream_session_t *old_s, *new_s;
 393   u32 current_thread_index = vlib_get_thread_index ();
 394
 395   /* If during the memcpy pool is reallocated AND the memory allocator
 396    * decides to give the old chunk of memory to somebody in a hurry to
 397    * scribble something on it, we have a problem. So add this thread as
 398    * a session pool peeker.
 399    */
 400   session_pool_add_peeker (thread_index);
 401   new_s = session_alloc (current_thread_index);
 402   old_s = session_manager_main.sessions[thread_index] + session_index;
 403   clib_memcpy (new_s, old_s, sizeof (*new_s));
 404   session_pool_remove_peeker (thread_index);
 405   new_s->thread_index = current_thread_index;
 406   new_s->session_index = session_get_index (new_s);
 407   return new_s;
 408 }
 409
 410 transport_connection_t *session_get_transport (stream_session_t * s);
 411
 412 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
 413
 414 stream_session_t *session_alloc (u32 thread_index);
 415 int
 416 session_enqueue_stream_connection (transport_connection_t * tc,
 417                                    vlib_buffer_t * b, u32 offset,
 418                                    u8 queue_event, u8 is_in_order);
 419 int session_enqueue_dgram_connection (stream_session_t * s, vlib_buffer_t * b,
 420                                       u8 proto, u8 queue_event);
 421 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
 422                                u32 offset, u32 max_bytes);
 423 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 424
 425 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
 426 int session_dgram_connect_notify (transport_connection_t * tc,
 427                                   u32 old_thread_index,
 428                                   stream_session_t ** new_session);
 429 void stream_session_init_fifos_pointers (transport_connection_t * tc,
 430                                          u32 rx_pointer, u32 tx_pointer);
 431
 432 void stream_session_accept_notify (transport_connection_t * tc);
 433 void stream_session_disconnect_notify (transport_connection_t * tc);
 434 void stream_session_delete_notify (transport_connection_t * tc);
 435 void stream_session_reset_notify (transport_connection_t * tc);
 436 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
 437                            u8 notify);
 438 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 439 int stream_session_listen (stream_session_t * s, session_endpoint_t * tep);
 440 int stream_session_stop_listen (stream_session_t * s);
 441 void stream_session_disconnect (stream_session_t * s);
 442 void stream_session_cleanup (stream_session_t * s);
 443 void session_send_session_evt_to_thread (u64 session_handle,
 444                                          fifo_event_type_t evt_type,
 445                                          u32 thread_index);
 446
 447 u8 *format_stream_session (u8 * s, va_list * args);
 448 uword unformat_stream_session (unformat_input_t * input, va_list * args);
 449 uword unformat_transport_connection (unformat_input_t * input,
 450                                      va_list * args);
 451
 452 void session_register_transport (transport_proto_t transport_proto,
 453                                  const transport_proto_vft_t * vft, u8 is_ip4,
 454                                  u32 output_node);
 455
 456 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 457
 458 always_inline unix_shared_memory_queue_t *
 459 session_manager_get_vpp_event_queue (u32 thread_index)
 460 {
 461   return session_manager_main.vpp_event_queues[thread_index];
 462 }
 463
 464 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
 465
 466 always_inline u64
 467 listen_session_get_handle (stream_session_t * s)
 468 {
 469   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 470   return ((u64) s->session_type << 32) | s->session_index;
 471 }
 472
 473 always_inline stream_session_t *
 474 listen_session_get_from_handle (u64 handle)
 475 {
 476   session_manager_main_t *smm = &session_manager_main;
 477   stream_session_t *s;
 478   u32 type, index;
 479   type = handle >> 32;
 480   index = handle & 0xFFFFFFFF;
 481
 482   if (pool_is_free_index (smm->listen_sessions[type], index))
 483     return 0;
 484
 485   s = pool_elt_at_index (smm->listen_sessions[type], index);
 486   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 487   return s;
 488 }
 489
 490 always_inline stream_session_t *
 491 listen_session_new (session_type_t type)
 492 {
 493   stream_session_t *s;
 494   pool_get_aligned (session_manager_main.listen_sessions[type], s,
 495                     CLIB_CACHE_LINE_BYTES);
 496   memset (s, 0, sizeof (*s));
 497
 498   s->session_type = type;
 499   s->session_state = SESSION_STATE_LISTENING;
 500   s->session_index = s - session_manager_main.listen_sessions[type];
 501
 502   return s;
 503 }
 504
 505 always_inline stream_session_t *
 506 listen_session_get (session_type_t type, u32 index)
 507 {
 508   return pool_elt_at_index (session_manager_main.listen_sessions[type],
 509                             index);
 510 }
 511
 512 always_inline void
 513 listen_session_del (stream_session_t * s)
 514 {
 515   pool_put (session_manager_main.listen_sessions[s->session_type], s);
 516 }
 517
 518 transport_connection_t *listen_session_get_transport (stream_session_t * s);
 519
 520 int
 521 listen_session_get_local_session_endpoint (stream_session_t * listener,
 522                                            session_endpoint_t * sep);
 523
 524 always_inline stream_session_t *
 525 session_manager_get_listener (u8 session_type, u32 index)
 526 {
 527   return
 528     pool_elt_at_index (session_manager_main.listen_sessions[session_type],
 529                        index);
 530 }
 531
 532 /**
 533  * Set peek or dequeue function for given session type
 534  *
 535  * Reliable transport protocols will probably want to use a peek function
 536  */
 537 always_inline void
 538 session_manager_set_transport_rx_fn (session_type_t type, u8 is_peek)
 539 {
 540   session_manager_main.session_tx_fns[type] = (is_peek) ?
 541     session_tx_fifo_peek_and_snd : session_tx_fifo_dequeue_and_snd;
 542 }
 543
 544 always_inline u8
 545 session_manager_is_enabled ()
 546 {
 547   return session_manager_main.is_enabled == 1;
 548 }
 549
 550 #define session_cli_return_if_not_enabled()                             \
 551 do {                                                                    \
 552     if (!session_manager_main.is_enabled)                               \
 553       return clib_error_return(0, "session layer is not enabled");      \
 554 } while (0)
 555
 556 void session_node_enable_disable (u8 is_en);
 557
 558 #endif /* __included_session_h__ */
 559
 560 /*
 561  * fd.io coding-style-patch-verification: ON
 562  *
 563  * Local Variables:
 564  * eval: (c-set-style "gnu")
 565  * End:
 566  */