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   /** Vector of buffers to be sent */
 138   u32 *pending_tx_buffers;
 139
 140   /** Vector of nexts for the pending tx buffers */
 141   u16 *pending_tx_nexts;
 142
 143   /** Clib file for timerfd. Used only if adaptive mode is on */
 144   uword timerfd_file;
 145
 146   /** List of pending connects for first worker */
 147   clib_llist_index_t pending_connects;
 148
 149   /** Flag that is set if main thread signaled to handle connects */
 150   u32 n_pending_connects;
 151
 152   /** Main thread loops in poll mode without a connect */
 153   u32 no_connect_loops;
 154
 155   /** List head for first worker evts pending handling on main */
 156   clib_llist_index_t evts_pending_main;
 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  * Get session from handle and avoid pool validation if no same thread
 387  *
 388  * Peekers are fine because pool grows with barrier (see @ref session_alloc)
 389  */
 390 always_inline session_t *
 391 session_get_from_handle_safe (u64 handle)
 392 {
 393   u32 thread_index = session_thread_from_handle (handle);
 394   session_worker_t *wrk = &session_main.wrk[thread_index];
 395
 396   if (thread_index == vlib_get_thread_index ())
 397     {
 398       return pool_elt_at_index (wrk->sessions,
 399                                 session_index_from_handle (handle));
 400     }
 401   else
 402     {
 403       /* Don't use pool_elt_at index to avoid pool bitmap reallocs */
 404       return wrk->sessions + session_index_from_handle (handle);
 405     }
 406 }
 407
 408 always_inline session_t *
 409 session_clone_safe (u32 session_index, u32 thread_index)
 410 {
 411   u32 current_thread_index = vlib_get_thread_index (), new_index;
 412   session_t *old_s, *new_s;
 413
 414   new_s = session_alloc (current_thread_index);
 415   new_index = new_s->session_index;
 416   /* Session pools are reallocated with barrier (see @ref session_alloc) */
 417   old_s = session_main.wrk[thread_index].sessions + session_index;
 418   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 419   new_s->thread_index = current_thread_index;
 420   new_s->session_index = new_index;
 421   return new_s;
 422 }
 423
 424 int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
 425 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 426 int session_stop_listen (session_t * s);
 427 void session_half_close (session_t *s);
 428 void session_close (session_t * s);
 429 void session_reset (session_t * s);
 430 void session_transport_half_close (session_t *s);
 431 void session_transport_close (session_t * s);
 432 void session_transport_reset (session_t * s);
 433 void session_transport_cleanup (session_t * s);
 434 int session_send_io_evt_to_thread (svm_fifo_t * f,
 435                                    session_evt_type_t evt_type);
 436 int session_enqueue_notify (session_t * s);
 437 int session_dequeue_notify (session_t * s);
 438 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 439                                           session_evt_type_t evt_type);
 440 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 441                                      void *rpc_args);
 442 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
 443                                            void *rpc_args);
 444 void session_add_self_custom_tx_evt (transport_connection_t * tc,
 445                                      u8 has_prio);
 446 void sesssion_reschedule_tx (transport_connection_t * tc);
 447 transport_connection_t *session_get_transport (session_t * s);
 448 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
 449                            u8 is_lcl);
 450 int session_transport_attribute (session_t *s, u8 is_get,
 451                                  transport_endpt_attr_t *attr);
 452
 453 u8 *format_session (u8 * s, va_list * args);
 454 uword unformat_session (unformat_input_t * input, va_list * args);
 455 uword unformat_transport_connection (unformat_input_t * input,
 456                                      va_list * args);
 457
 458 /*
 459  * Interface to transport protos
 460  */
 461
 462 int session_enqueue_stream_connection (transport_connection_t * tc,
 463                                        vlib_buffer_t * b, u32 offset,
 464                                        u8 queue_event, u8 is_in_order);
 465 int session_enqueue_dgram_connection (session_t * s,
 466                                       session_dgram_hdr_t * hdr,
 467                                       vlib_buffer_t * b, u8 proto,
 468                                       u8 queue_event);
 469 int session_stream_connect_notify (transport_connection_t * tc,
 470                                    session_error_t err);
 471 int session_dgram_connect_notify (transport_connection_t * tc,
 472                                   u32 old_thread_index,
 473                                   session_t ** new_session);
 474 int session_stream_accept_notify (transport_connection_t * tc);
 475 void session_transport_closing_notify (transport_connection_t * tc);
 476 void session_transport_delete_notify (transport_connection_t * tc);
 477 void session_half_open_delete_notify (transport_connection_t *tc);
 478 void session_half_open_migrate_notify (transport_connection_t *tc);
 479 int session_half_open_migrated_notify (transport_connection_t *tc);
 480 void session_transport_closed_notify (transport_connection_t * tc);
 481 void session_transport_reset_notify (transport_connection_t * tc);
 482 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 483                            u32 thread_index, u8 notify);
 484 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
 485                           u32 thread_index);
 486 /**
 487  * Initialize session layer for given transport proto and ip version
 488  *
 489  * Allocates per session type (transport proto + ip version) data structures
 490  * and adds arc from session queue node to session type output node.
 491  *
 492  * @param transport_proto       transport proto to be registered
 493  * @param vft                   virtual function table for transport
 494  * @param is_ip4                flag that indicates if transports uses ipv4
 495  *                              as underlying network layer
 496  * @param output_node           output node for transport
 497  */
 498 void session_register_transport (transport_proto_t transport_proto,
 499                                  const transport_proto_vft_t * vft, u8 is_ip4,
 500                                  u32 output_node);
 501 transport_proto_t session_add_transport_proto (void);
 502 void session_register_update_time_fn (session_update_time_fn fn, u8 is_add);
 503 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 504                                 u32 offset, u32 max_bytes);
 505 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 506
 507 always_inline u32
 508 transport_max_rx_enqueue (transport_connection_t * tc)
 509 {
 510   session_t *s = session_get (tc->s_index, tc->thread_index);
 511   return svm_fifo_max_enqueue_prod (s->rx_fifo);
 512 }
 513
 514 always_inline u32
 515 transport_max_tx_dequeue (transport_connection_t * tc)
 516 {
 517   session_t *s = session_get (tc->s_index, tc->thread_index);
 518   return svm_fifo_max_dequeue_cons (s->tx_fifo);
 519 }
 520
 521 always_inline u32
 522 transport_max_rx_dequeue (transport_connection_t * tc)
 523 {
 524   session_t *s = session_get (tc->s_index, tc->thread_index);
 525   return svm_fifo_max_dequeue (s->rx_fifo);
 526 }
 527
 528 always_inline u32
 529 transport_rx_fifo_size (transport_connection_t * tc)
 530 {
 531   session_t *s = session_get (tc->s_index, tc->thread_index);
 532   return svm_fifo_size (s->rx_fifo);
 533 }
 534
 535 always_inline u32
 536 transport_tx_fifo_size (transport_connection_t * tc)
 537 {
 538   session_t *s = session_get (tc->s_index, tc->thread_index);
 539   return svm_fifo_size (s->tx_fifo);
 540 }
 541
 542 always_inline u8
 543 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 544 {
 545   session_t *s = session_get (tc->c_index, tc->thread_index);
 546   return svm_fifo_has_ooo_data (s->rx_fifo);
 547 }
 548
 549 always_inline void
 550 transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
 551 {
 552   session_t *s = session_get (tc->s_index, tc->thread_index);
 553   svm_fifo_add_want_deq_ntf (s->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 554 }
 555
 556 always_inline clib_time_type_t
 557 transport_time_now (u32 thread_index)
 558 {
 559   return session_main.wrk[thread_index].last_vlib_time;
 560 }
 561
 562 always_inline clib_us_time_t
 563 transport_us_time_now (u32 thread_index)
 564 {
 565   return session_main.wrk[thread_index].last_vlib_us_time;
 566 }
 567
 568 always_inline clib_time_type_t
 569 transport_seconds_per_loop (u32 thread_index)
 570 {
 571   return session_main.wrk[thread_index].vm->seconds_per_loop;
 572 }
 573
 574 always_inline void
 575 transport_add_tx_event (transport_connection_t * tc)
 576 {
 577   session_t *s = session_get (tc->s_index, tc->thread_index);
 578   if (svm_fifo_has_event (s->tx_fifo))
 579     return;
 580   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 581 }
 582
 583 always_inline u32
 584 transport_cl_thread (void)
 585 {
 586   return session_main.transport_cl_thread;
 587 }
 588
 589 /*
 590  * Listen sessions
 591  */
 592
 593 always_inline u64
 594 listen_session_get_handle (session_t * s)
 595 {
 596   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
 597           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
 598   return session_handle (s);
 599 }
 600
 601 always_inline session_t *
 602 listen_session_get_from_handle (session_handle_t handle)
 603 {
 604   return session_get_from_handle (handle);
 605 }
 606
 607 always_inline void
 608 listen_session_parse_handle (session_handle_t handle, u32 * index,
 609                              u32 * thread_index)
 610 {
 611   session_parse_handle (handle, index, thread_index);
 612 }
 613
 614 always_inline session_t *
 615 listen_session_alloc (u8 thread_index, session_type_t type)
 616 {
 617   session_t *s;
 618   s = session_alloc (thread_index);
 619   s->session_type = type;
 620   s->session_state = SESSION_STATE_LISTENING;
 621   return s;
 622 }
 623
 624 always_inline session_t *
 625 listen_session_get (u32 ls_index)
 626 {
 627   return session_get (ls_index, 0);
 628 }
 629
 630 always_inline void
 631 listen_session_free (session_t * s)
 632 {
 633   ASSERT (!s->rx_fifo);
 634   session_free (s);
 635 }
 636
 637 always_inline session_t *
 638 ho_session_alloc (void)
 639 {
 640   session_t *s;
 641   ASSERT (vlib_get_thread_index () == 0);
 642   s = session_alloc (0);
 643   s->session_state = SESSION_STATE_CONNECTING;
 644   s->flags |= SESSION_F_HALF_OPEN;
 645   /* Not ideal. Half-opens are only allocated from main with worker barrier
 646    * but can be cleaned up, i.e., session_half_open_free, from main without
 647    * a barrier. In debug images, the free_bitmap can grow while workers peek
 648    * the sessions pool, e.g., session_half_open_migrate_notify, and as a
 649    * result crash while validating the session. To avoid this, grow the bitmap
 650    * now. */
 651   if (CLIB_DEBUG)
 652     {
 653       session_t *sp = session_main.wrk[0].sessions;
 654       clib_bitmap_validate (pool_header (sp)->free_bitmap, s->session_index);
 655     }
 656   return s;
 657 }
 658
 659 always_inline session_t *
 660 ho_session_get (u32 ho_index)
 661 {
 662   return session_get (ho_index, 0 /* half-open thread */);
 663 }
 664
 665 always_inline void
 666 ho_session_free (session_t *s)
 667 {
 668   ASSERT (!s->rx_fifo && s->thread_index == 0);
 669   session_free (s);
 670 }
 671
 672 transport_connection_t *listen_session_get_transport (session_t * s);
 673
 674 /*
 675  * Session layer functions
 676  */
 677
 678 always_inline session_main_t *
 679 vnet_get_session_main ()
 680 {
 681   return &session_main;
 682 }
 683
 684 always_inline session_worker_t *
 685 session_main_get_worker (u32 thread_index)
 686 {
 687   return &session_main.wrk[thread_index];
 688 }
 689
 690 static inline session_worker_t *
 691 session_main_get_worker_if_valid (u32 thread_index)
 692 {
 693   if (thread_index > vec_len (session_main.wrk))
 694     return 0;
 695   return &session_main.wrk[thread_index];
 696 }
 697
 698 always_inline svm_msg_q_t *
 699 session_main_get_vpp_event_queue (u32 thread_index)
 700 {
 701   return session_main.wrk[thread_index].vpp_event_queue;
 702 }
 703
 704 always_inline u8
 705 session_main_is_enabled ()
 706 {
 707   return session_main.is_enabled == 1;
 708 }
 709
 710 #define session_cli_return_if_not_enabled()                             \
 711 do {                                                                    \
 712     if (!session_main.is_enabled)                                       \
 713       return clib_error_return (0, "session layer is not enabled");     \
 714 } while (0)
 715
 716 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 717 int session_main_flush_all_enqueue_events (u8 transport_proto);
 718 void session_queue_run_on_main_thread (vlib_main_t * vm);
 719
 720 /**
 721  * Add session node pending buffer with custom node
 722  *
 723  * @param thread_index  worker thread expected to send the buffer
 724  * @param bi            buffer index
 725  * @param next_node     next node edge index for buffer. Edge to next node
 726  *                      must exist
 727  */
 728 always_inline void
 729 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
 730 {
 731   session_worker_t *wrk = session_main_get_worker (thread_index);
 732   vec_add1 (wrk->pending_tx_buffers, bi);
 733   vec_add1 (wrk->pending_tx_nexts, next_node);
 734   if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
 735     vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
 736 }
 737
 738 always_inline void
 739 session_wrk_update_time (session_worker_t *wrk, f64 now)
 740 {
 741   wrk->last_vlib_time = now;
 742   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
 743 }
 744
 745 void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
 746 fifo_segment_t *session_main_get_wrk_mqs_segment (void);
 747 void session_node_enable_disable (u8 is_en);
 748 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 749 void session_wrk_handle_evts_main_rpc ();
 750
 751 session_t *session_alloc_for_connection (transport_connection_t * tc);
 752 session_t *session_alloc_for_half_open (transport_connection_t *tc);
 753
 754 typedef void (pool_safe_realloc_rpc_fn) (void *rpc_args);
 755
 756 typedef struct
 757 {
 758   u8 ph[STRUCT_OFFSET_OF (pool_header_t, max_elts) + 4];
 759   u32 flag;
 760 } pool_safe_realloc_header_t;
 761
 762 STATIC_ASSERT_SIZEOF (pool_safe_realloc_header_t, sizeof (pool_header_t));
 763
 764 #define POOL_REALLOC_SAFE_ELT_THRESH 32
 765
 766 #define pool_realloc_flag(PH)                                                 \
 767   ((pool_safe_realloc_header_t *) pool_header (PH))->flag
 768
 769 #define pool_realloc_safe_aligned(P, align)                                   \
 770   do                                                                          \
 771     {                                                                         \
 772       vlib_main_t *vm = vlib_get_main ();                                     \
 773       u32 free_elts, max_elts, n_alloc;                                       \
 774       ASSERT (vlib_get_thread_index () == 0);                                 \
 775       vlib_worker_thread_barrier_sync (vm);                                   \
 776       free_elts = pool_free_elts (P);                                         \
 777       max_elts = pool_max_len (P);                                            \
 778       n_alloc = clib_max (2 * max_elts, POOL_REALLOC_SAFE_ELT_THRESH);        \
 779       pool_alloc_aligned (P, free_elts + n_alloc, align);                     \
 780       clib_bitmap_validate (pool_header (P)->free_bitmap,                     \
 781                             max_elts + n_alloc);                              \
 782       pool_realloc_flag (P) = 0;                                              \
 783       vlib_worker_thread_barrier_release (vm);                                \
 784     }                                                                         \
 785   while (0)
 786
 787 always_inline void
 788 pool_program_safe_realloc (void *p, u32 thread_index,
 789                            pool_safe_realloc_rpc_fn *rpc_fn)
 790 {
 791   /* Reuse pad as a realloc flag */
 792   if (pool_realloc_flag (p))
 793     return;
 794
 795   pool_realloc_flag (p) = 1;
 796   session_send_rpc_evt_to_thread (0 /* thread index */, rpc_fn,
 797                                   uword_to_pointer (thread_index, void *));
 798 }
 799
 800 always_inline void
 801 pool_realloc_maybe_wait_at_barrier (void)
 802 {
 803   if (!(*vlib_worker_threads->wait_at_barrier))
 804     return;
 805
 806   /* Node refork required. Don't stop at the barrier from within a node */
 807   if (*vlib_worker_threads->node_reforks_required)
 808     return;
 809
 810   clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
 811
 812   while (*vlib_worker_threads->wait_at_barrier)
 813     ;
 814
 815   clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
 816 }
 817
 818 #define pool_realloc_all_at_barrier(_not)                                     \
 819   (*vlib_worker_threads->workers_at_barrier >= (vlib_num_workers () - _not))
 820
 821 #define pool_realloc_safe_force(P)                                            \
 822   do                                                                          \
 823     {                                                                         \
 824       ALWAYS_ASSERT (*vlib_worker_threads->node_reforks_required);            \
 825       if (pool_realloc_all_at_barrier (1))                                    \
 826         {                                                                     \
 827           pool_alloc (P, pool_max_len (P));                                   \
 828         }                                                                     \
 829       else                                                                    \
 830         {                                                                     \
 831           session_main_t *sm = &session_main;                                 \
 832           clib_warning ("forced pool realloc");                               \
 833           clib_atomic_fetch_add (&sm->pool_realloc_at_barrier, 1);            \
 834           while (!pool_realloc_all_at_barrier (sm->pool_realloc_at_barrier))  \
 835             ;                                                                 \
 836           clib_spinlock_lock (&sm->pool_realloc_lock);                        \
 837           pool_alloc (P, pool_max_len (P));                                   \
 838           clib_spinlock_unlock (&sm->pool_realloc_lock);                      \
 839           clib_atomic_fetch_add (&sm->pool_realloc_at_barrier, -1);           \
 840         }                                                                     \
 841     }                                                                         \
 842   while (0)
 843
 844 #define pool_needs_realloc(P)                                                 \
 845   ((!P) ||                                                                    \
 846    (vec_len (pool_header (P)->free_indices) < POOL_REALLOC_SAFE_ELT_THRESH && \
 847     pool_free_elts (P) < POOL_REALLOC_SAFE_ELT_THRESH))
 848
 849 #define pool_get_aligned_safe(P, E, thread_index, rpc_fn, align)              \
 850   do                                                                          \
 851     {                                                                         \
 852       ASSERT (vlib_get_thread_index () == thread_index ||                     \
 853               vlib_thread_is_main_w_barrier ());                              \
 854       if (PREDICT_FALSE (pool_needs_realloc (P)))                             \
 855         {                                                                     \
 856           if (PREDICT_FALSE (!(P)))                                           \
 857             {                                                                 \
 858               pool_alloc_aligned (P, 2 * POOL_REALLOC_SAFE_ELT_THRESH,        \
 859                                   align);                                     \
 860             }                                                                 \
 861           else if (PREDICT_FALSE (pool_free_elts (P) <                        \
 862                                   POOL_REALLOC_SAFE_ELT_THRESH / 2))          \
 863             {                                                                 \
 864               volatile typeof (P) *PP = &(P);                                 \
 865               pool_program_safe_realloc (P, thread_index, rpc_fn);            \
 866               if (thread_index)                                               \
 867                 {                                                             \
 868                   while (pool_realloc_flag (P))                               \
 869                     {                                                         \
 870                       /* If refork required abort and consume existing elt */ \
 871                       if (*vlib_worker_threads->node_reforks_required)        \
 872                         {                                                     \
 873                           /* All workers at barrier realloc now */            \
 874                           if (pool_realloc_all_at_barrier (1))                \
 875                             pool_alloc_aligned (P, pool_max_len (P), align);  \
 876                           break;                                              \
 877                         }                                                     \
 878                       pool_realloc_maybe_wait_at_barrier ();                  \
 879                     }                                                         \
 880                   if (pool_free_elts (P) == 0)                                \
 881                     pool_realloc_safe_force (P);                              \
 882                   ALWAYS_ASSERT (pool_free_elts (P) > 0);                     \
 883                 }                                                             \
 884               (P) = *PP;                                                      \
 885             }                                                                 \
 886           else                                                                \
 887             {                                                                 \
 888               pool_program_safe_realloc (P, thread_index, rpc_fn);            \
 889             }                                                                 \
 890         }                                                                     \
 891       pool_get_aligned (P, E, align);                                         \
 892     }                                                                         \
 893   while (0)
 894
 895 #endif /* __included_session_h__ */
 896
 897 /*
 898  * fd.io coding-style-patch-verification: ON
 899  *
 900  * Local Variables:
 901  * eval: (c-set-style "gnu")
 902  * End:
 903  */