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