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 #include <vlib/dma/dma.h>
  25
  26 #define foreach_session_input_error                                     \
  27 _(NO_SESSION, "No session drops")                                       \
  28 _(NO_LISTENER, "No listener for dst port drops")                        \
  29 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  30 _(NOT_READY, "Session not ready packets")                               \
  31 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  32 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  33 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  34
  35 typedef enum
  36 {
  37 #define _(sym,str) SESSION_ERROR_##sym,
  38   foreach_session_input_error
  39 #undef _
  40     SESSION_N_ERROR,
  41 } session_input_error_t;
  42
  43 typedef struct session_tx_context_
  44 {
  45   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  46   session_t *s;
  47   transport_proto_vft_t *transport_vft;
  48   transport_connection_t *tc;
  49   transport_send_params_t sp;
  50   u32 max_dequeue;
  51   u32 left_to_snd;
  52   u32 max_len_to_snd;
  53   u16 deq_per_first_buf;
  54   u16 deq_per_buf;
  55   u16 n_segs_per_evt;
  56   u16 n_bufs_needed;
  57   u8 n_bufs_per_seg;
  58     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  59   session_dgram_hdr_t hdr;
  60
  61   /** Vector of tx buffer free lists */
  62   u32 *tx_buffers;
  63   vlib_buffer_t **transport_pending_bufs;
  64 } session_tx_context_t;
  65
  66 typedef struct session_evt_elt
  67 {
  68   clib_llist_anchor_t evt_list;
  69   session_event_t evt;
  70 } session_evt_elt_t;
  71
  72 typedef struct session_ctrl_evt_data_
  73 {
  74   u8 data[SESSION_CTRL_MSG_MAX_SIZE];
  75 } session_evt_ctrl_data_t;
  76
  77 typedef enum session_wrk_state_
  78 {
  79   SESSION_WRK_POLLING,
  80   SESSION_WRK_INTERRUPT,
  81   SESSION_WRK_IDLE,
  82 } __clib_packed session_wrk_state_t;
  83
  84 typedef enum session_wrk_flags_
  85 {
  86   SESSION_WRK_F_ADAPTIVE = 1 << 0,
  87 } __clib_packed session_wrk_flag_t;
  88
  89 #define DMA_TRANS_SIZE 1024
  90 typedef struct
  91 {
  92   u32 *pending_tx_buffers;
  93   u16 *pending_tx_nexts;
  94 } session_dma_transfer;
  95
  96 typedef struct session_worker_
  97 {
  98   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  99
 100   /** Worker session pool */
 101   session_t *sessions;
 102
 103   /** vpp event message queue for worker */
 104   svm_msg_q_t *vpp_event_queue;
 105
 106   /** vlib_time_now last time around the track */
 107   clib_time_type_t last_vlib_time;
 108
 109   /** vlib_time_now rounded to us precision and as u64 */
 110   clib_us_time_t last_vlib_us_time;
 111
 112   /** Convenience pointer to this worker's vlib_main */
 113   vlib_main_t *vm;
 114
 115   /** Per-proto vector of sessions to enqueue */
 116   u32 **session_to_enqueue;
 117
 118   /** Timerfd used to periodically signal wrk session queue node */
 119   int timerfd;
 120
 121   /** Worker flags */
 122   session_wrk_flag_t flags;
 123
 124   /** Worker state */
 125   session_wrk_state_t state;
 126
 127   /** Context for session tx */
 128   session_tx_context_t ctx;
 129
 130   /** Pool of session event list elements */
 131   session_evt_elt_t *event_elts;
 132
 133   /** Pool of ctrl events data buffers */
 134   session_evt_ctrl_data_t *ctrl_evts_data;
 135
 136   /** Head of control events list */
 137   clib_llist_index_t ctrl_head;
 138
 139   /** Head of list of elements */
 140   clib_llist_index_t new_head;
 141
 142   /** Head of list of pending events */
 143   clib_llist_index_t old_head;
 144
 145   /** Vector of buffers to be sent */
 146   u32 *pending_tx_buffers;
 147
 148   /** Vector of nexts for the pending tx buffers */
 149   u16 *pending_tx_nexts;
 150
 151   /** Clib file for timerfd. Used only if adaptive mode is on */
 152   uword timerfd_file;
 153
 154   /** List of pending connects for first worker */
 155   clib_llist_index_t pending_connects;
 156
 157   /** Flag that is set if main thread signaled to handle connects */
 158   u32 n_pending_connects;
 159
 160   /** List head for first worker evts pending handling on main */
 161   clib_llist_index_t evts_pending_main;
 162
 163   int config_index;
 164   u8 dma_enabled;
 165   session_dma_transfer *dma_trans;
 166   u16 trans_head;
 167   u16 trans_tail;
 168   u16 trans_size;
 169   u16 batch_num;
 170   vlib_dma_batch_t *batch;
 171
 172 #if SESSION_DEBUG
 173   /** last event poll time by thread */
 174   clib_time_type_t last_event_poll;
 175 #endif
 176 } session_worker_t;
 177
 178 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
 179                                   vlib_node_runtime_t * node,
 180                                   session_evt_elt_t * e, int *n_tx_packets);
 181
 182 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 183 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 184 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 185
 186 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
 187
 188 typedef void (*session_update_time_fn) (f64 time_now, u8 thread_index);
 189
 190 typedef struct session_main_
 191 {
 192   /** Worker contexts */
 193   session_worker_t *wrk;
 194
 195   /** Vector of transport update time functions */
 196   session_update_time_fn *update_time_fns;
 197
 198   /** Event queues memfd segment */
 199   fifo_segment_t wrk_mqs_segment;
 200
 201   /** Unique segment name counter */
 202   u32 unique_segment_name_counter;
 203
 204   /** Per transport rx function that can either dequeue or peek */
 205   session_fifo_rx_fn **session_tx_fns;
 206
 207   /** Per session type output nodes. Could optimize to group nodes by
 208    * fib but lookup would then require session type parsing in session node.
 209    * Trade memory for speed, for now */
 210   u32 *session_type_to_next;
 211
 212   /** Thread used for allocating active open connections, i.e., half-opens
 213    * for transports like tcp, and sessions that will be migrated for cl
 214    * transports like udp. If vpp has workers, this will be first worker. */
 215   u32 transport_cl_thread;
 216
 217   transport_proto_t last_transport_proto_type;
 218
 219   /** Number of workers at pool realloc barrier */
 220   volatile u32 pool_realloc_at_barrier;
 221
 222   /** Number of workers doing reallocs */
 223   volatile u32 pool_realloc_doing_work;
 224
 225   /** Lock to synchronize parallel forced reallocs */
 226   clib_spinlock_t pool_realloc_lock;
 227
 228   /*
 229    * Config parameters
 230    */
 231
 232   /** Session manager is enabled */
 233   u8 is_enabled;
 234
 235   /** Session manager initialized (not necessarily enabled) */
 236   u8 is_initialized;
 237
 238   /** Enable session manager at startup */
 239   u8 session_enable_asap;
 240
 241   /** Poll session node in main thread */
 242   u8 poll_main;
 243
 244   /** Allocate private rx mqs for external apps */
 245   u8 use_private_rx_mqs;
 246
 247   /** Do not enable session queue node adaptive mode */
 248   u8 no_adaptive;
 249
 250   /** vpp fifo event queue configured length */
 251   u32 configured_wrk_mq_length;
 252
 253   /** Session ssvm segment configs*/
 254   uword wrk_mqs_segment_size;
 255
 256   /** Session enable dma*/
 257   u8 dma_enabled;
 258
 259   /** Session table size parameters */
 260   u32 configured_v4_session_table_buckets;
 261   u32 configured_v4_session_table_memory;
 262   u32 configured_v4_halfopen_table_buckets;
 263   u32 configured_v4_halfopen_table_memory;
 264   u32 configured_v6_session_table_buckets;
 265   u32 configured_v6_session_table_memory;
 266   u32 configured_v6_halfopen_table_buckets;
 267   u32 configured_v6_halfopen_table_memory;
 268
 269   /** Transport table (preallocation) size parameters */
 270   u32 local_endpoints_table_memory;
 271   u32 local_endpoints_table_buckets;
 272
 273   /** Preallocate session config parameter */
 274   u32 preallocated_sessions;
 275
 276   u16 msg_id_base;
 277 } session_main_t;
 278
 279 extern session_main_t session_main;
 280 extern vlib_node_registration_t session_queue_node;
 281 extern vlib_node_registration_t session_queue_process_node;
 282 extern vlib_node_registration_t session_queue_pre_input_node;
 283
 284 typedef enum session_q_process_evt_
 285 {
 286   SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
 287   SESSION_Q_PROCESS_STOP
 288 } session_q_process_evt_t;
 289
 290 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
 291 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
 292
 293 static inline void
 294 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
 295 {
 296   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 297                        clib_llist_elt (wrk->event_elts, wrk->old_head));
 298 }
 299
 300 static inline void
 301 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
 302 {
 303   clib_llist_add (wrk->event_elts, evt_list, elt,
 304                   clib_llist_elt (wrk->event_elts, wrk->old_head));
 305 }
 306
 307
 308 static inline u32
 309 session_evt_ctrl_data_alloc (session_worker_t * wrk)
 310 {
 311   session_evt_ctrl_data_t *data;
 312   pool_get (wrk->ctrl_evts_data, data);
 313   return (data - wrk->ctrl_evts_data);
 314 }
 315
 316 static inline session_evt_elt_t *
 317 session_evt_alloc_ctrl (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->ctrl_head));
 323   return elt;
 324 }
 325
 326 static inline void *
 327 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
 328 {
 329   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
 330                                       elt->evt.ctrl_data_index));
 331 }
 332
 333 static inline void
 334 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
 335 {
 336   ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
 337   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
 338 }
 339
 340 static inline session_evt_elt_t *
 341 session_evt_alloc_new (session_worker_t * wrk)
 342 {
 343   session_evt_elt_t *elt;
 344   clib_llist_get (wrk->event_elts, elt);
 345   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 346                        clib_llist_elt (wrk->event_elts, wrk->new_head));
 347   return elt;
 348 }
 349
 350 static inline session_evt_elt_t *
 351 session_evt_alloc_old (session_worker_t * wrk)
 352 {
 353   session_evt_elt_t *elt;
 354   clib_llist_get (wrk->event_elts, elt);
 355   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
 356                        clib_llist_elt (wrk->event_elts, wrk->old_head));
 357   return elt;
 358 }
 359
 360 int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
 361
 362 session_t *session_alloc (u32 thread_index);
 363 void session_free (session_t * s);
 364 void session_free_w_fifos (session_t * s);
 365 void session_cleanup_half_open (session_handle_t ho_handle);
 366 u8 session_is_valid (u32 si, u8 thread_index);
 367
 368 always_inline session_t *
 369 session_get (u32 si, u32 thread_index)
 370 {
 371   ASSERT (session_is_valid (si, thread_index));
 372   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 373 }
 374
 375 always_inline session_t *
 376 session_get_if_valid (u64 si, u32 thread_index)
 377 {
 378   if (thread_index >= vec_len (session_main.wrk))
 379     return 0;
 380
 381   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
 382     return 0;
 383
 384   ASSERT (session_is_valid (si, thread_index));
 385   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
 386 }
 387
 388 always_inline session_t *
 389 session_get_from_handle (session_handle_t handle)
 390 {
 391   session_main_t *smm = &session_main;
 392   u32 session_index, thread_index;
 393   session_parse_handle (handle, &session_index, &thread_index);
 394   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 395 }
 396
 397 always_inline session_t *
 398 session_get_from_handle_if_valid (session_handle_t handle)
 399 {
 400   u32 session_index, thread_index;
 401   session_parse_handle (handle, &session_index, &thread_index);
 402   return session_get_if_valid (session_index, thread_index);
 403 }
 404
 405 u64 session_segment_handle (session_t * s);
 406
 407 /**
 408  * Get session from handle and avoid pool validation if no same thread
 409  *
 410  * Peekers are fine because pool grows with barrier (see @ref session_alloc)
 411  */
 412 always_inline session_t *
 413 session_get_from_handle_safe (u64 handle)
 414 {
 415   u32 thread_index = session_thread_from_handle (handle);
 416   session_worker_t *wrk = &session_main.wrk[thread_index];
 417
 418   if (thread_index == vlib_get_thread_index ())
 419     {
 420       return pool_elt_at_index (wrk->sessions,
 421                                 session_index_from_handle (handle));
 422     }
 423   else
 424     {
 425       /* Don't use pool_elt_at index to avoid pool bitmap reallocs */
 426       return wrk->sessions + session_index_from_handle (handle);
 427     }
 428 }
 429
 430 always_inline session_t *
 431 session_clone_safe (u32 session_index, u32 thread_index)
 432 {
 433   u32 current_thread_index = vlib_get_thread_index (), new_index;
 434   session_t *old_s, *new_s;
 435
 436   new_s = session_alloc (current_thread_index);
 437   new_index = new_s->session_index;
 438   /* Session pools are reallocated with barrier (see @ref session_alloc) */
 439   old_s = session_main.wrk[thread_index].sessions + session_index;
 440   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
 441   new_s->thread_index = current_thread_index;
 442   new_s->session_index = new_index;
 443   return new_s;
 444 }
 445
 446 int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
 447 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 448 int session_stop_listen (session_t * s);
 449 void session_half_close (session_t *s);
 450 void session_close (session_t * s);
 451 void session_reset (session_t * s);
 452 void session_transport_half_close (session_t *s);
 453 void session_transport_close (session_t * s);
 454 void session_transport_reset (session_t * s);
 455 void session_transport_cleanup (session_t * s);
 456 int session_send_io_evt_to_thread (svm_fifo_t * f,
 457                                    session_evt_type_t evt_type);
 458 int session_enqueue_notify (session_t * s);
 459 int session_dequeue_notify (session_t * s);
 460 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 461                                           session_evt_type_t evt_type);
 462 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 463                                      void *rpc_args);
 464 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
 465                                            void *rpc_args);
 466 void session_add_self_custom_tx_evt (transport_connection_t * tc,
 467                                      u8 has_prio);
 468 void sesssion_reschedule_tx (transport_connection_t * tc);
 469 transport_connection_t *session_get_transport (session_t * s);
 470 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
 471                            u8 is_lcl);
 472 int session_transport_attribute (session_t *s, u8 is_get,
 473                                  transport_endpt_attr_t *attr);
 474
 475 u8 *format_session (u8 * s, va_list * args);
 476 uword unformat_session (unformat_input_t * input, va_list * args);
 477 uword unformat_transport_connection (unformat_input_t * input,
 478                                      va_list * args);
 479
 480 /*
 481  * Interface to transport protos
 482  */
 483
 484 int session_enqueue_stream_connection (transport_connection_t * tc,
 485                                        vlib_buffer_t * b, u32 offset,
 486                                        u8 queue_event, u8 is_in_order);
 487 int session_enqueue_dgram_connection (session_t * s,
 488                                       session_dgram_hdr_t * hdr,
 489                                       vlib_buffer_t * b, u8 proto,
 490                                       u8 queue_event);
 491 int session_stream_connect_notify (transport_connection_t * tc,
 492                                    session_error_t err);
 493 int session_dgram_connect_notify (transport_connection_t * tc,
 494                                   u32 old_thread_index,
 495                                   session_t ** new_session);
 496 int session_stream_accept_notify (transport_connection_t * tc);
 497 void session_transport_closing_notify (transport_connection_t * tc);
 498 void session_transport_delete_notify (transport_connection_t * tc);
 499 void session_half_open_delete_notify (transport_connection_t *tc);
 500 void session_half_open_migrate_notify (transport_connection_t *tc);
 501 int session_half_open_migrated_notify (transport_connection_t *tc);
 502 void session_transport_closed_notify (transport_connection_t * tc);
 503 void session_transport_reset_notify (transport_connection_t * tc);
 504 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
 505                            u32 thread_index, u8 notify);
 506 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
 507                           u32 thread_index);
 508 /**
 509  * Initialize session layer for given transport proto and ip version
 510  *
 511  * Allocates per session type (transport proto + ip version) data structures
 512  * and adds arc from session queue node to session type output node.
 513  *
 514  * @param transport_proto       transport proto to be registered
 515  * @param vft                   virtual function table for transport
 516  * @param is_ip4                flag that indicates if transports uses ipv4
 517  *                              as underlying network layer
 518  * @param output_node           output node for transport
 519  */
 520 void session_register_transport (transport_proto_t transport_proto,
 521                                  const transport_proto_vft_t * vft, u8 is_ip4,
 522                                  u32 output_node);
 523 transport_proto_t session_add_transport_proto (void);
 524 void session_register_update_time_fn (session_update_time_fn fn, u8 is_add);
 525 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
 526                                 u32 offset, u32 max_bytes);
 527 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 528
 529 always_inline void
 530 session_set_state (session_t *s, session_state_t session_state)
 531 {
 532   s->session_state = session_state;
 533   SESSION_EVT (SESSION_EVT_STATE_CHANGE, s);
 534 }
 535
 536 always_inline u32
 537 transport_max_rx_enqueue (transport_connection_t * tc)
 538 {
 539   session_t *s = session_get (tc->s_index, tc->thread_index);
 540   return svm_fifo_max_enqueue_prod (s->rx_fifo);
 541 }
 542
 543 always_inline u32
 544 transport_max_tx_dequeue (transport_connection_t * tc)
 545 {
 546   session_t *s = session_get (tc->s_index, tc->thread_index);
 547   return svm_fifo_max_dequeue_cons (s->tx_fifo);
 548 }
 549
 550 always_inline u32
 551 transport_max_rx_dequeue (transport_connection_t * tc)
 552 {
 553   session_t *s = session_get (tc->s_index, tc->thread_index);
 554   return svm_fifo_max_dequeue (s->rx_fifo);
 555 }
 556
 557 always_inline u32
 558 transport_rx_fifo_size (transport_connection_t * tc)
 559 {
 560   session_t *s = session_get (tc->s_index, tc->thread_index);
 561   return svm_fifo_size (s->rx_fifo);
 562 }
 563
 564 always_inline u32
 565 transport_tx_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->tx_fifo);
 569 }
 570
 571 always_inline u8
 572 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
 573 {
 574   session_t *s = session_get (tc->c_index, tc->thread_index);
 575   return svm_fifo_has_ooo_data (s->rx_fifo);
 576 }
 577
 578 always_inline void
 579 transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
 580 {
 581   session_t *s = session_get (tc->s_index, tc->thread_index);
 582   svm_fifo_add_want_deq_ntf (s->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 583 }
 584
 585 always_inline clib_time_type_t
 586 transport_time_now (u32 thread_index)
 587 {
 588   return session_main.wrk[thread_index].last_vlib_time;
 589 }
 590
 591 always_inline clib_us_time_t
 592 transport_us_time_now (u32 thread_index)
 593 {
 594   return session_main.wrk[thread_index].last_vlib_us_time;
 595 }
 596
 597 always_inline clib_time_type_t
 598 transport_seconds_per_loop (u32 thread_index)
 599 {
 600   return session_main.wrk[thread_index].vm->seconds_per_loop;
 601 }
 602
 603 always_inline void
 604 transport_add_tx_event (transport_connection_t * tc)
 605 {
 606   session_t *s = session_get (tc->s_index, tc->thread_index);
 607   if (svm_fifo_has_event (s->tx_fifo))
 608     return;
 609   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
 610 }
 611
 612 always_inline u32
 613 transport_cl_thread (void)
 614 {
 615   return session_main.transport_cl_thread;
 616 }
 617
 618 always_inline u32
 619 session_vlib_thread_is_cl_thread (void)
 620 {
 621   return (vlib_get_thread_index () == transport_cl_thread () ||
 622           vlib_thread_is_main_w_barrier ());
 623 }
 624
 625 /*
 626  * Listen sessions
 627  */
 628
 629 always_inline u64
 630 listen_session_get_handle (session_t * s)
 631 {
 632   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
 633           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
 634   return session_handle (s);
 635 }
 636
 637 always_inline session_t *
 638 listen_session_get_from_handle (session_handle_t handle)
 639 {
 640   return session_get_from_handle (handle);
 641 }
 642
 643 always_inline void
 644 listen_session_parse_handle (session_handle_t handle, u32 * index,
 645                              u32 * thread_index)
 646 {
 647   session_parse_handle (handle, index, thread_index);
 648 }
 649
 650 always_inline session_t *
 651 listen_session_alloc (u8 thread_index, session_type_t type)
 652 {
 653   session_t *s;
 654   s = session_alloc (thread_index);
 655   s->session_type = type;
 656   s->session_state = SESSION_STATE_LISTENING;
 657   return s;
 658 }
 659
 660 always_inline session_t *
 661 listen_session_get (u32 ls_index)
 662 {
 663   return session_get (ls_index, 0);
 664 }
 665
 666 always_inline void
 667 listen_session_free (session_t * s)
 668 {
 669   ASSERT (!s->rx_fifo);
 670   session_free (s);
 671 }
 672
 673 always_inline session_t *
 674 ho_session_alloc (void)
 675 {
 676   session_t *s;
 677   ASSERT (session_vlib_thread_is_cl_thread ());
 678   s = session_alloc (transport_cl_thread ());
 679   s->session_state = SESSION_STATE_CONNECTING;
 680   s->flags |= SESSION_F_HALF_OPEN;
 681   return s;
 682 }
 683
 684 always_inline session_t *
 685 ho_session_get (u32 ho_index)
 686 {
 687   return session_get (ho_index, transport_cl_thread ());
 688 }
 689
 690 always_inline void
 691 ho_session_free (session_t *s)
 692 {
 693   ASSERT (!s->rx_fifo && s->thread_index == 0);
 694   session_free (s);
 695 }
 696
 697 transport_connection_t *listen_session_get_transport (session_t * s);
 698
 699 /*
 700  * Session layer functions
 701  */
 702
 703 always_inline session_main_t *
 704 vnet_get_session_main ()
 705 {
 706   return &session_main;
 707 }
 708
 709 always_inline session_worker_t *
 710 session_main_get_worker (u32 thread_index)
 711 {
 712   return vec_elt_at_index (session_main.wrk, thread_index);
 713 }
 714
 715 static inline session_worker_t *
 716 session_main_get_worker_if_valid (u32 thread_index)
 717 {
 718   if (thread_index > vec_len (session_main.wrk))
 719     return 0;
 720   return session_main_get_worker (thread_index);
 721 }
 722
 723 always_inline svm_msg_q_t *
 724 session_main_get_vpp_event_queue (u32 thread_index)
 725 {
 726   return session_main_get_worker (thread_index)->vpp_event_queue;
 727 }
 728
 729 always_inline u8
 730 session_main_is_enabled ()
 731 {
 732   return session_main.is_enabled == 1;
 733 }
 734
 735 #define session_cli_return_if_not_enabled()                             \
 736 do {                                                                    \
 737     if (!session_main.is_enabled)                                       \
 738       return clib_error_return (0, "session layer is not enabled");     \
 739 } while (0)
 740
 741 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 742 int session_main_flush_all_enqueue_events (u8 transport_proto);
 743 void session_queue_run_on_main_thread (vlib_main_t * vm);
 744
 745 /**
 746  * Add session node pending buffer with custom node
 747  *
 748  * @param thread_index  worker thread expected to send the buffer
 749  * @param bi            buffer index
 750  * @param next_node     next node edge index for buffer. Edge to next node
 751  *                      must exist
 752  */
 753 always_inline void
 754 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
 755 {
 756   session_worker_t *wrk = session_main_get_worker (thread_index);
 757   vec_add1 (wrk->pending_tx_buffers, bi);
 758   vec_add1 (wrk->pending_tx_nexts, next_node);
 759   if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
 760     vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
 761 }
 762
 763 always_inline void
 764 session_wrk_update_time (session_worker_t *wrk, f64 now)
 765 {
 766   wrk->last_vlib_time = now;
 767   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
 768 }
 769
 770 void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
 771 fifo_segment_t *session_main_get_wrk_mqs_segment (void);
 772 void session_node_enable_disable (u8 is_en);
 773 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 774 void session_wrk_handle_evts_main_rpc (void *);
 775
 776 session_t *session_alloc_for_connection (transport_connection_t * tc);
 777 session_t *session_alloc_for_half_open (transport_connection_t *tc);
 778
 779 typedef void (pool_safe_realloc_rpc_fn) (void *rpc_args);
 780
 781 typedef struct
 782 {
 783   u8 ph[STRUCT_OFFSET_OF (pool_header_t, max_elts) + 4];
 784   u32 flag;
 785 } pool_safe_realloc_header_t;
 786
 787 STATIC_ASSERT_SIZEOF (pool_safe_realloc_header_t, sizeof (pool_header_t));
 788
 789 #define POOL_REALLOC_SAFE_ELT_THRESH 32
 790
 791 #define pool_realloc_flag(PH)                                                 \
 792   ((pool_safe_realloc_header_t *) pool_header (PH))->flag
 793
 794 typedef struct pool_realloc_rpc_args_
 795 {
 796   void **pool;
 797   uword elt_size;
 798   uword align;
 799 } pool_realloc_rpc_args_t;
 800
 801 always_inline void
 802 pool_program_safe_realloc_rpc (void *args)
 803 {
 804   vlib_main_t *vm = vlib_get_main ();
 805   u32 free_elts, max_elts, n_alloc;
 806   pool_realloc_rpc_args_t *pra;
 807
 808   ASSERT (vlib_get_thread_index () == 0);
 809   pra = (pool_realloc_rpc_args_t *) args;
 810
 811   vlib_worker_thread_barrier_sync (vm);
 812
 813   free_elts = _pool_free_elts (*pra->pool, pra->elt_size);
 814   if (free_elts < POOL_REALLOC_SAFE_ELT_THRESH)
 815     {
 816       max_elts = _vec_max_len (*pra->pool, pra->elt_size);
 817       n_alloc = clib_max (2 * max_elts, POOL_REALLOC_SAFE_ELT_THRESH);
 818       _pool_alloc (pra->pool, n_alloc, pra->align, 0, pra->elt_size);
 819     }
 820   pool_realloc_flag (*pra->pool) = 0;
 821   clib_mem_free (args);
 822
 823   vlib_worker_thread_barrier_release (vm);
 824 }
 825
 826 always_inline void
 827 pool_program_safe_realloc (void **p, u32 elt_size, u32 align)
 828 {
 829   pool_realloc_rpc_args_t *pra;
 830
 831   /* Reuse pad as a realloc flag */
 832   if (pool_realloc_flag (*p))
 833     return;
 834
 835   pra = clib_mem_alloc (sizeof (*pra));
 836   pra->pool = p;
 837   pra->elt_size = elt_size;
 838   pra->align = align;
 839   pool_realloc_flag (*p) = 1;
 840
 841   session_send_rpc_evt_to_thread (0 /* thread index */,
 842                                   pool_program_safe_realloc_rpc, pra);
 843 }
 844
 845 #define pool_needs_realloc(P)                                                 \
 846   ((!P) ||                                                                    \
 847    (vec_len (pool_header (P)->free_indices) < POOL_REALLOC_SAFE_ELT_THRESH && \
 848     pool_free_elts (P) < POOL_REALLOC_SAFE_ELT_THRESH))
 849
 850 #define pool_get_aligned_safe(P, E, align)                                    \
 851   do                                                                          \
 852     {                                                                         \
 853       if (PREDICT_FALSE (pool_needs_realloc (P)))                             \
 854         {                                                                     \
 855           if (PREDICT_FALSE (!(P)))                                           \
 856             {                                                                 \
 857               pool_alloc_aligned (P, POOL_REALLOC_SAFE_ELT_THRESH, align);    \
 858             }                                                                 \
 859           else if (PREDICT_FALSE (!pool_free_elts (P)))                       \
 860             {                                                                 \
 861               vlib_workers_sync ();                                           \
 862               pool_alloc_aligned (P, pool_max_len (P), align);                \
 863               vlib_workers_continue ();                                       \
 864               ALWAYS_ASSERT (pool_free_elts (P) > 0);                         \
 865             }                                                                 \
 866           else                                                                \
 867             {                                                                 \
 868               pool_program_safe_realloc ((void **) &(P), sizeof ((P)[0]),     \
 869                                          _vec_align (P, align));              \
 870             }                                                                 \
 871         }                                                                     \
 872       pool_get_aligned (P, E, align);                                         \
 873     }                                                                         \
 874   while (0)
 875
 876 #endif /* __included_session_h__ */
 877
 878 /*
 879  * fd.io coding-style-patch-verification: ON
 880  *
 881  * Local Variables:
 882  * eval: (c-set-style "gnu")
 883  * End:
 884  */