src/vnet/session/session.h

   1 /*
   2  * Copyright (c) 2017-2019 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 <vppinfra/llist.h>
  19 #include <vnet/session/session_types.h>
  20 #include <vnet/session/session_lookup.h>
  21 #include <vnet/session/session_debug.h>
  22 #include <svm/message_queue.h>
  23 #include <svm/ssvm.h>
  24
  25 #define foreach_session_input_error                                     \
  26 _(NO_SESSION, "No session drops")                                       \
  27 _(NO_LISTENER, "No listener for dst port drops")                        \
  28 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  29 _(NOT_READY, "Session not ready packets")                               \
  30 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  31 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  32 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  33 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
  34 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
  35 _(SEG_CREATE, "Couldn't create a new segment")
  36
  37 typedef enum
  38 {
  39 #define _(sym,str) SESSION_ERROR_##sym,
  40   foreach_session_input_error
  41 #undef _
  42     SESSION_N_ERROR,
  43 } session_error_t;
  44
  45 typedef struct session_tx_context_
  46 {
  47   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  48   session_t *s;
  49   transport_proto_vft_t *transport_vft;
  50   transport_connection_t *tc;
  51   u32 max_dequeue;
  52   u32 snd_space;
  53   u32 left_to_snd;
  54   u32 tx_offset;
  55   u32 max_len_to_snd;
  56   u16 deq_per_first_buf;
  57   u16 deq_per_buf;
  58   u16 snd_mss;
  59   u16 n_segs_per_evt;
  60   u8 n_bufs_per_seg;
  61     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  62   session_dgram_hdr_t hdr;
  63 } session_tx_context_t;
  64
  65 typedef struct session_evt_elt
  66 {
  67   clib_llist_anchor_t evt_list;
  68   session_event_t evt;
  69 } session_evt_elt_t;
  70
  71 typedef struct session_worker_
  72 {
  73   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  74
  75   /** Worker session pool */
  76   session_t *sessions;
  77
  78   /** vpp event message queue for worker */
  79   svm_msg_q_t *vpp_event_queue;
  80
  81   /** Our approximation of a "complete" dispatch loop period */
  82   f64 dispatch_period;
  83
  84   /** vlib_time_now last time around the track */
  85   f64 last_vlib_time;
  86
  87   /** Per-proto vector of sessions to enqueue */
  88   u32 *session_to_enqueue[TRANSPORT_N_PROTO];
  89
  90   /** Context for session tx */
  91   session_tx_context_t ctx;
  92
  93   /** Vector of tx buffer free lists */
  94   u32 *tx_buffers;
  95
  96   /** Pool of session event list elements */
  97   session_evt_elt_t *event_elts;
  98
  99   /** Head of list of elements */
 100   clib_llist_index_t new_head;
 101
 102   /** Head of list of pending events */
 103   clib_llist_index_t pending_head;
 104
 105   /** Head of list of postponed events */
 106   clib_llist_index_t postponed_head;
 107
 108   /** Head of list of disconnect events */
 109   clib_llist_index_t disconnects_head;
 110
 111   /** Peekers rw lock */
 112   clib_rwlock_t peekers_rw_locks;
 113
 114   u32 last_tx_packets;
 115
 116 #if SESSION_DEBUG
 117   /** last event poll time by thread */
 118   f64 last_event_poll;
 119 #endif
 120 } session_worker_t;
 121
 122 typedef int (session_fifo_rx_fn) (vlib_main_t * vm,
 123                                   vlib_node_runtime_t * node,
 124                                   session_worker_t * wrk,
 125                                   session_evt_elt_t * e, int *n_tx_pkts);
 126
 127 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 128 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 129 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 130
 131 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
 132
 133 typedef struct session_main_
 134 {
 135   /** Worker contexts */
 136   session_worker_t *wrk;
 137
 138   /** Event queues memfd segment initialized only if so configured */
 139   ssvm_private_t evt_qs_segment;
 140
 141   /** Unique segment name counter */
 142   u32 unique_segment_name_counter;
 143
 144   /** Per transport rx function that can either dequeue or peek */
 145   session_fifo_rx_fn **session_tx_fns;
 146
 147   /** Per session type output nodes. Could optimize to group nodes by
 148    * fib but lookup would then require session type parsing in session node.
 149    * Trade memory for speed, for now */
 150   u32 *session_type_to_next;
 151
 152   /*
 153    * Config parameters
 154    */
 155
 156   /** Session manager is enabled */
 157   u8 is_enabled;
 158
 159   /** vpp fifo event queue configured length */
 160   u32 configured_event_queue_length;
 161
 162   /** Session ssvm segment configs*/
 163   uword session_baseva;
 164   uword session_va_space_size;
 165   uword evt_qs_segment_size;
 166   u8 evt_qs_use_memfd_seg;
 167
 168   /** Session table size parameters */
 169   u32 configured_v4_session_table_buckets;
 170   u32 configured_v4_session_table_memory;
 171   u32 configured_v4_halfopen_table_buckets;
 172   u32 configured_v4_halfopen_table_memory;
 173   u32 configured_v6_session_table_buckets;
 174   u32 configured_v6_session_table_memory;
 175   u32 configured_v6_halfopen_table_buckets;
 176   u32 configured_v6_halfopen_table_memory;
 177
 178   /** Transport table (preallocation) size parameters */
 179   u32 local_endpoints_table_memory;
 180   u32 local_endpoints_table_buckets;
 181
 182   /** Preallocate session config parameter */
 183   u32 preallocated_sessions;
 184
 185 } session_main_t;
 186
 187 extern session_main_t session_main;
 188 extern vlib_node_registration_t session_queue_node;
 189 extern vlib_node_registration_t session_queue_process_node;
 190 extern vlib_node_registration_t session_queue_pre_input_node;
 191
 192 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
 193 #define SESSION_Q_PROCESS_STOP          2
 194
 195 static inline session_evt_elt_t *
 196 session_evt_elt_alloc (session_worker_t * wrk)
 197 {
 198   session_evt_elt_t *elt;
 199   pool_get (wrk->event_elts, elt);
 200   return elt;
 201 }
 202
 203 static inline void
 204 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
 205 {
 206   pool_put (wrk->event_elts, elt);
 207 }
 208
 209 static inline session_evt_elt_t *
 210 session_evt_pending_head (session_worker_t * wrk)
 211 {
 212   return pool_elt_at_index (wrk->event_elts, wrk->pending_head);
 213 }
 214
 215 static inline session_evt_elt_t *
 216 session_evt_postponed_head (session_worker_t * wrk)
 217 {
 218   return pool_elt_at_index (wrk->event_elts, wrk->postponed_head);
 219 }
 220
 221 static inline session_evt_elt_t *
 222 session_evt_pending_disconnects_head (session_worker_t * wrk)
 223 {
 224   return pool_elt_at_index (wrk->event_elts, wrk->disconnects_head);
 225 }
 226
 227 static inline void
 228 session_evt_add_pending (session_worker_t * wrk, session_evt_elt_t * elt)
 229 {
 230   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 231                        session_evt_pending_head (wrk));
 232 }
 233
 234 static inline void
 235 session_evt_add_postponed (session_worker_t * wrk, session_evt_elt_t * elt)
 236 {
 237   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 238                        session_evt_postponed_head (wrk));
 239 }
 240
 241 static inline void
 242 session_evt_add_pending_disconnects (session_worker_t * wrk,
 243                                      session_evt_elt_t * elt)
 244 {
 245   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 246                        session_evt_pending_disconnects_head (wrk));
 247 }
 248
 249 always_inline u8
 250 session_is_valid (u32 si, u8 thread_index)
 251 {
 252   session_t *s;
 253   s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 254   if (s->session_state == SESSION_STATE_CLOSED)
 255     return 1;
 256
 257   if (s->thread_index != thread_index || s->session_index != si)
 258     return 0;
 259   return 1;
 260 }
 261
 262 session_t *session_alloc (u32 thread_index);
 263 void session_free (session_t * s);
 264 void session_free_w_fifos (session_t * s);
 265
 266 always_inline session_t *
 267 session_get (u32 si, u32 thread_index)
 268 {
 269   ASSERT (session_is_valid (si, thread_index));
 270   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 271 }
 272
 273 always_inline session_t *
 274 session_get_if_valid (u64 si, u32 thread_index)
 275 {
 276   if (thread_index >= vec_len (session_main.wrk))
 277     return 0;
 278
 279   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
 280     return 0;
 281
 282   ASSERT (session_is_valid (si, thread_index));
 283   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 284 }
 285
 286 always_inline session_t *
 287 session_get_from_handle (session_handle_t handle)
 288 {
 289   session_main_t *smm = &session_main;
 290   u32 session_index, thread_index;
 291   session_parse_handle (handle, &session_index, &thread_index);
 292   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 293 }
 294
 295 always_inline 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 u64 session_segment_handle (session_t * s);
 304
 305 /**
 306  * Acquires a lock that blocks a session pool from expanding.
 307  *
 308  * This is typically used for safely peeking into other threads'
 309  * pools in order to clone elements. Lock should be dropped as soon
 310  * as possible by calling @ref session_pool_remove_peeker.
 311  *
 312  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 313  * it may lead to free elt bitmap expansion/contraction!
 314  */
 315 always_inline void
 316 session_pool_add_peeker (u32 thread_index)
 317 {
 318   session_worker_t *wrk = &session_main.wrk[thread_index];
 319   if (thread_index == vlib_get_thread_index ())
 320     return;
 321   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
 322 }
 323
 324 always_inline void
 325 session_pool_remove_peeker (u32 thread_index)
 326 {
 327   session_worker_t *wrk = &session_main.wrk[thread_index];
 328   if (thread_index == vlib_get_thread_index ())
 329     return;
 330   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
 331 }
 332
 333 /**
 334  * Get session from handle and 'lock' pool resize if not in same thread
 335  *
 336  * Caller should drop the peek 'lock' as soon as possible.
 337  */
 338 always_inline session_t *
 339 session_get_from_handle_safe (u64 handle)
 340 {
 341   u32 thread_index = session_thread_from_handle (handle);
 342   session_worker_t *wrk = &session_main.wrk[thread_index];
 343
 344   if (thread_index == vlib_get_thread_index ())
 345     {
 346       return pool_elt_at_index (wrk->sessions,
 347                                 session_index_from_handle (handle));
 348     }
 349   else
 350     {
 351       session_pool_add_peeker (thread_index);
 352       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 353       return wrk->sessions + session_index_from_handle (handle);
 354     }
 355 }
 356
 357 always_inline u32
 358 session_get_index (session_t * s)
 359 {
 360   return (s - session_main.wrk[s->thread_index].sessions);
 361 }
 362
 363 always_inline session_t *
 364 session_clone_safe (u32 session_index, u32 thread_index)
 365 {
 366   session_t *old_s, *new_s;
 367   u32 current_thread_index = vlib_get_thread_index ();
 368
 369   /* If during the memcpy pool is reallocated AND the memory allocator
 370    * decides to give the old chunk of memory to somebody in a hurry to
 371    * scribble something on it, we have a problem. So add this thread as
 372    * a session pool peeker.
 373    */
 374   session_pool_add_peeker (thread_index);
 375   new_s = session_alloc (current_thread_index);
 376   old_s = session_main.wrk[thread_index].sessions + session_index;
 377   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 378   session_pool_remove_peeker (thread_index);
 379   new_s->thread_index = current_thread_index;
 380   new_s->session_index = session_get_index (new_s);
 381   return new_s;
 382 }
 383
 384 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 385 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 386 int session_stop_listen (session_t * s);
 387 void session_close (session_t * s);
 388 void session_transport_close (session_t * s);
 389 void session_transport_cleanup (session_t * s);
 390 int session_send_io_evt_to_thread (svm_fifo_t * f,
 391                                    session_evt_type_t evt_type);
 392 int session_enqueue_notify (session_t * s);
 393 int session_dequeue_notify (session_t * s);
 394 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 395                                           session_evt_type_t evt_type);
 396 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 397                                      void *rpc_args);
 398 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
 399                                            void *rpc_args);
 400 transport_connection_t *session_get_transport (session_t * s);
 401 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
 402                            u8 is_lcl);
 403
 404 u8 *format_session (u8 * s, va_list * args);
 405 uword unformat_session (unformat_input_t * input, va_list * args);
 406 uword unformat_transport_connection (unformat_input_t * input,
 407                                      va_list * args);
 408
 409 /*
 410  * Interface to transport protos
 411  */
 412
 413 int session_enqueue_stream_connection (transport_connection_t * tc,
 414                                        vlib_buffer_t * b, u32 offset,
 415                                        u8 queue_event, u8 is_in_order);
 416 int session_enqueue_dgram_connection (session_t * s,
 417                                       session_dgram_hdr_t * hdr,
 418                                       vlib_buffer_t * b, u8 proto,
 419                                       u8 queue_event);
 420 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
 421 int session_dgram_connect_notify (transport_connection_t * tc,
 422                                   u32 old_thread_index,
 423                                   session_t ** new_session);
 424 int session_stream_accept_notify (transport_connection_t * tc);
 425 void session_transport_closing_notify (transport_connection_t * tc);
 426 void session_transport_delete_notify (transport_connection_t * tc);
 427 void session_transport_closed_notify (transport_connection_t * tc);
 428 void session_transport_reset_notify (transport_connection_t * tc);
 429 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 430                            u32 thread_index, u8 notify);
 431 void session_register_transport (transport_proto_t transport_proto,
 432                                  const transport_proto_vft_t * vft, u8 is_ip4,
 433                                  u32 output_node);
 434 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 435                                 u32 offset, u32 max_bytes);
 436 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 437
 438 always_inline u32
 439 transport_max_rx_enqueue (transport_connection_t * tc)
 440 {
 441   session_t *s = session_get (tc->s_index, tc->thread_index);
 442   return svm_fifo_max_enqueue_prod (s->rx_fifo);
 443 }
 444
 445 always_inline u32
 446 transport_max_tx_dequeue (transport_connection_t * tc)
 447 {
 448   session_t *s = session_get (tc->s_index, tc->thread_index);
 449   return svm_fifo_max_dequeue_cons (s->tx_fifo);
 450 }
 451
 452 always_inline u32
 453 transport_max_rx_dequeue (transport_connection_t * tc)
 454 {
 455   session_t *s = session_get (tc->s_index, tc->thread_index);
 456   return svm_fifo_max_dequeue (s->rx_fifo);
 457 }
 458
 459 always_inline u32
 460 transport_rx_fifo_size (transport_connection_t * tc)
 461 {
 462   session_t *s = session_get (tc->s_index, tc->thread_index);
 463   return s->rx_fifo->nitems;
 464 }
 465
 466 always_inline u32
 467 transport_tx_fifo_size (transport_connection_t * tc)
 468 {
 469   session_t *s = session_get (tc->s_index, tc->thread_index);
 470   return s->tx_fifo->nitems;
 471 }
 472
 473 always_inline u8
 474 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 475 {
 476   session_t *s = session_get (tc->c_index, tc->thread_index);
 477   return svm_fifo_has_ooo_data (s->rx_fifo);
 478 }
 479
 480 always_inline f64
 481 transport_dispatch_period (u32 thread_index)
 482 {
 483   return session_main.wrk[thread_index].dispatch_period;
 484 }
 485
 486 always_inline f64
 487 transport_time_now (u32 thread_index)
 488 {
 489   return session_main.wrk[thread_index].last_vlib_time;
 490 }
 491
 492 always_inline void
 493 transport_add_tx_event (transport_connection_t * tc)
 494 {
 495   session_t *s = session_get (tc->s_index, tc->thread_index);
 496   if (svm_fifo_has_event (s->tx_fifo))
 497     return;
 498   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 499 }
 500
 501 /*
 502  * Listen sessions
 503  */
 504
 505 always_inline u64
 506 listen_session_get_handle (session_t * s)
 507 {
 508   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
 509           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
 510   return session_handle (s);
 511 }
 512
 513 always_inline session_t *
 514 listen_session_get_from_handle (session_handle_t handle)
 515 {
 516   return session_get_from_handle (handle);
 517 }
 518
 519 always_inline void
 520 listen_session_parse_handle (session_handle_t handle, u32 * index,
 521                              u32 * thread_index)
 522 {
 523   session_parse_handle (handle, index, thread_index);
 524 }
 525
 526 always_inline session_t *
 527 listen_session_alloc (u8 thread_index, session_type_t type)
 528 {
 529   session_t *s;
 530   s = session_alloc (thread_index);
 531   s->session_type = type;
 532   s->session_state = SESSION_STATE_LISTENING;
 533   return s;
 534 }
 535
 536 always_inline session_t *
 537 listen_session_get (u32 ls_index)
 538 {
 539   return session_get (ls_index, 0);
 540 }
 541
 542 always_inline void
 543 listen_session_free (session_t * s)
 544 {
 545   session_free (s);
 546 }
 547
 548 transport_connection_t *listen_session_get_transport (session_t * s);
 549
 550 /*
 551  * Session layer functions
 552  */
 553
 554 always_inline session_main_t *
 555 vnet_get_session_main ()
 556 {
 557   return &session_main;
 558 }
 559
 560 always_inline session_worker_t *
 561 session_main_get_worker (u32 thread_index)
 562 {
 563   return &session_main.wrk[thread_index];
 564 }
 565
 566 always_inline svm_msg_q_t *
 567 session_main_get_vpp_event_queue (u32 thread_index)
 568 {
 569   return session_main.wrk[thread_index].vpp_event_queue;
 570 }
 571
 572 always_inline u8
 573 session_main_is_enabled ()
 574 {
 575   return session_main.is_enabled == 1;
 576 }
 577
 578 #define session_cli_return_if_not_enabled()                             \
 579 do {                                                                    \
 580     if (!session_main.is_enabled)                               \
 581       return clib_error_return(0, "session layer is not enabled");      \
 582 } while (0)
 583
 584 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 585 int session_main_flush_all_enqueue_events (u8 transport_proto);
 586 void session_flush_frames_main_thread (vlib_main_t * vm);
 587 ssvm_private_t *session_main_get_evt_q_segment (void);
 588 void session_node_enable_disable (u8 is_en);
 589 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 590
 591 #endif /* __included_session_h__ */
 592
 593 /*
 594  * fd.io coding-style-patch-verification: ON
 595  *
 596  * Local Variables:
 597  * eval: (c-set-style "gnu")
 598  * End:
 599  */