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>
23 #include <svm/fifo_segment.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") \
36 #define _(sym,str) SESSION_ERROR_##sym,
37 foreach_session_input_error
40 } session_input_error_t;
42 typedef struct session_tx_context_
44 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
46 transport_proto_vft_t *transport_vft;
47 transport_connection_t *tc;
48 transport_send_params_t sp;
52 u16 deq_per_first_buf;
57 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
58 session_dgram_hdr_t hdr;
60 /** Vector of tx buffer free lists */
62 } session_tx_context_t;
64 typedef struct session_evt_elt
66 clib_llist_anchor_t evt_list;
70 typedef struct session_ctrl_evt_data_
72 u8 data[SESSION_CTRL_MSG_MAX_SIZE];
73 } session_evt_ctrl_data_t;
75 typedef enum session_wrk_state_
78 SESSION_WRK_INTERRUPT,
80 } __clib_packed session_wrk_state_t;
82 typedef enum session_wrk_flags_
84 SESSION_WRK_F_ADAPTIVE = 1 << 0,
85 } __clib_packed session_wrk_flag_t;
87 typedef struct session_worker_
89 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
91 /** Worker session pool */
94 /** vpp event message queue for worker */
95 svm_msg_q_t *vpp_event_queue;
97 /** vlib_time_now last time around the track */
98 clib_time_type_t last_vlib_time;
100 /** vlib_time_now rounded to us precision and as u64 */
101 clib_us_time_t last_vlib_us_time;
103 /** Convenience pointer to this worker's vlib_main */
106 /** Per-proto vector of sessions to enqueue */
107 u32 **session_to_enqueue;
109 /** Timerfd used to periodically signal wrk session queue node */
113 session_wrk_flag_t flags;
116 session_wrk_state_t state;
118 /** Context for session tx */
119 session_tx_context_t ctx;
121 /** Pool of session event list elements */
122 session_evt_elt_t *event_elts;
124 /** Pool of ctrl events data buffers */
125 session_evt_ctrl_data_t *ctrl_evts_data;
127 /** Head of control events list */
128 clib_llist_index_t ctrl_head;
130 /** Head of list of elements */
131 clib_llist_index_t new_head;
133 /** Head of list of pending events */
134 clib_llist_index_t old_head;
136 /** Peekers rw lock */
137 clib_rwlock_t peekers_rw_locks;
139 /** Vector of buffers to be sent */
140 u32 *pending_tx_buffers;
142 /** Vector of nexts for the pending tx buffers */
143 u16 *pending_tx_nexts;
145 /** Clib file for timerfd. Used only if adaptive mode is on */
148 /** List of pending connects for first worker */
149 clib_llist_index_t pending_connects;
151 /** Flag that is set if main thread signaled to handle connects */
152 u32 n_pending_connects;
154 /** Main thread loops in poll mode without a connect */
155 u32 no_connect_loops;
158 /** last event poll time by thread */
159 clib_time_type_t last_event_poll;
163 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
164 vlib_node_runtime_t * node,
165 session_evt_elt_t * e, int *n_tx_packets);
167 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
168 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
169 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
171 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
173 typedef struct session_main_
175 /** Worker contexts */
176 session_worker_t *wrk;
178 /** Event queues memfd segment */
179 fifo_segment_t evt_qs_segment;
181 /** Unique segment name counter */
182 u32 unique_segment_name_counter;
184 /** Per transport rx function that can either dequeue or peek */
185 session_fifo_rx_fn **session_tx_fns;
187 /** Per session type output nodes. Could optimize to group nodes by
188 * fib but lookup would then require session type parsing in session node.
189 * Trade memory for speed, for now */
190 u32 *session_type_to_next;
192 /** Thread for cl and ho that rely on cl allocs */
193 u32 transport_cl_thread;
195 transport_proto_t last_transport_proto_type;
201 /** Session manager is enabled */
204 /** Session manager initialized (not necessarily enabled) */
207 /** Enable session manager at startup */
208 u8 session_enable_asap;
210 /** Poll session node in main thread */
213 /** Allocate private rx mqs for external apps */
214 u8 use_private_rx_mqs;
216 /** Do not enable session queue node adaptive mode */
219 /** vpp fifo event queue configured length */
220 u32 configured_event_queue_length;
222 /** Session ssvm segment configs*/
223 uword session_baseva;
224 uword session_va_space_size;
225 uword evt_qs_segment_size;
227 /** Session table size parameters */
228 u32 configured_v4_session_table_buckets;
229 u32 configured_v4_session_table_memory;
230 u32 configured_v4_halfopen_table_buckets;
231 u32 configured_v4_halfopen_table_memory;
232 u32 configured_v6_session_table_buckets;
233 u32 configured_v6_session_table_memory;
234 u32 configured_v6_halfopen_table_buckets;
235 u32 configured_v6_halfopen_table_memory;
237 /** Transport table (preallocation) size parameters */
238 u32 local_endpoints_table_memory;
239 u32 local_endpoints_table_buckets;
241 /** Preallocate session config parameter */
242 u32 preallocated_sessions;
247 extern session_main_t session_main;
248 extern vlib_node_registration_t session_queue_node;
249 extern vlib_node_registration_t session_queue_process_node;
250 extern vlib_node_registration_t session_queue_pre_input_node;
252 typedef enum session_q_process_evt_
254 SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
255 SESSION_Q_PROCESS_STOP
256 } session_q_process_evt_t;
258 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
259 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
262 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
264 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
265 clib_llist_elt (wrk->event_elts, wrk->old_head));
269 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
271 clib_llist_add (wrk->event_elts, evt_list, elt,
272 clib_llist_elt (wrk->event_elts, wrk->old_head));
277 session_evt_ctrl_data_alloc (session_worker_t * wrk)
279 session_evt_ctrl_data_t *data;
280 pool_get (wrk->ctrl_evts_data, data);
281 return (data - wrk->ctrl_evts_data);
284 static inline session_evt_elt_t *
285 session_evt_alloc_ctrl (session_worker_t * wrk)
287 session_evt_elt_t *elt;
288 clib_llist_get (wrk->event_elts, elt);
289 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
290 clib_llist_elt (wrk->event_elts, wrk->ctrl_head));
295 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
297 return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
298 elt->evt.ctrl_data_index));
302 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
304 ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
305 pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
308 static inline session_evt_elt_t *
309 session_evt_alloc_new (session_worker_t * wrk)
311 session_evt_elt_t *elt;
312 clib_llist_get (wrk->event_elts, elt);
313 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
314 clib_llist_elt (wrk->event_elts, wrk->new_head));
318 static inline session_evt_elt_t *
319 session_evt_alloc_old (session_worker_t * wrk)
321 session_evt_elt_t *elt;
322 clib_llist_get (wrk->event_elts, elt);
323 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
324 clib_llist_elt (wrk->event_elts, wrk->old_head));
328 int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
330 session_t *session_alloc (u32 thread_index);
331 void session_free (session_t * s);
332 void session_free_w_fifos (session_t * s);
333 void session_cleanup_half_open (session_handle_t ho_handle);
334 u8 session_is_valid (u32 si, u8 thread_index);
336 always_inline session_t *
337 session_get (u32 si, u32 thread_index)
339 ASSERT (session_is_valid (si, thread_index));
340 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
343 always_inline session_t *
344 session_get_if_valid (u64 si, u32 thread_index)
346 if (thread_index >= vec_len (session_main.wrk))
349 if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
352 ASSERT (session_is_valid (si, thread_index));
353 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
356 always_inline session_t *
357 session_get_from_handle (session_handle_t handle)
359 session_main_t *smm = &session_main;
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);
365 always_inline session_t *
366 session_get_from_handle_if_valid (session_handle_t handle)
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);
373 u64 session_segment_handle (session_t * s);
376 * Acquires a lock that blocks a session pool from expanding.
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.
382 * NOTE: Avoid using pool_elt_at_index while the lock is held because
383 * it may lead to free elt bitmap expansion/contraction!
386 session_pool_add_peeker (u32 thread_index)
388 session_worker_t *wrk = &session_main.wrk[thread_index];
389 if (thread_index == vlib_get_thread_index ())
391 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
395 session_pool_remove_peeker (u32 thread_index)
397 session_worker_t *wrk = &session_main.wrk[thread_index];
398 if (thread_index == vlib_get_thread_index ())
400 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
404 * Get session from handle and 'lock' pool resize if not in same thread
406 * Caller should drop the peek 'lock' as soon as possible.
408 always_inline session_t *
409 session_get_from_handle_safe (u64 handle)
411 u32 thread_index = session_thread_from_handle (handle);
412 session_worker_t *wrk = &session_main.wrk[thread_index];
414 if (thread_index == vlib_get_thread_index ())
416 return pool_elt_at_index (wrk->sessions,
417 session_index_from_handle (handle));
421 session_pool_add_peeker (thread_index);
422 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
423 return wrk->sessions + session_index_from_handle (handle);
428 session_get_index (session_t * s)
430 return (s - session_main.wrk[s->thread_index].sessions);
433 always_inline session_t *
434 session_clone_safe (u32 session_index, u32 thread_index)
436 session_t *old_s, *new_s;
437 u32 current_thread_index = vlib_get_thread_index ();
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.
444 session_pool_add_peeker (thread_index);
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));
448 session_pool_remove_peeker (thread_index);
449 new_s->thread_index = current_thread_index;
450 new_s->session_index = session_get_index (new_s);
454 int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
455 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
456 int session_stop_listen (session_t * s);
457 void session_half_close (session_t *s);
458 void session_close (session_t * s);
459 void session_reset (session_t * s);
460 void session_transport_half_close (session_t *s);
461 void session_transport_close (session_t * s);
462 void session_transport_reset (session_t * s);
463 void session_transport_cleanup (session_t * s);
464 int session_send_io_evt_to_thread (svm_fifo_t * f,
465 session_evt_type_t evt_type);
466 int session_enqueue_notify (session_t * s);
467 int session_dequeue_notify (session_t * s);
468 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
469 session_evt_type_t evt_type);
470 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
472 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
474 void session_add_self_custom_tx_evt (transport_connection_t * tc,
476 void sesssion_reschedule_tx (transport_connection_t * tc);
477 transport_connection_t *session_get_transport (session_t * s);
478 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
480 int session_transport_attribute (session_t *s, u8 is_get,
481 transport_endpt_attr_t *attr);
483 u8 *format_session (u8 * s, va_list * args);
484 uword unformat_session (unformat_input_t * input, va_list * args);
485 uword unformat_transport_connection (unformat_input_t * input,
489 * Interface to transport protos
492 int session_enqueue_stream_connection (transport_connection_t * tc,
493 vlib_buffer_t * b, u32 offset,
494 u8 queue_event, u8 is_in_order);
495 int session_enqueue_dgram_connection (session_t * s,
496 session_dgram_hdr_t * hdr,
497 vlib_buffer_t * b, u8 proto,
499 int session_stream_connect_notify (transport_connection_t * tc,
500 session_error_t err);
501 int session_dgram_connect_notify (transport_connection_t * tc,
502 u32 old_thread_index,
503 session_t ** new_session);
504 int session_stream_accept_notify (transport_connection_t * tc);
505 void session_transport_closing_notify (transport_connection_t * tc);
506 void session_transport_delete_notify (transport_connection_t * tc);
507 void session_half_open_delete_notify (transport_connection_t *tc);
508 void session_half_open_migrate_notify (transport_connection_t *tc);
509 int session_half_open_migrated_notify (transport_connection_t *tc);
510 void session_transport_closed_notify (transport_connection_t * tc);
511 void session_transport_reset_notify (transport_connection_t * tc);
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,
517 * Initialize session layer for given transport proto and ip version
519 * Allocates per session type (transport proto + ip version) data structures
520 * and adds arc from session queue node to session type output node.
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
528 void session_register_transport (transport_proto_t transport_proto,
529 const transport_proto_vft_t * vft, u8 is_ip4,
531 transport_proto_t session_add_transport_proto (void);
532 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
533 u32 offset, u32 max_bytes);
534 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
537 transport_max_rx_enqueue (transport_connection_t * tc)
539 session_t *s = session_get (tc->s_index, tc->thread_index);
540 return svm_fifo_max_enqueue_prod (s->rx_fifo);
544 transport_max_tx_dequeue (transport_connection_t * tc)
546 session_t *s = session_get (tc->s_index, tc->thread_index);
547 return svm_fifo_max_dequeue_cons (s->tx_fifo);
551 transport_max_rx_dequeue (transport_connection_t * tc)
553 session_t *s = session_get (tc->s_index, tc->thread_index);
554 return svm_fifo_max_dequeue (s->rx_fifo);
558 transport_rx_fifo_size (transport_connection_t * tc)
560 session_t *s = session_get (tc->s_index, tc->thread_index);
561 return svm_fifo_size (s->rx_fifo);
565 transport_tx_fifo_size (transport_connection_t * tc)
567 session_t *s = session_get (tc->s_index, tc->thread_index);
568 return svm_fifo_size (s->tx_fifo);
572 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
574 session_t *s = session_get (tc->c_index, tc->thread_index);
575 return svm_fifo_has_ooo_data (s->rx_fifo);
579 transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
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);
585 always_inline clib_time_type_t
586 transport_time_now (u32 thread_index)
588 return session_main.wrk[thread_index].last_vlib_time;
591 always_inline clib_us_time_t
592 transport_us_time_now (u32 thread_index)
594 return session_main.wrk[thread_index].last_vlib_us_time;
597 always_inline clib_time_type_t
598 transport_seconds_per_loop (u32 thread_index)
600 return session_main.wrk[thread_index].vm->seconds_per_loop;
604 transport_add_tx_event (transport_connection_t * tc)
606 session_t *s = session_get (tc->s_index, tc->thread_index);
607 if (svm_fifo_has_event (s->tx_fifo))
609 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
613 transport_cl_thread (void)
615 return session_main.transport_cl_thread;
623 listen_session_get_handle (session_t * s)
625 ASSERT (s->session_state == SESSION_STATE_LISTENING ||
626 session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
627 return session_handle (s);
630 always_inline session_t *
631 listen_session_get_from_handle (session_handle_t handle)
633 return session_get_from_handle (handle);
637 listen_session_parse_handle (session_handle_t handle, u32 * index,
640 session_parse_handle (handle, index, thread_index);
643 always_inline session_t *
644 listen_session_alloc (u8 thread_index, session_type_t type)
647 s = session_alloc (thread_index);
648 s->session_type = type;
649 s->session_state = SESSION_STATE_LISTENING;
653 always_inline session_t *
654 listen_session_get (u32 ls_index)
656 return session_get (ls_index, 0);
660 listen_session_free (session_t * s)
662 ASSERT (!s->rx_fifo);
666 always_inline session_t *
667 ho_session_alloc (void)
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;
677 always_inline session_t *
678 ho_session_get (u32 ho_index)
680 return session_get (ho_index, 0 /* half-open thread */);
684 ho_session_free (session_t *s)
686 ASSERT (!s->rx_fifo && s->thread_index == 0);
690 transport_connection_t *listen_session_get_transport (session_t * s);
693 * Session layer functions
696 always_inline session_main_t *
697 vnet_get_session_main ()
699 return &session_main;
702 always_inline session_worker_t *
703 session_main_get_worker (u32 thread_index)
705 return &session_main.wrk[thread_index];
708 static inline session_worker_t *
709 session_main_get_worker_if_valid (u32 thread_index)
711 if (thread_index > vec_len (session_main.wrk))
713 return &session_main.wrk[thread_index];
716 always_inline svm_msg_q_t *
717 session_main_get_vpp_event_queue (u32 thread_index)
719 return session_main.wrk[thread_index].vpp_event_queue;
723 session_main_is_enabled ()
725 return session_main.is_enabled == 1;
728 #define session_cli_return_if_not_enabled() \
730 if (!session_main.is_enabled) \
731 return clib_error_return (0, "session layer is not enabled"); \
734 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
735 int session_main_flush_all_enqueue_events (u8 transport_proto);
736 void session_queue_run_on_main_thread (vlib_main_t * vm);
739 * Add session node pending buffer with custom node
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
747 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
749 session_worker_t *wrk = session_main_get_worker (thread_index);
750 vec_add1 (wrk->pending_tx_buffers, bi);
751 vec_add1 (wrk->pending_tx_nexts, next_node);
752 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
753 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
757 session_wrk_update_time (session_worker_t *wrk, f64 now)
759 wrk->last_vlib_time = now;
760 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
763 void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
764 fifo_segment_t *session_main_get_evt_q_segment (void);
765 void session_node_enable_disable (u8 is_en);
766 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
768 session_t *session_alloc_for_connection (transport_connection_t * tc);
769 session_t *session_alloc_for_half_open (transport_connection_t *tc);
771 #endif /* __included_session_h__ */
774 * fd.io coding-style-patch-verification: ON
777 * eval: (c-set-style "gnu")