FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
session.h
Go to the documentation of this file.
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>
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,
38 #undef _
41 
42 typedef struct session_tx_context_
43 {
44  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
57  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
59 
60  /** Vector of tx buffer free lists */
63 
64 typedef struct session_evt_elt
65 {
67  session_event_t evt;
69 
70 typedef struct session_ctrl_evt_data_
71 {
74 
75 typedef enum session_wrk_state_
76 {
80 } __clib_packed session_wrk_state_t;
81 
82 typedef enum session_wrk_flags_
83 {
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 */
93 
94  /** vpp event message queue for worker */
96 
97  /** vlib_time_now last time around the track */
99 
100  /** vlib_time_now rounded to us precision and as u64 */
102 
103  /** Convenience pointer to this worker's vlib_main */
105 
106  /** Per-proto vector of sessions to enqueue */
108 
109  /** Timerfd used to periodically signal wrk session queue node */
110  int timerfd;
111 
112  /** Worker flags */
114 
115  /** Worker state */
117 
118  /** Context for session tx */
120 
121  /** Pool of session event list elements */
123 
124  /** Pool of ctrl events data buffers */
126 
127  /** Head of control events list */
129 
130  /** Head of list of elements */
132 
133  /** Head of list of pending events */
135 
136  /** Peekers rw lock */
138 
139  /** Vector of buffers to be sent */
141 
142  /** Vector of nexts for the pending tx buffers */
144 
145  /** Clib file for timerfd. Used only if adaptive mode is on */
147 
148  /** List of pending connects for first worker */
150 
151  /** Flag that is set if main thread signaled to handle connects */
153 
154  /** Main thread loops in poll mode without a connect */
156 
157 #if SESSION_DEBUG
158  /** last event poll time by thread */
159  clib_time_type_t last_event_poll;
160 #endif
162 
165  session_evt_elt_t * e, int *n_tx_packets);
166 
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 */
177 
178  /** Event queues memfd segment */
180 
181  /** Unique segment name counter */
183 
184  /** Per transport rx function that can either dequeue or peek */
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 */
191 
192  /** Thread for cl and ho that rely on cl allocs */
194 
196 
197  /*
198  * Config parameters
199  */
200 
201  /** Session manager is enabled */
203 
204  /** Session manager initialized (not necessarily enabled) */
206 
207  /** Enable session manager at startup */
209 
210  /** Poll session node in main thread */
212 
213  /** Allocate private rx mqs for external apps */
215 
216  /** Do not enable session queue node adaptive mode */
218 
219  /** vpp fifo event queue configured length */
221 
222  /** Session ssvm segment configs*/
226 
227  /** Session table size parameters */
236 
237  /** Transport table (preallocation) size parameters */
240 
241  /** Preallocate session config parameter */
243 
246 
251 
253 {
257 
258 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
259 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
260 
261 static inline void
263 {
264  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
266 }
267 
268 static inline void
270 {
271  clib_llist_add (wrk->event_elts, evt_list, elt,
273 }
274 
275 
276 static inline u32
278 {
281  return (data - wrk->ctrl_evts_data);
282 }
283 
284 static inline session_evt_elt_t *
286 {
289  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
291  return elt;
292 }
293 
294 static inline void *
296 {
297  return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
298  elt->evt.ctrl_data_index));
299 }
300 
301 static inline void
303 {
304  ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
305  pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
306 }
307 
308 static inline session_evt_elt_t *
310 {
313  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
315  return elt;
316 }
317 
318 static inline session_evt_elt_t *
320 {
323  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
325  return elt;
326 }
327 
329 
331 void session_free (session_t * s);
335 
338 {
341 }
342 
345 {
347  return 0;
348 
350  return 0;
351 
354 }
355 
358 {
360  u32 session_index, thread_index;
361  session_parse_handle (handle, &session_index, &thread_index);
362  return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
363 }
364 
367 {
368  u32 session_index, thread_index;
369  session_parse_handle (handle, &session_index, &thread_index);
370  return session_get_if_valid (session_index, thread_index);
371 }
372 
374 
375 /**
376  * Acquires a lock that blocks a session pool from expanding.
377  *
378  * This is typically used for safely peeking into other threads'
379  * pools in order to clone elements. Lock should be dropped as soon
380  * as possible by calling @ref session_pool_remove_peeker.
381  *
382  * NOTE: Avoid using pool_elt_at_index while the lock is held because
383  * it may lead to free elt bitmap expansion/contraction!
384  */
385 always_inline void
387 {
390  return;
392 }
393 
394 always_inline void
396 {
399  return;
401 }
402 
403 /**
404  * Get session from handle and 'lock' pool resize if not in same thread
405  *
406  * Caller should drop the peek 'lock' as soon as possible.
407  */
410 {
413 
415  {
416  return pool_elt_at_index (wrk->sessions,
417  session_index_from_handle (handle));
418  }
419  else
420  {
422  /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
423  return wrk->sessions + session_index_from_handle (handle);
424  }
425 }
426 
429 {
430  return (s - session_main.wrk[s->thread_index].sessions);
431 }
432 
435 {
436  session_t *old_s, *new_s;
437  u32 current_thread_index = vlib_get_thread_index ();
438 
439  /* If during the memcpy pool is reallocated AND the memory allocator
440  * decides to give the old chunk of memory to somebody in a hurry to
441  * scribble something on it, we have a problem. So add this thread as
442  * a session pool peeker.
443  */
445  new_s = session_alloc (current_thread_index);
446  old_s = session_main.wrk[thread_index].sessions + session_index;
447  clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
449  new_s->thread_index = current_thread_index;
450  new_s->session_index = session_get_index (new_s);
451  return new_s;
452 }
453 
457 void session_half_close (session_t *s);
458 void session_close (session_t * s);
459 void session_reset (session_t * s);
465  session_evt_type_t evt_type);
469  session_evt_type_t evt_type);
471  void *rpc_args);
473  void *rpc_args);
475  u8 has_prio);
479  u8 is_lcl);
481  transport_endpt_attr_t *attr);
482 
483 u8 *format_session (u8 * s, va_list * args);
484 uword unformat_session (unformat_input_t * input, va_list * args);
486  va_list * args);
487 
488 /*
489  * Interface to transport protos
490  */
491 
494  u8 queue_event, u8 is_in_order);
496  session_dgram_hdr_t * hdr,
497  vlib_buffer_t * b, u8 proto,
498  u8 queue_event);
500  session_error_t err);
502  u32 old_thread_index,
503  session_t ** new_session);
512 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
513  u32 thread_index, u8 notify);
514 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
515  u32 thread_index);
516 /**
517  * Initialize session layer for given transport proto and ip version
518  *
519  * Allocates per session type (transport proto + ip version) data structures
520  * and adds arc from session queue node to session type output node.
521  *
522  * @param transport_proto transport proto to be registered
523  * @param vft virtual function table for transport
524  * @param is_ip4 flag that indicates if transports uses ipv4
525  * as underlying network layer
526  * @param output_node output node for transport
527  */
529  const transport_proto_vft_t * vft, u8 is_ip4,
530  u32 output_node);
533  u32 offset, u32 max_bytes);
535 
538 {
539  session_t *s = session_get (tc->s_index, tc->thread_index);
541 }
542 
545 {
546  session_t *s = session_get (tc->s_index, tc->thread_index);
548 }
549 
552 {
553  session_t *s = session_get (tc->s_index, tc->thread_index);
554  return svm_fifo_max_dequeue (s->rx_fifo);
555 }
556 
559 {
560  session_t *s = session_get (tc->s_index, tc->thread_index);
561  return svm_fifo_size (s->rx_fifo);
562 }
563 
566 {
567  session_t *s = session_get (tc->s_index, tc->thread_index);
568  return svm_fifo_size (s->tx_fifo);
569 }
570 
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
580 {
581  session_t *s = session_get (tc->s_index, tc->thread_index);
583 }
584 
587 {
589 }
590 
593 {
595 }
596 
599 {
601 }
602 
603 always_inline void
605 {
606  session_t *s = session_get (tc->s_index, tc->thread_index);
607  if (svm_fifo_has_event (s->tx_fifo))
608  return;
610 }
611 
614 {
616 }
617 
618 /*
619  * Listen sessions
620  */
621 
624 {
625  ASSERT (s->session_state == SESSION_STATE_LISTENING ||
626  session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
627  return session_handle (s);
628 }
629 
632 {
633  return session_get_from_handle (handle);
634 }
635 
636 always_inline void
638  u32 * thread_index)
639 {
641 }
642 
645 {
646  session_t *s;
648  s->session_type = type;
649  s->session_state = SESSION_STATE_LISTENING;
650  return s;
651 }
652 
655 {
656  return session_get (ls_index, 0);
657 }
658 
659 always_inline void
661 {
662  ASSERT (!s->rx_fifo);
663  session_free (s);
664 }
665 
668 {
669  session_t *s;
670  ASSERT (vlib_get_thread_index () == 0);
671  s = session_alloc (0);
672  s->session_state = SESSION_STATE_CONNECTING;
673  s->flags |= SESSION_F_HALF_OPEN;
674  return s;
675 }
676 
678 ho_session_get (u32 ho_index)
679 {
680  return session_get (ho_index, 0 /* half-open thread */);
681 }
682 
683 always_inline void
685 {
686  ASSERT (!s->rx_fifo && s->thread_index == 0);
687  session_free (s);
688 }
689 
691 
692 /*
693  * Session layer functions
694  */
695 
698 {
699  return &session_main;
700 }
701 
704 {
705  return &session_main.wrk[thread_index];
706 }
707 
708 static inline session_worker_t *
710 {
712  return 0;
713  return &session_main.wrk[thread_index];
714 }
715 
718 {
720 }
721 
724 {
725  return session_main.is_enabled == 1;
726 }
727 
728 #define session_cli_return_if_not_enabled() \
729 do { \
730  if (!session_main.is_enabled) \
731  return clib_error_return (0, "session layer is not enabled"); \
732 } while (0)
733 
737 
738 /**
739  * Add session node pending buffer with custom node
740  *
741  * @param thread_index worker thread expected to send the buffer
742  * @param bi buffer index
743  * @param next_node next node edge index for buffer. Edge to next node
744  * must exist
745  */
746 always_inline void
748 {
751  vec_add1 (wrk->pending_tx_nexts, next_node);
754 }
755 
756 always_inline void
758 {
761 }
762 
765 void session_node_enable_disable (u8 is_en);
767 
770 
771 #endif /* __included_session_h__ */
772 
773 /*
774  * fd.io coding-style-patch-verification: ON
775  *
776  * Local Variables:
777  * eval: (c-set-style "gnu")
778  * End:
779  */
session_worker_::timerfd_file
uword timerfd_file
Clib file for timerfd.
Definition: session.h:146
transport_seconds_per_loop
static clib_time_type_t transport_seconds_per_loop(u32 thread_index)
Definition: session.h:598
session_tx_context_
Definition: session.h:42
session_wrk_flag_t
enum session_wrk_flags_ session_wrk_flag_t
session_main_::configured_v6_session_table_memory
u32 configured_v6_session_table_memory
Definition: session.h:233
session_tx_fifo_dequeue_and_snd
session_fifo_rx_fn session_tx_fifo_dequeue_and_snd
session_error_t
enum session_error_ session_error_t
session_evt_type_t
session_evt_type_t
Definition: session_types.h:326
svm_fifo_size
static u32 svm_fifo_size(svm_fifo_t *f)
Definition: svm_fifo.h:697
session_worker_::ctx
session_tx_context_t ctx
Context for session tx.
Definition: session.h:119
session_main_::session_enable_asap
u8 session_enable_asap
Enable session manager at startup.
Definition: session.h:208
thread_index
u32 thread_index
Definition: nat44_ei_hairpinning.c:495
session_types.h
session_tx_context_::s
session_t * s
Definition: session.h:45
session_dgram_header_
Definition: session_types.h:437
SESSION_CTRL_MSG_MAX_SIZE
#define SESSION_CTRL_MSG_MAX_SIZE
Definition: session_types.h:24
session_send_io_evt_to_thread
int session_send_io_evt_to_thread(svm_fifo_t *f, session_evt_type_t evt_type)
Definition: session.c:84
buffer
char * buffer
Definition: cJSON.h:163
session_main_::msg_id_base
u16 msg_id_base
Definition: session.h:244
session_::session_index
u32 session_index
Index in thread pool where session was allocated.
Definition: session_types.h:188
session_get_endpoint
void session_get_endpoint(session_t *s, transport_endpoint_t *tep, u8 is_lcl)
Definition: session.c:1754
session_fifo_rx_fn
int() session_fifo_rx_fn(session_worker_t *wrk, vlib_node_runtime_t *node, session_evt_elt_t *e, int *n_tx_packets)
Definition: session.h:163
session_send_rpc_evt_to_thread
void session_send_rpc_evt_to_thread(u32 thread_index, void *fp, void *rpc_args)
Definition: session.c:116
session_type_t
u8 session_type_t
Definition: session_types.h:110
session_tx_context_::CLIB_CACHE_LINE_ALIGN_MARK
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
session_tx_context_::sp
transport_send_params_t sp
Definition: session.h:48
session_ctrl_evt_data_::data
u8 data[SESSION_CTRL_MSG_MAX_SIZE]
Definition: session.h:72
session_clone_safe
static session_t * session_clone_safe(u32 session_index, u32 thread_index)
Definition: session.h:434
session_parse_handle
static void session_parse_handle(session_handle_t handle, u32 *index, u32 *thread_index)
Definition: session_types.h:301
session_stream_accept_notify
int session_stream_accept_notify(transport_connection_t *tc)
Definition: session.c:1202
f
vlib_frame_t * f
Definition: interface_output.c:1098
session_stream_connect_notify
int session_stream_connect_notify(transport_connection_t *tc, session_error_t err)
Definition: session.c:888
session_main_flush_enqueue_events
int session_main_flush_enqueue_events(u8 proto, u32 thread_index)
Flushes queue of sessions that are to be notified of new data enqueued events.
Definition: session.c:846
pool_elt_at_index
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:549
session_worker_::timerfd
int timerfd
Timerfd used to periodically signal wrk session queue node.
Definition: session.h:110
CLIB_US_TIME_FREQ
#define CLIB_US_TIME_FREQ
Definition: time.h:207
session_wrk_update_time
static void session_wrk_update_time(session_worker_t *wrk, f64 now)
Definition: session.h:757
session_tx_context_::left_to_snd
u32 left_to_snd
Definition: session.h:50
SESSION_WRK_F_ADAPTIVE
@ SESSION_WRK_F_ADAPTIVE
Definition: session.h:84
listen_session_get_handle
static u64 listen_session_get_handle(session_t *s)
Definition: session.h:623
session_transport_reset_notify
void session_transport_reset_notify(transport_connection_t *tc)
Notify application that connection has been reset.
Definition: session.c:1187
session_::tx_fifo
svm_fifo_t * tx_fifo
Definition: session_types.h:179
session_wrk_handle_mq
int session_wrk_handle_mq(session_worker_t *wrk, svm_msg_q_t *mq)
Definition: session_node.c:1671
clib_llist_add
#define clib_llist_add(LP, name, E, H)
Add entry after head.
Definition: llist.h:210
clib_llist_anchor
Definition: llist.h:29
fifo_segment_t
Definition: fifo_segment.h:68
session_main_::local_endpoints_table_memory
u32 local_endpoints_table_memory
Transport table (preallocation) size parameters.
Definition: session.h:238
node
vlib_main_t vlib_node_runtime_t * node
Definition: nat44_ei.c:3047
session_half_open_delete_notify
void session_half_open_delete_notify(transport_connection_t *tc)
Definition: session.c:347
session_
Definition: session_types.h:175
session_main_::preallocated_sessions
u32 preallocated_sessions
Preallocate session config parameter.
Definition: session.h:242
session_endpoint_cfg_t
struct _session_endpoint_cfg session_endpoint_cfg_t
session_main_get_worker_if_valid
static session_worker_t * session_main_get_worker_if_valid(u32 thread_index)
Definition: session.h:709
foreach_session_input_error
#define foreach_session_input_error
Definition: session.h:25
session_handle_t
u64 session_handle_t
Definition: session_types.h:111
wrk
session_worker_t * wrk
Definition: application.c:490
session_add_pending_tx_buffer
static void session_add_pending_tx_buffer(u32 thread_index, u32 bi, u32 next_node)
Add session node pending buffer with custom node.
Definition: session.h:747
session_transport_closed_notify
void session_transport_closed_notify(transport_connection_t *tc)
Notification from transport that it is closed.
Definition: session.c:1150
transport_proto_vft_t
struct _transport_proto_vft transport_proto_vft_t
clib_llist_index_t
u32 clib_llist_index_t
Definition: llist.h:27
u16
unsigned short u16
Definition: types.h:57
listen_session_get
static session_t * listen_session_get(u32 ls_index)
Definition: session.h:654
session_add_self_custom_tx_evt
void session_add_self_custom_tx_evt(transport_connection_t *tc, u8 has_prio)
Definition: session.c:128
session_::thread_index
u8 thread_index
Index of the thread that allocated the session.
Definition: session_types.h:194
session_ctrl_evt_data_
Definition: session.h:70
session_::session_type
session_type_t session_type
Type built from transport and network protocol types.
Definition: session_types.h:182
message_queue.h
Unidirectional shared-memory multi-ring message queue.
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
SESSION_Q_PROCESS_RUN_ON_MAIN
@ SESSION_Q_PROCESS_RUN_ON_MAIN
Definition: session.h:254
SESSION_IO_EVT_BUILTIN_TX
@ SESSION_IO_EVT_BUILTIN_TX
Definition: session_types.h:332
session_close
void session_close(session_t *s)
Initialize session closing procedure.
Definition: session.c:1494
session_node_lookup_fifo_event
u8 session_node_lookup_fifo_event(svm_fifo_t *f, session_event_t *e)
Definition: session_debug.c:213
session_thread_from_handle
static u32 session_thread_from_handle(session_handle_t handle)
Definition: session_types.h:295
session_main_::session_type_to_next
u32 * session_type_to_next
Per session type output nodes.
Definition: session.h:190
transport_connection_t
struct _transport_connection transport_connection_t
unformat_input_t
struct _unformat_input_t unformat_input_t
clib_rwlock_reader_lock
static void clib_rwlock_reader_lock(clib_rwlock_t *p)
Definition: lock.h:169
listen_session_parse_handle
static void listen_session_parse_handle(session_handle_t handle, u32 *index, u32 *thread_index)
Definition: session.h:637
transport_rx_fifo_size
static u32 transport_rx_fifo_size(transport_connection_t *tc)
Definition: session.h:558
session_alloc_for_connection
session_t * session_alloc_for_connection(transport_connection_t *tc)
Definition: session.c:392
session_main_::transport_cl_thread
u32 transport_cl_thread
Thread for cl and ho that rely on cl allocs.
Definition: session.h:193
ho_session_free
static void ho_session_free(session_t *s)
Definition: session.h:684
clib_memcpy_fast
static_always_inline void * clib_memcpy_fast(void *restrict dst, const void *restrict src, size_t n)
Definition: string.h:92
clib_rwlock_reader_unlock
static void clib_rwlock_reader_unlock(clib_rwlock_t *p)
Definition: lock.h:184
session_tx_context_::tx_buffers
u32 * tx_buffers
Vector of tx buffer free lists.
Definition: session.h:61
pool_put_index
#define pool_put_index(p, i)
Free pool element with given index.
Definition: pool.h:337
session_free_w_fifos
void session_free_w_fifos(session_t *s)
Definition: session.c:279
clib_llist_add_tail
#define clib_llist_add_tail(LP, name, E, H)
Add entry after tail.
Definition: llist.h:219
session_worker_::new_head
clib_llist_index_t new_head
Head of list of elements.
Definition: session.h:131
session_main_::configured_v6_halfopen_table_buckets
u32 configured_v6_halfopen_table_buckets
Definition: session.h:234
session_evt_alloc_new
static session_evt_elt_t * session_evt_alloc_new(session_worker_t *wrk)
Definition: session.h:309
session_tx_context_::transport_vft
transport_proto_vft_t * transport_vft
Definition: session.h:46
session_evt_add_old
static void session_evt_add_old(session_worker_t *wrk, session_evt_elt_t *elt)
Definition: session.h:262
session_segment_handle
u64 session_segment_handle(session_t *s)
Definition: session.c:1680
session_main_::wrk
session_worker_t * wrk
Worker contexts.
Definition: session.h:176
clib_time_type_t
f64 clib_time_type_t
Definition: time.h:203
session_evt_ctrl_data
static void * session_evt_ctrl_data(session_worker_t *wrk, session_evt_elt_t *elt)
Definition: session.h:295
session_worker_::last_vlib_time
clib_time_type_t last_vlib_time
vlib_time_now last time around the track
Definition: session.h:98
session_listen
int session_listen(session_t *s, session_endpoint_cfg_t *sep)
Ask transport to listen on session endpoint.
Definition: session.c:1423
svm_fifo_t
struct _svm_fifo svm_fifo_t
session_main_flush_all_enqueue_events
int session_main_flush_all_enqueue_events(u8 transport_proto)
Definition: session.c:878
pool_is_free_index
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:302
svm_fifo_has_ooo_data
static u8 svm_fifo_has_ooo_data(svm_fifo_t *f)
Check if fifo has out-of-order data.
Definition: svm_fifo.h:661
session_half_open_migrated_notify
int session_half_open_migrated_notify(transport_connection_t *tc)
Definition: session.c:373
session_pool_add_peeker
static void session_pool_add_peeker(u32 thread_index)
Acquires a lock that blocks a session pool from expanding.
Definition: session.h:386
session_worker_::pending_tx_buffers
u32 * pending_tx_buffers
Vector of buffers to be sent.
Definition: session.h:140
session_transport_cleanup
void session_transport_cleanup(session_t *s)
Cleanup transport and session state.
Definition: session.c:1605
session_worker_::no_connect_loops
u32 no_connect_loops
Main thread loops in poll mode without a connect.
Definition: session.h:155
session_transport_reset
void session_transport_reset(session_t *s)
Force transport close.
Definition: session.c:1581
SVM_FIFO_WANT_DEQ_NOTIF
@ SVM_FIFO_WANT_DEQ_NOTIF
Notify on dequeue.
Definition: svm_fifo.h:35
session_::rx_fifo
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
Definition: session_types.h:178
session_is_valid
u8 session_is_valid(u32 si, u8 thread_index)
Definition: session.c:241
session_main_::session_va_space_size
uword session_va_space_size
Definition: session.h:224
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
session_main_::unique_segment_name_counter
u32 unique_segment_name_counter
Unique segment name counter.
Definition: session.h:182
session_queue_run_on_main_thread
void session_queue_run_on_main_thread(vlib_main_t *vm)
Definition: session.c:1785
vnet_get_session_main
static session_main_t * vnet_get_session_main()
Definition: session.h:697
vec_add1
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:606
listen_session_free
static void listen_session_free(session_t *s)
Definition: session.h:660
session_tx_context_t
struct session_tx_context_ session_tx_context_t
session_send_rpc_evt_to_thread_force
void session_send_rpc_evt_to_thread_force(u32 thread_index, void *fp, void *rpc_args)
Definition: session.c:108
session_main_::configured_event_queue_length
u32 configured_event_queue_length
vpp fifo event queue configured length
Definition: session.h:220
session_open
int session_open(session_endpoint_cfg_t *sep, session_handle_t *rsh)
Ask transport to open connection to remote transport endpoint.
Definition: session.c:1407
session_q_process_evt_t
enum session_q_process_evt_ session_q_process_evt_t
session_tx_context_::max_len_to_snd
u32 max_len_to_snd
Definition: session.h:51
session_worker_::session_to_enqueue
u32 ** session_to_enqueue
Per-proto vector of sessions to enqueue.
Definition: session.h:107
session_main_::session_baseva
uword session_baseva
Session ssvm segment configs.
Definition: session.h:223
transport_rx_fifo_has_ooo_data
static u8 transport_rx_fifo_has_ooo_data(transport_connection_t *tc)
Definition: session.h:572
session_evt_elt
Definition: session.h:64
session_add_transport_proto
transport_proto_t session_add_transport_proto(void)
Definition: session.c:1725
session_free
void session_free(session_t *s)
Definition: session.c:227
session_main_get_vpp_event_queue
static svm_msg_q_t * session_main_get_vpp_event_queue(u32 thread_index)
Definition: session.h:717
session_reset
void session_reset(session_t *s)
Force a close without waiting for data to be flushed.
Definition: session.c:1517
PREDICT_FALSE
#define PREDICT_FALSE(x)
Definition: clib.h:124
session_tx_fifo_peek_and_snd
session_fifo_rx_fn session_tx_fifo_peek_and_snd
session_tx_context_::n_bufs_needed
u16 n_bufs_needed
Definition: session.h:55
vlib_get_thread_index
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:187
session_enqueue_stream_connection
int session_enqueue_stream_connection(transport_connection_t *tc, vlib_buffer_t *b, u32 offset, u8 queue_event, u8 is_in_order)
Definition: session.c:564
session_tx_fifo_peek_bytes
int session_tx_fifo_peek_bytes(transport_connection_t *tc, u8 *buffer, u32 offset, u32 max_bytes)
Definition: session.c:684
session_main_::session_tx_fns
session_fifo_rx_fn ** session_tx_fns
Per transport rx function that can either dequeue or peek.
Definition: session.h:185
clib_rw_lock_
Definition: lock.h:139
unformat_session
uword unformat_session(unformat_input_t *input, va_list *args)
Definition: session_cli.c:238
transport_max_rx_dequeue
static u32 transport_max_rx_dequeue(transport_connection_t *tc)
Definition: session.h:551
session_enqueue_notify
int session_enqueue_notify(session_t *s)
Definition: session.c:778
session_worker_::peekers_rw_locks
clib_rwlock_t peekers_rw_locks
Peekers rw lock.
Definition: session.h:137
session_get_from_handle_safe
static session_t * session_get_from_handle_safe(u64 handle)
Get session from handle and 'lock' pool resize if not in same thread.
Definition: session.h:409
transport_endpt_attr_
Definition: transport_types.h:256
uword
u64 uword
Definition: types.h:112
session_main_::configured_v6_halfopen_table_memory
u32 configured_v6_halfopen_table_memory
Definition: session.h:235
session_evt_ctrl_data_t
struct session_ctrl_evt_data_ session_evt_ctrl_data_t
transport_max_tx_dequeue
static u32 transport_max_tx_dequeue(transport_connection_t *tc)
Definition: session.h:544
session_queue_pre_input_node
vlib_node_registration_t session_queue_pre_input_node
(constructor) VLIB_REGISTER_NODE (session_queue_pre_input_node)
Definition: session_node.c:1972
session_evt_alloc_ctrl
static session_evt_elt_t * session_evt_alloc_ctrl(session_worker_t *wrk)
Definition: session.h:285
session_get_index
static u32 session_get_index(session_t *s)
Definition: session.h:428
SESSION_Q_PROCESS_STOP
@ SESSION_Q_PROCESS_STOP
Definition: session.h:255
transport_cl_thread
static u32 transport_cl_thread(void)
Definition: session.h:613
session_evt_ctrl_data_alloc
static u32 session_evt_ctrl_data_alloc(session_worker_t *wrk)
Definition: session.h:277
session_index_from_handle
static u32 session_index_from_handle(session_handle_t handle)
Definition: session_types.h:289
session_transport_half_close
void session_transport_half_close(session_t *s)
Notify transport the session can be half-disconnected.
Definition: session.c:1533
session_main_::configured_v4_session_table_buckets
u32 configured_v4_session_table_buckets
Session table size parameters.
Definition: session.h:228
f64
double f64
Definition: types.h:142
session_handle
static session_handle_t session_handle(session_t *s)
Definition: session_types.h:283
session_alloc_for_half_open
session_t * session_alloc_for_half_open(transport_connection_t *tc)
Definition: session.c:411
pool_get
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:255
session_get_from_handle
static session_t * session_get_from_handle(session_handle_t handle)
Definition: session.h:357
session_get_from_handle_if_valid
static session_t * session_get_from_handle_if_valid(session_handle_t handle)
Definition: session.h:366
session_worker_::flags
session_wrk_flag_t flags
Worker flags.
Definition: session.h:113
session_tx_fifo_dequeue_drop
u32 session_tx_fifo_dequeue_drop(transport_connection_t *tc, u32 max_bytes)
Definition: session.c:692
session_node_enable_disable
void session_node_enable_disable(u8 is_en)
Definition: session.c:1883
session_main_::is_enabled
u8 is_enabled
Session manager is enabled.
Definition: session.h:202
session_get_transport
transport_connection_t * session_get_transport(session_t *s)
Definition: session.c:1743
session_main_::use_private_rx_mqs
u8 use_private_rx_mqs
Allocate private rx mqs for external apps.
Definition: session.h:214
session_worker_::CLIB_CACHE_LINE_ALIGN_MARK
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
SESSION_IO_EVT_TX
@ SESSION_IO_EVT_TX
Definition: session_types.h:329
session_evt_elt::evt_list
clib_llist_anchor_t evt_list
Definition: session.h:66
session_evt_add_head_old
static void session_evt_add_head_old(session_worker_t *wrk, session_evt_elt_t *elt)
Definition: session.h:269
session_main_t
struct session_main_ session_main_t
session_main_::is_initialized
u8 is_initialized
Session manager initialized (not necessarily enabled)
Definition: session.h:205
session_half_open_migrate_notify
void session_half_open_migrate_notify(transport_connection_t *tc)
Definition: session.c:363
vnet_session_enable_disable
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: session.c:1925
session_transport_close
void session_transport_close(session_t *s)
Notify transport the session can be disconnected.
Definition: session.c:1553
llist.h
session_main_::evt_qs_segment
fifo_segment_t evt_qs_segment
Event queues memfd segment.
Definition: session.h:179
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
session_get
static session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:337
svm_msg_q_
Definition: message_queue.h:72
session_main_::configured_v6_session_table_buckets
u32 configured_v6_session_table_buckets
Definition: session.h:232
format_session
u8 * format_session(u8 *s, va_list *args)
Format stream session as per the following format.
Definition: session_cli.c:101
session_stream_accept
int session_stream_accept(transport_connection_t *tc, u32 listener_index, u32 thread_index, u8 notify)
Accept a stream session.
Definition: session.c:1228
transport_time_now
static clib_time_type_t transport_time_now(u32 thread_index)
Definition: session.h:586
session_worker_::last_vlib_us_time
clib_us_time_t last_vlib_us_time
vlib_time_now rounded to us precision and as u64
Definition: session.h:101
session_worker_::vpp_event_queue
svm_msg_q_t * vpp_event_queue
vpp event message queue for worker
Definition: session.h:95
unformat_transport_connection
uword unformat_transport_connection(unformat_input_t *input, va_list *args)
Definition: session_cli.c:269
session_half_close
void session_half_close(session_t *s)
Initialize session half-closing procedure.
Definition: session.c:1479
session_dgram_accept
int session_dgram_accept(transport_connection_t *tc, u32 listener_index, u32 thread_index)
Definition: session.c:1263
transport_send_params_
Definition: transport.h:45
data
u8 data[128]
Definition: ipsec_types.api:95
session_tx_context_::deq_per_first_buf
u16 deq_per_first_buf
Definition: session.h:52
session_main_get_evt_q_segment
fifo_segment_t * session_main_get_evt_q_segment(void)
Definition: session.c:1674
transport_rx_fifo_req_deq_ntf
static void transport_rx_fifo_req_deq_ntf(transport_connection_t *tc)
Definition: session.h:579
session_main_::last_transport_proto_type
transport_proto_t last_transport_proto_type
Definition: session.h:195
session_worker_::event_elts
session_evt_elt_t * event_elts
Pool of session event list elements.
Definition: session.h:122
session_queue_process_node
vlib_node_registration_t session_queue_process_node
(constructor) VLIB_REGISTER_NODE (session_queue_process_node)
Definition: session_node.c:1951
index
u32 index
Definition: flow_types.api:221
session_wrk_state_t
enum session_wrk_state_ session_wrk_state_t
session_wrk_state_
session_wrk_state_
Definition: session.h:75
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
clib_bihash_value
template key/value backing page structure
Definition: bihash_doc.h:44
session_evt_ctrl_data_free
static void session_evt_ctrl_data_free(session_worker_t *wrk, session_evt_elt_t *elt)
Definition: session.h:302
svm_fifo_max_enqueue_prod
static u32 svm_fifo_max_enqueue_prod(svm_fifo_t *f)
Maximum number of bytes that can be enqueued into fifo.
Definition: svm_fifo.h:607
session_main_is_enabled
static u8 session_main_is_enabled()
Definition: session.h:723
session_tx_context_::max_dequeue
u32 max_dequeue
Definition: session.h:49
u64
unsigned long u64
Definition: types.h:89
SESSION_WRK_IDLE
@ SESSION_WRK_IDLE
Definition: session.h:79
session_main_::configured_v4_halfopen_table_memory
u32 configured_v4_halfopen_table_memory
Definition: session.h:231
ASSERT
#define ASSERT(truth)
Definition: error_bootstrap.h:69
transport_tx_fifo_size
static u32 transport_tx_fifo_size(transport_connection_t *tc)
Definition: session.h:565
SESSION_WRK_POLLING
@ SESSION_WRK_POLLING
Definition: session.h:77
session_stop_listen
int session_stop_listen(session_t *s)
Ask transport to stop listening on local transport endpoint.
Definition: session.c:1452
session_get_if_valid
static session_t * session_get_if_valid(u64 si, u32 thread_index)
Definition: session.h:344
u32
unsigned int u32
Definition: types.h:88
transport_endpoint_
Definition: transport_types.h:193
session_enqueue_dgram_connection
int session_enqueue_dgram_connection(session_t *s, session_dgram_hdr_t *hdr, vlib_buffer_t *b, u8 proto, u8 queue_event)
Definition: session.c:619
vlib_main_t::seconds_per_loop
f64 seconds_per_loop
Definition: main.h:240
vlib_node_set_interrupt_pending
static void vlib_node_set_interrupt_pending(vlib_main_t *vm, u32 node_index)
Definition: node_funcs.h:249
ho_session_alloc
static session_t * ho_session_alloc(void)
Definition: session.h:667
transport_proto_t
enum _transport_proto transport_proto_t
si
vnet_sw_interface_t * si
Definition: interface_output.c:418
session_worker_::vm
vlib_main_t * vm
Convenience pointer to this worker's vlib_main.
Definition: session.h:104
session_main
session_main_t session_main
Definition: session.c:25
listen_session_alloc
static session_t * listen_session_alloc(u8 thread_index, session_type_t type)
Definition: session.h:644
session_wrk_flags_
session_wrk_flags_
Definition: session.h:82
listen_session_get_transport
transport_connection_t * listen_session_get_transport(session_t *s)
Definition: session.c:1778
session_tx_fifo_dequeue_internal
session_fifo_rx_fn session_tx_fifo_dequeue_internal
session_evt_elt_t
struct session_evt_elt session_evt_elt_t
clib_llist_get
#define clib_llist_get(LP, E)
Alloc new element.
Definition: llist.h:60
elt
app_rx_mq_elt_t * elt
Definition: application.c:488
session_worker_::pending_tx_nexts
u16 * pending_tx_nexts
Vector of nexts for the pending tx buffers.
Definition: session.h:143
session_worker_::pending_connects
clib_llist_index_t pending_connects
List of pending connects for first worker.
Definition: session.h:149
now
f64 now
Definition: nat44_ei_out2in.c:710
session_worker_::sessions
session_t * sessions
Worker session pool.
Definition: session.h:92
clib_us_time_t
u64 clib_us_time_t
Definition: time.h:204
session_q_process_evt_
session_q_process_evt_
Definition: session.h:252
vlib_main_t
Definition: main.h:102
session_worker_::old_head
clib_llist_index_t old_head
Head of list of pending events.
Definition: session.h:134
session_main_::no_adaptive
u8 no_adaptive
Do not enable session queue node adaptive mode.
Definition: session.h:217
session_get_transport_proto
static transport_proto_t session_get_transport_proto(session_t *s)
Definition: session_types.h:242
session_transport_attribute
int session_transport_attribute(session_t *s, u8 is_get, transport_endpt_attr_t *attr)
Definition: session.c:1766
session_transport_delete_notify
void session_transport_delete_notify(transport_connection_t *tc)
Notification from transport that connection is being deleted.
Definition: session.c:1084
b
vlib_buffer_t ** b
Definition: nat44_ei_out2in.c:717
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
session_tx_context_::deq_per_buf
u16 deq_per_buf
Definition: session.h:53
transport_max_rx_enqueue
static u32 transport_max_rx_enqueue(transport_connection_t *tc)
Definition: session.h:537
session_tx_context_::tc
transport_connection_t * tc
Definition: session.h:47
session_tx_context_::hdr
session_dgram_hdr_t hdr
Definition: session.h:58
session_worker_::ctrl_evts_data
session_evt_ctrl_data_t * ctrl_evts_data
Pool of ctrl events data buffers.
Definition: session.h:125
session_tx_context_::n_bufs_per_seg
u8 n_bufs_per_seg
Definition: session.h:56
session_worker_::n_pending_connects
u32 n_pending_connects
Flag that is set if main thread signaled to handle connects.
Definition: session.h:152
ho_session_get
static session_t * ho_session_get(u32 ho_index)
Definition: session.h:678
session_send_io_evt_to_thread_custom
int session_send_io_evt_to_thread_custom(void *data, u32 thread_index, session_evt_type_t evt_type)
Definition: session.c:91
session_dequeue_notify
int session_dequeue_notify(session_t *s)
Definition: session.c:816
session_main_::local_endpoints_table_buckets
u32 local_endpoints_table_buckets
Definition: session.h:239
session_::flags
u32 flags
Session flags.
Definition: session_types.h:197
session_lookup.h
session_pool_remove_peeker
static void session_pool_remove_peeker(u32 thread_index)
Definition: session.h:395
transport_proto
transport_proto
Definition: session.api:22
transport_add_tx_event
static void transport_add_tx_event(transport_connection_t *tc)
Definition: session.h:604
session_worker_t
struct session_worker_ session_worker_t
session_evt_elt::evt
session_event_t evt
Definition: session.h:67
vlib_node_runtime_t
Definition: node.h:454
session_main_::poll_main
u8 poll_main
Poll session node in main thread.
Definition: session.h:211
session_main_
Definition: session.h:173
session_worker_::state
session_wrk_state_t state
Worker state.
Definition: session.h:116
proto
vl_api_ip_proto_t proto
Definition: acl_types.api:51
session_dgram_connect_notify
int session_dgram_connect_notify(transport_connection_t *tc, u32 old_thread_index, session_t **new_session)
Move dgram session to the right thread.
Definition: session.c:1008
session_queue_node
vlib_node_registration_t session_queue_node
(constructor) VLIB_REGISTER_NODE (session_queue_node)
Definition: session_node.c:1835
session_tx_context_::n_segs_per_evt
u16 n_segs_per_evt
Definition: session.h:54
session_main_::configured_v4_session_table_memory
u32 configured_v4_session_table_memory
Definition: session.h:229
session_debug.h
svm_fifo_max_dequeue_cons
static u32 svm_fifo_max_dequeue_cons(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for consumer.
Definition: svm_fifo.h:487
SESSION_WRK_INTERRUPT
@ SESSION_WRK_INTERRUPT
Definition: session.h:78
session_cleanup_half_open
void session_cleanup_half_open(session_handle_t ho_handle)
Definition: session.c:304
svm_fifo_add_want_deq_ntf
static void svm_fifo_add_want_deq_ntf(svm_fifo_t *f, u8 ntf_type)
Set specific want notification flag.
Definition: svm_fifo.h:760
transport_us_time_now
static clib_us_time_t transport_us_time_now(u32 thread_index)
Definition: session.h:592
fifo_segment.h
SESSION_N_ERROR
@ SESSION_N_ERROR
Definition: session.h:39
session_::session_state
volatile u8 session_state
State in session layer state machine.
Definition: session_types.h:185
session_main_get_worker
static session_worker_t * session_main_get_worker(u32 thread_index)
Definition: session.h:703
svm_fifo_has_event
static int svm_fifo_has_event(svm_fifo_t *f)
Check if fifo has io event.
Definition: svm_fifo.h:719
session_wrk_enable_adaptive_mode
void session_wrk_enable_adaptive_mode(session_worker_t *wrk)
Definition: session_node.c:1869
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
listen_session_get_from_handle
static session_t * listen_session_get_from_handle(session_handle_t handle)
Definition: session.h:631
session_main_::configured_v4_halfopen_table_buckets
u32 configured_v4_halfopen_table_buckets
Definition: session.h:230
session_main_::evt_qs_segment_size
uword evt_qs_segment_size
Definition: session.h:225
session_transport_closing_notify
void session_transport_closing_notify(transport_connection_t *tc)
Notification from transport that connection is being closed.
Definition: session.c:1062
session_worker_
Definition: session.h:87
session_register_transport
void session_register_transport(transport_proto_t transport_proto, const transport_proto_vft_t *vft, u8 is_ip4, u32 output_node)
Initialize session layer for given transport proto and ip version.
Definition: session.c:1702
session_input_error_t
session_input_error_t
Definition: session.h:34
svm_fifo_max_dequeue
static u32 svm_fifo_max_dequeue(svm_fifo_t *f)
Fifo max bytes to dequeue.
Definition: svm_fifo.h:516
session_alloc
session_t * session_alloc(u32 thread_index)
Definition: session.c:201
vlib_buffer_t
VLIB buffer representation.
Definition: buffer.h:111
session_worker_::ctrl_head
clib_llist_index_t ctrl_head
Head of control events list.
Definition: session.h:128
clib_llist_elt
#define clib_llist_elt(LP, EI)
Get list elt at index.
Definition: llist.h:81
sesssion_reschedule_tx
void sesssion_reschedule_tx(transport_connection_t *tc)
Definition: session.c:161
session_evt_alloc_old
static session_evt_elt_t * session_evt_alloc_old(session_worker_t *wrk)
Definition: session.h:319