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