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