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