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