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