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 <vnet/session/session_debug.h>
  22 #include <vnet/session/segment_manager.h>
  23 #include <svm/queue.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 _(SEG_CREATE, "Couldn't create a new segment")
  75
  76 typedef enum
  77 {
  78 #define _(sym,str) SESSION_ERROR_##sym,
  79   foreach_session_input_error
  80 #undef _
  81     SESSION_N_ERROR,
  82 } session_error_t;
  83
  84 typedef struct
  85 {
  86   void *fp;
  87   void *arg;
  88 } rpc_args_t;
  89
  90 /* *INDENT-OFF* */
  91 typedef CLIB_PACKED (struct {
  92   union
  93     {
  94       svm_fifo_t * fifo;
  95       u64 session_handle;
  96       rpc_args_t rpc_args;
  97     };
  98   u8 event_type;
  99   u8 postponed;
 100 }) session_fifo_event_t;
 101 /* *INDENT-ON* */
 102
 103 /* Forward definition */
 104 typedef struct _session_manager_main session_manager_main_t;
 105
 106 typedef int
 107   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
 108                         session_manager_main_t * smm,
 109                         session_fifo_event_t * e0, stream_session_t * s0,
 110                         u32 thread_index, int *n_tx_pkts);
 111
 112 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 113 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 114
 115 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e);
 116
 117 struct _session_manager_main
 118 {
 119   /** Per worker thread session pools */
 120   stream_session_t **sessions;
 121
 122   /** Per worker-thread session pool peekers rw locks */
 123   clib_rwlock_t *peekers_rw_locks;
 124
 125   /** Pool of listen sessions. Same type as stream sessions to ease lookups */
 126   stream_session_t **listen_sessions;
 127
 128   /** Per-proto, per-worker enqueue epoch counters */
 129   u32 *current_enqueue_epoch[TRANSPORT_N_PROTO];
 130
 131   /** Per-proto, per-worker thread vector of sessions to enqueue */
 132   u32 **session_to_enqueue[TRANSPORT_N_PROTO];
 133
 134   /** per-worker tx buffer free lists */
 135   u32 **tx_buffers;
 136
 137   /** Per worker-thread vector of partially read events */
 138   session_fifo_event_t **free_event_vector;
 139
 140   /** per-worker active event vectors */
 141   session_fifo_event_t **pending_event_vector;
 142
 143   /** per-worker postponed disconnects */
 144   session_fifo_event_t **pending_disconnects;
 145
 146   /** vpp fifo event queue */
 147   svm_queue_t **vpp_event_queues;
 148
 149   /** Event queues memfd segment initialized only if so configured */
 150   ssvm_private_t evt_qs_segment;
 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 ssvm segment configs*/
 174   uword session_baseva;
 175   uword session_va_space_size;
 176   u32 evt_qs_segment_size;
 177   u8 evt_qs_use_memfd_seg;
 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 always_inline transport_proto_t
 289 session_get_transport_proto (stream_session_t * s)
 290 {
 291   return (s->session_type >> 1);
 292 }
 293
 294 always_inline session_type_t
 295 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
 296 {
 297   return (proto << 1 | is_ip4);
 298 }
 299
 300 /**
 301  * Acquires a lock that blocks a session pool from expanding.
 302  *
 303  * This is typically used for safely peeking into other threads'
 304  * pools in order to clone elements. Lock should be dropped as soon
 305  * as possible by calling @ref session_pool_remove_peeker.
 306  *
 307  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 308  * it may lead to free elt bitmap expansion/contraction!
 309  */
 310 always_inline void
 311 session_pool_add_peeker (u32 thread_index)
 312 {
 313   session_manager_main_t *smm = &session_manager_main;
 314   if (thread_index == vlib_get_thread_index ())
 315     return;
 316   clib_rwlock_reader_lock (&smm->peekers_rw_locks[thread_index]);
 317 }
 318
 319 always_inline void
 320 session_pool_remove_peeker (u32 thread_index)
 321 {
 322   session_manager_main_t *smm = &session_manager_main;
 323   if (thread_index == vlib_get_thread_index ())
 324     return;
 325   clib_rwlock_reader_unlock (&smm->peekers_rw_locks[thread_index]);
 326 }
 327
 328 /**
 329  * Get session from handle and 'lock' pool resize if not in same thread
 330  *
 331  * Caller should drop the peek 'lock' as soon as possible.
 332  */
 333 always_inline stream_session_t *
 334 session_get_from_handle_safe (u64 handle)
 335 {
 336   session_manager_main_t *smm = &session_manager_main;
 337   u32 thread_index = session_thread_from_handle (handle);
 338   if (thread_index == vlib_get_thread_index ())
 339     {
 340       return pool_elt_at_index (smm->sessions[thread_index],
 341                                 session_index_from_handle (handle));
 342     }
 343   else
 344     {
 345       session_pool_add_peeker (thread_index);
 346       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 347       return smm->sessions[thread_index] + session_index_from_handle (handle);
 348     }
 349 }
 350
 351 always_inline stream_session_t *
 352 stream_session_listener_get (u8 sst, u64 si)
 353 {
 354   return pool_elt_at_index (session_manager_main.listen_sessions[sst], si);
 355 }
 356
 357 always_inline u32
 358 stream_session_get_index (stream_session_t * s)
 359 {
 360   if (s->session_state == SESSION_STATE_LISTENING)
 361     return s - session_manager_main.listen_sessions[s->session_type];
 362
 363   return s - session_manager_main.sessions[s->thread_index];
 364 }
 365
 366 always_inline u32
 367 stream_session_max_rx_enqueue (transport_connection_t * tc)
 368 {
 369   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 370   return svm_fifo_max_enqueue (s->server_rx_fifo);
 371 }
 372
 373 always_inline u32
 374 stream_session_rx_fifo_size (transport_connection_t * tc)
 375 {
 376   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 377   return s->server_rx_fifo->nitems;
 378 }
 379
 380 always_inline u32
 381 session_get_index (stream_session_t * s)
 382 {
 383   return (s - session_manager_main.sessions[s->thread_index]);
 384 }
 385
 386 always_inline stream_session_t *
 387 session_clone_safe (u32 session_index, u32 thread_index)
 388 {
 389   stream_session_t *old_s, *new_s;
 390   u32 current_thread_index = vlib_get_thread_index ();
 391
 392   /* If during the memcpy pool is reallocated AND the memory allocator
 393    * decides to give the old chunk of memory to somebody in a hurry to
 394    * scribble something on it, we have a problem. So add this thread as
 395    * a session pool peeker.
 396    */
 397   session_pool_add_peeker (thread_index);
 398   new_s = session_alloc (current_thread_index);
 399   old_s = session_manager_main.sessions[thread_index] + session_index;
 400   clib_memcpy (new_s, old_s, sizeof (*new_s));
 401   session_pool_remove_peeker (thread_index);
 402   new_s->thread_index = current_thread_index;
 403   new_s->session_index = session_get_index (new_s);
 404   return new_s;
 405 }
 406
 407 transport_connection_t *session_get_transport (stream_session_t * s);
 408
 409 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
 410
 411 stream_session_t *session_alloc (u32 thread_index);
 412 int
 413 session_enqueue_stream_connection (transport_connection_t * tc,
 414                                    vlib_buffer_t * b, u32 offset,
 415                                    u8 queue_event, u8 is_in_order);
 416 int session_enqueue_dgram_connection (stream_session_t * s, vlib_buffer_t * b,
 417                                       u8 proto, u8 queue_event);
 418 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
 419                                u32 offset, u32 max_bytes);
 420 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 421
 422 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
 423 int session_dgram_connect_notify (transport_connection_t * tc,
 424                                   u32 old_thread_index,
 425                                   stream_session_t ** new_session);
 426 void stream_session_init_fifos_pointers (transport_connection_t * tc,
 427                                          u32 rx_pointer, u32 tx_pointer);
 428
 429 void stream_session_accept_notify (transport_connection_t * tc);
 430 void stream_session_disconnect_notify (transport_connection_t * tc);
 431 void stream_session_delete_notify (transport_connection_t * tc);
 432 void stream_session_reset_notify (transport_connection_t * tc);
 433 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
 434                            u8 notify);
 435 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 436 int stream_session_listen (stream_session_t * s, session_endpoint_t * tep);
 437 int stream_session_stop_listen (stream_session_t * s);
 438 void stream_session_disconnect (stream_session_t * s);
 439 void stream_session_disconnect_transport (stream_session_t * s);
 440 void stream_session_cleanup (stream_session_t * s);
 441 void session_send_session_evt_to_thread (u64 session_handle,
 442                                          fifo_event_type_t evt_type,
 443                                          u32 thread_index);
 444 ssvm_private_t *session_manager_get_evt_q_segment (void);
 445
 446 u8 *format_stream_session (u8 * s, va_list * args);
 447 uword unformat_stream_session (unformat_input_t * input, va_list * args);
 448 uword unformat_transport_connection (unformat_input_t * input,
 449                                      va_list * args);
 450
 451 void session_register_transport (transport_proto_t transport_proto,
 452                                  const transport_proto_vft_t * vft, u8 is_ip4,
 453                                  u32 output_node);
 454
 455 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 456
 457 always_inline svm_queue_t *
 458 session_manager_get_vpp_event_queue (u32 thread_index)
 459 {
 460   return session_manager_main.vpp_event_queues[thread_index];
 461 }
 462
 463 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
 464
 465 always_inline u64
 466 listen_session_get_handle (stream_session_t * s)
 467 {
 468   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 469   return ((u64) s->session_type << 32) | s->session_index;
 470 }
 471
 472 always_inline stream_session_t *
 473 listen_session_get_from_handle (u64 handle)
 474 {
 475   session_manager_main_t *smm = &session_manager_main;
 476   stream_session_t *s;
 477   u32 type, index;
 478   type = handle >> 32;
 479   index = handle & 0xFFFFFFFF;
 480
 481   if (pool_is_free_index (smm->listen_sessions[type], index))
 482     return 0;
 483
 484   s = pool_elt_at_index (smm->listen_sessions[type], index);
 485   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 486   return s;
 487 }
 488
 489 always_inline stream_session_t *
 490 listen_session_new (session_type_t type)
 491 {
 492   stream_session_t *s;
 493   pool_get_aligned (session_manager_main.listen_sessions[type], s,
 494                     CLIB_CACHE_LINE_BYTES);
 495   memset (s, 0, sizeof (*s));
 496
 497   s->session_type = type;
 498   s->session_state = SESSION_STATE_LISTENING;
 499   s->session_index = s - session_manager_main.listen_sessions[type];
 500
 501   return s;
 502 }
 503
 504 always_inline stream_session_t *
 505 listen_session_get (session_type_t type, u32 index)
 506 {
 507   return pool_elt_at_index (session_manager_main.listen_sessions[type],
 508                             index);
 509 }
 510
 511 always_inline void
 512 listen_session_del (stream_session_t * s)
 513 {
 514   pool_put (session_manager_main.listen_sessions[s->session_type], s);
 515 }
 516
 517 transport_connection_t *listen_session_get_transport (stream_session_t * s);
 518
 519 int
 520 listen_session_get_local_session_endpoint (stream_session_t * listener,
 521                                            session_endpoint_t * sep);
 522
 523 always_inline stream_session_t *
 524 session_manager_get_listener (u8 session_type, u32 index)
 525 {
 526   return
 527     pool_elt_at_index (session_manager_main.listen_sessions[session_type],
 528                        index);
 529 }
 530
 531 /**
 532  * Set peek or dequeue function for given session type
 533  *
 534  * Reliable transport protocols will probably want to use a peek function
 535  */
 536 always_inline void
 537 session_manager_set_transport_rx_fn (session_type_t type, u8 is_peek)
 538 {
 539   session_manager_main.session_tx_fns[type] = (is_peek) ?
 540     session_tx_fifo_peek_and_snd : session_tx_fifo_dequeue_and_snd;
 541 }
 542
 543 always_inline u8
 544 session_manager_is_enabled ()
 545 {
 546   return session_manager_main.is_enabled == 1;
 547 }
 548
 549 #define session_cli_return_if_not_enabled()                             \
 550 do {                                                                    \
 551     if (!session_manager_main.is_enabled)                               \
 552       return clib_error_return(0, "session layer is not enabled");      \
 553 } while (0)
 554
 555 void session_node_enable_disable (u8 is_en);
 556
 557 #endif /* __included_session_h__ */
 558
 559 /*
 560  * fd.io coding-style-patch-verification: ON
 561  *
 562  * Local Variables:
 563  * eval: (c-set-style "gnu")
 564  * End:
 565  */