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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __included_session_h__
16 #define __included_session_h__
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>
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 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
34 _(NO_SPACE, "Couldn't allocate a fifo pair") \
35 _(SEG_CREATE, "Couldn't create a new segment")
39 #define _(sym,str) SESSION_ERROR_##sym,
40 foreach_session_input_error
45 typedef struct session_tx_context_
47 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
49 transport_proto_vft_t *transport_vft;
50 transport_connection_t *tc;
56 u16 deq_per_first_buf;
61 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
62 session_dgram_hdr_t hdr;
63 } session_tx_context_t;
65 typedef struct session_evt_elt
67 clib_llist_anchor_t evt_list;
71 typedef struct session_ctrl_evt_data_
73 u8 data[SESSION_CTRL_MSG_MAX_SIZE];
74 } session_evt_ctrl_data_t;
76 typedef struct session_worker_
78 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
80 /** Worker session pool */
83 /** vpp event message queue for worker */
84 svm_msg_q_t *vpp_event_queue;
86 /** vlib_time_now last time around the track */
89 /** Convenience pointer to this worker's vlib_main */
92 /** Per-proto vector of sessions to enqueue */
93 u32 *session_to_enqueue[TRANSPORT_N_PROTO];
95 /** Context for session tx */
96 session_tx_context_t ctx;
98 /** Vector of tx buffer free lists */
101 /** Pool of session event list elements */
102 session_evt_elt_t *event_elts;
104 /** Pool of ctrl events data buffers */
105 session_evt_ctrl_data_t *ctrl_evts_data;
107 /** Head of control events list */
108 clib_llist_index_t ctrl_head;
110 /** Head of list of elements */
111 clib_llist_index_t new_head;
113 /** Head of list of pending events */
114 clib_llist_index_t old_head;
116 /** Peekers rw lock */
117 clib_rwlock_t peekers_rw_locks;
119 /** Vector of buffers to be sent */
120 u32 *pending_tx_buffers;
122 /** Vector of nexts for the pending tx buffers */
123 u16 *pending_tx_nexts;
126 /** last event poll time by thread */
131 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
132 vlib_node_runtime_t * node,
133 session_evt_elt_t * e, int *n_tx_packets);
135 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
136 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
137 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
139 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
141 typedef struct session_main_
143 /** Worker contexts */
144 session_worker_t *wrk;
146 /** Event queues memfd segment initialized only if so configured */
147 ssvm_private_t evt_qs_segment;
149 /** Unique segment name counter */
150 u32 unique_segment_name_counter;
152 /** Per transport rx function that can either dequeue or peek */
153 session_fifo_rx_fn **session_tx_fns;
155 /** Per session type output nodes. Could optimize to group nodes by
156 * fib but lookup would then require session type parsing in session node.
157 * Trade memory for speed, for now */
158 u32 *session_type_to_next;
164 /** Session manager is enabled */
167 /** vpp fifo event queue configured length */
168 u32 configured_event_queue_length;
170 /** Session ssvm segment configs*/
171 uword session_baseva;
172 uword session_va_space_size;
173 uword evt_qs_segment_size;
174 u8 evt_qs_use_memfd_seg;
176 /** Session table size parameters */
177 u32 configured_v4_session_table_buckets;
178 u32 configured_v4_session_table_memory;
179 u32 configured_v4_halfopen_table_buckets;
180 u32 configured_v4_halfopen_table_memory;
181 u32 configured_v6_session_table_buckets;
182 u32 configured_v6_session_table_memory;
183 u32 configured_v6_halfopen_table_buckets;
184 u32 configured_v6_halfopen_table_memory;
186 /** Transport table (preallocation) size parameters */
187 u32 local_endpoints_table_memory;
188 u32 local_endpoints_table_buckets;
190 /** Preallocate session config parameter */
191 u32 preallocated_sessions;
195 extern session_main_t session_main;
196 extern vlib_node_registration_t session_queue_node;
197 extern vlib_node_registration_t session_queue_process_node;
198 extern vlib_node_registration_t session_queue_pre_input_node;
200 #define SESSION_Q_PROCESS_FLUSH_FRAMES 1
201 #define SESSION_Q_PROCESS_STOP 2
203 static inline session_evt_elt_t *
204 session_evt_elt_alloc (session_worker_t * wrk)
206 session_evt_elt_t *elt;
207 pool_get (wrk->event_elts, elt);
212 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
214 pool_put (wrk->event_elts, elt);
218 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
220 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
221 pool_elt_at_index (wrk->event_elts, wrk->old_head));
225 session_evt_ctrl_data_alloc (session_worker_t * wrk)
227 session_evt_ctrl_data_t *data;
228 pool_get (wrk->ctrl_evts_data, data);
229 return (data - wrk->ctrl_evts_data);
232 static inline session_evt_elt_t *
233 session_evt_alloc_ctrl (session_worker_t * wrk)
235 session_evt_elt_t *elt;
236 elt = session_evt_elt_alloc (wrk);
237 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
238 pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
243 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
245 return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
246 elt->evt.ctrl_data_index));
250 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
252 ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
253 pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
256 static inline session_evt_elt_t *
257 session_evt_alloc_new (session_worker_t * wrk)
259 session_evt_elt_t *elt;
260 elt = session_evt_elt_alloc (wrk);
261 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
262 pool_elt_at_index (wrk->event_elts, wrk->new_head));
266 static inline session_evt_elt_t *
267 session_evt_alloc_old (session_worker_t * wrk)
269 session_evt_elt_t *elt;
270 elt = session_evt_elt_alloc (wrk);
271 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
272 pool_elt_at_index (wrk->event_elts, wrk->old_head));
277 session_is_valid (u32 si, u8 thread_index)
280 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
281 if (s->session_state == SESSION_STATE_CLOSED)
284 if (s->thread_index != thread_index || s->session_index != si)
289 session_t *session_alloc (u32 thread_index);
290 void session_free (session_t * s);
291 void session_free_w_fifos (session_t * s);
293 always_inline session_t *
294 session_get (u32 si, u32 thread_index)
296 ASSERT (session_is_valid (si, thread_index));
297 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
300 always_inline session_t *
301 session_get_if_valid (u64 si, u32 thread_index)
303 if (thread_index >= vec_len (session_main.wrk))
306 if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
309 ASSERT (session_is_valid (si, thread_index));
310 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
313 always_inline session_t *
314 session_get_from_handle (session_handle_t handle)
316 session_main_t *smm = &session_main;
317 u32 session_index, thread_index;
318 session_parse_handle (handle, &session_index, &thread_index);
319 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
322 always_inline session_t *
323 session_get_from_handle_if_valid (session_handle_t handle)
325 u32 session_index, thread_index;
326 session_parse_handle (handle, &session_index, &thread_index);
327 return session_get_if_valid (session_index, thread_index);
330 u64 session_segment_handle (session_t * s);
333 * Acquires a lock that blocks a session pool from expanding.
335 * This is typically used for safely peeking into other threads'
336 * pools in order to clone elements. Lock should be dropped as soon
337 * as possible by calling @ref session_pool_remove_peeker.
339 * NOTE: Avoid using pool_elt_at_index while the lock is held because
340 * it may lead to free elt bitmap expansion/contraction!
343 session_pool_add_peeker (u32 thread_index)
345 session_worker_t *wrk = &session_main.wrk[thread_index];
346 if (thread_index == vlib_get_thread_index ())
348 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
352 session_pool_remove_peeker (u32 thread_index)
354 session_worker_t *wrk = &session_main.wrk[thread_index];
355 if (thread_index == vlib_get_thread_index ())
357 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
361 * Get session from handle and 'lock' pool resize if not in same thread
363 * Caller should drop the peek 'lock' as soon as possible.
365 always_inline session_t *
366 session_get_from_handle_safe (u64 handle)
368 u32 thread_index = session_thread_from_handle (handle);
369 session_worker_t *wrk = &session_main.wrk[thread_index];
371 if (thread_index == vlib_get_thread_index ())
373 return pool_elt_at_index (wrk->sessions,
374 session_index_from_handle (handle));
378 session_pool_add_peeker (thread_index);
379 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
380 return wrk->sessions + session_index_from_handle (handle);
385 session_get_index (session_t * s)
387 return (s - session_main.wrk[s->thread_index].sessions);
390 always_inline session_t *
391 session_clone_safe (u32 session_index, u32 thread_index)
393 session_t *old_s, *new_s;
394 u32 current_thread_index = vlib_get_thread_index ();
396 /* If during the memcpy pool is reallocated AND the memory allocator
397 * decides to give the old chunk of memory to somebody in a hurry to
398 * scribble something on it, we have a problem. So add this thread as
399 * a session pool peeker.
401 session_pool_add_peeker (thread_index);
402 new_s = session_alloc (current_thread_index);
403 old_s = session_main.wrk[thread_index].sessions + session_index;
404 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
405 session_pool_remove_peeker (thread_index);
406 new_s->thread_index = current_thread_index;
407 new_s->session_index = session_get_index (new_s);
411 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
412 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
413 int session_stop_listen (session_t * s);
414 void session_close (session_t * s);
415 void session_reset (session_t * s);
416 void session_transport_close (session_t * s);
417 void session_transport_reset (session_t * s);
418 void session_transport_cleanup (session_t * s);
419 int session_send_io_evt_to_thread (svm_fifo_t * f,
420 session_evt_type_t evt_type);
421 int session_enqueue_notify (session_t * s);
422 int session_dequeue_notify (session_t * s);
423 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
424 session_evt_type_t evt_type);
425 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
427 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
429 void session_add_self_custom_tx_evt (transport_connection_t * tc,
431 transport_connection_t *session_get_transport (session_t * s);
432 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
435 u8 *format_session (u8 * s, va_list * args);
436 uword unformat_session (unformat_input_t * input, va_list * args);
437 uword unformat_transport_connection (unformat_input_t * input,
441 * Interface to transport protos
444 int session_enqueue_stream_connection (transport_connection_t * tc,
445 vlib_buffer_t * b, u32 offset,
446 u8 queue_event, u8 is_in_order);
447 int session_enqueue_dgram_connection (session_t * s,
448 session_dgram_hdr_t * hdr,
449 vlib_buffer_t * b, u8 proto,
451 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
452 int session_dgram_connect_notify (transport_connection_t * tc,
453 u32 old_thread_index,
454 session_t ** new_session);
455 int session_stream_accept_notify (transport_connection_t * tc);
456 void session_transport_closing_notify (transport_connection_t * tc);
457 void session_transport_delete_notify (transport_connection_t * tc);
458 void session_transport_closed_notify (transport_connection_t * tc);
459 void session_transport_reset_notify (transport_connection_t * tc);
460 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
461 u32 thread_index, u8 notify);
462 void session_register_transport (transport_proto_t transport_proto,
463 const transport_proto_vft_t * vft, u8 is_ip4,
465 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
466 u32 offset, u32 max_bytes);
467 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
470 transport_max_rx_enqueue (transport_connection_t * tc)
472 session_t *s = session_get (tc->s_index, tc->thread_index);
473 return svm_fifo_max_enqueue_prod (s->rx_fifo);
477 transport_max_tx_dequeue (transport_connection_t * tc)
479 session_t *s = session_get (tc->s_index, tc->thread_index);
480 return svm_fifo_max_dequeue_cons (s->tx_fifo);
484 transport_max_rx_dequeue (transport_connection_t * tc)
486 session_t *s = session_get (tc->s_index, tc->thread_index);
487 return svm_fifo_max_dequeue (s->rx_fifo);
491 transport_rx_fifo_size (transport_connection_t * tc)
493 session_t *s = session_get (tc->s_index, tc->thread_index);
494 return s->rx_fifo->nitems;
498 transport_tx_fifo_size (transport_connection_t * tc)
500 session_t *s = session_get (tc->s_index, tc->thread_index);
501 return s->tx_fifo->nitems;
505 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
507 session_t *s = session_get (tc->c_index, tc->thread_index);
508 return svm_fifo_has_ooo_data (s->rx_fifo);
512 transport_time_now (u32 thread_index)
514 return session_main.wrk[thread_index].last_vlib_time;
518 transport_add_tx_event (transport_connection_t * tc)
520 session_t *s = session_get (tc->s_index, tc->thread_index);
521 if (svm_fifo_has_event (s->tx_fifo))
523 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
531 listen_session_get_handle (session_t * s)
533 ASSERT (s->session_state == SESSION_STATE_LISTENING ||
534 session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
535 return session_handle (s);
538 always_inline session_t *
539 listen_session_get_from_handle (session_handle_t handle)
541 return session_get_from_handle (handle);
545 listen_session_parse_handle (session_handle_t handle, u32 * index,
548 session_parse_handle (handle, index, thread_index);
551 always_inline session_t *
552 listen_session_alloc (u8 thread_index, session_type_t type)
555 s = session_alloc (thread_index);
556 s->session_type = type;
557 s->session_state = SESSION_STATE_LISTENING;
561 always_inline session_t *
562 listen_session_get (u32 ls_index)
564 return session_get (ls_index, 0);
568 listen_session_free (session_t * s)
573 transport_connection_t *listen_session_get_transport (session_t * s);
576 * Session layer functions
579 always_inline session_main_t *
580 vnet_get_session_main ()
582 return &session_main;
585 always_inline session_worker_t *
586 session_main_get_worker (u32 thread_index)
588 return &session_main.wrk[thread_index];
591 static inline session_worker_t *
592 session_main_get_worker_if_valid (u32 thread_index)
594 if (pool_is_free_index (session_main.wrk, thread_index))
596 return &session_main.wrk[thread_index];
599 always_inline svm_msg_q_t *
600 session_main_get_vpp_event_queue (u32 thread_index)
602 return session_main.wrk[thread_index].vpp_event_queue;
606 session_main_is_enabled ()
608 return session_main.is_enabled == 1;
611 #define session_cli_return_if_not_enabled() \
613 if (!session_main.is_enabled) \
614 return clib_error_return (0, "session layer is not enabled"); \
617 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
618 int session_main_flush_all_enqueue_events (u8 transport_proto);
619 void session_flush_frames_main_thread (vlib_main_t * vm);
622 session_add_pending_tx_buffer (session_type_t st, u32 thread_index, u32 bi)
624 session_worker_t *wrk = session_main_get_worker (thread_index);
625 vec_add1 (wrk->pending_tx_buffers, bi);
626 vec_add1 (wrk->pending_tx_nexts, session_main.session_type_to_next[st]);
629 ssvm_private_t *session_main_get_evt_q_segment (void);
630 void session_node_enable_disable (u8 is_en);
631 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
633 #endif /* __included_session_h__ */
636 * fd.io coding-style-patch-verification: ON
639 * eval: (c-set-style "gnu")