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 <vnet/session/session_types.h>
  19 #include <vnet/session/session_lookup.h>
  20 #include <vnet/session/session_debug.h>
  21 #include <svm/message_queue.h>
  22 #include <svm/ssvm.h>
  23
  24 #define SESSION_PROXY_LISTENER_INDEX ((u8)~0 - 1)
  25
  26 #define foreach_session_input_error                                     \
  27 _(NO_SESSION, "No session drops")                                       \
  28 _(NO_LISTENER, "No listener for dst port drops")                        \
  29 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  30 _(NOT_READY, "Session not ready packets")                               \
  31 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  32 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  33 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  34 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
  35 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
  36 _(SEG_CREATE, "Couldn't create a new segment")
  37
  38 typedef enum
  39 {
  40 #define _(sym,str) SESSION_ERROR_##sym,
  41   foreach_session_input_error
  42 #undef _
  43     SESSION_N_ERROR,
  44 } session_error_t;
  45
  46 typedef struct session_tx_context_
  47 {
  48   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  49   session_t *s;
  50   transport_proto_vft_t *transport_vft;
  51   transport_connection_t *tc;
  52   vlib_buffer_t *b;
  53   u32 max_dequeue;
  54   u32 snd_space;
  55   u32 left_to_snd;
  56   u32 tx_offset;
  57   u32 max_len_to_snd;
  58   u16 deq_per_first_buf;
  59   u16 deq_per_buf;
  60   u16 snd_mss;
  61   u16 n_segs_per_evt;
  62   u8 n_bufs_per_seg;
  63     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  64   session_dgram_hdr_t hdr;
  65 } session_tx_context_t;
  66
  67 typedef struct session_worker_
  68 {
  69   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  70
  71   /** Worker session pool */
  72   session_t *sessions;
  73
  74   /** vpp event message queue for worker */
  75   svm_msg_q_t *vpp_event_queue;
  76
  77   /** Our approximation of a "complete" dispatch loop period */
  78   f64 dispatch_period;
  79
  80   /** vlib_time_now last time around the track */
  81   f64 last_vlib_time;
  82
  83   /** Per-proto enqueue epoch counters */
  84   u64 current_enqueue_epoch[TRANSPORT_N_PROTO];
  85
  86   /** Per-proto vector of sessions to enqueue */
  87   u32 *session_to_enqueue[TRANSPORT_N_PROTO];
  88
  89   /** Context for session tx */
  90   session_tx_context_t ctx;
  91
  92   /** Vector of tx buffer free lists */
  93   u32 *tx_buffers;
  94
  95   /** Vector of partially read events */
  96   session_event_t *free_event_vector;
  97
  98   /** Vector of active event vectors */
  99   session_event_t *pending_event_vector;
 100
 101   /** Vector of postponed disconnects */
 102   session_event_t *pending_disconnects;
 103
 104   /** Vector of postponed events */
 105   session_event_t *postponed_event_vector;
 106
 107   /** Peekers rw lock */
 108   clib_rwlock_t peekers_rw_locks;
 109
 110   u32 last_tx_packets;
 111
 112 } session_worker_t;
 113
 114 typedef int (session_fifo_rx_fn) (vlib_main_t * vm,
 115                                   vlib_node_runtime_t * node,
 116                                   session_worker_t * wrk,
 117                                   session_event_t * e, int *n_tx_pkts);
 118
 119 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 120 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 121 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 122
 123 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
 124
 125 typedef struct session_main_
 126 {
 127   /** Worker contexts */
 128   session_worker_t *wrk;
 129
 130   /** Event queues memfd segment initialized only if so configured */
 131   ssvm_private_t evt_qs_segment;
 132
 133   /** Unique segment name counter */
 134   u32 unique_segment_name_counter;
 135
 136   /** Per transport rx function that can either dequeue or peek */
 137   session_fifo_rx_fn **session_tx_fns;
 138
 139   /** Per session type output nodes. Could optimize to group nodes by
 140    * fib but lookup would then require session type parsing in session node.
 141    * Trade memory for speed, for now */
 142   u32 *session_type_to_next;
 143
 144   /*
 145    * Config parameters
 146    */
 147
 148   /** Session manager is enabled */
 149   u8 is_enabled;
 150
 151   /** vpp fifo event queue configured length */
 152   u32 configured_event_queue_length;
 153
 154   /** Session ssvm segment configs*/
 155   uword session_baseva;
 156   uword session_va_space_size;
 157   uword evt_qs_segment_size;
 158   u8 evt_qs_use_memfd_seg;
 159
 160   /** Session table size parameters */
 161   u32 configured_v4_session_table_buckets;
 162   u32 configured_v4_session_table_memory;
 163   u32 configured_v4_halfopen_table_buckets;
 164   u32 configured_v4_halfopen_table_memory;
 165   u32 configured_v6_session_table_buckets;
 166   u32 configured_v6_session_table_memory;
 167   u32 configured_v6_halfopen_table_buckets;
 168   u32 configured_v6_halfopen_table_memory;
 169
 170   /** Transport table (preallocation) size parameters */
 171   u32 local_endpoints_table_memory;
 172   u32 local_endpoints_table_buckets;
 173
 174   /** Preallocate session config parameter */
 175   u32 preallocated_sessions;
 176
 177 #if SESSION_DEBUG
 178   /**
 179    * last event poll time by thread
 180    * Debug only. Will cause false cache-line sharing as-is
 181    */
 182   f64 *last_event_poll_by_thread;
 183 #endif
 184
 185 } session_main_t;
 186
 187 extern session_main_t session_main;
 188 extern vlib_node_registration_t session_queue_node;
 189 extern vlib_node_registration_t session_queue_process_node;
 190
 191 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
 192 #define SESSION_Q_PROCESS_STOP          2
 193
 194 always_inline u8
 195 session_is_valid (u32 si, u8 thread_index)
 196 {
 197   session_t *s;
 198   s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 199   if (s->thread_index != thread_index || s->session_index != si)
 200     return 0;
 201   return 1;
 202 }
 203
 204 session_t *session_alloc (u32 thread_index);
 205 void session_free (session_t * s);
 206 void session_free_w_fifos (session_t * s);
 207
 208 always_inline session_t *
 209 session_get (u32 si, u32 thread_index)
 210 {
 211   ASSERT (session_is_valid (si, thread_index));
 212   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 213 }
 214
 215 always_inline session_t *
 216 session_get_if_valid (u64 si, u32 thread_index)
 217 {
 218   if (thread_index >= vec_len (session_main.wrk))
 219     return 0;
 220
 221   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
 222     return 0;
 223
 224   ASSERT (session_is_valid (si, thread_index));
 225   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 226 }
 227
 228 always_inline session_t *
 229 session_get_from_handle (session_handle_t handle)
 230 {
 231   session_main_t *smm = &session_main;
 232   u32 session_index, thread_index;
 233   session_parse_handle (handle, &session_index, &thread_index);
 234   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 235 }
 236
 237 always_inline session_t *
 238 session_get_from_handle_if_valid (session_handle_t handle)
 239 {
 240   u32 session_index, thread_index;
 241   session_parse_handle (handle, &session_index, &thread_index);
 242   return session_get_if_valid (session_index, thread_index);
 243 }
 244
 245 u64 session_segment_handle (session_t * s);
 246
 247 /**
 248  * Acquires a lock that blocks a session pool from expanding.
 249  *
 250  * This is typically used for safely peeking into other threads'
 251  * pools in order to clone elements. Lock should be dropped as soon
 252  * as possible by calling @ref session_pool_remove_peeker.
 253  *
 254  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 255  * it may lead to free elt bitmap expansion/contraction!
 256  */
 257 always_inline void
 258 session_pool_add_peeker (u32 thread_index)
 259 {
 260   session_worker_t *wrk = &session_main.wrk[thread_index];
 261   if (thread_index == vlib_get_thread_index ())
 262     return;
 263   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
 264 }
 265
 266 always_inline void
 267 session_pool_remove_peeker (u32 thread_index)
 268 {
 269   session_worker_t *wrk = &session_main.wrk[thread_index];
 270   if (thread_index == vlib_get_thread_index ())
 271     return;
 272   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
 273 }
 274
 275 /**
 276  * Get session from handle and 'lock' pool resize if not in same thread
 277  *
 278  * Caller should drop the peek 'lock' as soon as possible.
 279  */
 280 always_inline session_t *
 281 session_get_from_handle_safe (u64 handle)
 282 {
 283   u32 thread_index = session_thread_from_handle (handle);
 284   session_worker_t *wrk = &session_main.wrk[thread_index];
 285
 286   if (thread_index == vlib_get_thread_index ())
 287     {
 288       return pool_elt_at_index (wrk->sessions,
 289                                 session_index_from_handle (handle));
 290     }
 291   else
 292     {
 293       session_pool_add_peeker (thread_index);
 294       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 295       return wrk->sessions + session_index_from_handle (handle);
 296     }
 297 }
 298
 299 always_inline u32
 300 session_get_index (session_t * s)
 301 {
 302   return (s - session_main.wrk[s->thread_index].sessions);
 303 }
 304
 305 always_inline session_t *
 306 session_clone_safe (u32 session_index, u32 thread_index)
 307 {
 308   session_t *old_s, *new_s;
 309   u32 current_thread_index = vlib_get_thread_index ();
 310
 311   /* If during the memcpy pool is reallocated AND the memory allocator
 312    * decides to give the old chunk of memory to somebody in a hurry to
 313    * scribble something on it, we have a problem. So add this thread as
 314    * a session pool peeker.
 315    */
 316   session_pool_add_peeker (thread_index);
 317   new_s = session_alloc (current_thread_index);
 318   old_s = session_main.wrk[thread_index].sessions + session_index;
 319   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 320   session_pool_remove_peeker (thread_index);
 321   new_s->thread_index = current_thread_index;
 322   new_s->session_index = session_get_index (new_s);
 323   return new_s;
 324 }
 325
 326 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 327 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 328 int session_stop_listen (session_t * s);
 329 void session_close (session_t * s);
 330 void session_transport_close (session_t * s);
 331 void session_transport_cleanup (session_t * s);
 332 int session_send_io_evt_to_thread (svm_fifo_t * f,
 333                                    session_evt_type_t evt_type);
 334 int session_dequeue_notify (session_t * s);
 335 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 336                                           session_evt_type_t evt_type);
 337 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 338                                      void *rpc_args);
 339 transport_connection_t *session_get_transport (session_t * s);
 340
 341
 342 u8 *format_session (u8 * s, va_list * args);
 343 uword unformat_session (unformat_input_t * input, va_list * args);
 344 uword unformat_transport_connection (unformat_input_t * input,
 345                                      va_list * args);
 346
 347 /*
 348  * Interface to transport protos
 349  */
 350
 351 int session_enqueue_stream_connection (transport_connection_t * tc,
 352                                        vlib_buffer_t * b, u32 offset,
 353                                        u8 queue_event, u8 is_in_order);
 354 int session_enqueue_dgram_connection (session_t * s,
 355                                       session_dgram_hdr_t * hdr,
 356                                       vlib_buffer_t * b, u8 proto,
 357                                       u8 queue_event);
 358 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
 359 int session_dgram_connect_notify (transport_connection_t * tc,
 360                                   u32 old_thread_index,
 361                                   session_t ** new_session);
 362 int session_stream_accept_notify (transport_connection_t * tc);
 363 void session_transport_closing_notify (transport_connection_t * tc);
 364 void session_transport_delete_notify (transport_connection_t * tc);
 365 void session_transport_closed_notify (transport_connection_t * tc);
 366 void session_transport_reset_notify (transport_connection_t * tc);
 367 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 368                            u8 notify);
 369 void session_register_transport (transport_proto_t transport_proto,
 370                                  const transport_proto_vft_t * vft, u8 is_ip4,
 371                                  u32 output_node);
 372 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 373                                 u32 offset, u32 max_bytes);
 374 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 375
 376 always_inline u32
 377 transport_max_rx_enqueue (transport_connection_t * tc)
 378 {
 379   session_t *s = session_get (tc->s_index, tc->thread_index);
 380   return svm_fifo_max_enqueue (s->rx_fifo);
 381 }
 382
 383 always_inline u32
 384 transport_max_tx_dequeue (transport_connection_t * tc)
 385 {
 386   session_t *s = session_get (tc->s_index, tc->thread_index);
 387   return svm_fifo_max_dequeue (s->tx_fifo);
 388 }
 389
 390 always_inline u32
 391 transport_rx_fifo_size (transport_connection_t * tc)
 392 {
 393   session_t *s = session_get (tc->s_index, tc->thread_index);
 394   return s->rx_fifo->nitems;
 395 }
 396
 397 always_inline u32
 398 transport_tx_fifo_size (transport_connection_t * tc)
 399 {
 400   session_t *s = session_get (tc->s_index, tc->thread_index);
 401   return s->tx_fifo->nitems;
 402 }
 403
 404 always_inline u8
 405 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 406 {
 407   session_t *s = session_get (tc->c_index, tc->thread_index);
 408   return svm_fifo_has_ooo_data (s->rx_fifo);
 409 }
 410
 411 always_inline f64
 412 transport_dispatch_period (u32 thread_index)
 413 {
 414   return session_main.wrk[thread_index].dispatch_period;
 415 }
 416
 417 always_inline f64
 418 transport_time_now (u32 thread_index)
 419 {
 420   return session_main.wrk[thread_index].last_vlib_time;
 421 }
 422
 423 always_inline void
 424 transport_add_tx_event (transport_connection_t * tc)
 425 {
 426   session_t *s = session_get (tc->s_index, tc->thread_index);
 427   if (svm_fifo_has_event (s->tx_fifo))
 428     return;
 429   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 430 }
 431
 432 /*
 433  * Listen sessions
 434  */
 435
 436 always_inline u64
 437 listen_session_get_handle (session_t * s)
 438 {
 439   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 440   return session_handle (s);
 441 }
 442
 443 always_inline session_t *
 444 listen_session_get_from_handle (session_handle_t handle)
 445 {
 446   return session_get_from_handle (handle);
 447 }
 448
 449 always_inline void
 450 listen_session_parse_handle (session_handle_t handle, u32 * index,
 451                              u32 * thread_index)
 452 {
 453   session_parse_handle (handle, index, thread_index);
 454 }
 455
 456 always_inline session_t *
 457 listen_session_alloc (u8 thread_index, session_type_t type)
 458 {
 459   session_t *s;
 460   s = session_alloc (thread_index);
 461   s->session_type = type;
 462   s->session_state = SESSION_STATE_LISTENING;
 463   return s;
 464 }
 465
 466 always_inline session_t *
 467 listen_session_get (u32 ls_index)
 468 {
 469   return session_get (ls_index, 0);
 470 }
 471
 472 always_inline void
 473 listen_session_free (session_t * s)
 474 {
 475   session_free (s);
 476 }
 477
 478 transport_connection_t *listen_session_get_transport (session_t * s);
 479
 480 /*
 481  * Session layer functions
 482  */
 483
 484 always_inline session_main_t *
 485 vnet_get_session_main ()
 486 {
 487   return &session_main;
 488 }
 489
 490 always_inline session_worker_t *
 491 session_main_get_worker (u32 thread_index)
 492 {
 493   return &session_main.wrk[thread_index];
 494 }
 495
 496 always_inline svm_msg_q_t *
 497 session_main_get_vpp_event_queue (u32 thread_index)
 498 {
 499   return session_main.wrk[thread_index].vpp_event_queue;
 500 }
 501
 502 always_inline u8
 503 session_main_is_enabled ()
 504 {
 505   return session_main.is_enabled == 1;
 506 }
 507
 508 #define session_cli_return_if_not_enabled()                             \
 509 do {                                                                    \
 510     if (!session_main.is_enabled)                               \
 511       return clib_error_return(0, "session layer is not enabled");      \
 512 } while (0)
 513
 514 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 515 int session_main_flush_all_enqueue_events (u8 transport_proto);
 516 void session_flush_frames_main_thread (vlib_main_t * vm);
 517 ssvm_private_t *session_main_get_evt_q_segment (void);
 518 void session_node_enable_disable (u8 is_en);
 519 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 520
 521 #endif /* __included_session_h__ */
 522
 523 /*
 524  * fd.io coding-style-patch-verification: ON
 525  *
 526  * Local Variables:
 527  * eval: (c-set-style "gnu")
 528  * End:
 529  */