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 ((u8)~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,
41 FIFO_EVENT_BUILTIN_TX,
43 SESSION_CTRL_EVT_BOUND,
44 SESSION_CTRL_EVT_ACCEPTED,
45 SESSION_CTRL_EVT_ACCEPTED_REPLY,
46 SESSION_CTRL_EVT_CONNECTED,
47 SESSION_CTRL_EVT_CONNECTED_REPLY,
48 SESSION_CTRL_EVT_DISCONNECTED,
49 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
50 SESSION_CTRL_EVT_RESET,
51 SESSION_CTRL_EVT_RESET_REPLY
54 static inline const char *
55 fifo_event_type_str (session_evt_type_t et)
59 case FIFO_EVENT_APP_RX:
60 return "FIFO_EVENT_APP_RX";
61 case FIFO_EVENT_APP_TX:
62 return "FIFO_EVENT_APP_TX";
63 case FIFO_EVENT_DISCONNECT:
64 return "FIFO_EVENT_DISCONNECT";
65 case FIFO_EVENT_BUILTIN_RX:
66 return "FIFO_EVENT_BUILTIN_RX";
68 return "FIFO_EVENT_RPC";
70 return "UNKNOWN FIFO EVENT";
76 SESSION_MQ_IO_EVT_RING,
77 SESSION_MQ_CTRL_EVT_RING,
81 #define foreach_session_input_error \
82 _(NO_SESSION, "No session drops") \
83 _(NO_LISTENER, "No listener for dst port drops") \
84 _(ENQUEUED, "Packets pushed into rx fifo") \
85 _(NOT_READY, "Session not ready packets") \
86 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
87 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
88 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
89 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
90 _(NO_SPACE, "Couldn't allocate a fifo pair") \
91 _(SEG_CREATE, "Couldn't create a new segment")
95 #define _(sym,str) SESSION_ERROR_##sym,
96 foreach_session_input_error
105 } session_rpc_args_t;
107 typedef u64 session_handle_t;
117 session_handle_t session_handle;
118 session_rpc_args_t rpc_args;
124 } __clib_packed session_event_t;
127 #define SESSION_MSG_NULL { }
129 typedef struct session_dgram_pre_hdr_
133 } session_dgram_pre_hdr_t;
136 typedef CLIB_PACKED (struct session_dgram_header_
140 ip46_address_t rmt_ip;
141 ip46_address_t lcl_ip;
145 }) session_dgram_hdr_t;
148 #define SESSION_CONN_ID_LEN 37
149 #define SESSION_CONN_HDR_LEN 45
151 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
152 "session conn id wrong length");
154 typedef struct session_tx_context_
156 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
158 transport_proto_vft_t *transport_vft;
159 transport_connection_t *tc;
166 u16 deq_per_first_buf;
171 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
172 session_dgram_hdr_t hdr;
173 } session_tx_context_t;
175 /* Forward definition */
176 typedef struct _session_manager_main session_manager_main_t;
179 (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
180 session_event_t * e0, stream_session_t * s0,
183 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
184 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
185 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
187 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
189 typedef struct session_manager_worker_
191 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
193 /** Worker session pool */
194 stream_session_t *sessions;
196 /** vpp event message queue for worker */
197 svm_msg_q_t *vpp_event_queue;
199 /** Our approximation of a "complete" dispatch loop period */
202 /** vlib_time_now last time around the track */
205 /** Per-proto enqueue epoch counters */
206 u64 current_enqueue_epoch[TRANSPORT_N_PROTO];
208 /** Per-proto vector of sessions to enqueue */
209 u32 *session_to_enqueue[TRANSPORT_N_PROTO];
211 /** Context for session tx */
212 session_tx_context_t ctx;
214 /** Vector of tx buffer free lists */
217 /** Vector of partially read events */
218 session_event_t *free_event_vector;
220 /** Vector of active event vectors */
221 session_event_t *pending_event_vector;
223 /** Vector of postponed disconnects */
224 session_event_t *pending_disconnects;
226 /** Vector of postponed events */
227 session_event_t *postponed_event_vector;
229 /** Peekers rw lock */
230 clib_rwlock_t peekers_rw_locks;
232 } session_manager_worker_t;
234 struct _session_manager_main
236 /** Worker contexts */
237 session_manager_worker_t *wrk;
239 /** Event queues memfd segment initialized only if so configured */
240 ssvm_private_t evt_qs_segment;
242 /** Unique segment name counter */
243 u32 unique_segment_name_counter;
245 /** Per transport rx function that can either dequeue or peek */
246 session_fifo_rx_fn **session_tx_fns;
248 /** Per session type output nodes. Could optimize to group nodes by
249 * fib but lookup would then require session type parsing in session node.
250 * Trade memory for speed, for now */
251 u32 *session_type_to_next;
257 /** Session manager is enabled */
260 /** vpp fifo event queue configured length */
261 u32 configured_event_queue_length;
263 /** Session ssvm segment configs*/
264 uword session_baseva;
265 uword session_va_space_size;
266 u32 evt_qs_segment_size;
267 u8 evt_qs_use_memfd_seg;
269 /** Session table size parameters */
270 u32 configured_v4_session_table_buckets;
271 u32 configured_v4_session_table_memory;
272 u32 configured_v4_halfopen_table_buckets;
273 u32 configured_v4_halfopen_table_memory;
274 u32 configured_v6_session_table_buckets;
275 u32 configured_v6_session_table_memory;
276 u32 configured_v6_halfopen_table_buckets;
277 u32 configured_v6_halfopen_table_memory;
279 /** Transport table (preallocation) size parameters */
280 u32 local_endpoints_table_memory;
281 u32 local_endpoints_table_buckets;
283 /** Preallocate session config parameter */
284 u32 preallocated_sessions;
288 * last event poll time by thread
289 * Debug only. Will cause false cache-line sharing as-is
291 f64 *last_event_poll_by_thread;
296 extern session_manager_main_t session_manager_main;
297 extern vlib_node_registration_t session_queue_node;
298 extern vlib_node_registration_t session_queue_process_node;
300 #define SESSION_Q_PROCESS_FLUSH_FRAMES 1
301 #define SESSION_Q_PROCESS_STOP 2
304 * Session manager function
306 always_inline session_manager_main_t *
307 vnet_get_session_manager_main ()
309 return &session_manager_main;
312 always_inline session_manager_worker_t *
313 session_manager_get_worker (u32 thread_index)
315 return &session_manager_main.wrk[thread_index];
319 stream_session_is_valid (u32 si, u8 thread_index)
322 s = pool_elt_at_index (session_manager_main.wrk[thread_index].sessions, si);
323 if (s->thread_index != thread_index || s->session_index != si
324 /* || s->server_rx_fifo->master_session_index != si
325 || s->server_tx_fifo->master_session_index != si
326 || s->server_rx_fifo->master_thread_index != thread_index
327 || s->server_tx_fifo->master_thread_index != thread_index */ )
332 stream_session_t *session_alloc (u32 thread_index);
333 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
334 void session_free (stream_session_t * s);
335 void session_free_w_fifos (stream_session_t * s);
337 always_inline stream_session_t *
338 session_get (u32 si, u32 thread_index)
340 ASSERT (stream_session_is_valid (si, thread_index));
341 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
345 always_inline stream_session_t *
346 session_get_if_valid (u64 si, u32 thread_index)
348 if (thread_index >= vec_len (session_manager_main.wrk))
351 if (pool_is_free_index (session_manager_main.wrk[thread_index].sessions,
355 ASSERT (stream_session_is_valid (si, thread_index));
356 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
360 always_inline session_handle_t
361 session_handle (stream_session_t * s)
363 return ((u64) s->thread_index << 32) | (u64) s->session_index;
367 session_index_from_handle (session_handle_t handle)
369 return handle & 0xFFFFFFFF;
373 session_thread_from_handle (session_handle_t handle)
379 session_parse_handle (session_handle_t handle, u32 * index,
382 *index = session_index_from_handle (handle);
383 *thread_index = session_thread_from_handle (handle);
386 always_inline stream_session_t *
387 session_get_from_handle (session_handle_t handle)
389 session_manager_main_t *smm = &session_manager_main;
390 u32 session_index, thread_index;
391 session_parse_handle (handle, &session_index, &thread_index);
392 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
395 always_inline stream_session_t *
396 session_get_from_handle_if_valid (session_handle_t handle)
398 u32 session_index, thread_index;
399 session_parse_handle (handle, &session_index, &thread_index);
400 return session_get_if_valid (session_index, thread_index);
404 session_handle_is_local (session_handle_t handle)
406 if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
411 always_inline transport_proto_t
412 session_type_transport_proto (session_type_t st)
418 session_type_is_ip4 (session_type_t st)
423 always_inline transport_proto_t
424 session_get_transport_proto (stream_session_t * s)
426 return (s->session_type >> 1);
429 always_inline fib_protocol_t
430 session_get_fib_proto (stream_session_t * s)
432 u8 is_ip4 = s->session_type & 1;
433 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
436 always_inline session_type_t
437 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
439 return (proto << 1 | is_ip4);
443 session_has_transport (stream_session_t * s)
445 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
448 transport_service_type_t session_transport_service_type (stream_session_t *);
449 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
450 u8 session_tx_is_dgram (stream_session_t * s);
453 * Acquires a lock that blocks a session pool from expanding.
455 * This is typically used for safely peeking into other threads'
456 * pools in order to clone elements. Lock should be dropped as soon
457 * as possible by calling @ref session_pool_remove_peeker.
459 * NOTE: Avoid using pool_elt_at_index while the lock is held because
460 * it may lead to free elt bitmap expansion/contraction!
463 session_pool_add_peeker (u32 thread_index)
465 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
466 if (thread_index == vlib_get_thread_index ())
468 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
472 session_pool_remove_peeker (u32 thread_index)
474 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
475 if (thread_index == vlib_get_thread_index ())
477 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
481 * Get session from handle and 'lock' pool resize if not in same thread
483 * Caller should drop the peek 'lock' as soon as possible.
485 always_inline stream_session_t *
486 session_get_from_handle_safe (u64 handle)
488 u32 thread_index = session_thread_from_handle (handle);
489 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
491 if (thread_index == vlib_get_thread_index ())
493 return pool_elt_at_index (wrk->sessions,
494 session_index_from_handle (handle));
498 session_pool_add_peeker (thread_index);
499 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
500 return wrk->sessions + session_index_from_handle (handle);
505 transport_max_rx_enqueue (transport_connection_t * tc)
507 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
508 return svm_fifo_max_enqueue (s->server_rx_fifo);
512 transport_rx_fifo_size (transport_connection_t * tc)
514 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
515 return s->server_rx_fifo->nitems;
519 transport_tx_fifo_size (transport_connection_t * tc)
521 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
522 return s->server_tx_fifo->nitems;
526 transport_dispatch_period (u32 thread_index)
528 return session_manager_main.wrk[thread_index].dispatch_period;
532 transport_time_now (u32 thread_index)
534 return session_manager_main.wrk[thread_index].last_vlib_time;
538 session_get_index (stream_session_t * s)
540 return (s - session_manager_main.wrk[s->thread_index].sessions);
543 always_inline stream_session_t *
544 session_clone_safe (u32 session_index, u32 thread_index)
546 stream_session_t *old_s, *new_s;
547 u32 current_thread_index = vlib_get_thread_index ();
549 /* If during the memcpy pool is reallocated AND the memory allocator
550 * decides to give the old chunk of memory to somebody in a hurry to
551 * scribble something on it, we have a problem. So add this thread as
552 * a session pool peeker.
554 session_pool_add_peeker (thread_index);
555 new_s = session_alloc (current_thread_index);
556 old_s = session_manager_main.wrk[thread_index].sessions + session_index;
557 clib_memcpy (new_s, old_s, sizeof (*new_s));
558 session_pool_remove_peeker (thread_index);
559 new_s->thread_index = current_thread_index;
560 new_s->session_index = session_get_index (new_s);
564 transport_connection_t *session_get_transport (stream_session_t * s);
566 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
569 session_enqueue_stream_connection (transport_connection_t * tc,
570 vlib_buffer_t * b, u32 offset,
571 u8 queue_event, u8 is_in_order);
572 int session_enqueue_dgram_connection (stream_session_t * s,
573 session_dgram_hdr_t * hdr,
574 vlib_buffer_t * b, u8 proto,
576 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
577 u32 offset, u32 max_bytes);
578 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
580 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
581 int session_dgram_connect_notify (transport_connection_t * tc,
582 u32 old_thread_index,
583 stream_session_t ** new_session);
584 int session_dequeue_notify (stream_session_t * s);
585 void stream_session_init_fifos_pointers (transport_connection_t * tc,
586 u32 rx_pointer, u32 tx_pointer);
588 void stream_session_accept_notify (transport_connection_t * tc);
589 void stream_session_disconnect_notify (transport_connection_t * tc);
590 void stream_session_delete_notify (transport_connection_t * tc);
591 void stream_session_reset_notify (transport_connection_t * tc);
592 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
594 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
595 int session_listen (stream_session_t * s, session_endpoint_cfg_t * sep);
596 int session_stop_listen (stream_session_t * s);
597 void stream_session_disconnect (stream_session_t * s);
598 void stream_session_disconnect_transport (stream_session_t * s);
599 void stream_session_cleanup (stream_session_t * s);
600 int session_send_io_evt_to_thread (svm_fifo_t * f,
601 session_evt_type_t evt_type);
602 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
603 session_evt_type_t evt_type);
604 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
607 ssvm_private_t *session_manager_get_evt_q_segment (void);
609 u8 *format_stream_session (u8 * s, va_list * args);
610 uword unformat_stream_session (unformat_input_t * input, va_list * args);
611 uword unformat_transport_connection (unformat_input_t * input,
614 void session_register_transport (transport_proto_t transport_proto,
615 const transport_proto_vft_t * vft, u8 is_ip4,
619 transport_add_tx_event (transport_connection_t * tc)
621 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
622 if (svm_fifo_has_event (s->server_tx_fifo))
624 session_send_io_evt_to_thread (s->server_tx_fifo, FIFO_EVENT_APP_TX);
627 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
629 always_inline svm_msg_q_t *
630 session_manager_get_vpp_event_queue (u32 thread_index)
632 return session_manager_main.wrk[thread_index].vpp_event_queue;
635 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
636 int session_manager_flush_all_enqueue_events (u8 transport_proto);
639 listen_session_get_handle (stream_session_t * s)
641 ASSERT (s->session_state == SESSION_STATE_LISTENING);
642 return session_handle (s);
645 always_inline stream_session_t *
646 listen_session_get_from_handle (session_handle_t handle)
648 return session_get_from_handle (handle);
652 listen_session_parse_handle (session_handle_t handle, u32 * index,
655 session_parse_handle (handle, index, thread_index);
658 always_inline stream_session_t *
659 listen_session_new (u8 thread_index, session_type_t type)
662 s = session_alloc (thread_index);
663 s->session_type = type;
664 s->session_state = SESSION_STATE_LISTENING;
668 always_inline stream_session_t *
669 listen_session_get (u32 index)
671 return session_get (index, 0);
675 listen_session_del (stream_session_t * s)
680 transport_connection_t *listen_session_get_transport (stream_session_t * s);
683 listen_session_get_local_session_endpoint (stream_session_t * listener,
684 session_endpoint_t * sep);
686 void session_flush_frames_main_thread (vlib_main_t * vm);
689 session_manager_is_enabled ()
691 return session_manager_main.is_enabled == 1;
694 #define session_cli_return_if_not_enabled() \
696 if (!session_manager_main.is_enabled) \
697 return clib_error_return(0, "session layer is not enabled"); \
700 void session_node_enable_disable (u8 is_en);
702 #endif /* __included_session_h__ */
705 * fd.io coding-style-patch-verification: ON
708 * eval: (c-set-style "gnu")