2 * Copyright (c) 2017 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/stream_session.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/queue.h>
25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
26 #define INVALID_INDEX ((u32)~0)
27 #define SESSION_PROXY_LISTENER_INDEX ((u32)~0 - 1)
28 #define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
30 /* TODO decide how much since we have pre-data as well */
31 #define MAX_HDRS_LEN 100 /* Max number of bytes for headers */
39 FIFO_EVENT_DISCONNECT,
40 FIFO_EVENT_BUILTIN_RX,
42 SESSION_CTRL_EVT_ACCEPTED,
43 SESSION_CTRL_EVT_ACCEPTED_REPLY,
44 SESSION_CTRL_EVT_CONNECTED,
45 SESSION_CTRL_EVT_CONNECTED_REPLY,
46 SESSION_CTRL_EVT_DISCONNECTED,
47 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
48 SESSION_CTRL_EVT_RESET,
49 SESSION_CTRL_EVT_RESET_REPLY
52 static inline const char *
53 fifo_event_type_str (session_evt_type_t et)
57 case FIFO_EVENT_APP_RX:
58 return "FIFO_EVENT_APP_RX";
59 case FIFO_EVENT_APP_TX:
60 return "FIFO_EVENT_APP_TX";
61 case FIFO_EVENT_DISCONNECT:
62 return "FIFO_EVENT_DISCONNECT";
63 case FIFO_EVENT_BUILTIN_RX:
64 return "FIFO_EVENT_BUILTIN_RX";
66 return "FIFO_EVENT_RPC";
68 return "UNKNOWN FIFO EVENT";
74 SESSION_MQ_IO_EVT_RING,
75 SESSION_MQ_CTRL_EVT_RING,
79 #define foreach_session_input_error \
80 _(NO_SESSION, "No session drops") \
81 _(NO_LISTENER, "No listener for dst port drops") \
82 _(ENQUEUED, "Packets pushed into rx fifo") \
83 _(NOT_READY, "Session not ready packets") \
84 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
85 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
86 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
87 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
88 _(NO_SPACE, "Couldn't allocate a fifo pair") \
89 _(SEG_CREATE, "Couldn't create a new segment")
93 #define _(sym,str) SESSION_ERROR_##sym,
94 foreach_session_input_error
103 } session_rpc_args_t;
105 typedef u64 session_handle_t;
115 session_handle_t session_handle;
116 session_rpc_args_t rpc_args;
122 } __clib_packed session_event_t;
125 #define SESSION_MSG_NULL { }
127 typedef struct session_dgram_pre_hdr_
131 } session_dgram_pre_hdr_t;
134 typedef CLIB_PACKED (struct session_dgram_header_
138 ip46_address_t rmt_ip;
139 ip46_address_t lcl_ip;
143 }) session_dgram_hdr_t;
146 #define SESSION_CONN_ID_LEN 37
147 #define SESSION_CONN_HDR_LEN 45
149 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
150 "session conn id wrong length");
152 typedef struct session_tx_context_
154 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
156 transport_proto_vft_t *transport_vft;
157 transport_connection_t *tc;
164 u16 deq_per_first_buf;
169 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
170 session_dgram_hdr_t hdr;
171 } session_tx_context_t;
173 /* Forward definition */
174 typedef struct _session_manager_main session_manager_main_t;
177 (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
178 session_event_t * e0, stream_session_t * s0,
181 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
182 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
183 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
185 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
187 struct _session_manager_main
189 /** Per worker thread session pools */
190 stream_session_t **sessions;
192 /** Per worker-thread session pool peekers rw locks */
193 clib_rwlock_t *peekers_rw_locks;
195 /** Per-proto, per-worker enqueue epoch counters */
196 u32 *current_enqueue_epoch[TRANSPORT_N_PROTO];
198 /** Per-proto, per-worker thread vector of sessions to enqueue */
199 u32 **session_to_enqueue[TRANSPORT_N_PROTO];
201 /** per-worker tx buffer free lists */
204 /** Per worker-thread vector of partially read events */
205 session_event_t **free_event_vector;
207 /** per-worker active event vectors */
208 session_event_t **pending_event_vector;
210 /** per-worker postponed disconnects */
211 session_event_t **pending_disconnects;
213 /** per-worker session context */
214 session_tx_context_t *ctx;
216 /** vpp fifo event queue */
217 svm_msg_q_t **vpp_event_queues;
219 /** Event queues memfd segment initialized only if so configured */
220 ssvm_private_t evt_qs_segment;
222 /** Unique segment name counter */
223 u32 unique_segment_name_counter;
225 /** Per transport rx function that can either dequeue or peek */
226 session_fifo_rx_fn **session_tx_fns;
228 /** Per session type output nodes. Could optimize to group nodes by
229 * fib but lookup would then require session type parsing in session node.
230 * Trade memory for speed, for now */
231 u32 *session_type_to_next;
233 /** Session manager is enabled */
236 /** vpp fifo event queue configured length */
237 u32 configured_event_queue_length;
243 /** Session ssvm segment configs*/
244 uword session_baseva;
245 uword session_va_space_size;
246 u32 evt_qs_segment_size;
247 u8 evt_qs_use_memfd_seg;
249 /** Session table size parameters */
250 u32 configured_v4_session_table_buckets;
251 u32 configured_v4_session_table_memory;
252 u32 configured_v4_halfopen_table_buckets;
253 u32 configured_v4_halfopen_table_memory;
254 u32 configured_v6_session_table_buckets;
255 u32 configured_v6_session_table_memory;
256 u32 configured_v6_halfopen_table_buckets;
257 u32 configured_v6_halfopen_table_memory;
259 /** Transport table (preallocation) size parameters */
260 u32 local_endpoints_table_memory;
261 u32 local_endpoints_table_buckets;
263 /** Preallocate session config parameter */
264 u32 preallocated_sessions;
268 * last event poll time by thread
269 * Debug only. Will cause false cache-line sharing as-is
271 f64 *last_event_poll_by_thread;
276 extern session_manager_main_t session_manager_main;
277 extern vlib_node_registration_t session_queue_node;
278 extern vlib_node_registration_t session_queue_process_node;
280 #define SESSION_Q_PROCESS_FLUSH_FRAMES 1
281 #define SESSION_Q_PROCESS_STOP 2
284 * Session manager function
286 always_inline session_manager_main_t *
287 vnet_get_session_manager_main ()
289 return &session_manager_main;
293 stream_session_is_valid (u32 si, u8 thread_index)
296 s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
297 if (s->thread_index != thread_index || s->session_index != si
298 /* || s->server_rx_fifo->master_session_index != si
299 || s->server_tx_fifo->master_session_index != si
300 || s->server_rx_fifo->master_thread_index != thread_index
301 || s->server_tx_fifo->master_thread_index != thread_index */ )
306 stream_session_t *session_alloc (u32 thread_index);
307 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
308 void session_free (stream_session_t * s);
310 always_inline stream_session_t *
311 session_get (u32 si, u32 thread_index)
313 ASSERT (stream_session_is_valid (si, thread_index));
314 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
317 always_inline stream_session_t *
318 session_get_if_valid (u64 si, u32 thread_index)
320 if (thread_index >= vec_len (session_manager_main.sessions))
323 if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
326 ASSERT (stream_session_is_valid (si, thread_index));
327 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
330 always_inline session_handle_t
331 session_handle (stream_session_t * s)
333 return ((u64) s->thread_index << 32) | (u64) s->session_index;
337 session_index_from_handle (session_handle_t handle)
339 return handle & 0xFFFFFFFF;
343 session_thread_from_handle (session_handle_t handle)
349 session_parse_handle (session_handle_t handle, u32 * index,
352 *index = session_index_from_handle (handle);
353 *thread_index = session_thread_from_handle (handle);
356 always_inline stream_session_t *
357 session_get_from_handle (session_handle_t handle)
359 session_manager_main_t *smm = &session_manager_main;
360 u32 session_index, thread_index;
361 session_parse_handle (handle, &session_index, &thread_index);
362 return pool_elt_at_index (smm->sessions[thread_index], session_index);
365 always_inline stream_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);
374 session_handle_is_local (session_handle_t handle)
376 if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
381 always_inline transport_proto_t
382 session_type_transport_proto (session_type_t st)
388 session_type_is_ip4 (session_type_t st)
393 always_inline transport_proto_t
394 session_get_transport_proto (stream_session_t * s)
396 return (s->session_type >> 1);
399 always_inline fib_protocol_t
400 session_get_fib_proto (stream_session_t * s)
402 u8 is_ip4 = s->session_type & 1;
403 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
406 always_inline session_type_t
407 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
409 return (proto << 1 | is_ip4);
413 session_has_transport (stream_session_t * s)
415 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
418 transport_service_type_t session_transport_service_type (stream_session_t *);
419 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
420 u8 session_tx_is_dgram (stream_session_t * s);
423 * Acquires a lock that blocks a session pool from expanding.
425 * This is typically used for safely peeking into other threads'
426 * pools in order to clone elements. Lock should be dropped as soon
427 * as possible by calling @ref session_pool_remove_peeker.
429 * NOTE: Avoid using pool_elt_at_index while the lock is held because
430 * it may lead to free elt bitmap expansion/contraction!
433 session_pool_add_peeker (u32 thread_index)
435 session_manager_main_t *smm = &session_manager_main;
436 if (thread_index == vlib_get_thread_index ())
438 clib_rwlock_reader_lock (&smm->peekers_rw_locks[thread_index]);
442 session_pool_remove_peeker (u32 thread_index)
444 session_manager_main_t *smm = &session_manager_main;
445 if (thread_index == vlib_get_thread_index ())
447 clib_rwlock_reader_unlock (&smm->peekers_rw_locks[thread_index]);
451 * Get session from handle and 'lock' pool resize if not in same thread
453 * Caller should drop the peek 'lock' as soon as possible.
455 always_inline stream_session_t *
456 session_get_from_handle_safe (u64 handle)
458 session_manager_main_t *smm = &session_manager_main;
459 u32 thread_index = session_thread_from_handle (handle);
460 if (thread_index == vlib_get_thread_index ())
462 return pool_elt_at_index (smm->sessions[thread_index],
463 session_index_from_handle (handle));
467 session_pool_add_peeker (thread_index);
468 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
469 return smm->sessions[thread_index] + session_index_from_handle (handle);
474 transport_max_rx_enqueue (transport_connection_t * tc)
476 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
477 return svm_fifo_max_enqueue (s->server_rx_fifo);
481 transport_rx_fifo_size (transport_connection_t * tc)
483 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
484 return s->server_rx_fifo->nitems;
488 transport_tx_fifo_size (transport_connection_t * tc)
490 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
491 return s->server_tx_fifo->nitems;
495 session_get_index (stream_session_t * s)
497 return (s - session_manager_main.sessions[s->thread_index]);
500 always_inline stream_session_t *
501 session_clone_safe (u32 session_index, u32 thread_index)
503 stream_session_t *old_s, *new_s;
504 u32 current_thread_index = vlib_get_thread_index ();
506 /* If during the memcpy pool is reallocated AND the memory allocator
507 * decides to give the old chunk of memory to somebody in a hurry to
508 * scribble something on it, we have a problem. So add this thread as
509 * a session pool peeker.
511 session_pool_add_peeker (thread_index);
512 new_s = session_alloc (current_thread_index);
513 old_s = session_manager_main.sessions[thread_index] + session_index;
514 clib_memcpy (new_s, old_s, sizeof (*new_s));
515 session_pool_remove_peeker (thread_index);
516 new_s->thread_index = current_thread_index;
517 new_s->session_index = session_get_index (new_s);
521 transport_connection_t *session_get_transport (stream_session_t * s);
523 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
526 session_enqueue_stream_connection (transport_connection_t * tc,
527 vlib_buffer_t * b, u32 offset,
528 u8 queue_event, u8 is_in_order);
529 int session_enqueue_dgram_connection (stream_session_t * s,
530 session_dgram_hdr_t * hdr,
531 vlib_buffer_t * b, u8 proto,
533 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
534 u32 offset, u32 max_bytes);
535 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
537 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
538 int session_dgram_connect_notify (transport_connection_t * tc,
539 u32 old_thread_index,
540 stream_session_t ** new_session);
541 int session_dequeue_notify (stream_session_t * s);
542 void stream_session_init_fifos_pointers (transport_connection_t * tc,
543 u32 rx_pointer, u32 tx_pointer);
545 void stream_session_accept_notify (transport_connection_t * tc);
546 void stream_session_disconnect_notify (transport_connection_t * tc);
547 void stream_session_delete_notify (transport_connection_t * tc);
548 void stream_session_reset_notify (transport_connection_t * tc);
549 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
551 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
552 int stream_session_listen (stream_session_t * s, session_endpoint_t * tep);
553 int stream_session_stop_listen (stream_session_t * s);
554 void stream_session_disconnect (stream_session_t * s);
555 void stream_session_disconnect_transport (stream_session_t * s);
556 void stream_session_cleanup (stream_session_t * s);
557 int session_send_io_evt_to_thread (svm_fifo_t * f,
558 session_evt_type_t evt_type);
559 int session_send_io_evt_to_thread_custom (svm_fifo_t * f, u32 thread_index,
560 session_evt_type_t evt_type);
561 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
563 ssvm_private_t *session_manager_get_evt_q_segment (void);
565 u8 *format_stream_session (u8 * s, va_list * args);
566 uword unformat_stream_session (unformat_input_t * input, va_list * args);
567 uword unformat_transport_connection (unformat_input_t * input,
570 void session_register_transport (transport_proto_t transport_proto,
571 const transport_proto_vft_t * vft, u8 is_ip4,
574 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
576 always_inline svm_msg_q_t *
577 session_manager_get_vpp_event_queue (u32 thread_index)
579 return session_manager_main.vpp_event_queues[thread_index];
582 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
583 int session_manager_flush_all_enqueue_events (u8 transport_proto);
586 listen_session_get_handle (stream_session_t * s)
588 ASSERT (s->session_state == SESSION_STATE_LISTENING);
589 return session_handle (s);
592 always_inline stream_session_t *
593 listen_session_get_from_handle (session_handle_t handle)
595 return session_get_from_handle (handle);
599 listen_session_parse_handle (session_handle_t handle, u32 * index,
602 session_parse_handle (handle, index, thread_index);
605 always_inline stream_session_t *
606 listen_session_new (u8 thread_index, session_type_t type)
609 s = session_alloc (thread_index);
610 s->session_type = type;
611 s->session_state = SESSION_STATE_LISTENING;
615 always_inline stream_session_t *
616 listen_session_get (u32 index)
618 return session_get (index, 0);
622 listen_session_del (stream_session_t * s)
627 transport_connection_t *listen_session_get_transport (stream_session_t * s);
630 listen_session_get_local_session_endpoint (stream_session_t * listener,
631 session_endpoint_t * sep);
633 void session_flush_frames_main_thread (vlib_main_t * vm);
636 session_manager_is_enabled ()
638 return session_manager_main.is_enabled == 1;
641 #define session_cli_return_if_not_enabled() \
643 if (!session_manager_main.is_enabled) \
644 return clib_error_return(0, "session layer is not enabled"); \
647 void session_node_enable_disable (u8 is_en);
649 #endif /* __included_session_h__ */
652 * fd.io coding-style-patch-verification: ON
655 * eval: (c-set-style "gnu")