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 session handles to enqueue */
 104   session_handle_t **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   /** Per-app-worker bitmap of pending notifications */
 152   uword *app_wrks_pending_ntf;
 153
 154   int config_index;
 155   u8 dma_enabled;
 156   session_dma_transfer *dma_trans;
 157   u16 trans_head;
 158   u16 trans_tail;
 159   u16 trans_size;
 160   u16 batch_num;
 161   vlib_dma_batch_t *batch;
 162
 163   session_wrk_stats_t stats;
 164
 165 #if SESSION_DEBUG
 166   /** last event poll time by thread */
 167   clib_time_type_t last_event_poll;
 168 #endif
 169 } session_worker_t;
 170
 171 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
 172                                   vlib_node_runtime_t * node,
 173                                   session_evt_elt_t * e, int *n_tx_packets);
 174
 175 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 176 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 177 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 178
 179 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
 180
 181 typedef void (*session_update_time_fn) (f64 time_now, u8 thread_index);
 182 typedef void (*nat44_original_dst_lookup_fn) (
 183   ip4_address_t *i2o_src, u16 i2o_src_port, ip4_address_t *i2o_dst,
 184   u16 i2o_dst_port, ip_protocol_t proto, u32 *original_dst,
 185   u16 *original_dst_port);
 186
 187 typedef struct session_main_
 188 {
 189   /** Worker contexts */
 190   session_worker_t *wrk;
 191
 192   /** Vector of transport update time functions */
 193   session_update_time_fn *update_time_fns;
 194
 195   /** Event queues memfd segment */
 196   fifo_segment_t wrk_mqs_segment;
 197
 198   /** Unique segment name counter */
 199   u32 unique_segment_name_counter;
 200
 201   /** Per transport rx function that can either dequeue or peek */
 202   session_fifo_rx_fn **session_tx_fns;
 203
 204   /** Per session type output nodes. Could optimize to group nodes by
 205    * fib but lookup would then require session type parsing in session node.
 206    * Trade memory for speed, for now */
 207   u32 *session_type_to_next;
 208
 209   /** Thread used for allocating active open connections, i.e., half-opens
 210    * for transports like tcp, and sessions that will be migrated for cl
 211    * transports like udp. If vpp has workers, this will be first worker. */
 212   u32 transport_cl_thread;
 213
 214   transport_proto_t last_transport_proto_type;
 215
 216   /** Number of workers at pool realloc barrier */
 217   volatile u32 pool_realloc_at_barrier;
 218
 219   /** Number of workers doing reallocs */
 220   volatile u32 pool_realloc_doing_work;
 221
 222   /** Lock to synchronize parallel forced reallocs */
 223   clib_spinlock_t pool_realloc_lock;
 224
 225   /*
 226    * Config parameters
 227    */
 228
 229   /** Session manager is enabled */
 230   u8 is_enabled;
 231
 232   /** Session manager initialized (not necessarily enabled) */
 233   u8 is_initialized;
 234
 235   /** Enable session manager at startup */
 236   u8 session_enable_asap;
 237
 238   /** Poll session node in main thread */
 239   u8 poll_main;
 240
 241   /** Allocate private rx mqs for external apps */
 242   u8 use_private_rx_mqs;
 243
 244   /** Do not enable session queue node adaptive mode */
 245   u8 no_adaptive;
 246
 247   /** vpp fifo event queue configured length */
 248   u32 configured_wrk_mq_length;
 249
 250   /** Session ssvm segment configs*/
 251   uword wrk_mqs_segment_size;
 252
 253   /** Session enable dma*/
 254   u8 dma_enabled;
 255
 256   /** Session table size parameters */
 257   u32 configured_v4_session_table_buckets;
 258   u32 configured_v4_session_table_memory;
 259   u32 configured_v4_halfopen_table_buckets;
 260   u32 configured_v4_halfopen_table_memory;
 261   u32 configured_v6_session_table_buckets;
 262   u32 configured_v6_session_table_memory;
 263   u32 configured_v6_halfopen_table_buckets;
 264   u32 configured_v6_halfopen_table_memory;
 265
 266   /** Transport table (preallocation) size parameters */
 267   u32 local_endpoints_table_memory;
 268   u32 local_endpoints_table_buckets;
 269
 270   /** Preallocate session config parameter */
 271   u32 preallocated_sessions;
 272
 273   u16 msg_id_base;
 274
 275   /** Query nat44-ed session to get original dst ip4 & dst port. */
 276   nat44_original_dst_lookup_fn original_dst_lookup;
 277 } session_main_t;
 278
 279 extern session_main_t session_main;
 280 extern vlib_node_registration_t session_queue_node;
 281 extern vlib_node_registration_t session_input_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_CTRL_EVT_RPC);
 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_cleanup (session_t *s);
 366 void session_program_cleanup (session_t *s);
 367 void session_cleanup_half_open (session_handle_t ho_handle);
 368 u8 session_is_valid (u32 si, u8 thread_index);
 369
 370 always_inline session_t *
 371 session_get (u32 si, u32 thread_index)
 372 {
 373   ASSERT (session_is_valid (si, thread_index));
 374   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 375 }
 376
 377 always_inline session_t *
 378 session_get_if_valid (u64 si, u32 thread_index)
 379 {
 380   if (thread_index >= vec_len (session_main.wrk))
 381     return 0;
 382
 383   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
 384     return 0;
 385
 386   ASSERT (session_is_valid (si, thread_index));
 387   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 388 }
 389
 390 always_inline session_t *
 391 session_get_from_handle (session_handle_t handle)
 392 {
 393   session_main_t *smm = &session_main;
 394   u32 session_index, thread_index;
 395   session_parse_handle (handle, &session_index, &thread_index);
 396   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 397 }
 398
 399 always_inline session_t *
 400 session_get_from_handle_if_valid (session_handle_t handle)
 401 {
 402   u32 session_index, thread_index;
 403   session_parse_handle (handle, &session_index, &thread_index);
 404   return session_get_if_valid (session_index, thread_index);
 405 }
 406
 407 u64 session_segment_handle (session_t * s);
 408
 409 /**
 410  * Get session from handle and avoid pool validation if no same thread
 411  *
 412  * Peekers are fine because pool grows with barrier (see @ref session_alloc)
 413  */
 414 always_inline session_t *
 415 session_get_from_handle_safe (u64 handle)
 416 {
 417   u32 thread_index = session_thread_from_handle (handle);
 418   session_worker_t *wrk = &session_main.wrk[thread_index];
 419
 420   if (thread_index == vlib_get_thread_index ())
 421     {
 422       return pool_elt_at_index (wrk->sessions,
 423                                 session_index_from_handle (handle));
 424     }
 425   else
 426     {
 427       /* Don't use pool_elt_at index to avoid pool bitmap reallocs */
 428       return wrk->sessions + session_index_from_handle (handle);
 429     }
 430 }
 431
 432 always_inline session_t *
 433 session_clone_safe (u32 session_index, u32 thread_index)
 434 {
 435   u32 current_thread_index = vlib_get_thread_index (), new_index;
 436   session_t *old_s, *new_s;
 437
 438   new_s = session_alloc (current_thread_index);
 439   new_index = new_s->session_index;
 440   /* Session pools are reallocated with barrier (see @ref session_alloc) */
 441   old_s = session_main.wrk[thread_index].sessions + session_index;
 442   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 443   new_s->thread_index = current_thread_index;
 444   new_s->session_index = new_index;
 445   return new_s;
 446 }
 447
 448 int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
 449 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 450 int session_stop_listen (session_t * s);
 451 void session_half_close (session_t *s);
 452 void session_close (session_t * s);
 453 void session_reset (session_t * s);
 454 void session_transport_half_close (session_t *s);
 455 void session_transport_close (session_t * s);
 456 void session_transport_reset (session_t * s);
 457 void session_transport_cleanup (session_t * s);
 458 int session_send_io_evt_to_thread (svm_fifo_t * f,
 459                                    session_evt_type_t evt_type);
 460 int session_enqueue_notify (session_t *s);
 461 int session_dequeue_notify (session_t * s);
 462 int session_enqueue_notify_cl (session_t *s);
 463 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 464                                           session_evt_type_t evt_type);
 465 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 466                                      void *rpc_args);
 467 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
 468                                            void *rpc_args);
 469 void session_add_self_custom_tx_evt (transport_connection_t * tc,
 470                                      u8 has_prio);
 471 void sesssion_reschedule_tx (transport_connection_t * tc);
 472 transport_connection_t *session_get_transport (session_t * s);
 473 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
 474                            u8 is_lcl);
 475 int session_transport_attribute (session_t *s, u8 is_get,
 476                                  transport_endpt_attr_t *attr);
 477
 478 u8 *format_session (u8 * s, va_list * args);
 479 uword unformat_session (unformat_input_t * input, va_list * args);
 480 uword unformat_transport_connection (unformat_input_t * input,
 481                                      va_list * args);
 482
 483 /*
 484  * Interface to transport protos
 485  */
 486
 487 int session_enqueue_stream_connection (transport_connection_t * tc,
 488                                        vlib_buffer_t * b, u32 offset,
 489                                        u8 queue_event, u8 is_in_order);
 490 int session_enqueue_dgram_connection (session_t * s,
 491                                       session_dgram_hdr_t * hdr,
 492                                       vlib_buffer_t * b, u8 proto,
 493                                       u8 queue_event);
 494 int session_enqueue_dgram_connection_cl (session_t *s,
 495                                          session_dgram_hdr_t *hdr,
 496                                          vlib_buffer_t *b, u8 proto,
 497                                          u8 queue_event);
 498 int session_stream_connect_notify (transport_connection_t * tc,
 499                                    session_error_t err);
 500 int session_dgram_connect_notify (transport_connection_t * tc,
 501                                   u32 old_thread_index,
 502                                   session_t ** new_session);
 503 int session_stream_accept_notify (transport_connection_t * tc);
 504 void session_transport_closing_notify (transport_connection_t * tc);
 505 void session_transport_delete_notify (transport_connection_t * tc);
 506 void session_half_open_delete_notify (transport_connection_t *tc);
 507 void session_half_open_migrate_notify (transport_connection_t *tc);
 508 int session_half_open_migrated_notify (transport_connection_t *tc);
 509 void session_transport_closed_notify (transport_connection_t * tc);
 510 void session_transport_reset_notify (transport_connection_t * tc);
 511 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 512                            u32 thread_index, u8 notify);
 513 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
 514                           u32 thread_index);
 515
 516 /**
 517  * Initialize session layer for given transport proto and ip version
 518  *
 519  * Allocates per session type (transport proto + ip version) data structures
 520  * and adds arc from session queue node to session type output node.
 521  *
 522  * @param transport_proto       transport proto to be registered
 523  * @param vft                   virtual function table for transport
 524  * @param is_ip4                flag that indicates if transports uses ipv4
 525  *                              as underlying network layer
 526  * @param output_node           output node for transport
 527  */
 528 void session_register_transport (transport_proto_t transport_proto,
 529                                  const transport_proto_vft_t * vft, u8 is_ip4,
 530                                  u32 output_node);
 531 transport_proto_t session_add_transport_proto (void);
 532 void session_register_update_time_fn (session_update_time_fn fn, u8 is_add);
 533 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 534                                 u32 offset, u32 max_bytes);
 535 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 536
 537 always_inline void
 538 session_set_state (session_t *s, session_state_t session_state)
 539 {
 540   s->session_state = session_state;
 541   SESSION_EVT (SESSION_EVT_STATE_CHANGE, s);
 542 }
 543
 544 always_inline u32
 545 transport_max_rx_enqueue (transport_connection_t * tc)
 546 {
 547   session_t *s = session_get (tc->s_index, tc->thread_index);
 548   return svm_fifo_max_enqueue_prod (s->rx_fifo);
 549 }
 550
 551 always_inline u32
 552 transport_max_tx_dequeue (transport_connection_t * tc)
 553 {
 554   session_t *s = session_get (tc->s_index, tc->thread_index);
 555   return svm_fifo_max_dequeue_cons (s->tx_fifo);
 556 }
 557
 558 always_inline u32
 559 transport_max_rx_dequeue (transport_connection_t * tc)
 560 {
 561   session_t *s = session_get (tc->s_index, tc->thread_index);
 562   return svm_fifo_max_dequeue (s->rx_fifo);
 563 }
 564
 565 always_inline u32
 566 transport_rx_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->rx_fifo);
 570 }
 571
 572 always_inline u32
 573 transport_tx_fifo_size (transport_connection_t * tc)
 574 {
 575   session_t *s = session_get (tc->s_index, tc->thread_index);
 576   return svm_fifo_size (s->tx_fifo);
 577 }
 578
 579 always_inline u8
 580 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 581 {
 582   session_t *s = session_get (tc->c_index, tc->thread_index);
 583   return svm_fifo_has_ooo_data (s->rx_fifo);
 584 }
 585
 586 always_inline u32
 587 transport_tx_fifo_has_dgram (transport_connection_t *tc)
 588 {
 589   session_t *s = session_get (tc->s_index, tc->thread_index);
 590   u32 max_deq = svm_fifo_max_dequeue_cons (s->tx_fifo);
 591   session_dgram_pre_hdr_t phdr;
 592
 593   if (max_deq <= sizeof (session_dgram_hdr_t))
 594     return 0;
 595   svm_fifo_peek (s->tx_fifo, 0, sizeof (phdr), (u8 *) &phdr);
 596   return max_deq >= phdr.data_length + sizeof (session_dgram_hdr_t);
 597 }
 598
 599 always_inline void
 600 transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
 601 {
 602   session_t *s = session_get (tc->s_index, tc->thread_index);
 603   svm_fifo_add_want_deq_ntf (s->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 604 }
 605
 606 always_inline clib_time_type_t
 607 transport_time_now (u32 thread_index)
 608 {
 609   return session_main.wrk[thread_index].last_vlib_time;
 610 }
 611
 612 always_inline clib_us_time_t
 613 transport_us_time_now (u32 thread_index)
 614 {
 615   return session_main.wrk[thread_index].last_vlib_us_time;
 616 }
 617
 618 always_inline clib_time_type_t
 619 transport_seconds_per_loop (u32 thread_index)
 620 {
 621   return session_main.wrk[thread_index].vm->seconds_per_loop;
 622 }
 623
 624 always_inline void
 625 transport_add_tx_event (transport_connection_t * tc)
 626 {
 627   session_t *s = session_get (tc->s_index, tc->thread_index);
 628   if (svm_fifo_has_event (s->tx_fifo))
 629     return;
 630   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 631 }
 632
 633 always_inline u32
 634 transport_cl_thread (void)
 635 {
 636   return session_main.transport_cl_thread;
 637 }
 638
 639 always_inline u32
 640 session_vlib_thread_is_cl_thread (void)
 641 {
 642   return (vlib_get_thread_index () == transport_cl_thread () ||
 643           vlib_thread_is_main_w_barrier ());
 644 }
 645
 646 /*
 647  * Listen sessions
 648  */
 649
 650 always_inline u64
 651 listen_session_get_handle (session_t * s)
 652 {
 653   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
 654           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
 655   return session_handle (s);
 656 }
 657
 658 always_inline session_t *
 659 listen_session_get_from_handle (session_handle_t handle)
 660 {
 661   return session_get_from_handle (handle);
 662 }
 663
 664 always_inline void
 665 listen_session_parse_handle (session_handle_t handle, u32 * index,
 666                              u32 * thread_index)
 667 {
 668   session_parse_handle (handle, index, thread_index);
 669 }
 670
 671 always_inline session_t *
 672 listen_session_alloc (u8 thread_index, session_type_t type)
 673 {
 674   session_t *s;
 675   s = session_alloc (thread_index);
 676   s->session_type = type;
 677   s->session_state = SESSION_STATE_LISTENING;
 678   return s;
 679 }
 680
 681 always_inline session_t *
 682 listen_session_get (u32 ls_index)
 683 {
 684   return session_get (ls_index, 0);
 685 }
 686
 687 always_inline void
 688 listen_session_free (session_t * s)
 689 {
 690   ASSERT (!s->rx_fifo);
 691   session_free (s);
 692 }
 693
 694 always_inline session_t *
 695 ho_session_alloc (void)
 696 {
 697   session_t *s;
 698   ASSERT (session_vlib_thread_is_cl_thread ());
 699   s = session_alloc (transport_cl_thread ());
 700   s->session_state = SESSION_STATE_CONNECTING;
 701   s->flags |= SESSION_F_HALF_OPEN;
 702   return s;
 703 }
 704
 705 always_inline session_t *
 706 ho_session_get (u32 ho_index)
 707 {
 708   return session_get (ho_index, transport_cl_thread ());
 709 }
 710
 711 always_inline void
 712 ho_session_free (session_t *s)
 713 {
 714   ASSERT (!s->rx_fifo && s->thread_index == 0);
 715   session_free (s);
 716 }
 717
 718 transport_connection_t *listen_session_get_transport (session_t * s);
 719
 720 /*
 721  * Session layer functions
 722  */
 723
 724 always_inline session_main_t *
 725 vnet_get_session_main ()
 726 {
 727   return &session_main;
 728 }
 729
 730 always_inline session_worker_t *
 731 session_main_get_worker (u32 thread_index)
 732 {
 733   return vec_elt_at_index (session_main.wrk, thread_index);
 734 }
 735
 736 static inline session_worker_t *
 737 session_main_get_worker_if_valid (u32 thread_index)
 738 {
 739   if (thread_index > vec_len (session_main.wrk))
 740     return 0;
 741   return session_main_get_worker (thread_index);
 742 }
 743
 744 always_inline svm_msg_q_t *
 745 session_main_get_vpp_event_queue (u32 thread_index)
 746 {
 747   return session_main_get_worker (thread_index)->vpp_event_queue;
 748 }
 749
 750 always_inline u8
 751 session_main_is_enabled ()
 752 {
 753   return session_main.is_enabled == 1;
 754 }
 755
 756 always_inline void
 757 session_worker_stat_error_inc (session_worker_t *wrk, int error, int value)
 758 {
 759   if ((-(error) >= 0 && -(error) < SESSION_N_ERRORS))
 760     wrk->stats.errors[-error] += value;
 761   else
 762     SESSION_DBG ("unknown session counter");
 763 }
 764
 765 always_inline void
 766 session_stat_error_inc (int error, int value)
 767 {
 768   session_worker_t *wrk;
 769   wrk = session_main_get_worker (vlib_get_thread_index ());
 770   session_worker_stat_error_inc (wrk, error, value);
 771 }
 772
 773 #define session_cli_return_if_not_enabled()                             \
 774 do {                                                                    \
 775     if (!session_main.is_enabled)                                       \
 776       return clib_error_return (0, "session layer is not enabled");     \
 777 } while (0)
 778
 779 void session_main_flush_enqueue_events (transport_proto_t transport_proto,
 780                                         u32 thread_index);
 781 void session_queue_run_on_main_thread (vlib_main_t * vm);
 782
 783 /**
 784  * Add session node pending buffer with custom node
 785  *
 786  * @param thread_index  worker thread expected to send the buffer
 787  * @param bi            buffer index
 788  * @param next_node     next node edge index for buffer. Edge to next node
 789  *                      must exist
 790  */
 791 always_inline void
 792 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
 793 {
 794   session_worker_t *wrk = session_main_get_worker (thread_index);
 795   vec_add1 (wrk->pending_tx_buffers, bi);
 796   vec_add1 (wrk->pending_tx_nexts, next_node);
 797   if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
 798     vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
 799 }
 800
 801 always_inline void
 802 session_wrk_update_time (session_worker_t *wrk, f64 now)
 803 {
 804   wrk->last_vlib_time = now;
 805   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
 806 }
 807
 808 void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
 809 fifo_segment_t *session_main_get_wrk_mqs_segment (void);
 810 void session_node_enable_disable (u8 is_en);
 811 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 812 void session_wrk_handle_evts_main_rpc (void *);
 813 void session_wrk_program_app_wrk_evts (session_worker_t *wrk,
 814                                        u32 app_wrk_index);
 815
 816 session_t *session_alloc_for_connection (transport_connection_t * tc);
 817 session_t *session_alloc_for_half_open (transport_connection_t *tc);
 818 void session_get_original_dst (transport_endpoint_t *i2o_src,
 819                                transport_endpoint_t *i2o_dst,
 820                                transport_proto_t transport_proto,
 821                                u32 *original_dst, u16 *original_dst_port);
 822
 823 typedef void (pool_safe_realloc_rpc_fn) (void *rpc_args);
 824
 825 typedef struct
 826 {
 827   u8 ph[STRUCT_OFFSET_OF (pool_header_t, max_elts) + 4];
 828   u32 flag;
 829 } pool_safe_realloc_header_t;
 830
 831 STATIC_ASSERT_SIZEOF (pool_safe_realloc_header_t, sizeof (pool_header_t));
 832
 833 #define POOL_REALLOC_SAFE_ELT_THRESH 32
 834
 835 #define pool_realloc_flag(PH)                                                 \
 836   ((pool_safe_realloc_header_t *) pool_header (PH))->flag
 837
 838 typedef struct pool_realloc_rpc_args_
 839 {
 840   void **pool;
 841   uword elt_size;
 842   uword align;
 843 } pool_realloc_rpc_args_t;
 844
 845 always_inline void
 846 pool_program_safe_realloc_rpc (void *args)
 847 {
 848   vlib_main_t *vm = vlib_get_main ();
 849   u32 free_elts, max_elts, n_alloc;
 850   pool_realloc_rpc_args_t *pra;
 851
 852   ASSERT (vlib_get_thread_index () == 0);
 853   pra = (pool_realloc_rpc_args_t *) args;
 854
 855   vlib_worker_thread_barrier_sync (vm);
 856
 857   free_elts = _pool_free_elts (*pra->pool, pra->elt_size);
 858   if (free_elts < POOL_REALLOC_SAFE_ELT_THRESH)
 859     {
 860       max_elts = _vec_max_len (*pra->pool, pra->elt_size);
 861       n_alloc = clib_max (2 * max_elts, POOL_REALLOC_SAFE_ELT_THRESH);
 862       _pool_alloc (pra->pool, n_alloc, pra->align, 0, pra->elt_size);
 863     }
 864   pool_realloc_flag (*pra->pool) = 0;
 865   clib_mem_free (args);
 866
 867   vlib_worker_thread_barrier_release (vm);
 868 }
 869
 870 always_inline void
 871 pool_program_safe_realloc (void **p, u32 elt_size, u32 align)
 872 {
 873   pool_realloc_rpc_args_t *pra;
 874
 875   /* Reuse pad as a realloc flag */
 876   if (pool_realloc_flag (*p))
 877     return;
 878
 879   pra = clib_mem_alloc (sizeof (*pra));
 880   pra->pool = p;
 881   pra->elt_size = elt_size;
 882   pra->align = align;
 883   pool_realloc_flag (*p) = 1;
 884
 885   session_send_rpc_evt_to_thread (0 /* thread index */,
 886                                   pool_program_safe_realloc_rpc, pra);
 887 }
 888
 889 #define pool_needs_realloc(P)                                                 \
 890   ((!P) ||                                                                    \
 891    (vec_len (pool_header (P)->free_indices) < POOL_REALLOC_SAFE_ELT_THRESH && \
 892     pool_free_elts (P) < POOL_REALLOC_SAFE_ELT_THRESH))
 893
 894 #define pool_get_aligned_safe(P, E, align)                                    \
 895   do                                                                          \
 896     {                                                                         \
 897       if (PREDICT_FALSE (pool_needs_realloc (P)))                             \
 898         {                                                                     \
 899           if (PREDICT_FALSE (!(P)))                                           \
 900             {                                                                 \
 901               pool_alloc_aligned (P, POOL_REALLOC_SAFE_ELT_THRESH, align);    \
 902             }                                                                 \
 903           else if (PREDICT_FALSE (!pool_free_elts (P)))                       \
 904             {                                                                 \
 905               vlib_workers_sync ();                                           \
 906               pool_alloc_aligned (P, pool_max_len (P), align);                \
 907               vlib_workers_continue ();                                       \
 908               ALWAYS_ASSERT (pool_free_elts (P) > 0);                         \
 909             }                                                                 \
 910           else                                                                \
 911             {                                                                 \
 912               pool_program_safe_realloc ((void **) &(P), sizeof ((P)[0]),     \
 913                                          _vec_align (P, align));              \
 914             }                                                                 \
 915         }                                                                     \
 916       pool_get_aligned (P, E, align);                                         \
 917     }                                                                         \
 918   while (0)
 919
 920 #endif /* __included_session_h__ */
 921
 922 /*
 923  * fd.io coding-style-patch-verification: ON
 924  *
 925  * Local Variables:
 926  * eval: (c-set-style "gnu")
 927  * End:
 928  */