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 extern vlib_node_registration_t session_queue_pre_input_node;
 191
 192 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
 193 #define SESSION_Q_PROCESS_STOP          2
 194
 195 always_inline u8
 196 session_is_valid (u32 si, u8 thread_index)
 197 {
 198   session_t *s;
 199   s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 200   if (s->session_state == SESSION_STATE_CLOSED)
 201     return 1;
 202
 203   if (s->thread_index != thread_index || s->session_index != si)
 204     return 0;
 205   return 1;
 206 }
 207
 208 session_t *session_alloc (u32 thread_index);
 209 void session_free (session_t * s);
 210 void session_free_w_fifos (session_t * s);
 211
 212 always_inline session_t *
 213 session_get (u32 si, u32 thread_index)
 214 {
 215   ASSERT (session_is_valid (si, thread_index));
 216   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 217 }
 218
 219 always_inline session_t *
 220 session_get_if_valid (u64 si, u32 thread_index)
 221 {
 222   if (thread_index >= vec_len (session_main.wrk))
 223     return 0;
 224
 225   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
 226     return 0;
 227
 228   ASSERT (session_is_valid (si, thread_index));
 229   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 230 }
 231
 232 always_inline session_t *
 233 session_get_from_handle (session_handle_t handle)
 234 {
 235   session_main_t *smm = &session_main;
 236   u32 session_index, thread_index;
 237   session_parse_handle (handle, &session_index, &thread_index);
 238   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 239 }
 240
 241 always_inline session_t *
 242 session_get_from_handle_if_valid (session_handle_t handle)
 243 {
 244   u32 session_index, thread_index;
 245   session_parse_handle (handle, &session_index, &thread_index);
 246   return session_get_if_valid (session_index, thread_index);
 247 }
 248
 249 u64 session_segment_handle (session_t * s);
 250
 251 /**
 252  * Acquires a lock that blocks a session pool from expanding.
 253  *
 254  * This is typically used for safely peeking into other threads'
 255  * pools in order to clone elements. Lock should be dropped as soon
 256  * as possible by calling @ref session_pool_remove_peeker.
 257  *
 258  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 259  * it may lead to free elt bitmap expansion/contraction!
 260  */
 261 always_inline void
 262 session_pool_add_peeker (u32 thread_index)
 263 {
 264   session_worker_t *wrk = &session_main.wrk[thread_index];
 265   if (thread_index == vlib_get_thread_index ())
 266     return;
 267   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
 268 }
 269
 270 always_inline void
 271 session_pool_remove_peeker (u32 thread_index)
 272 {
 273   session_worker_t *wrk = &session_main.wrk[thread_index];
 274   if (thread_index == vlib_get_thread_index ())
 275     return;
 276   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
 277 }
 278
 279 /**
 280  * Get session from handle and 'lock' pool resize if not in same thread
 281  *
 282  * Caller should drop the peek 'lock' as soon as possible.
 283  */
 284 always_inline session_t *
 285 session_get_from_handle_safe (u64 handle)
 286 {
 287   u32 thread_index = session_thread_from_handle (handle);
 288   session_worker_t *wrk = &session_main.wrk[thread_index];
 289
 290   if (thread_index == vlib_get_thread_index ())
 291     {
 292       return pool_elt_at_index (wrk->sessions,
 293                                 session_index_from_handle (handle));
 294     }
 295   else
 296     {
 297       session_pool_add_peeker (thread_index);
 298       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 299       return wrk->sessions + session_index_from_handle (handle);
 300     }
 301 }
 302
 303 always_inline u32
 304 session_get_index (session_t * s)
 305 {
 306   return (s - session_main.wrk[s->thread_index].sessions);
 307 }
 308
 309 always_inline session_t *
 310 session_clone_safe (u32 session_index, u32 thread_index)
 311 {
 312   session_t *old_s, *new_s;
 313   u32 current_thread_index = vlib_get_thread_index ();
 314
 315   /* If during the memcpy pool is reallocated AND the memory allocator
 316    * decides to give the old chunk of memory to somebody in a hurry to
 317    * scribble something on it, we have a problem. So add this thread as
 318    * a session pool peeker.
 319    */
 320   session_pool_add_peeker (thread_index);
 321   new_s = session_alloc (current_thread_index);
 322   old_s = session_main.wrk[thread_index].sessions + session_index;
 323   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 324   session_pool_remove_peeker (thread_index);
 325   new_s->thread_index = current_thread_index;
 326   new_s->session_index = session_get_index (new_s);
 327   return new_s;
 328 }
 329
 330 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 331 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 332 int session_stop_listen (session_t * s);
 333 void session_close (session_t * s);
 334 void session_transport_close (session_t * s);
 335 void session_transport_cleanup (session_t * s);
 336 int session_send_io_evt_to_thread (svm_fifo_t * f,
 337                                    session_evt_type_t evt_type);
 338 int session_enqueue_notify (session_t * s);
 339 int session_dequeue_notify (session_t * s);
 340 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 341                                           session_evt_type_t evt_type);
 342 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 343                                      void *rpc_args);
 344 transport_connection_t *session_get_transport (session_t * s);
 345
 346
 347 u8 *format_session (u8 * s, va_list * args);
 348 uword unformat_session (unformat_input_t * input, va_list * args);
 349 uword unformat_transport_connection (unformat_input_t * input,
 350                                      va_list * args);
 351
 352 /*
 353  * Interface to transport protos
 354  */
 355
 356 int session_enqueue_stream_connection (transport_connection_t * tc,
 357                                        vlib_buffer_t * b, u32 offset,
 358                                        u8 queue_event, u8 is_in_order);
 359 int session_enqueue_dgram_connection (session_t * s,
 360                                       session_dgram_hdr_t * hdr,
 361                                       vlib_buffer_t * b, u8 proto,
 362                                       u8 queue_event);
 363 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
 364 int session_dgram_connect_notify (transport_connection_t * tc,
 365                                   u32 old_thread_index,
 366                                   session_t ** new_session);
 367 int session_stream_accept_notify (transport_connection_t * tc);
 368 void session_transport_closing_notify (transport_connection_t * tc);
 369 void session_transport_delete_notify (transport_connection_t * tc);
 370 void session_transport_closed_notify (transport_connection_t * tc);
 371 void session_transport_reset_notify (transport_connection_t * tc);
 372 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 373                            u8 notify);
 374 void session_register_transport (transport_proto_t transport_proto,
 375                                  const transport_proto_vft_t * vft, u8 is_ip4,
 376                                  u32 output_node);
 377 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 378                                 u32 offset, u32 max_bytes);
 379 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 380
 381 always_inline u32
 382 transport_max_rx_enqueue (transport_connection_t * tc)
 383 {
 384   session_t *s = session_get (tc->s_index, tc->thread_index);
 385   return svm_fifo_max_enqueue (s->rx_fifo);
 386 }
 387
 388 always_inline u32
 389 transport_max_tx_dequeue (transport_connection_t * tc)
 390 {
 391   session_t *s = session_get (tc->s_index, tc->thread_index);
 392   return svm_fifo_max_dequeue (s->tx_fifo);
 393 }
 394
 395 always_inline u32
 396 transport_rx_fifo_size (transport_connection_t * tc)
 397 {
 398   session_t *s = session_get (tc->s_index, tc->thread_index);
 399   return s->rx_fifo->nitems;
 400 }
 401
 402 always_inline u32
 403 transport_tx_fifo_size (transport_connection_t * tc)
 404 {
 405   session_t *s = session_get (tc->s_index, tc->thread_index);
 406   return s->tx_fifo->nitems;
 407 }
 408
 409 always_inline u8
 410 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 411 {
 412   session_t *s = session_get (tc->c_index, tc->thread_index);
 413   return svm_fifo_has_ooo_data (s->rx_fifo);
 414 }
 415
 416 always_inline f64
 417 transport_dispatch_period (u32 thread_index)
 418 {
 419   return session_main.wrk[thread_index].dispatch_period;
 420 }
 421
 422 always_inline f64
 423 transport_time_now (u32 thread_index)
 424 {
 425   return session_main.wrk[thread_index].last_vlib_time;
 426 }
 427
 428 always_inline void
 429 transport_add_tx_event (transport_connection_t * tc)
 430 {
 431   session_t *s = session_get (tc->s_index, tc->thread_index);
 432   if (svm_fifo_has_event (s->tx_fifo))
 433     return;
 434   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 435 }
 436
 437 /*
 438  * Listen sessions
 439  */
 440
 441 always_inline u64
 442 listen_session_get_handle (session_t * s)
 443 {
 444   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 445   return session_handle (s);
 446 }
 447
 448 always_inline session_t *
 449 listen_session_get_from_handle (session_handle_t handle)
 450 {
 451   return session_get_from_handle (handle);
 452 }
 453
 454 always_inline void
 455 listen_session_parse_handle (session_handle_t handle, u32 * index,
 456                              u32 * thread_index)
 457 {
 458   session_parse_handle (handle, index, thread_index);
 459 }
 460
 461 always_inline session_t *
 462 listen_session_alloc (u8 thread_index, session_type_t type)
 463 {
 464   session_t *s;
 465   s = session_alloc (thread_index);
 466   s->session_type = type;
 467   s->session_state = SESSION_STATE_LISTENING;
 468   return s;
 469 }
 470
 471 always_inline session_t *
 472 listen_session_get (u32 ls_index)
 473 {
 474   return session_get (ls_index, 0);
 475 }
 476
 477 always_inline void
 478 listen_session_free (session_t * s)
 479 {
 480   session_free (s);
 481 }
 482
 483 transport_connection_t *listen_session_get_transport (session_t * s);
 484
 485 /*
 486  * Session layer functions
 487  */
 488
 489 always_inline session_main_t *
 490 vnet_get_session_main ()
 491 {
 492   return &session_main;
 493 }
 494
 495 always_inline session_worker_t *
 496 session_main_get_worker (u32 thread_index)
 497 {
 498   return &session_main.wrk[thread_index];
 499 }
 500
 501 always_inline svm_msg_q_t *
 502 session_main_get_vpp_event_queue (u32 thread_index)
 503 {
 504   return session_main.wrk[thread_index].vpp_event_queue;
 505 }
 506
 507 always_inline u8
 508 session_main_is_enabled ()
 509 {
 510   return session_main.is_enabled == 1;
 511 }
 512
 513 #define session_cli_return_if_not_enabled()                             \
 514 do {                                                                    \
 515     if (!session_main.is_enabled)                               \
 516       return clib_error_return(0, "session layer is not enabled");      \
 517 } while (0)
 518
 519 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 520 int session_main_flush_all_enqueue_events (u8 transport_proto);
 521 void session_flush_frames_main_thread (vlib_main_t * vm);
 522 ssvm_private_t *session_main_get_evt_q_segment (void);
 523 void session_node_enable_disable (u8 is_en);
 524 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 525
 526 #endif /* __included_session_h__ */
 527
 528 /*
 529  * fd.io coding-style-patch-verification: ON
 530  *
 531  * Local Variables:
 532  * eval: (c-set-style "gnu")
 533  * End:
 534  */