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