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