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") \
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;
56 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
57 session_dgram_hdr_t hdr;
58 } session_tx_context_t;
60 typedef struct session_evt_elt
62 clib_llist_anchor_t evt_list;
66 typedef struct session_ctrl_evt_data_
68 u8 data[SESSION_CTRL_MSG_MAX_SIZE];
69 } session_evt_ctrl_data_t;
71 typedef struct session_worker_
73 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
75 /** Worker session pool */
78 /** vpp event message queue for worker */
79 svm_msg_q_t *vpp_event_queue;
81 /** vlib_time_now last time around the track */
82 clib_time_type_t last_vlib_time;
84 /** vlib_time_now rounded to us precision and as u64 */
85 clib_us_time_t last_vlib_us_time;
87 /** Convenience pointer to this worker's vlib_main */
90 /** Per-proto vector of sessions to enqueue */
91 u32 **session_to_enqueue;
93 /** Context for session tx */
94 session_tx_context_t ctx;
96 /** Vector of tx buffer free lists */
99 /** Pool of session event list elements */
100 session_evt_elt_t *event_elts;
102 /** Pool of ctrl events data buffers */
103 session_evt_ctrl_data_t *ctrl_evts_data;
105 /** Head of control events list */
106 clib_llist_index_t ctrl_head;
108 /** Head of list of elements */
109 clib_llist_index_t new_head;
111 /** Head of list of pending events */
112 clib_llist_index_t old_head;
114 /** Peekers rw lock */
115 clib_rwlock_t peekers_rw_locks;
117 /** Vector of buffers to be sent */
118 u32 *pending_tx_buffers;
120 /** Vector of nexts for the pending tx buffers */
121 u16 *pending_tx_nexts;
124 /** last event poll time by thread */
125 clib_time_type_t last_event_poll;
129 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
130 vlib_node_runtime_t * node,
131 session_evt_elt_t * e, int *n_tx_packets);
133 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
134 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
135 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
137 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
139 typedef struct session_main_
141 /** Worker contexts */
142 session_worker_t *wrk;
144 /** Event queues memfd segment initialized only if so configured */
145 ssvm_private_t evt_qs_segment;
147 /** Unique segment name counter */
148 u32 unique_segment_name_counter;
150 /** Per transport rx function that can either dequeue or peek */
151 session_fifo_rx_fn **session_tx_fns;
153 /** Per session type output nodes. Could optimize to group nodes by
154 * fib but lookup would then require session type parsing in session node.
155 * Trade memory for speed, for now */
156 u32 *session_type_to_next;
158 transport_proto_t last_transport_proto_type;
164 /** Session manager is enabled */
166 /** Enable session manager at startup */
167 u8 session_enable_asap;
169 /** vpp fifo event queue configured length */
170 u32 configured_event_queue_length;
172 /** Session ssvm segment configs*/
173 uword session_baseva;
174 uword session_va_space_size;
175 uword evt_qs_segment_size;
176 u8 evt_qs_use_memfd_seg;
178 /** Session table size parameters */
179 u32 configured_v4_session_table_buckets;
180 u32 configured_v4_session_table_memory;
181 u32 configured_v4_halfopen_table_buckets;
182 u32 configured_v4_halfopen_table_memory;
183 u32 configured_v6_session_table_buckets;
184 u32 configured_v6_session_table_memory;
185 u32 configured_v6_halfopen_table_buckets;
186 u32 configured_v6_halfopen_table_memory;
188 /** Transport table (preallocation) size parameters */
189 u32 local_endpoints_table_memory;
190 u32 local_endpoints_table_buckets;
192 /** Preallocate session config parameter */
193 u32 preallocated_sessions;
197 extern session_main_t session_main;
198 extern vlib_node_registration_t session_queue_node;
199 extern vlib_node_registration_t session_queue_process_node;
200 extern vlib_node_registration_t session_queue_pre_input_node;
202 typedef enum session_q_process_evt_
204 SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
205 SESSION_Q_PROCESS_STOP
206 } session_q_process_evt_t;
208 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
209 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
211 static inline session_evt_elt_t *
212 session_evt_elt_alloc (session_worker_t * wrk)
214 session_evt_elt_t *elt;
215 pool_get (wrk->event_elts, elt);
220 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
222 pool_put (wrk->event_elts, elt);
226 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
228 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
229 pool_elt_at_index (wrk->event_elts, wrk->old_head));
233 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
235 clib_llist_add (wrk->event_elts, evt_list, elt,
236 pool_elt_at_index (wrk->event_elts, wrk->old_head));
241 session_evt_ctrl_data_alloc (session_worker_t * wrk)
243 session_evt_ctrl_data_t *data;
244 pool_get (wrk->ctrl_evts_data, data);
245 return (data - wrk->ctrl_evts_data);
248 static inline session_evt_elt_t *
249 session_evt_alloc_ctrl (session_worker_t * wrk)
251 session_evt_elt_t *elt;
252 elt = session_evt_elt_alloc (wrk);
253 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
254 pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
259 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
261 return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
262 elt->evt.ctrl_data_index));
266 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
268 ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
269 pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
272 static inline session_evt_elt_t *
273 session_evt_alloc_new (session_worker_t * wrk)
275 session_evt_elt_t *elt;
276 elt = session_evt_elt_alloc (wrk);
277 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
278 pool_elt_at_index (wrk->event_elts, wrk->new_head));
282 static inline session_evt_elt_t *
283 session_evt_alloc_old (session_worker_t * wrk)
285 session_evt_elt_t *elt;
286 elt = session_evt_elt_alloc (wrk);
287 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
288 pool_elt_at_index (wrk->event_elts, wrk->old_head));
292 session_t *session_alloc (u32 thread_index);
293 void session_free (session_t * s);
294 void session_free_w_fifos (session_t * s);
295 u8 session_is_valid (u32 si, u8 thread_index);
297 always_inline session_t *
298 session_get (u32 si, u32 thread_index)
300 ASSERT (session_is_valid (si, thread_index));
301 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
304 always_inline session_t *
305 session_get_if_valid (u64 si, u32 thread_index)
307 if (thread_index >= vec_len (session_main.wrk))
310 if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
313 ASSERT (session_is_valid (si, thread_index));
314 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
317 always_inline session_t *
318 session_get_from_handle (session_handle_t handle)
320 session_main_t *smm = &session_main;
321 u32 session_index, thread_index;
322 session_parse_handle (handle, &session_index, &thread_index);
323 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
326 always_inline session_t *
327 session_get_from_handle_if_valid (session_handle_t handle)
329 u32 session_index, thread_index;
330 session_parse_handle (handle, &session_index, &thread_index);
331 return session_get_if_valid (session_index, thread_index);
334 u64 session_segment_handle (session_t * s);
337 * Acquires a lock that blocks a session pool from expanding.
339 * This is typically used for safely peeking into other threads'
340 * pools in order to clone elements. Lock should be dropped as soon
341 * as possible by calling @ref session_pool_remove_peeker.
343 * NOTE: Avoid using pool_elt_at_index while the lock is held because
344 * it may lead to free elt bitmap expansion/contraction!
347 session_pool_add_peeker (u32 thread_index)
349 session_worker_t *wrk = &session_main.wrk[thread_index];
350 if (thread_index == vlib_get_thread_index ())
352 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
356 session_pool_remove_peeker (u32 thread_index)
358 session_worker_t *wrk = &session_main.wrk[thread_index];
359 if (thread_index == vlib_get_thread_index ())
361 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
365 * Get session from handle and 'lock' pool resize if not in same thread
367 * Caller should drop the peek 'lock' as soon as possible.
369 always_inline session_t *
370 session_get_from_handle_safe (u64 handle)
372 u32 thread_index = session_thread_from_handle (handle);
373 session_worker_t *wrk = &session_main.wrk[thread_index];
375 if (thread_index == vlib_get_thread_index ())
377 return pool_elt_at_index (wrk->sessions,
378 session_index_from_handle (handle));
382 session_pool_add_peeker (thread_index);
383 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
384 return wrk->sessions + session_index_from_handle (handle);
389 session_get_index (session_t * s)
391 return (s - session_main.wrk[s->thread_index].sessions);
394 always_inline session_t *
395 session_clone_safe (u32 session_index, u32 thread_index)
397 session_t *old_s, *new_s;
398 u32 current_thread_index = vlib_get_thread_index ();
400 /* If during the memcpy pool is reallocated AND the memory allocator
401 * decides to give the old chunk of memory to somebody in a hurry to
402 * scribble something on it, we have a problem. So add this thread as
403 * a session pool peeker.
405 session_pool_add_peeker (thread_index);
406 new_s = session_alloc (current_thread_index);
407 old_s = session_main.wrk[thread_index].sessions + session_index;
408 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
409 session_pool_remove_peeker (thread_index);
410 new_s->thread_index = current_thread_index;
411 new_s->session_index = session_get_index (new_s);
415 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
416 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
417 int session_stop_listen (session_t * s);
418 void session_close (session_t * s);
419 void session_reset (session_t * s);
420 void session_transport_close (session_t * s);
421 void session_transport_reset (session_t * s);
422 void session_transport_cleanup (session_t * s);
423 int session_send_io_evt_to_thread (svm_fifo_t * f,
424 session_evt_type_t evt_type);
425 int session_enqueue_notify (session_t * s);
426 int session_dequeue_notify (session_t * s);
427 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
428 session_evt_type_t evt_type);
429 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
431 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
433 void session_add_self_custom_tx_evt (transport_connection_t * tc,
435 void sesssion_reschedule_tx (transport_connection_t * tc);
436 transport_connection_t *session_get_transport (session_t * s);
437 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
440 u8 *format_session (u8 * s, va_list * args);
441 uword unformat_session (unformat_input_t * input, va_list * args);
442 uword unformat_transport_connection (unformat_input_t * input,
446 * Interface to transport protos
449 int session_enqueue_stream_connection (transport_connection_t * tc,
450 vlib_buffer_t * b, u32 offset,
451 u8 queue_event, u8 is_in_order);
452 int session_enqueue_dgram_connection (session_t * s,
453 session_dgram_hdr_t * hdr,
454 vlib_buffer_t * b, u8 proto,
456 int session_stream_connect_notify (transport_connection_t * tc,
457 session_error_t err);
458 int session_dgram_connect_notify (transport_connection_t * tc,
459 u32 old_thread_index,
460 session_t ** new_session);
461 int session_stream_accept_notify (transport_connection_t * tc);
462 void session_transport_closing_notify (transport_connection_t * tc);
463 void session_transport_delete_notify (transport_connection_t * tc);
464 void session_transport_closed_notify (transport_connection_t * tc);
465 void session_transport_reset_notify (transport_connection_t * tc);
466 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
467 u32 thread_index, u8 notify);
469 * Initialize session layer for given transport proto and ip version
471 * Allocates per session type (transport proto + ip version) data structures
472 * and adds arc from session queue node to session type output node.
474 * @param transport_proto transport proto to be registered
475 * @param vft virtual function table for transport
476 * @param is_ip4 flag that indicates if transports uses ipv4
477 * as underlying network layer
478 * @param output_node output node for transport
480 void session_register_transport (transport_proto_t transport_proto,
481 const transport_proto_vft_t * vft, u8 is_ip4,
483 transport_proto_t session_add_transport_proto (void);
484 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
485 u32 offset, u32 max_bytes);
486 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
489 transport_max_rx_enqueue (transport_connection_t * tc)
491 session_t *s = session_get (tc->s_index, tc->thread_index);
492 return svm_fifo_max_enqueue_prod (s->rx_fifo);
496 transport_max_tx_dequeue (transport_connection_t * tc)
498 session_t *s = session_get (tc->s_index, tc->thread_index);
499 return svm_fifo_max_dequeue_cons (s->tx_fifo);
503 transport_max_rx_dequeue (transport_connection_t * tc)
505 session_t *s = session_get (tc->s_index, tc->thread_index);
506 return svm_fifo_max_dequeue (s->rx_fifo);
510 transport_rx_fifo_size (transport_connection_t * tc)
512 session_t *s = session_get (tc->s_index, tc->thread_index);
513 return svm_fifo_size (s->rx_fifo);
517 transport_tx_fifo_size (transport_connection_t * tc)
519 session_t *s = session_get (tc->s_index, tc->thread_index);
520 return svm_fifo_size (s->tx_fifo);
524 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
526 session_t *s = session_get (tc->c_index, tc->thread_index);
527 return svm_fifo_has_ooo_data (s->rx_fifo);
530 always_inline clib_time_type_t
531 transport_time_now (u32 thread_index)
533 return session_main.wrk[thread_index].last_vlib_time;
536 always_inline clib_us_time_t
537 transport_us_time_now (u32 thread_index)
539 return session_main.wrk[thread_index].last_vlib_us_time;
543 transport_add_tx_event (transport_connection_t * tc)
545 session_t *s = session_get (tc->s_index, tc->thread_index);
546 if (svm_fifo_has_event (s->tx_fifo))
548 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
556 listen_session_get_handle (session_t * s)
558 ASSERT (s->session_state == SESSION_STATE_LISTENING ||
559 session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
560 return session_handle (s);
563 always_inline session_t *
564 listen_session_get_from_handle (session_handle_t handle)
566 return session_get_from_handle (handle);
570 listen_session_parse_handle (session_handle_t handle, u32 * index,
573 session_parse_handle (handle, index, thread_index);
576 always_inline session_t *
577 listen_session_alloc (u8 thread_index, session_type_t type)
580 s = session_alloc (thread_index);
581 s->session_type = type;
582 s->session_state = SESSION_STATE_LISTENING;
586 always_inline session_t *
587 listen_session_get (u32 ls_index)
589 return session_get (ls_index, 0);
593 listen_session_free (session_t * s)
595 ASSERT (!s->rx_fifo);
599 transport_connection_t *listen_session_get_transport (session_t * s);
602 * Session layer functions
605 always_inline session_main_t *
606 vnet_get_session_main ()
608 return &session_main;
611 always_inline session_worker_t *
612 session_main_get_worker (u32 thread_index)
614 return &session_main.wrk[thread_index];
617 static inline session_worker_t *
618 session_main_get_worker_if_valid (u32 thread_index)
620 if (thread_index > vec_len (session_main.wrk))
622 return &session_main.wrk[thread_index];
625 always_inline svm_msg_q_t *
626 session_main_get_vpp_event_queue (u32 thread_index)
628 return session_main.wrk[thread_index].vpp_event_queue;
632 session_main_is_enabled ()
634 return session_main.is_enabled == 1;
637 #define session_cli_return_if_not_enabled() \
639 if (!session_main.is_enabled) \
640 return clib_error_return (0, "session layer is not enabled"); \
643 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
644 int session_main_flush_all_enqueue_events (u8 transport_proto);
645 void session_queue_run_on_main_thread (vlib_main_t * vm);
648 * Add session node pending buffer with custom node
650 * @param thread_index worker thread expected to send the buffer
651 * @param bi buffer index
652 * @param next_node next node edge index for buffer. Edge to next node
656 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
658 session_worker_t *wrk = session_main_get_worker (thread_index);
659 vec_add1 (wrk->pending_tx_buffers, bi);
660 vec_add1 (wrk->pending_tx_nexts, next_node);
663 ssvm_private_t *session_main_get_evt_q_segment (void);
664 void session_node_enable_disable (u8 is_en);
665 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
667 session_t *session_alloc_for_connection (transport_connection_t * tc);
669 #endif /* __included_session_h__ */
672 * fd.io coding-style-patch-verification: ON
675 * eval: (c-set-style "gnu")