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