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