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