src/vnet/session/session.h

   1 /*
   2  * Copyright (c) 2017-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __included_session_h__
  16 #define __included_session_h__
  17
  18 #include <vppinfra/llist.h>
  19 #include <vnet/session/session_types.h>
  20 #include <vnet/session/session_lookup.h>
  21 #include <vnet/session/session_debug.h>
  22 #include <svm/message_queue.h>
  23 #include <svm/fifo_segment.h>
  24
  25 #define foreach_session_input_error                                     \
  26 _(NO_SESSION, "No session drops")                                       \
  27 _(NO_LISTENER, "No listener for dst port drops")                        \
  28 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  29 _(NOT_READY, "Session not ready packets")                               \
  30 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  31 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  32 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  33
  34 typedef enum
  35 {
  36 #define _(sym,str) SESSION_ERROR_##sym,
  37   foreach_session_input_error
  38 #undef _
  39     SESSION_N_ERROR,
  40 } session_input_error_t;
  41
  42 typedef struct session_tx_context_
  43 {
  44   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  45   session_t *s;
  46   transport_proto_vft_t *transport_vft;
  47   transport_connection_t *tc;
  48   transport_send_params_t sp;
  49   u32 max_dequeue;
  50   u32 left_to_snd;
  51   u32 max_len_to_snd;
  52   u16 deq_per_first_buf;
  53   u16 deq_per_buf;
  54   u16 n_segs_per_evt;
  55   u16 n_bufs_needed;
  56   u8 n_bufs_per_seg;
  57     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  58   session_dgram_hdr_t hdr;
  59
  60   /** Vector of tx buffer free lists */
  61   u32 *tx_buffers;
  62   vlib_buffer_t **transport_pending_bufs;
  63 } session_tx_context_t;
  64
  65 typedef struct session_evt_elt
  66 {
  67   clib_llist_anchor_t evt_list;
  68   session_event_t evt;
  69 } session_evt_elt_t;
  70
  71 typedef struct session_ctrl_evt_data_
  72 {
  73   u8 data[SESSION_CTRL_MSG_MAX_SIZE];
  74 } session_evt_ctrl_data_t;
  75
  76 typedef enum session_wrk_state_
  77 {
  78   SESSION_WRK_POLLING,
  79   SESSION_WRK_INTERRUPT,
  80   SESSION_WRK_IDLE,
  81 } __clib_packed session_wrk_state_t;
  82
  83 typedef enum session_wrk_flags_
  84 {
  85   SESSION_WRK_F_ADAPTIVE = 1 << 0,
  86 } __clib_packed session_wrk_flag_t;
  87
  88 typedef struct session_worker_
  89 {
  90   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  91
  92   /** Worker session pool */
  93   session_t *sessions;
  94
  95   /** vpp event message queue for worker */
  96   svm_msg_q_t *vpp_event_queue;
  97
  98   /** vlib_time_now last time around the track */
  99   clib_time_type_t last_vlib_time;
 100
 101   /** vlib_time_now rounded to us precision and as u64 */
 102   clib_us_time_t last_vlib_us_time;
 103
 104   /** Convenience pointer to this worker's vlib_main */
 105   vlib_main_t *vm;
 106
 107   /** Per-proto vector of sessions to enqueue */
 108   u32 **session_to_enqueue;
 109
 110   /** Timerfd used to periodically signal wrk session queue node */
 111   int timerfd;
 112
 113   /** Worker flags */
 114   session_wrk_flag_t flags;
 115
 116   /** Worker state */
 117   session_wrk_state_t state;
 118
 119   /** Context for session tx */
 120   session_tx_context_t ctx;
 121
 122   /** Pool of session event list elements */
 123   session_evt_elt_t *event_elts;
 124
 125   /** Pool of ctrl events data buffers */
 126   session_evt_ctrl_data_t *ctrl_evts_data;
 127
 128   /** Head of control events list */
 129   clib_llist_index_t ctrl_head;
 130
 131   /** Head of list of elements */
 132   clib_llist_index_t new_head;
 133
 134   /** Head of list of pending events */
 135   clib_llist_index_t old_head;
 136
 137   /** Peekers rw lock */
 138   clib_rwlock_t peekers_rw_locks;
 139
 140   /** Vector of buffers to be sent */
 141   u32 *pending_tx_buffers;
 142
 143   /** Vector of nexts for the pending tx buffers */
 144   u16 *pending_tx_nexts;
 145
 146   /** Clib file for timerfd. Used only if adaptive mode is on */
 147   uword timerfd_file;
 148
 149   /** List of pending connects for first worker */
 150   clib_llist_index_t pending_connects;
 151
 152   /** Flag that is set if main thread signaled to handle connects */
 153   u32 n_pending_connects;
 154
 155   /** Main thread loops in poll mode without a connect */
 156   u32 no_connect_loops;
 157
 158 #if SESSION_DEBUG
 159   /** last event poll time by thread */
 160   clib_time_type_t last_event_poll;
 161 #endif
 162 } session_worker_t;
 163
 164 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
 165                                   vlib_node_runtime_t * node,
 166                                   session_evt_elt_t * e, int *n_tx_packets);
 167
 168 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 169 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 170 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 171
 172 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
 173
 174 typedef void (*session_update_time_fn) (f64 time_now, u8 thread_index);
 175
 176 typedef struct session_main_
 177 {
 178   /** Worker contexts */
 179   session_worker_t *wrk;
 180
 181   /** Vector of transport update time functions */
 182   session_update_time_fn *update_time_fns;
 183
 184   /** Event queues memfd segment */
 185   fifo_segment_t wrk_mqs_segment;
 186
 187   /** Unique segment name counter */
 188   u32 unique_segment_name_counter;
 189
 190   /** Per transport rx function that can either dequeue or peek */
 191   session_fifo_rx_fn **session_tx_fns;
 192
 193   /** Per session type output nodes. Could optimize to group nodes by
 194    * fib but lookup would then require session type parsing in session node.
 195    * Trade memory for speed, for now */
 196   u32 *session_type_to_next;
 197
 198   /** Thread for cl and ho that rely on cl allocs */
 199   u32 transport_cl_thread;
 200
 201   transport_proto_t last_transport_proto_type;
 202
 203   /*
 204    * Config parameters
 205    */
 206
 207   /** Session manager is enabled */
 208   u8 is_enabled;
 209
 210   /** Session manager initialized (not necessarily enabled) */
 211   u8 is_initialized;
 212
 213   /** Enable session manager at startup */
 214   u8 session_enable_asap;
 215
 216   /** Poll session node in main thread */
 217   u8 poll_main;
 218
 219   /** Allocate private rx mqs for external apps */
 220   u8 use_private_rx_mqs;
 221
 222   /** Do not enable session queue node adaptive mode */
 223   u8 no_adaptive;
 224
 225   /** vpp fifo event queue configured length */
 226   u32 configured_wrk_mq_length;
 227
 228   /** Session ssvm segment configs*/
 229   uword wrk_mqs_segment_size;
 230
 231   /** Session table size parameters */
 232   u32 configured_v4_session_table_buckets;
 233   u32 configured_v4_session_table_memory;
 234   u32 configured_v4_halfopen_table_buckets;
 235   u32 configured_v4_halfopen_table_memory;
 236   u32 configured_v6_session_table_buckets;
 237   u32 configured_v6_session_table_memory;
 238   u32 configured_v6_halfopen_table_buckets;
 239   u32 configured_v6_halfopen_table_memory;
 240
 241   /** Transport table (preallocation) size parameters */
 242   u32 local_endpoints_table_memory;
 243   u32 local_endpoints_table_buckets;
 244
 245   /** Preallocate session config parameter */
 246   u32 preallocated_sessions;
 247
 248   u16 msg_id_base;
 249 } session_main_t;
 250
 251 extern session_main_t session_main;
 252 extern vlib_node_registration_t session_queue_node;
 253 extern vlib_node_registration_t session_queue_process_node;
 254 extern vlib_node_registration_t session_queue_pre_input_node;
 255
 256 typedef enum session_q_process_evt_
 257 {
 258   SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
 259   SESSION_Q_PROCESS_STOP
 260 } session_q_process_evt_t;
 261
 262 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
 263 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
 264
 265 static inline void
 266 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
 267 {
 268   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 269                        clib_llist_elt (wrk->event_elts, wrk->old_head));
 270 }
 271
 272 static inline void
 273 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
 274 {
 275   clib_llist_add (wrk->event_elts, evt_list, elt,
 276                   clib_llist_elt (wrk->event_elts, wrk->old_head));
 277 }
 278
 279
 280 static inline u32
 281 session_evt_ctrl_data_alloc (session_worker_t * wrk)
 282 {
 283   session_evt_ctrl_data_t *data;
 284   pool_get (wrk->ctrl_evts_data, data);
 285   return (data - wrk->ctrl_evts_data);
 286 }
 287
 288 static inline session_evt_elt_t *
 289 session_evt_alloc_ctrl (session_worker_t * wrk)
 290 {
 291   session_evt_elt_t *elt;
 292   clib_llist_get (wrk->event_elts, elt);
 293   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 294                        clib_llist_elt (wrk->event_elts, wrk->ctrl_head));
 295   return elt;
 296 }
 297
 298 static inline void *
 299 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
 300 {
 301   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
 302                                       elt->evt.ctrl_data_index));
 303 }
 304
 305 static inline void
 306 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
 307 {
 308   ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
 309   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
 310 }
 311
 312 static inline session_evt_elt_t *
 313 session_evt_alloc_new (session_worker_t * wrk)
 314 {
 315   session_evt_elt_t *elt;
 316   clib_llist_get (wrk->event_elts, elt);
 317   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 318                        clib_llist_elt (wrk->event_elts, wrk->new_head));
 319   return elt;
 320 }
 321
 322 static inline session_evt_elt_t *
 323 session_evt_alloc_old (session_worker_t * wrk)
 324 {
 325   session_evt_elt_t *elt;
 326   clib_llist_get (wrk->event_elts, elt);
 327   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 328                        clib_llist_elt (wrk->event_elts, wrk->old_head));
 329   return elt;
 330 }
 331
 332 int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
 333
 334 session_t *session_alloc (u32 thread_index);
 335 void session_free (session_t * s);
 336 void session_free_w_fifos (session_t * s);
 337 void session_cleanup_half_open (session_handle_t ho_handle);
 338 u8 session_is_valid (u32 si, u8 thread_index);
 339
 340 always_inline session_t *
 341 session_get (u32 si, u32 thread_index)
 342 {
 343   ASSERT (session_is_valid (si, thread_index));
 344   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 345 }
 346
 347 always_inline session_t *
 348 session_get_if_valid (u64 si, u32 thread_index)
 349 {
 350   if (thread_index >= vec_len (session_main.wrk))
 351     return 0;
 352
 353   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
 354     return 0;
 355
 356   ASSERT (session_is_valid (si, thread_index));
 357   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 358 }
 359
 360 always_inline session_t *
 361 session_get_from_handle (session_handle_t handle)
 362 {
 363   session_main_t *smm = &session_main;
 364   u32 session_index, thread_index;
 365   session_parse_handle (handle, &session_index, &thread_index);
 366   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 367 }
 368
 369 always_inline session_t *
 370 session_get_from_handle_if_valid (session_handle_t handle)
 371 {
 372   u32 session_index, thread_index;
 373   session_parse_handle (handle, &session_index, &thread_index);
 374   return session_get_if_valid (session_index, thread_index);
 375 }
 376
 377 u64 session_segment_handle (session_t * s);
 378
 379 /**
 380  * Acquires a lock that blocks a session pool from expanding.
 381  *
 382  * This is typically used for safely peeking into other threads'
 383  * pools in order to clone elements. Lock should be dropped as soon
 384  * as possible by calling @ref session_pool_remove_peeker.
 385  *
 386  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 387  * it may lead to free elt bitmap expansion/contraction!
 388  */
 389 always_inline void
 390 session_pool_add_peeker (u32 thread_index)
 391 {
 392   session_worker_t *wrk = &session_main.wrk[thread_index];
 393   if (thread_index == vlib_get_thread_index ())
 394     return;
 395   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
 396 }
 397
 398 always_inline void
 399 session_pool_remove_peeker (u32 thread_index)
 400 {
 401   session_worker_t *wrk = &session_main.wrk[thread_index];
 402   if (thread_index == vlib_get_thread_index ())
 403     return;
 404   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
 405 }
 406
 407 /**
 408  * Get session from handle and 'lock' pool resize if not in same thread
 409  *
 410  * Caller should drop the peek 'lock' as soon as possible.
 411  */
 412 always_inline session_t *
 413 session_get_from_handle_safe (u64 handle)
 414 {
 415   u32 thread_index = session_thread_from_handle (handle);
 416   session_worker_t *wrk = &session_main.wrk[thread_index];
 417
 418   if (thread_index == vlib_get_thread_index ())
 419     {
 420       return pool_elt_at_index (wrk->sessions,
 421                                 session_index_from_handle (handle));
 422     }
 423   else
 424     {
 425       session_pool_add_peeker (thread_index);
 426       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 427       return wrk->sessions + session_index_from_handle (handle);
 428     }
 429 }
 430
 431 always_inline u32
 432 session_get_index (session_t * s)
 433 {
 434   return (s - session_main.wrk[s->thread_index].sessions);
 435 }
 436
 437 always_inline session_t *
 438 session_clone_safe (u32 session_index, u32 thread_index)
 439 {
 440   session_t *old_s, *new_s;
 441   u32 current_thread_index = vlib_get_thread_index ();
 442
 443   /* If during the memcpy pool is reallocated AND the memory allocator
 444    * decides to give the old chunk of memory to somebody in a hurry to
 445    * scribble something on it, we have a problem. So add this thread as
 446    * a session pool peeker.
 447    */
 448   session_pool_add_peeker (thread_index);
 449   new_s = session_alloc (current_thread_index);
 450   old_s = session_main.wrk[thread_index].sessions + session_index;
 451   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 452   session_pool_remove_peeker (thread_index);
 453   new_s->thread_index = current_thread_index;
 454   new_s->session_index = session_get_index (new_s);
 455   return new_s;
 456 }
 457
 458 int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
 459 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 460 int session_stop_listen (session_t * s);
 461 void session_half_close (session_t *s);
 462 void session_close (session_t * s);
 463 void session_reset (session_t * s);
 464 void session_transport_half_close (session_t *s);
 465 void session_transport_close (session_t * s);
 466 void session_transport_reset (session_t * s);
 467 void session_transport_cleanup (session_t * s);
 468 int session_send_io_evt_to_thread (svm_fifo_t * f,
 469                                    session_evt_type_t evt_type);
 470 int session_enqueue_notify (session_t * s);
 471 int session_dequeue_notify (session_t * s);
 472 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 473                                           session_evt_type_t evt_type);
 474 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 475                                      void *rpc_args);
 476 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
 477                                            void *rpc_args);
 478 void session_add_self_custom_tx_evt (transport_connection_t * tc,
 479                                      u8 has_prio);
 480 void sesssion_reschedule_tx (transport_connection_t * tc);
 481 transport_connection_t *session_get_transport (session_t * s);
 482 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
 483                            u8 is_lcl);
 484 int session_transport_attribute (session_t *s, u8 is_get,
 485                                  transport_endpt_attr_t *attr);
 486
 487 u8 *format_session (u8 * s, va_list * args);
 488 uword unformat_session (unformat_input_t * input, va_list * args);
 489 uword unformat_transport_connection (unformat_input_t * input,
 490                                      va_list * args);
 491
 492 /*
 493  * Interface to transport protos
 494  */
 495
 496 int session_enqueue_stream_connection (transport_connection_t * tc,
 497                                        vlib_buffer_t * b, u32 offset,
 498                                        u8 queue_event, u8 is_in_order);
 499 int session_enqueue_dgram_connection (session_t * s,
 500                                       session_dgram_hdr_t * hdr,
 501                                       vlib_buffer_t * b, u8 proto,
 502                                       u8 queue_event);
 503 int session_stream_connect_notify (transport_connection_t * tc,
 504                                    session_error_t err);
 505 int session_dgram_connect_notify (transport_connection_t * tc,
 506                                   u32 old_thread_index,
 507                                   session_t ** new_session);
 508 int session_stream_accept_notify (transport_connection_t * tc);
 509 void session_transport_closing_notify (transport_connection_t * tc);
 510 void session_transport_delete_notify (transport_connection_t * tc);
 511 void session_half_open_delete_notify (transport_connection_t *tc);
 512 void session_half_open_migrate_notify (transport_connection_t *tc);
 513 int session_half_open_migrated_notify (transport_connection_t *tc);
 514 void session_transport_closed_notify (transport_connection_t * tc);
 515 void session_transport_reset_notify (transport_connection_t * tc);
 516 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 517                            u32 thread_index, u8 notify);
 518 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
 519                           u32 thread_index);
 520 /**
 521  * Initialize session layer for given transport proto and ip version
 522  *
 523  * Allocates per session type (transport proto + ip version) data structures
 524  * and adds arc from session queue node to session type output node.
 525  *
 526  * @param transport_proto       transport proto to be registered
 527  * @param vft                   virtual function table for transport
 528  * @param is_ip4                flag that indicates if transports uses ipv4
 529  *                              as underlying network layer
 530  * @param output_node           output node for transport
 531  */
 532 void session_register_transport (transport_proto_t transport_proto,
 533                                  const transport_proto_vft_t * vft, u8 is_ip4,
 534                                  u32 output_node);
 535 transport_proto_t session_add_transport_proto (void);
 536 void session_register_update_time_fn (session_update_time_fn fn, u8 is_add);
 537 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 538                                 u32 offset, u32 max_bytes);
 539 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 540
 541 always_inline u32
 542 transport_max_rx_enqueue (transport_connection_t * tc)
 543 {
 544   session_t *s = session_get (tc->s_index, tc->thread_index);
 545   return svm_fifo_max_enqueue_prod (s->rx_fifo);
 546 }
 547
 548 always_inline u32
 549 transport_max_tx_dequeue (transport_connection_t * tc)
 550 {
 551   session_t *s = session_get (tc->s_index, tc->thread_index);
 552   return svm_fifo_max_dequeue_cons (s->tx_fifo);
 553 }
 554
 555 always_inline u32
 556 transport_max_rx_dequeue (transport_connection_t * tc)
 557 {
 558   session_t *s = session_get (tc->s_index, tc->thread_index);
 559   return svm_fifo_max_dequeue (s->rx_fifo);
 560 }
 561
 562 always_inline u32
 563 transport_rx_fifo_size (transport_connection_t * tc)
 564 {
 565   session_t *s = session_get (tc->s_index, tc->thread_index);
 566   return svm_fifo_size (s->rx_fifo);
 567 }
 568
 569 always_inline u32
 570 transport_tx_fifo_size (transport_connection_t * tc)
 571 {
 572   session_t *s = session_get (tc->s_index, tc->thread_index);
 573   return svm_fifo_size (s->tx_fifo);
 574 }
 575
 576 always_inline u8
 577 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 578 {
 579   session_t *s = session_get (tc->c_index, tc->thread_index);
 580   return svm_fifo_has_ooo_data (s->rx_fifo);
 581 }
 582
 583 always_inline void
 584 transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
 585 {
 586   session_t *s = session_get (tc->s_index, tc->thread_index);
 587   svm_fifo_add_want_deq_ntf (s->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 588 }
 589
 590 always_inline clib_time_type_t
 591 transport_time_now (u32 thread_index)
 592 {
 593   return session_main.wrk[thread_index].last_vlib_time;
 594 }
 595
 596 always_inline clib_us_time_t
 597 transport_us_time_now (u32 thread_index)
 598 {
 599   return session_main.wrk[thread_index].last_vlib_us_time;
 600 }
 601
 602 always_inline clib_time_type_t
 603 transport_seconds_per_loop (u32 thread_index)
 604 {
 605   return session_main.wrk[thread_index].vm->seconds_per_loop;
 606 }
 607
 608 always_inline void
 609 transport_add_tx_event (transport_connection_t * tc)
 610 {
 611   session_t *s = session_get (tc->s_index, tc->thread_index);
 612   if (svm_fifo_has_event (s->tx_fifo))
 613     return;
 614   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 615 }
 616
 617 always_inline u32
 618 transport_cl_thread (void)
 619 {
 620   return session_main.transport_cl_thread;
 621 }
 622
 623 /*
 624  * Listen sessions
 625  */
 626
 627 always_inline u64
 628 listen_session_get_handle (session_t * s)
 629 {
 630   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
 631           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
 632   return session_handle (s);
 633 }
 634
 635 always_inline session_t *
 636 listen_session_get_from_handle (session_handle_t handle)
 637 {
 638   return session_get_from_handle (handle);
 639 }
 640
 641 always_inline void
 642 listen_session_parse_handle (session_handle_t handle, u32 * index,
 643                              u32 * thread_index)
 644 {
 645   session_parse_handle (handle, index, thread_index);
 646 }
 647
 648 always_inline session_t *
 649 listen_session_alloc (u8 thread_index, session_type_t type)
 650 {
 651   session_t *s;
 652   s = session_alloc (thread_index);
 653   s->session_type = type;
 654   s->session_state = SESSION_STATE_LISTENING;
 655   return s;
 656 }
 657
 658 always_inline session_t *
 659 listen_session_get (u32 ls_index)
 660 {
 661   return session_get (ls_index, 0);
 662 }
 663
 664 always_inline void
 665 listen_session_free (session_t * s)
 666 {
 667   ASSERT (!s->rx_fifo);
 668   session_free (s);
 669 }
 670
 671 always_inline session_t *
 672 ho_session_alloc (void)
 673 {
 674   session_t *s;
 675   ASSERT (vlib_get_thread_index () == 0);
 676   s = session_alloc (0);
 677   s->session_state = SESSION_STATE_CONNECTING;
 678   s->flags |= SESSION_F_HALF_OPEN;
 679   /* Not ideal. Half-opens are only allocated from main with worker barrier
 680    * but can be cleaned up, i.e., session_half_open_free, from main without
 681    * a barrier. In debug images, the free_bitmap can grow while workers peek
 682    * the sessions pool, e.g., session_half_open_migrate_notify, and as a
 683    * result crash while validating the session. To avoid this, grow the bitmap
 684    * now. */
 685   if (CLIB_DEBUG)
 686     {
 687       session_t *sp = session_main.wrk[0].sessions;
 688       clib_bitmap_validate (pool_header (sp)->free_bitmap, s->session_index);
 689     }
 690   return s;
 691 }
 692
 693 always_inline session_t *
 694 ho_session_get (u32 ho_index)
 695 {
 696   return session_get (ho_index, 0 /* half-open thread */);
 697 }
 698
 699 always_inline void
 700 ho_session_free (session_t *s)
 701 {
 702   ASSERT (!s->rx_fifo && s->thread_index == 0);
 703   session_free (s);
 704 }
 705
 706 transport_connection_t *listen_session_get_transport (session_t * s);
 707
 708 /*
 709  * Session layer functions
 710  */
 711
 712 always_inline session_main_t *
 713 vnet_get_session_main ()
 714 {
 715   return &session_main;
 716 }
 717
 718 always_inline session_worker_t *
 719 session_main_get_worker (u32 thread_index)
 720 {
 721   return &session_main.wrk[thread_index];
 722 }
 723
 724 static inline session_worker_t *
 725 session_main_get_worker_if_valid (u32 thread_index)
 726 {
 727   if (thread_index > vec_len (session_main.wrk))
 728     return 0;
 729   return &session_main.wrk[thread_index];
 730 }
 731
 732 always_inline svm_msg_q_t *
 733 session_main_get_vpp_event_queue (u32 thread_index)
 734 {
 735   return session_main.wrk[thread_index].vpp_event_queue;
 736 }
 737
 738 always_inline u8
 739 session_main_is_enabled ()
 740 {
 741   return session_main.is_enabled == 1;
 742 }
 743
 744 #define session_cli_return_if_not_enabled()                             \
 745 do {                                                                    \
 746     if (!session_main.is_enabled)                                       \
 747       return clib_error_return (0, "session layer is not enabled");     \
 748 } while (0)
 749
 750 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 751 int session_main_flush_all_enqueue_events (u8 transport_proto);
 752 void session_queue_run_on_main_thread (vlib_main_t * vm);
 753
 754 /**
 755  * Add session node pending buffer with custom node
 756  *
 757  * @param thread_index  worker thread expected to send the buffer
 758  * @param bi            buffer index
 759  * @param next_node     next node edge index for buffer. Edge to next node
 760  *                      must exist
 761  */
 762 always_inline void
 763 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
 764 {
 765   session_worker_t *wrk = session_main_get_worker (thread_index);
 766   vec_add1 (wrk->pending_tx_buffers, bi);
 767   vec_add1 (wrk->pending_tx_nexts, next_node);
 768   if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
 769     vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
 770 }
 771
 772 always_inline void
 773 session_wrk_update_time (session_worker_t *wrk, f64 now)
 774 {
 775   wrk->last_vlib_time = now;
 776   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
 777 }
 778
 779 void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
 780 fifo_segment_t *session_main_get_wrk_mqs_segment (void);
 781 void session_node_enable_disable (u8 is_en);
 782 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 783
 784 session_t *session_alloc_for_connection (transport_connection_t * tc);
 785 session_t *session_alloc_for_half_open (transport_connection_t *tc);
 786
 787 #endif /* __included_session_h__ */
 788
 789 /*
 790  * fd.io coding-style-patch-verification: ON
 791  *
 792  * Local Variables:
 793  * eval: (c-set-style "gnu")
 794  * End:
 795  */