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