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