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