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