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