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