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