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 <vnet/session/session_types.h>
19 #include <vnet/session/session_lookup.h>
20 #include <vnet/session/transport_interface.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/segment_manager.h>
23 #include <svm/message_queue.h>
25 #define SESSION_PROXY_LISTENER_INDEX ((u8)~0 - 1)
26 #define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
28 /* TODO decide how much since we have pre-data as well */
29 #define MAX_HDRS_LEN 100 /* Max number of bytes for headers */
37 SESSION_IO_EVT_TX_FLUSH,
38 FIFO_EVENT_DISCONNECT,
39 FIFO_EVENT_BUILTIN_RX,
40 FIFO_EVENT_BUILTIN_TX,
42 SESSION_CTRL_EVT_BOUND,
43 SESSION_CTRL_EVT_ACCEPTED,
44 SESSION_CTRL_EVT_ACCEPTED_REPLY,
45 SESSION_CTRL_EVT_CONNECTED,
46 SESSION_CTRL_EVT_CONNECTED_REPLY,
47 SESSION_CTRL_EVT_DISCONNECTED,
48 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
49 SESSION_CTRL_EVT_RESET,
50 SESSION_CTRL_EVT_RESET_REPLY,
51 SESSION_CTRL_EVT_REQ_WORKER_UPDATE,
52 SESSION_CTRL_EVT_WORKER_UPDATE,
53 SESSION_CTRL_EVT_WORKER_UPDATE_REPLY,
56 static inline const char *
57 fifo_event_type_str (session_evt_type_t et)
61 case FIFO_EVENT_APP_RX:
62 return "FIFO_EVENT_APP_RX";
63 case FIFO_EVENT_APP_TX:
64 return "FIFO_EVENT_APP_TX";
65 case FIFO_EVENT_DISCONNECT:
66 return "FIFO_EVENT_DISCONNECT";
67 case FIFO_EVENT_BUILTIN_RX:
68 return "FIFO_EVENT_BUILTIN_RX";
70 return "FIFO_EVENT_RPC";
72 return "UNKNOWN FIFO EVENT";
78 SESSION_MQ_IO_EVT_RING,
79 SESSION_MQ_CTRL_EVT_RING,
83 #define foreach_session_input_error \
84 _(NO_SESSION, "No session drops") \
85 _(NO_LISTENER, "No listener for dst port drops") \
86 _(ENQUEUED, "Packets pushed into rx fifo") \
87 _(NOT_READY, "Session not ready packets") \
88 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
89 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
90 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
91 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
92 _(NO_SPACE, "Couldn't allocate a fifo pair") \
93 _(SEG_CREATE, "Couldn't create a new segment")
97 #define _(sym,str) SESSION_ERROR_##sym,
98 foreach_session_input_error
107 } session_rpc_args_t;
109 typedef u64 session_handle_t;
119 session_handle_t session_handle;
120 session_rpc_args_t rpc_args;
126 } __clib_packed session_event_t;
129 #define SESSION_MSG_NULL { }
131 typedef struct session_dgram_pre_hdr_
135 } session_dgram_pre_hdr_t;
138 typedef CLIB_PACKED (struct session_dgram_header_
142 ip46_address_t rmt_ip;
143 ip46_address_t lcl_ip;
147 }) session_dgram_hdr_t;
150 #define SESSION_CONN_ID_LEN 37
151 #define SESSION_CONN_HDR_LEN 45
153 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
154 "session conn id wrong length");
156 typedef struct session_tx_context_
158 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
160 transport_proto_vft_t *transport_vft;
161 transport_connection_t *tc;
168 u16 deq_per_first_buf;
173 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
174 session_dgram_hdr_t hdr;
175 } session_tx_context_t;
177 typedef struct session_manager_worker_
179 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
181 /** Worker session pool */
184 /** vpp event message queue for worker */
185 svm_msg_q_t *vpp_event_queue;
187 /** Our approximation of a "complete" dispatch loop period */
190 /** vlib_time_now last time around the track */
193 /** Per-proto enqueue epoch counters */
194 u64 current_enqueue_epoch[TRANSPORT_N_PROTO];
196 /** Per-proto vector of sessions to enqueue */
197 u32 *session_to_enqueue[TRANSPORT_N_PROTO];
199 /** Context for session tx */
200 session_tx_context_t ctx;
202 /** Vector of tx buffer free lists */
205 /** Vector of partially read events */
206 session_event_t *free_event_vector;
208 /** Vector of active event vectors */
209 session_event_t *pending_event_vector;
211 /** Vector of postponed disconnects */
212 session_event_t *pending_disconnects;
214 /** Vector of postponed events */
215 session_event_t *postponed_event_vector;
217 /** Peekers rw lock */
218 clib_rwlock_t peekers_rw_locks;
222 } session_manager_worker_t;
224 typedef int (session_fifo_rx_fn) (vlib_main_t * vm,
225 vlib_node_runtime_t * node,
226 session_manager_worker_t * wrk,
227 session_event_t * e, int *n_tx_pkts);
229 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
230 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
231 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
233 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
235 typedef struct session_manager_main_
237 /** Worker contexts */
238 session_manager_worker_t *wrk;
240 /** Event queues memfd segment initialized only if so configured */
241 ssvm_private_t evt_qs_segment;
243 /** Unique segment name counter */
244 u32 unique_segment_name_counter;
246 /** Per transport rx function that can either dequeue or peek */
247 session_fifo_rx_fn **session_tx_fns;
249 /** Per session type output nodes. Could optimize to group nodes by
250 * fib but lookup would then require session type parsing in session node.
251 * Trade memory for speed, for now */
252 u32 *session_type_to_next;
258 /** Session manager is enabled */
261 /** vpp fifo event queue configured length */
262 u32 configured_event_queue_length;
264 /** Session ssvm segment configs*/
265 uword session_baseva;
266 uword session_va_space_size;
267 u32 evt_qs_segment_size;
268 u8 evt_qs_use_memfd_seg;
270 /** Session table size parameters */
271 u32 configured_v4_session_table_buckets;
272 u32 configured_v4_session_table_memory;
273 u32 configured_v4_halfopen_table_buckets;
274 u32 configured_v4_halfopen_table_memory;
275 u32 configured_v6_session_table_buckets;
276 u32 configured_v6_session_table_memory;
277 u32 configured_v6_halfopen_table_buckets;
278 u32 configured_v6_halfopen_table_memory;
280 /** Transport table (preallocation) size parameters */
281 u32 local_endpoints_table_memory;
282 u32 local_endpoints_table_buckets;
284 /** Preallocate session config parameter */
285 u32 preallocated_sessions;
289 * last event poll time by thread
290 * Debug only. Will cause false cache-line sharing as-is
292 f64 *last_event_poll_by_thread;
295 } session_manager_main_t;
297 extern session_manager_main_t session_manager_main;
298 extern vlib_node_registration_t session_queue_node;
299 extern vlib_node_registration_t session_queue_process_node;
301 #define SESSION_Q_PROCESS_FLUSH_FRAMES 1
302 #define SESSION_Q_PROCESS_STOP 2
305 * Session manager function
307 always_inline session_manager_main_t *
308 vnet_get_session_manager_main ()
310 return &session_manager_main;
313 always_inline session_manager_worker_t *
314 session_manager_get_worker (u32 thread_index)
316 return &session_manager_main.wrk[thread_index];
320 stream_session_is_valid (u32 si, u8 thread_index)
323 s = pool_elt_at_index (session_manager_main.wrk[thread_index].sessions, si);
324 if (s->thread_index != thread_index || s->session_index != si
325 /* || s->server_rx_fifo->master_session_index != si
326 || s->server_tx_fifo->master_session_index != si
327 || s->server_rx_fifo->master_thread_index != thread_index
328 || s->server_tx_fifo->master_thread_index != thread_index */ )
333 session_t *session_alloc (u32 thread_index);
334 int session_alloc_fifos (segment_manager_t * sm, session_t * s);
335 void session_free (session_t * s);
336 void session_free_w_fifos (session_t * s);
338 always_inline session_t *
339 session_get (u32 si, u32 thread_index)
341 ASSERT (stream_session_is_valid (si, thread_index));
342 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
346 always_inline session_t *
347 session_get_if_valid (u64 si, u32 thread_index)
349 if (thread_index >= vec_len (session_manager_main.wrk))
352 if (pool_is_free_index (session_manager_main.wrk[thread_index].sessions,
356 ASSERT (stream_session_is_valid (si, thread_index));
357 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
361 always_inline session_handle_t
362 session_handle (session_t * s)
364 return ((u64) s->thread_index << 32) | (u64) s->session_index;
368 session_index_from_handle (session_handle_t handle)
370 return handle & 0xFFFFFFFF;
374 session_thread_from_handle (session_handle_t handle)
380 session_parse_handle (session_handle_t handle, u32 * index,
383 *index = session_index_from_handle (handle);
384 *thread_index = session_thread_from_handle (handle);
387 always_inline session_t *
388 session_get_from_handle (session_handle_t handle)
390 session_manager_main_t *smm = &session_manager_main;
391 u32 session_index, thread_index;
392 session_parse_handle (handle, &session_index, &thread_index);
393 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
396 always_inline session_t *
397 session_get_from_handle_if_valid (session_handle_t handle)
399 u32 session_index, thread_index;
400 session_parse_handle (handle, &session_index, &thread_index);
401 return session_get_if_valid (session_index, thread_index);
405 session_handle_is_local (session_handle_t handle)
407 if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
412 always_inline transport_proto_t
413 session_type_transport_proto (session_type_t st)
419 session_type_is_ip4 (session_type_t st)
424 always_inline transport_proto_t
425 session_get_transport_proto (session_t * s)
427 return (s->session_type >> 1);
430 always_inline fib_protocol_t
431 session_get_fib_proto (session_t * s)
433 u8 is_ip4 = s->session_type & 1;
434 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
437 always_inline session_type_t
438 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
440 return (proto << 1 | is_ip4);
444 session_segment_handle (session_t * s)
448 if (s->session_state == SESSION_STATE_LISTENING)
449 return SESSION_INVALID_HANDLE;
452 return segment_manager_make_segment_handle (f->segment_manager,
457 session_has_transport (session_t * s)
459 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
462 transport_service_type_t session_transport_service_type (session_t *);
463 transport_tx_fn_type_t session_transport_tx_fn_type (session_t *);
464 u8 session_tx_is_dgram (session_t * s);
467 * Acquires a lock that blocks a session pool from expanding.
469 * This is typically used for safely peeking into other threads'
470 * pools in order to clone elements. Lock should be dropped as soon
471 * as possible by calling @ref session_pool_remove_peeker.
473 * NOTE: Avoid using pool_elt_at_index while the lock is held because
474 * it may lead to free elt bitmap expansion/contraction!
477 session_pool_add_peeker (u32 thread_index)
479 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
480 if (thread_index == vlib_get_thread_index ())
482 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
486 session_pool_remove_peeker (u32 thread_index)
488 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
489 if (thread_index == vlib_get_thread_index ())
491 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
495 * Get session from handle and 'lock' pool resize if not in same thread
497 * Caller should drop the peek 'lock' as soon as possible.
499 always_inline session_t *
500 session_get_from_handle_safe (u64 handle)
502 u32 thread_index = session_thread_from_handle (handle);
503 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
505 if (thread_index == vlib_get_thread_index ())
507 return pool_elt_at_index (wrk->sessions,
508 session_index_from_handle (handle));
512 session_pool_add_peeker (thread_index);
513 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
514 return wrk->sessions + session_index_from_handle (handle);
519 transport_max_rx_enqueue (transport_connection_t * tc)
521 session_t *s = session_get (tc->s_index, tc->thread_index);
522 return svm_fifo_max_enqueue (s->rx_fifo);
526 transport_max_tx_dequeue (transport_connection_t * tc)
528 session_t *s = session_get (tc->s_index, tc->thread_index);
529 return svm_fifo_max_dequeue (s->tx_fifo);
533 transport_rx_fifo_size (transport_connection_t * tc)
535 session_t *s = session_get (tc->s_index, tc->thread_index);
536 return s->rx_fifo->nitems;
540 transport_tx_fifo_size (transport_connection_t * tc)
542 session_t *s = session_get (tc->s_index, tc->thread_index);
543 return s->tx_fifo->nitems;
547 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
549 session_t *s = session_get (tc->c_index, tc->thread_index);
550 return svm_fifo_has_ooo_data (s->rx_fifo);
554 transport_dispatch_period (u32 thread_index)
556 return session_manager_main.wrk[thread_index].dispatch_period;
560 transport_time_now (u32 thread_index)
562 return session_manager_main.wrk[thread_index].last_vlib_time;
566 session_get_index (session_t * s)
568 return (s - session_manager_main.wrk[s->thread_index].sessions);
571 always_inline session_t *
572 session_clone_safe (u32 session_index, u32 thread_index)
574 session_t *old_s, *new_s;
575 u32 current_thread_index = vlib_get_thread_index ();
577 /* If during the memcpy pool is reallocated AND the memory allocator
578 * decides to give the old chunk of memory to somebody in a hurry to
579 * scribble something on it, we have a problem. So add this thread as
580 * a session pool peeker.
582 session_pool_add_peeker (thread_index);
583 new_s = session_alloc (current_thread_index);
584 old_s = session_manager_main.wrk[thread_index].sessions + session_index;
585 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
586 session_pool_remove_peeker (thread_index);
587 new_s->thread_index = current_thread_index;
588 new_s->session_index = session_get_index (new_s);
592 transport_connection_t *session_get_transport (session_t * s);
594 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
597 session_enqueue_stream_connection (transport_connection_t * tc,
598 vlib_buffer_t * b, u32 offset,
599 u8 queue_event, u8 is_in_order);
600 int session_enqueue_dgram_connection (session_t * s,
601 session_dgram_hdr_t * hdr,
602 vlib_buffer_t * b, u8 proto,
604 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
605 u32 offset, u32 max_bytes);
606 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
608 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
609 int session_dgram_connect_notify (transport_connection_t * tc,
610 u32 old_thread_index,
611 session_t ** new_session);
612 int session_dequeue_notify (session_t * s);
613 void stream_session_init_fifos_pointers (transport_connection_t * tc,
614 u32 rx_pointer, u32 tx_pointer);
616 int stream_session_accept_notify (transport_connection_t * tc);
617 void session_transport_closing_notify (transport_connection_t * tc);
618 void session_transport_delete_notify (transport_connection_t * tc);
619 void session_transport_closed_notify (transport_connection_t * tc);
620 void session_transport_reset_notify (transport_connection_t * tc);
621 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
623 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
624 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
625 int session_stop_listen (session_t * s);
626 void session_close (session_t * s);
627 void session_transport_close (session_t * s);
628 void session_transport_cleanup (session_t * s);
629 int session_send_io_evt_to_thread (svm_fifo_t * f,
630 session_evt_type_t evt_type);
631 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
632 session_evt_type_t evt_type);
633 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
636 ssvm_private_t *session_manager_get_evt_q_segment (void);
638 u8 *format_stream_session (u8 * s, va_list * args);
639 uword unformat_stream_session (unformat_input_t * input, va_list * args);
640 uword unformat_transport_connection (unformat_input_t * input,
643 void session_register_transport (transport_proto_t transport_proto,
644 const transport_proto_vft_t * vft, u8 is_ip4,
648 transport_add_tx_event (transport_connection_t * tc)
650 session_t *s = session_get (tc->s_index, tc->thread_index);
651 if (svm_fifo_has_event (s->tx_fifo))
653 session_send_io_evt_to_thread (s->tx_fifo, FIFO_EVENT_APP_TX);
656 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
658 always_inline svm_msg_q_t *
659 session_manager_get_vpp_event_queue (u32 thread_index)
661 return session_manager_main.wrk[thread_index].vpp_event_queue;
664 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
665 int session_manager_flush_all_enqueue_events (u8 transport_proto);
668 listen_session_get_handle (session_t * s)
670 ASSERT (s->session_state == SESSION_STATE_LISTENING);
671 return session_handle (s);
674 always_inline session_t *
675 listen_session_get_from_handle (session_handle_t handle)
677 return session_get_from_handle (handle);
681 listen_session_parse_handle (session_handle_t handle, u32 * index,
684 session_parse_handle (handle, index, thread_index);
687 always_inline session_t *
688 listen_session_new (u8 thread_index, session_type_t type)
691 s = session_alloc (thread_index);
692 s->session_type = type;
693 s->session_state = SESSION_STATE_LISTENING;
697 always_inline session_t *
698 listen_session_get (u32 index)
700 return session_get (index, 0);
704 listen_session_del (session_t * s)
709 transport_connection_t *listen_session_get_transport (session_t * s);
712 listen_session_get_local_session_endpoint (session_t * listener,
713 session_endpoint_t * sep);
715 void session_flush_frames_main_thread (vlib_main_t * vm);
718 session_manager_is_enabled ()
720 return session_manager_main.is_enabled == 1;
723 #define session_cli_return_if_not_enabled() \
725 if (!session_manager_main.is_enabled) \
726 return clib_error_return(0, "session layer is not enabled"); \
729 void session_node_enable_disable (u8 is_en);
731 #endif /* __included_session_h__ */
734 * fd.io coding-style-patch-verification: ON
737 * eval: (c-set-style "gnu")