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