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