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