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 SESSION_IO_EVT_TX_FLUSH,
40 FIFO_EVENT_DISCONNECT,
41 FIFO_EVENT_BUILTIN_RX,
42 FIFO_EVENT_BUILTIN_TX,
44 SESSION_CTRL_EVT_BOUND,
45 SESSION_CTRL_EVT_ACCEPTED,
46 SESSION_CTRL_EVT_ACCEPTED_REPLY,
47 SESSION_CTRL_EVT_CONNECTED,
48 SESSION_CTRL_EVT_CONNECTED_REPLY,
49 SESSION_CTRL_EVT_DISCONNECTED,
50 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
51 SESSION_CTRL_EVT_RESET,
52 SESSION_CTRL_EVT_RESET_REPLY
55 static inline const char *
56 fifo_event_type_str (session_evt_type_t et)
60 case FIFO_EVENT_APP_RX:
61 return "FIFO_EVENT_APP_RX";
62 case FIFO_EVENT_APP_TX:
63 return "FIFO_EVENT_APP_TX";
64 case FIFO_EVENT_DISCONNECT:
65 return "FIFO_EVENT_DISCONNECT";
66 case FIFO_EVENT_BUILTIN_RX:
67 return "FIFO_EVENT_BUILTIN_RX";
69 return "FIFO_EVENT_RPC";
71 return "UNKNOWN FIFO EVENT";
77 SESSION_MQ_IO_EVT_RING,
78 SESSION_MQ_CTRL_EVT_RING,
82 #define foreach_session_input_error \
83 _(NO_SESSION, "No session drops") \
84 _(NO_LISTENER, "No listener for dst port drops") \
85 _(ENQUEUED, "Packets pushed into rx fifo") \
86 _(NOT_READY, "Session not ready packets") \
87 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
88 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
89 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
90 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
91 _(NO_SPACE, "Couldn't allocate a fifo pair") \
92 _(SEG_CREATE, "Couldn't create a new segment")
96 #define _(sym,str) SESSION_ERROR_##sym,
97 foreach_session_input_error
106 } session_rpc_args_t;
108 typedef u64 session_handle_t;
118 session_handle_t session_handle;
119 session_rpc_args_t rpc_args;
125 } __clib_packed session_event_t;
128 #define SESSION_MSG_NULL { }
130 typedef struct session_dgram_pre_hdr_
134 } session_dgram_pre_hdr_t;
137 typedef CLIB_PACKED (struct session_dgram_header_
141 ip46_address_t rmt_ip;
142 ip46_address_t lcl_ip;
146 }) session_dgram_hdr_t;
149 #define SESSION_CONN_ID_LEN 37
150 #define SESSION_CONN_HDR_LEN 45
152 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
153 "session conn id wrong length");
155 typedef struct session_tx_context_
157 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
159 transport_proto_vft_t *transport_vft;
160 transport_connection_t *tc;
167 u16 deq_per_first_buf;
172 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
173 session_dgram_hdr_t hdr;
174 } session_tx_context_t;
176 /* Forward definition */
177 typedef struct _session_manager_main session_manager_main_t;
180 (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
181 session_event_t * e0, stream_session_t * s0,
184 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
185 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
186 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
188 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
190 typedef struct session_manager_worker_
192 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
194 /** Worker session pool */
195 stream_session_t *sessions;
197 /** vpp event message queue for worker */
198 svm_msg_q_t *vpp_event_queue;
200 /** Our approximation of a "complete" dispatch loop period */
203 /** vlib_time_now last time around the track */
206 /** Per-proto enqueue epoch counters */
207 u64 current_enqueue_epoch[TRANSPORT_N_PROTO];
209 /** Per-proto vector of sessions to enqueue */
210 u32 *session_to_enqueue[TRANSPORT_N_PROTO];
212 /** Context for session tx */
213 session_tx_context_t ctx;
215 /** Vector of tx buffer free lists */
218 /** Vector of partially read events */
219 session_event_t *free_event_vector;
221 /** Vector of active event vectors */
222 session_event_t *pending_event_vector;
224 /** Vector of postponed disconnects */
225 session_event_t *pending_disconnects;
227 /** Vector of postponed events */
228 session_event_t *postponed_event_vector;
230 /** Peekers rw lock */
231 clib_rwlock_t peekers_rw_locks;
235 } session_manager_worker_t;
237 struct _session_manager_main
239 /** Worker contexts */
240 session_manager_worker_t *wrk;
242 /** Event queues memfd segment initialized only if so configured */
243 ssvm_private_t evt_qs_segment;
245 /** Unique segment name counter */
246 u32 unique_segment_name_counter;
248 /** Per transport rx function that can either dequeue or peek */
249 session_fifo_rx_fn **session_tx_fns;
251 /** Per session type output nodes. Could optimize to group nodes by
252 * fib but lookup would then require session type parsing in session node.
253 * Trade memory for speed, for now */
254 u32 *session_type_to_next;
260 /** Session manager is enabled */
263 /** vpp fifo event queue configured length */
264 u32 configured_event_queue_length;
266 /** Session ssvm segment configs*/
267 uword session_baseva;
268 uword session_va_space_size;
269 u32 evt_qs_segment_size;
270 u8 evt_qs_use_memfd_seg;
272 /** Session table size parameters */
273 u32 configured_v4_session_table_buckets;
274 u32 configured_v4_session_table_memory;
275 u32 configured_v4_halfopen_table_buckets;
276 u32 configured_v4_halfopen_table_memory;
277 u32 configured_v6_session_table_buckets;
278 u32 configured_v6_session_table_memory;
279 u32 configured_v6_halfopen_table_buckets;
280 u32 configured_v6_halfopen_table_memory;
282 /** Transport table (preallocation) size parameters */
283 u32 local_endpoints_table_memory;
284 u32 local_endpoints_table_buckets;
286 /** Preallocate session config parameter */
287 u32 preallocated_sessions;
291 * last event poll time by thread
292 * Debug only. Will cause false cache-line sharing as-is
294 f64 *last_event_poll_by_thread;
299 extern session_manager_main_t session_manager_main;
300 extern vlib_node_registration_t session_queue_node;
301 extern vlib_node_registration_t session_queue_process_node;
303 #define SESSION_Q_PROCESS_FLUSH_FRAMES 1
304 #define SESSION_Q_PROCESS_STOP 2
307 * Session manager function
309 always_inline session_manager_main_t *
310 vnet_get_session_manager_main ()
312 return &session_manager_main;
315 always_inline session_manager_worker_t *
316 session_manager_get_worker (u32 thread_index)
318 return &session_manager_main.wrk[thread_index];
322 stream_session_is_valid (u32 si, u8 thread_index)
325 s = pool_elt_at_index (session_manager_main.wrk[thread_index].sessions, si);
326 if (s->thread_index != thread_index || s->session_index != si
327 /* || s->server_rx_fifo->master_session_index != si
328 || s->server_tx_fifo->master_session_index != si
329 || s->server_rx_fifo->master_thread_index != thread_index
330 || s->server_tx_fifo->master_thread_index != thread_index */ )
335 stream_session_t *session_alloc (u32 thread_index);
336 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
337 void session_free (stream_session_t * s);
338 void session_free_w_fifos (stream_session_t * s);
340 always_inline stream_session_t *
341 session_get (u32 si, u32 thread_index)
343 ASSERT (stream_session_is_valid (si, thread_index));
344 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
348 always_inline stream_session_t *
349 session_get_if_valid (u64 si, u32 thread_index)
351 if (thread_index >= vec_len (session_manager_main.wrk))
354 if (pool_is_free_index (session_manager_main.wrk[thread_index].sessions,
358 ASSERT (stream_session_is_valid (si, thread_index));
359 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
363 always_inline session_handle_t
364 session_handle (stream_session_t * s)
366 return ((u64) s->thread_index << 32) | (u64) s->session_index;
370 session_index_from_handle (session_handle_t handle)
372 return handle & 0xFFFFFFFF;
376 session_thread_from_handle (session_handle_t handle)
382 session_parse_handle (session_handle_t handle, u32 * index,
385 *index = session_index_from_handle (handle);
386 *thread_index = session_thread_from_handle (handle);
389 always_inline stream_session_t *
390 session_get_from_handle (session_handle_t handle)
392 session_manager_main_t *smm = &session_manager_main;
393 u32 session_index, thread_index;
394 session_parse_handle (handle, &session_index, &thread_index);
395 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
398 always_inline stream_session_t *
399 session_get_from_handle_if_valid (session_handle_t handle)
401 u32 session_index, thread_index;
402 session_parse_handle (handle, &session_index, &thread_index);
403 return session_get_if_valid (session_index, thread_index);
407 session_handle_is_local (session_handle_t handle)
409 if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
414 always_inline transport_proto_t
415 session_type_transport_proto (session_type_t st)
421 session_type_is_ip4 (session_type_t st)
426 always_inline transport_proto_t
427 session_get_transport_proto (stream_session_t * s)
429 return (s->session_type >> 1);
432 always_inline fib_protocol_t
433 session_get_fib_proto (stream_session_t * s)
435 u8 is_ip4 = s->session_type & 1;
436 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
439 always_inline session_type_t
440 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
442 return (proto << 1 | is_ip4);
446 session_segment_handle (stream_session_t * s)
448 svm_fifo_t *f = s->server_rx_fifo;
449 return segment_manager_make_segment_handle (f->segment_manager,
454 session_has_transport (stream_session_t * s)
456 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
459 transport_service_type_t session_transport_service_type (stream_session_t *);
460 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
461 u8 session_tx_is_dgram (stream_session_t * s);
464 * Acquires a lock that blocks a session pool from expanding.
466 * This is typically used for safely peeking into other threads'
467 * pools in order to clone elements. Lock should be dropped as soon
468 * as possible by calling @ref session_pool_remove_peeker.
470 * NOTE: Avoid using pool_elt_at_index while the lock is held because
471 * it may lead to free elt bitmap expansion/contraction!
474 session_pool_add_peeker (u32 thread_index)
476 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
477 if (thread_index == vlib_get_thread_index ())
479 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
483 session_pool_remove_peeker (u32 thread_index)
485 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
486 if (thread_index == vlib_get_thread_index ())
488 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
492 * Get session from handle and 'lock' pool resize if not in same thread
494 * Caller should drop the peek 'lock' as soon as possible.
496 always_inline stream_session_t *
497 session_get_from_handle_safe (u64 handle)
499 u32 thread_index = session_thread_from_handle (handle);
500 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
502 if (thread_index == vlib_get_thread_index ())
504 return pool_elt_at_index (wrk->sessions,
505 session_index_from_handle (handle));
509 session_pool_add_peeker (thread_index);
510 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
511 return wrk->sessions + session_index_from_handle (handle);
516 transport_max_rx_enqueue (transport_connection_t * tc)
518 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
519 return svm_fifo_max_enqueue (s->server_rx_fifo);
523 transport_max_tx_dequeue (transport_connection_t * tc)
525 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
526 return svm_fifo_max_dequeue (s->server_tx_fifo);
530 transport_rx_fifo_size (transport_connection_t * tc)
532 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
533 return s->server_rx_fifo->nitems;
537 transport_tx_fifo_size (transport_connection_t * tc)
539 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
540 return s->server_tx_fifo->nitems;
544 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
546 stream_session_t *s = session_get (tc->c_index, tc->thread_index);
547 return svm_fifo_has_ooo_data (s->server_rx_fifo);
551 transport_dispatch_period (u32 thread_index)
553 return session_manager_main.wrk[thread_index].dispatch_period;
557 transport_time_now (u32 thread_index)
559 return session_manager_main.wrk[thread_index].last_vlib_time;
563 session_get_index (stream_session_t * s)
565 return (s - session_manager_main.wrk[s->thread_index].sessions);
568 always_inline stream_session_t *
569 session_clone_safe (u32 session_index, u32 thread_index)
571 stream_session_t *old_s, *new_s;
572 u32 current_thread_index = vlib_get_thread_index ();
574 /* If during the memcpy pool is reallocated AND the memory allocator
575 * decides to give the old chunk of memory to somebody in a hurry to
576 * scribble something on it, we have a problem. So add this thread as
577 * a session pool peeker.
579 session_pool_add_peeker (thread_index);
580 new_s = session_alloc (current_thread_index);
581 old_s = session_manager_main.wrk[thread_index].sessions + session_index;
582 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
583 session_pool_remove_peeker (thread_index);
584 new_s->thread_index = current_thread_index;
585 new_s->session_index = session_get_index (new_s);
589 transport_connection_t *session_get_transport (stream_session_t * s);
591 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
594 session_enqueue_stream_connection (transport_connection_t * tc,
595 vlib_buffer_t * b, u32 offset,
596 u8 queue_event, u8 is_in_order);
597 int session_enqueue_dgram_connection (stream_session_t * s,
598 session_dgram_hdr_t * hdr,
599 vlib_buffer_t * b, u8 proto,
601 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
602 u32 offset, u32 max_bytes);
603 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
605 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
606 int session_dgram_connect_notify (transport_connection_t * tc,
607 u32 old_thread_index,
608 stream_session_t ** new_session);
609 int session_dequeue_notify (stream_session_t * s);
610 void stream_session_init_fifos_pointers (transport_connection_t * tc,
611 u32 rx_pointer, u32 tx_pointer);
613 int stream_session_accept_notify (transport_connection_t * tc);
614 void stream_session_disconnect_notify (transport_connection_t * tc);
615 void stream_session_delete_notify (transport_connection_t * tc);
616 void stream_session_reset_notify (transport_connection_t * tc);
617 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
619 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
620 int session_listen (stream_session_t * s, session_endpoint_cfg_t * sep);
621 int session_stop_listen (stream_session_t * s);
622 void stream_session_disconnect (stream_session_t * s);
623 void stream_session_disconnect_transport (stream_session_t * s);
624 void stream_session_cleanup (stream_session_t * s);
625 int session_send_io_evt_to_thread (svm_fifo_t * f,
626 session_evt_type_t evt_type);
627 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
628 session_evt_type_t evt_type);
629 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
632 ssvm_private_t *session_manager_get_evt_q_segment (void);
634 u8 *format_stream_session (u8 * s, va_list * args);
635 uword unformat_stream_session (unformat_input_t * input, va_list * args);
636 uword unformat_transport_connection (unformat_input_t * input,
639 void session_register_transport (transport_proto_t transport_proto,
640 const transport_proto_vft_t * vft, u8 is_ip4,
644 transport_add_tx_event (transport_connection_t * tc)
646 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
647 if (svm_fifo_has_event (s->server_tx_fifo))
649 session_send_io_evt_to_thread (s->server_tx_fifo, FIFO_EVENT_APP_TX);
652 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
654 always_inline svm_msg_q_t *
655 session_manager_get_vpp_event_queue (u32 thread_index)
657 return session_manager_main.wrk[thread_index].vpp_event_queue;
660 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
661 int session_manager_flush_all_enqueue_events (u8 transport_proto);
664 listen_session_get_handle (stream_session_t * s)
666 ASSERT (s->session_state == SESSION_STATE_LISTENING);
667 return session_handle (s);
670 always_inline stream_session_t *
671 listen_session_get_from_handle (session_handle_t handle)
673 return session_get_from_handle (handle);
677 listen_session_parse_handle (session_handle_t handle, u32 * index,
680 session_parse_handle (handle, index, thread_index);
683 always_inline stream_session_t *
684 listen_session_new (u8 thread_index, session_type_t type)
687 s = session_alloc (thread_index);
688 s->session_type = type;
689 s->session_state = SESSION_STATE_LISTENING;
693 always_inline stream_session_t *
694 listen_session_get (u32 index)
696 return session_get (index, 0);
700 listen_session_del (stream_session_t * s)
705 transport_connection_t *listen_session_get_transport (stream_session_t * s);
708 listen_session_get_local_session_endpoint (stream_session_t * listener,
709 session_endpoint_t * sep);
711 void session_flush_frames_main_thread (vlib_main_t * vm);
714 session_manager_is_enabled ()
716 return session_manager_main.is_enabled == 1;
719 #define session_cli_return_if_not_enabled() \
721 if (!session_manager_main.is_enabled) \
722 return clib_error_return(0, "session layer is not enabled"); \
725 void session_node_enable_disable (u8 is_en);
727 #endif /* __included_session_h__ */
730 * fd.io coding-style-patch-verification: ON
733 * eval: (c-set-style "gnu")