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