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