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/fifo_segment.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
  34 typedef enum
  35 {
  36 #define _(sym,str) SESSION_ERROR_##sym,
  37   foreach_session_input_error
  38 #undef _
  39     SESSION_N_ERROR,
  40 } session_input_error_t;
  41
  42 typedef struct session_tx_context_
  43 {
  44   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  45   session_t *s;
  46   transport_proto_vft_t *transport_vft;
  47   transport_connection_t *tc;
  48   transport_send_params_t sp;
  49   u32 max_dequeue;
  50   u32 left_to_snd;
  51   u32 max_len_to_snd;
  52   u16 deq_per_first_buf;
  53   u16 deq_per_buf;
  54   u16 n_segs_per_evt;
  55   u16 n_bufs_needed;
  56   u8 n_bufs_per_seg;
  57     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  58   session_dgram_hdr_t hdr;
  59
  60   /** Vector of tx buffer free lists */
  61   u32 *tx_buffers;
  62   vlib_buffer_t **transport_pending_bufs;
  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 enum session_wrk_state_
  77 {
  78   SESSION_WRK_POLLING,
  79   SESSION_WRK_INTERRUPT,
  80   SESSION_WRK_IDLE,
  81 } __clib_packed session_wrk_state_t;
  82
  83 typedef enum session_wrk_flags_
  84 {
  85   SESSION_WRK_F_ADAPTIVE = 1 << 0,
  86 } __clib_packed session_wrk_flag_t;
  87
  88 typedef struct session_worker_
  89 {
  90   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  91
  92   /** Worker session pool */
  93   session_t *sessions;
  94
  95   /** vpp event message queue for worker */
  96   svm_msg_q_t *vpp_event_queue;
  97
  98   /** vlib_time_now last time around the track */
  99   clib_time_type_t last_vlib_time;
 100
 101   /** vlib_time_now rounded to us precision and as u64 */
 102   clib_us_time_t last_vlib_us_time;
 103
 104   /** Convenience pointer to this worker's vlib_main */
 105   vlib_main_t *vm;
 106
 107   /** Per-proto vector of sessions to enqueue */
 108   u32 **session_to_enqueue;
 109
 110   /** Timerfd used to periodically signal wrk session queue node */
 111   int timerfd;
 112
 113   /** Worker flags */
 114   session_wrk_flag_t flags;
 115
 116   /** Worker state */
 117   session_wrk_state_t state;
 118
 119   /** Context for session tx */
 120   session_tx_context_t ctx;
 121
 122   /** Pool of session event list elements */
 123   session_evt_elt_t *event_elts;
 124
 125   /** Pool of ctrl events data buffers */
 126   session_evt_ctrl_data_t *ctrl_evts_data;
 127
 128   /** Head of control events list */
 129   clib_llist_index_t ctrl_head;
 130
 131   /** Head of list of elements */
 132   clib_llist_index_t new_head;
 133
 134   /** Head of list of pending events */
 135   clib_llist_index_t old_head;
 136
 137   /** Peekers rw lock */
 138   clib_rwlock_t peekers_rw_locks;
 139
 140   /** Vector of buffers to be sent */
 141   u32 *pending_tx_buffers;
 142
 143   /** Vector of nexts for the pending tx buffers */
 144   u16 *pending_tx_nexts;
 145
 146   /** Clib file for timerfd. Used only if adaptive mode is on */
 147   uword timerfd_file;
 148
 149   /** List of pending connects for first worker */
 150   clib_llist_index_t pending_connects;
 151
 152   /** Flag that is set if main thread signaled to handle connects */
 153   u32 n_pending_connects;
 154
 155   /** Main thread loops in poll mode without a connect */
 156   u32 no_connect_loops;
 157
 158 #if SESSION_DEBUG
 159   /** last event poll time by thread */
 160   clib_time_type_t last_event_poll;
 161 #endif
 162 } session_worker_t;
 163
 164 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
 165                                   vlib_node_runtime_t * node,
 166                                   session_evt_elt_t * e, int *n_tx_packets);
 167
 168 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 169 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 170 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 171
 172 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
 173
 174 typedef void (*session_update_time_fn) (f64 time_now, u8 thread_index);
 175
 176 typedef struct session_main_
 177 {
 178   /** Worker contexts */
 179   session_worker_t *wrk;
 180
 181   /** Vector of transport update time functions */
 182   session_update_time_fn *update_time_fns;
 183
 184   /** Event queues memfd segment */
 185   fifo_segment_t wrk_mqs_segment;
 186
 187   /** Unique segment name counter */
 188   u32 unique_segment_name_counter;
 189
 190   /** Per transport rx function that can either dequeue or peek */
 191   session_fifo_rx_fn **session_tx_fns;
 192
 193   /** Per session type output nodes. Could optimize to group nodes by
 194    * fib but lookup would then require session type parsing in session node.
 195    * Trade memory for speed, for now */
 196   u32 *session_type_to_next;
 197
 198   /** Thread for cl and ho that rely on cl allocs */
 199   u32 transport_cl_thread;
 200
 201   transport_proto_t last_transport_proto_type;
 202
 203   /** Number of workers at pool realloc barrier */
 204   u32 pool_realloc_at_barrier;
 205
 206   /** Lock to synchronize parallel forced reallocs */
 207   clib_spinlock_t pool_realloc_lock;
 208
 209   /*
 210    * Config parameters
 211    */
 212
 213   /** Session manager is enabled */
 214   u8 is_enabled;
 215
 216   /** Session manager initialized (not necessarily enabled) */
 217   u8 is_initialized;
 218
 219   /** Enable session manager at startup */
 220   u8 session_enable_asap;
 221
 222   /** Poll session node in main thread */
 223   u8 poll_main;
 224
 225   /** Allocate private rx mqs for external apps */
 226   u8 use_private_rx_mqs;
 227
 228   /** Do not enable session queue node adaptive mode */
 229   u8 no_adaptive;
 230
 231   /** vpp fifo event queue configured length */
 232   u32 configured_wrk_mq_length;
 233
 234   /** Session ssvm segment configs*/
 235   uword wrk_mqs_segment_size;
 236
 237   /** Session table size parameters */
 238   u32 configured_v4_session_table_buckets;
 239   u32 configured_v4_session_table_memory;
 240   u32 configured_v4_halfopen_table_buckets;
 241   u32 configured_v4_halfopen_table_memory;
 242   u32 configured_v6_session_table_buckets;
 243   u32 configured_v6_session_table_memory;
 244   u32 configured_v6_halfopen_table_buckets;
 245   u32 configured_v6_halfopen_table_memory;
 246
 247   /** Transport table (preallocation) size parameters */
 248   u32 local_endpoints_table_memory;
 249   u32 local_endpoints_table_buckets;
 250
 251   /** Preallocate session config parameter */
 252   u32 preallocated_sessions;
 253
 254   u16 msg_id_base;
 255 } session_main_t;
 256
 257 extern session_main_t session_main;
 258 extern vlib_node_registration_t session_queue_node;
 259 extern vlib_node_registration_t session_queue_process_node;
 260 extern vlib_node_registration_t session_queue_pre_input_node;
 261
 262 typedef enum session_q_process_evt_
 263 {
 264   SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
 265   SESSION_Q_PROCESS_STOP
 266 } session_q_process_evt_t;
 267
 268 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
 269 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
 270
 271 static inline void
 272 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
 273 {
 274   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 275                        clib_llist_elt (wrk->event_elts, wrk->old_head));
 276 }
 277
 278 static inline void
 279 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
 280 {
 281   clib_llist_add (wrk->event_elts, evt_list, elt,
 282                   clib_llist_elt (wrk->event_elts, wrk->old_head));
 283 }
 284
 285
 286 static inline u32
 287 session_evt_ctrl_data_alloc (session_worker_t * wrk)
 288 {
 289   session_evt_ctrl_data_t *data;
 290   pool_get (wrk->ctrl_evts_data, data);
 291   return (data - wrk->ctrl_evts_data);
 292 }
 293
 294 static inline session_evt_elt_t *
 295 session_evt_alloc_ctrl (session_worker_t * wrk)
 296 {
 297   session_evt_elt_t *elt;
 298   clib_llist_get (wrk->event_elts, elt);
 299   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 300                        clib_llist_elt (wrk->event_elts, wrk->ctrl_head));
 301   return elt;
 302 }
 303
 304 static inline void *
 305 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
 306 {
 307   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
 308                                       elt->evt.ctrl_data_index));
 309 }
 310
 311 static inline void
 312 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
 313 {
 314   ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
 315   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
 316 }
 317
 318 static inline session_evt_elt_t *
 319 session_evt_alloc_new (session_worker_t * wrk)
 320 {
 321   session_evt_elt_t *elt;
 322   clib_llist_get (wrk->event_elts, elt);
 323   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 324                        clib_llist_elt (wrk->event_elts, wrk->new_head));
 325   return elt;
 326 }
 327
 328 static inline session_evt_elt_t *
 329 session_evt_alloc_old (session_worker_t * wrk)
 330 {
 331   session_evt_elt_t *elt;
 332   clib_llist_get (wrk->event_elts, elt);
 333   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 334                        clib_llist_elt (wrk->event_elts, wrk->old_head));
 335   return elt;
 336 }
 337
 338 int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
 339
 340 session_t *session_alloc (u32 thread_index);
 341 void session_free (session_t * s);
 342 void session_free_w_fifos (session_t * s);
 343 void session_cleanup_half_open (session_handle_t ho_handle);
 344 u8 session_is_valid (u32 si, u8 thread_index);
 345
 346 always_inline session_t *
 347 session_get (u32 si, u32 thread_index)
 348 {
 349   ASSERT (session_is_valid (si, thread_index));
 350   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 351 }
 352
 353 always_inline session_t *
 354 session_get_if_valid (u64 si, u32 thread_index)
 355 {
 356   if (thread_index >= vec_len (session_main.wrk))
 357     return 0;
 358
 359   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
 360     return 0;
 361
 362   ASSERT (session_is_valid (si, thread_index));
 363   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 364 }
 365
 366 always_inline session_t *
 367 session_get_from_handle (session_handle_t handle)
 368 {
 369   session_main_t *smm = &session_main;
 370   u32 session_index, thread_index;
 371   session_parse_handle (handle, &session_index, &thread_index);
 372   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 373 }
 374
 375 always_inline session_t *
 376 session_get_from_handle_if_valid (session_handle_t handle)
 377 {
 378   u32 session_index, thread_index;
 379   session_parse_handle (handle, &session_index, &thread_index);
 380   return session_get_if_valid (session_index, thread_index);
 381 }
 382
 383 u64 session_segment_handle (session_t * s);
 384
 385 /**
 386  * Acquires a lock that blocks a session pool from expanding.
 387  *
 388  * This is typically used for safely peeking into other threads'
 389  * pools in order to clone elements. Lock should be dropped as soon
 390  * as possible by calling @ref session_pool_remove_peeker.
 391  *
 392  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 393  * it may lead to free elt bitmap expansion/contraction!
 394  */
 395 always_inline void
 396 session_pool_add_peeker (u32 thread_index)
 397 {
 398   session_worker_t *wrk = &session_main.wrk[thread_index];
 399   if (thread_index == vlib_get_thread_index ())
 400     return;
 401   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
 402 }
 403
 404 always_inline void
 405 session_pool_remove_peeker (u32 thread_index)
 406 {
 407   session_worker_t *wrk = &session_main.wrk[thread_index];
 408   if (thread_index == vlib_get_thread_index ())
 409     return;
 410   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
 411 }
 412
 413 /**
 414  * Get session from handle and 'lock' pool resize if not in same thread
 415  *
 416  * Caller should drop the peek 'lock' as soon as possible.
 417  */
 418 always_inline session_t *
 419 session_get_from_handle_safe (u64 handle)
 420 {
 421   u32 thread_index = session_thread_from_handle (handle);
 422   session_worker_t *wrk = &session_main.wrk[thread_index];
 423
 424   if (thread_index == vlib_get_thread_index ())
 425     {
 426       return pool_elt_at_index (wrk->sessions,
 427                                 session_index_from_handle (handle));
 428     }
 429   else
 430     {
 431       session_pool_add_peeker (thread_index);
 432       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 433       return wrk->sessions + session_index_from_handle (handle);
 434     }
 435 }
 436
 437 always_inline u32
 438 session_get_index (session_t * s)
 439 {
 440   return (s - session_main.wrk[s->thread_index].sessions);
 441 }
 442
 443 always_inline session_t *
 444 session_clone_safe (u32 session_index, u32 thread_index)
 445 {
 446   session_t *old_s, *new_s;
 447   u32 current_thread_index = vlib_get_thread_index ();
 448
 449   /* If during the memcpy pool is reallocated AND the memory allocator
 450    * decides to give the old chunk of memory to somebody in a hurry to
 451    * scribble something on it, we have a problem. So add this thread as
 452    * a session pool peeker.
 453    */
 454   session_pool_add_peeker (thread_index);
 455   new_s = session_alloc (current_thread_index);
 456   old_s = session_main.wrk[thread_index].sessions + session_index;
 457   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 458   session_pool_remove_peeker (thread_index);
 459   new_s->thread_index = current_thread_index;
 460   new_s->session_index = session_get_index (new_s);
 461   return new_s;
 462 }
 463
 464 int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
 465 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 466 int session_stop_listen (session_t * s);
 467 void session_half_close (session_t *s);
 468 void session_close (session_t * s);
 469 void session_reset (session_t * s);
 470 void session_transport_half_close (session_t *s);
 471 void session_transport_close (session_t * s);
 472 void session_transport_reset (session_t * s);
 473 void session_transport_cleanup (session_t * s);
 474 int session_send_io_evt_to_thread (svm_fifo_t * f,
 475                                    session_evt_type_t evt_type);
 476 int session_enqueue_notify (session_t * s);
 477 int session_dequeue_notify (session_t * s);
 478 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 479                                           session_evt_type_t evt_type);
 480 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 481                                      void *rpc_args);
 482 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
 483                                            void *rpc_args);
 484 void session_add_self_custom_tx_evt (transport_connection_t * tc,
 485                                      u8 has_prio);
 486 void sesssion_reschedule_tx (transport_connection_t * tc);
 487 transport_connection_t *session_get_transport (session_t * s);
 488 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
 489                            u8 is_lcl);
 490 int session_transport_attribute (session_t *s, u8 is_get,
 491                                  transport_endpt_attr_t *attr);
 492
 493 u8 *format_session (u8 * s, va_list * args);
 494 uword unformat_session (unformat_input_t * input, va_list * args);
 495 uword unformat_transport_connection (unformat_input_t * input,
 496                                      va_list * args);
 497
 498 /*
 499  * Interface to transport protos
 500  */
 501
 502 int session_enqueue_stream_connection (transport_connection_t * tc,
 503                                        vlib_buffer_t * b, u32 offset,
 504                                        u8 queue_event, u8 is_in_order);
 505 int session_enqueue_dgram_connection (session_t * s,
 506                                       session_dgram_hdr_t * hdr,
 507                                       vlib_buffer_t * b, u8 proto,
 508                                       u8 queue_event);
 509 int session_stream_connect_notify (transport_connection_t * tc,
 510                                    session_error_t err);
 511 int session_dgram_connect_notify (transport_connection_t * tc,
 512                                   u32 old_thread_index,
 513                                   session_t ** new_session);
 514 int session_stream_accept_notify (transport_connection_t * tc);
 515 void session_transport_closing_notify (transport_connection_t * tc);
 516 void session_transport_delete_notify (transport_connection_t * tc);
 517 void session_half_open_delete_notify (transport_connection_t *tc);
 518 void session_half_open_migrate_notify (transport_connection_t *tc);
 519 int session_half_open_migrated_notify (transport_connection_t *tc);
 520 void session_transport_closed_notify (transport_connection_t * tc);
 521 void session_transport_reset_notify (transport_connection_t * tc);
 522 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 523                            u32 thread_index, u8 notify);
 524 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
 525                           u32 thread_index);
 526 /**
 527  * Initialize session layer for given transport proto and ip version
 528  *
 529  * Allocates per session type (transport proto + ip version) data structures
 530  * and adds arc from session queue node to session type output node.
 531  *
 532  * @param transport_proto       transport proto to be registered
 533  * @param vft                   virtual function table for transport
 534  * @param is_ip4                flag that indicates if transports uses ipv4
 535  *                              as underlying network layer
 536  * @param output_node           output node for transport
 537  */
 538 void session_register_transport (transport_proto_t transport_proto,
 539                                  const transport_proto_vft_t * vft, u8 is_ip4,
 540                                  u32 output_node);
 541 transport_proto_t session_add_transport_proto (void);
 542 void session_register_update_time_fn (session_update_time_fn fn, u8 is_add);
 543 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 544                                 u32 offset, u32 max_bytes);
 545 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 546
 547 always_inline u32
 548 transport_max_rx_enqueue (transport_connection_t * tc)
 549 {
 550   session_t *s = session_get (tc->s_index, tc->thread_index);
 551   return svm_fifo_max_enqueue_prod (s->rx_fifo);
 552 }
 553
 554 always_inline u32
 555 transport_max_tx_dequeue (transport_connection_t * tc)
 556 {
 557   session_t *s = session_get (tc->s_index, tc->thread_index);
 558   return svm_fifo_max_dequeue_cons (s->tx_fifo);
 559 }
 560
 561 always_inline u32
 562 transport_max_rx_dequeue (transport_connection_t * tc)
 563 {
 564   session_t *s = session_get (tc->s_index, tc->thread_index);
 565   return svm_fifo_max_dequeue (s->rx_fifo);
 566 }
 567
 568 always_inline u32
 569 transport_rx_fifo_size (transport_connection_t * tc)
 570 {
 571   session_t *s = session_get (tc->s_index, tc->thread_index);
 572   return svm_fifo_size (s->rx_fifo);
 573 }
 574
 575 always_inline u32
 576 transport_tx_fifo_size (transport_connection_t * tc)
 577 {
 578   session_t *s = session_get (tc->s_index, tc->thread_index);
 579   return svm_fifo_size (s->tx_fifo);
 580 }
 581
 582 always_inline u8
 583 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 584 {
 585   session_t *s = session_get (tc->c_index, tc->thread_index);
 586   return svm_fifo_has_ooo_data (s->rx_fifo);
 587 }
 588
 589 always_inline void
 590 transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
 591 {
 592   session_t *s = session_get (tc->s_index, tc->thread_index);
 593   svm_fifo_add_want_deq_ntf (s->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 594 }
 595
 596 always_inline clib_time_type_t
 597 transport_time_now (u32 thread_index)
 598 {
 599   return session_main.wrk[thread_index].last_vlib_time;
 600 }
 601
 602 always_inline clib_us_time_t
 603 transport_us_time_now (u32 thread_index)
 604 {
 605   return session_main.wrk[thread_index].last_vlib_us_time;
 606 }
 607
 608 always_inline clib_time_type_t
 609 transport_seconds_per_loop (u32 thread_index)
 610 {
 611   return session_main.wrk[thread_index].vm->seconds_per_loop;
 612 }
 613
 614 always_inline void
 615 transport_add_tx_event (transport_connection_t * tc)
 616 {
 617   session_t *s = session_get (tc->s_index, tc->thread_index);
 618   if (svm_fifo_has_event (s->tx_fifo))
 619     return;
 620   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 621 }
 622
 623 always_inline u32
 624 transport_cl_thread (void)
 625 {
 626   return session_main.transport_cl_thread;
 627 }
 628
 629 /*
 630  * Listen sessions
 631  */
 632
 633 always_inline u64
 634 listen_session_get_handle (session_t * s)
 635 {
 636   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
 637           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
 638   return session_handle (s);
 639 }
 640
 641 always_inline session_t *
 642 listen_session_get_from_handle (session_handle_t handle)
 643 {
 644   return session_get_from_handle (handle);
 645 }
 646
 647 always_inline void
 648 listen_session_parse_handle (session_handle_t handle, u32 * index,
 649                              u32 * thread_index)
 650 {
 651   session_parse_handle (handle, index, thread_index);
 652 }
 653
 654 always_inline session_t *
 655 listen_session_alloc (u8 thread_index, session_type_t type)
 656 {
 657   session_t *s;
 658   s = session_alloc (thread_index);
 659   s->session_type = type;
 660   s->session_state = SESSION_STATE_LISTENING;
 661   return s;
 662 }
 663
 664 always_inline session_t *
 665 listen_session_get (u32 ls_index)
 666 {
 667   return session_get (ls_index, 0);
 668 }
 669
 670 always_inline void
 671 listen_session_free (session_t * s)
 672 {
 673   ASSERT (!s->rx_fifo);
 674   session_free (s);
 675 }
 676
 677 always_inline session_t *
 678 ho_session_alloc (void)
 679 {
 680   session_t *s;
 681   ASSERT (vlib_get_thread_index () == 0);
 682   s = session_alloc (0);
 683   s->session_state = SESSION_STATE_CONNECTING;
 684   s->flags |= SESSION_F_HALF_OPEN;
 685   /* Not ideal. Half-opens are only allocated from main with worker barrier
 686    * but can be cleaned up, i.e., session_half_open_free, from main without
 687    * a barrier. In debug images, the free_bitmap can grow while workers peek
 688    * the sessions pool, e.g., session_half_open_migrate_notify, and as a
 689    * result crash while validating the session. To avoid this, grow the bitmap
 690    * now. */
 691   if (CLIB_DEBUG)
 692     {
 693       session_t *sp = session_main.wrk[0].sessions;
 694       clib_bitmap_validate (pool_header (sp)->free_bitmap, s->session_index);
 695     }
 696   return s;
 697 }
 698
 699 always_inline session_t *
 700 ho_session_get (u32 ho_index)
 701 {
 702   return session_get (ho_index, 0 /* half-open thread */);
 703 }
 704
 705 always_inline void
 706 ho_session_free (session_t *s)
 707 {
 708   ASSERT (!s->rx_fifo && s->thread_index == 0);
 709   session_free (s);
 710 }
 711
 712 transport_connection_t *listen_session_get_transport (session_t * s);
 713
 714 /*
 715  * Session layer functions
 716  */
 717
 718 always_inline session_main_t *
 719 vnet_get_session_main ()
 720 {
 721   return &session_main;
 722 }
 723
 724 always_inline session_worker_t *
 725 session_main_get_worker (u32 thread_index)
 726 {
 727   return &session_main.wrk[thread_index];
 728 }
 729
 730 static inline session_worker_t *
 731 session_main_get_worker_if_valid (u32 thread_index)
 732 {
 733   if (thread_index > vec_len (session_main.wrk))
 734     return 0;
 735   return &session_main.wrk[thread_index];
 736 }
 737
 738 always_inline svm_msg_q_t *
 739 session_main_get_vpp_event_queue (u32 thread_index)
 740 {
 741   return session_main.wrk[thread_index].vpp_event_queue;
 742 }
 743
 744 always_inline u8
 745 session_main_is_enabled ()
 746 {
 747   return session_main.is_enabled == 1;
 748 }
 749
 750 #define session_cli_return_if_not_enabled()                             \
 751 do {                                                                    \
 752     if (!session_main.is_enabled)                                       \
 753       return clib_error_return (0, "session layer is not enabled");     \
 754 } while (0)
 755
 756 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 757 int session_main_flush_all_enqueue_events (u8 transport_proto);
 758 void session_queue_run_on_main_thread (vlib_main_t * vm);
 759
 760 /**
 761  * Add session node pending buffer with custom node
 762  *
 763  * @param thread_index  worker thread expected to send the buffer
 764  * @param bi            buffer index
 765  * @param next_node     next node edge index for buffer. Edge to next node
 766  *                      must exist
 767  */
 768 always_inline void
 769 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
 770 {
 771   session_worker_t *wrk = session_main_get_worker (thread_index);
 772   vec_add1 (wrk->pending_tx_buffers, bi);
 773   vec_add1 (wrk->pending_tx_nexts, next_node);
 774   if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
 775     vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
 776 }
 777
 778 always_inline void
 779 session_wrk_update_time (session_worker_t *wrk, f64 now)
 780 {
 781   wrk->last_vlib_time = now;
 782   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
 783 }
 784
 785 void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
 786 fifo_segment_t *session_main_get_wrk_mqs_segment (void);
 787 void session_node_enable_disable (u8 is_en);
 788 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 789
 790 session_t *session_alloc_for_connection (transport_connection_t * tc);
 791 session_t *session_alloc_for_half_open (transport_connection_t *tc);
 792
 793 typedef void (pool_safe_realloc_rpc_fn) (void *rpc_args);
 794
 795 typedef struct
 796 {
 797   u8 ph[STRUCT_OFFSET_OF (pool_header_t, max_elts) + 4];
 798   u32 flag;
 799 } pool_safe_realloc_header_t;
 800
 801 STATIC_ASSERT_SIZEOF (pool_safe_realloc_header_t, sizeof (pool_header_t));
 802
 803 #define POOL_REALLOC_SAFE_ELT_THRESH 32
 804
 805 #define pool_realloc_flag(PH)                                                 \
 806   ((pool_safe_realloc_header_t *) pool_header (PH))->flag
 807
 808 #define pool_realloc_safe_aligned(P, align)                                   \
 809   do                                                                          \
 810     {                                                                         \
 811       vlib_main_t *vm = vlib_get_main ();                                     \
 812       u32 free_elts, max_elts, n_alloc;                                       \
 813       ASSERT (vlib_get_thread_index () == 0);                                 \
 814       vlib_worker_thread_barrier_sync (vm);                                   \
 815       free_elts = pool_free_elts (P);                                         \
 816       max_elts = pool_max_len (P);                                            \
 817       n_alloc = clib_max (2 * max_elts, POOL_REALLOC_SAFE_ELT_THRESH);        \
 818       pool_alloc_aligned (P, free_elts + n_alloc, align);                     \
 819       clib_bitmap_validate (pool_header (P)->free_bitmap,                     \
 820                             max_elts + n_alloc);                              \
 821       pool_realloc_flag (P) = 0;                                              \
 822       vlib_worker_thread_barrier_release (vm);                                \
 823     }                                                                         \
 824   while (0)
 825
 826 always_inline void
 827 pool_program_safe_realloc (void *p, u32 thread_index,
 828                            pool_safe_realloc_rpc_fn *rpc_fn)
 829 {
 830   /* Reuse pad as a realloc flag */
 831   if (pool_realloc_flag (p))
 832     return;
 833
 834   pool_realloc_flag (p) = 1;
 835   session_send_rpc_evt_to_thread (0 /* thread index */, rpc_fn,
 836                                   uword_to_pointer (thread_index, void *));
 837 }
 838
 839 always_inline void
 840 pool_realloc_maybe_wait_at_barrier (void)
 841 {
 842   if (!(*vlib_worker_threads->wait_at_barrier))
 843     return;
 844
 845   /* Node refork required. Don't stop at the barrier from within a node */
 846   if (*vlib_worker_threads->node_reforks_required)
 847     return;
 848
 849   clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
 850
 851   while (*vlib_worker_threads->wait_at_barrier)
 852     ;
 853
 854   clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
 855 }
 856
 857 #define pool_realloc_all_at_barrier(_not)                                     \
 858   (*vlib_worker_threads->workers_at_barrier >= (vlib_num_workers () - _not))
 859
 860 #define pool_realloc_safe_force(P)                                            \
 861   do                                                                          \
 862     {                                                                         \
 863       ALWAYS_ASSERT (*vlib_worker_threads->node_reforks_required);            \
 864       if (pool_realloc_all_at_barrier (1))                                    \
 865         {                                                                     \
 866           pool_alloc (P, pool_max_len (P));                                   \
 867         }                                                                     \
 868       else                                                                    \
 869         {                                                                     \
 870           session_main_t *sm = &session_main;                                 \
 871           clib_warning ("forced pool realloc");                               \
 872           clib_atomic_fetch_add (&sm->pool_realloc_at_barrier, 1);            \
 873           while (!pool_realloc_all_at_barrier (sm->pool_realloc_at_barrier))  \
 874             ;                                                                 \
 875           clib_spinlock_lock (&sm->pool_realloc_lock);                        \
 876           pool_alloc (P, pool_max_len (P));                                   \
 877           clib_spinlock_unlock (&sm->pool_realloc_lock);                      \
 878           clib_atomic_fetch_add (&sm->pool_realloc_at_barrier, -1);           \
 879         }                                                                     \
 880     }                                                                         \
 881   while (0)
 882
 883 #define pool_needs_realloc(P)                                                 \
 884   ((!P) ||                                                                    \
 885    (vec_len (pool_header (P)->free_indices) < POOL_REALLOC_SAFE_ELT_THRESH && \
 886     pool_free_elts (P) < POOL_REALLOC_SAFE_ELT_THRESH))
 887
 888 #define pool_get_aligned_safe(P, E, thread_index, rpc_fn, align)              \
 889   do                                                                          \
 890     {                                                                         \
 891       ASSERT (vlib_get_thread_index () == thread_index ||                     \
 892               vlib_thread_is_main_w_barrier ());                              \
 893       if (PREDICT_FALSE (pool_needs_realloc (P)))                             \
 894         {                                                                     \
 895           if (PREDICT_FALSE (!(P)))                                           \
 896             {                                                                 \
 897               pool_alloc_aligned (P, 2 * POOL_REALLOC_SAFE_ELT_THRESH,        \
 898                                   align);                                     \
 899             }                                                                 \
 900           else if (PREDICT_FALSE (pool_free_elts (P) <                        \
 901                                   POOL_REALLOC_SAFE_ELT_THRESH / 2))          \
 902             {                                                                 \
 903               volatile typeof (P) *PP = &(P);                                 \
 904               pool_program_safe_realloc (P, thread_index, rpc_fn);            \
 905               if (thread_index)                                               \
 906                 {                                                             \
 907                   while (pool_realloc_flag (P))                               \
 908                     {                                                         \
 909                       /* If refork required abort and consume existing elt */ \
 910                       if (*vlib_worker_threads->node_reforks_required)        \
 911                         {                                                     \
 912                           /* All workers at barrier realloc now */            \
 913                           if (pool_realloc_all_at_barrier (1))                \
 914                             pool_alloc_aligned (P, pool_max_len (P), align);  \
 915                           break;                                              \
 916                         }                                                     \
 917                       pool_realloc_maybe_wait_at_barrier ();                  \
 918                     }                                                         \
 919                   if (pool_free_elts (P) == 0)                                \
 920                     pool_realloc_safe_force (P);                              \
 921                   ALWAYS_ASSERT (pool_free_elts (P) > 0);                     \
 922                 }                                                             \
 923               (P) = *PP;                                                      \
 924             }                                                                 \
 925           else                                                                \
 926             {                                                                 \
 927               pool_program_safe_realloc (P, thread_index, rpc_fn);            \
 928             }                                                                 \
 929         }                                                                     \
 930       pool_get_aligned (P, E, align);                                         \
 931     }                                                                         \
 932   while (0)
 933
 934 #endif /* __included_session_h__ */
 935
 936 /*
 937  * fd.io coding-style-patch-verification: ON
 938  *
 939  * Local Variables:
 940  * eval: (c-set-style "gnu")
 941  * End:
 942  */