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