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 */
38 FIFO_EVENT_DISCONNECT,
39 FIFO_EVENT_BUILTIN_RX,
43 static inline const char *
44 fifo_event_type_str (fifo_event_type_t et)
48 case FIFO_EVENT_APP_RX:
49 return "FIFO_EVENT_APP_RX";
50 case FIFO_EVENT_APP_TX:
51 return "FIFO_EVENT_APP_TX";
52 case FIFO_EVENT_TIMEOUT:
53 return "FIFO_EVENT_TIMEOUT";
54 case FIFO_EVENT_DISCONNECT:
55 return "FIFO_EVENT_DISCONNECT";
56 case FIFO_EVENT_BUILTIN_RX:
57 return "FIFO_EVENT_BUILTIN_RX";
59 return "FIFO_EVENT_RPC";
61 return "UNKNOWN FIFO EVENT";
65 #define foreach_session_input_error \
66 _(NO_SESSION, "No session drops") \
67 _(NO_LISTENER, "No listener for dst port drops") \
68 _(ENQUEUED, "Packets pushed into rx fifo") \
69 _(NOT_READY, "Session not ready packets") \
70 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
71 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
72 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
73 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
74 _(NO_SPACE, "Couldn't allocate a fifo pair") \
75 _(SEG_CREATE, "Couldn't create a new segment")
79 #define _(sym,str) SESSION_ERROR_##sym,
80 foreach_session_input_error
91 typedef u64 session_handle_t;
94 typedef CLIB_PACKED (struct {
98 session_handle_t session_handle;
103 }) session_fifo_event_t;
106 typedef struct session_dgram_pre_hdr_
110 } session_dgram_pre_hdr_t;
113 typedef CLIB_PACKED (struct session_dgram_header_
117 ip46_address_t rmt_ip;
118 ip46_address_t lcl_ip;
122 }) session_dgram_hdr_t;
125 #define SESSION_CONN_ID_LEN 37
126 #define SESSION_CONN_HDR_LEN 45
128 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
129 "session conn id wrong length");
131 typedef struct session_tx_context_
133 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
135 transport_proto_vft_t *transport_vft;
136 transport_connection_t *tc;
143 u16 deq_per_first_buf;
148 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
149 session_dgram_hdr_t hdr;
150 } session_tx_context_t;
152 /* Forward definition */
153 typedef struct _session_manager_main session_manager_main_t;
156 (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
157 session_fifo_event_t * e0, stream_session_t * s0,
160 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
161 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
162 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
164 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e);
166 struct _session_manager_main
168 /** Per worker thread session pools */
169 stream_session_t **sessions;
171 /** Per worker-thread session pool peekers rw locks */
172 clib_rwlock_t *peekers_rw_locks;
174 /** Per-proto, per-worker enqueue epoch counters */
175 u32 *current_enqueue_epoch[TRANSPORT_N_PROTO];
177 /** Per-proto, per-worker thread vector of sessions to enqueue */
178 u32 **session_to_enqueue[TRANSPORT_N_PROTO];
180 /** per-worker tx buffer free lists */
183 /** Per worker-thread vector of partially read events */
184 session_fifo_event_t **free_event_vector;
186 /** per-worker active event vectors */
187 session_fifo_event_t **pending_event_vector;
189 /** per-worker postponed disconnects */
190 session_fifo_event_t **pending_disconnects;
192 /** per-worker session context */
193 session_tx_context_t *ctx;
195 /** vpp fifo event queue */
196 svm_queue_t **vpp_event_queues;
198 /** Event queues memfd segment initialized only if so configured */
199 ssvm_private_t evt_qs_segment;
201 /** Unique segment name counter */
202 u32 unique_segment_name_counter;
204 /** Per transport rx function that can either dequeue or peek */
205 session_fifo_rx_fn **session_tx_fns;
207 /** Per session type output nodes. Could optimize to group nodes by
208 * fib but lookup would then require session type parsing in session node.
209 * Trade memory for speed, for now */
210 u32 *session_type_to_next;
212 /** Session manager is enabled */
215 /** vpp fifo event queue configured length */
216 u32 configured_event_queue_length;
222 /** Session ssvm segment configs*/
223 uword session_baseva;
224 uword session_va_space_size;
225 u32 evt_qs_segment_size;
226 u8 evt_qs_use_memfd_seg;
228 /** Session table size parameters */
229 u32 configured_v4_session_table_buckets;
230 u32 configured_v4_session_table_memory;
231 u32 configured_v4_halfopen_table_buckets;
232 u32 configured_v4_halfopen_table_memory;
233 u32 configured_v6_session_table_buckets;
234 u32 configured_v6_session_table_memory;
235 u32 configured_v6_halfopen_table_buckets;
236 u32 configured_v6_halfopen_table_memory;
238 /** Transport table (preallocation) size parameters */
239 u32 local_endpoints_table_memory;
240 u32 local_endpoints_table_buckets;
242 /** Preallocate session config parameter */
243 u32 preallocated_sessions;
247 * last event poll time by thread
248 * Debug only. Will cause false cache-line sharing as-is
250 f64 *last_event_poll_by_thread;
255 extern session_manager_main_t session_manager_main;
256 extern vlib_node_registration_t session_queue_node;
259 * Session manager function
261 always_inline session_manager_main_t *
262 vnet_get_session_manager_main ()
264 return &session_manager_main;
268 stream_session_is_valid (u32 si, u8 thread_index)
271 s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
272 if (s->thread_index != thread_index || s->session_index != si
273 /* || s->server_rx_fifo->master_session_index != si
274 || s->server_tx_fifo->master_session_index != si
275 || s->server_rx_fifo->master_thread_index != thread_index
276 || s->server_tx_fifo->master_thread_index != thread_index */ )
281 stream_session_t *session_alloc (u32 thread_index);
282 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
283 void session_free (stream_session_t * s);
285 always_inline stream_session_t *
286 session_get (u32 si, u32 thread_index)
288 ASSERT (stream_session_is_valid (si, thread_index));
289 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
292 always_inline stream_session_t *
293 session_get_if_valid (u64 si, u32 thread_index)
295 if (thread_index >= vec_len (session_manager_main.sessions))
298 if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
301 ASSERT (stream_session_is_valid (si, thread_index));
302 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
305 always_inline session_handle_t
306 session_handle (stream_session_t * s)
308 return ((u64) s->thread_index << 32) | (u64) s->session_index;
312 session_index_from_handle (session_handle_t handle)
314 return handle & 0xFFFFFFFF;
318 session_thread_from_handle (session_handle_t handle)
324 session_parse_handle (session_handle_t handle, u32 * index,
327 *index = session_index_from_handle (handle);
328 *thread_index = session_thread_from_handle (handle);
331 always_inline stream_session_t *
332 session_get_from_handle (session_handle_t handle)
334 session_manager_main_t *smm = &session_manager_main;
335 u32 session_index, thread_index;
336 session_parse_handle (handle, &session_index, &thread_index);
337 return pool_elt_at_index (smm->sessions[thread_index], session_index);
340 always_inline stream_session_t *
341 session_get_from_handle_if_valid (session_handle_t handle)
343 u32 session_index, thread_index;
344 session_parse_handle (handle, &session_index, &thread_index);
345 return session_get_if_valid (session_index, thread_index);
349 session_handle_is_local (session_handle_t handle)
351 if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
356 always_inline transport_proto_t
357 session_type_transport_proto (session_type_t st)
363 session_type_is_ip4 (session_type_t st)
368 always_inline transport_proto_t
369 session_get_transport_proto (stream_session_t * s)
371 return (s->session_type >> 1);
374 always_inline fib_protocol_t
375 session_get_fib_proto (stream_session_t * s)
377 u8 is_ip4 = s->session_type & 1;
378 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
381 always_inline session_type_t
382 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
384 return (proto << 1 | is_ip4);
388 session_has_transport (stream_session_t * s)
390 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
393 transport_service_type_t session_transport_service_type (stream_session_t *);
394 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
395 u8 session_tx_is_dgram (stream_session_t * s);
398 * Acquires a lock that blocks a session pool from expanding.
400 * This is typically used for safely peeking into other threads'
401 * pools in order to clone elements. Lock should be dropped as soon
402 * as possible by calling @ref session_pool_remove_peeker.
404 * NOTE: Avoid using pool_elt_at_index while the lock is held because
405 * it may lead to free elt bitmap expansion/contraction!
408 session_pool_add_peeker (u32 thread_index)
410 session_manager_main_t *smm = &session_manager_main;
411 if (thread_index == vlib_get_thread_index ())
413 clib_rwlock_reader_lock (&smm->peekers_rw_locks[thread_index]);
417 session_pool_remove_peeker (u32 thread_index)
419 session_manager_main_t *smm = &session_manager_main;
420 if (thread_index == vlib_get_thread_index ())
422 clib_rwlock_reader_unlock (&smm->peekers_rw_locks[thread_index]);
426 * Get session from handle and 'lock' pool resize if not in same thread
428 * Caller should drop the peek 'lock' as soon as possible.
430 always_inline stream_session_t *
431 session_get_from_handle_safe (u64 handle)
433 session_manager_main_t *smm = &session_manager_main;
434 u32 thread_index = session_thread_from_handle (handle);
435 if (thread_index == vlib_get_thread_index ())
437 return pool_elt_at_index (smm->sessions[thread_index],
438 session_index_from_handle (handle));
442 session_pool_add_peeker (thread_index);
443 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
444 return smm->sessions[thread_index] + session_index_from_handle (handle);
449 stream_session_max_rx_enqueue (transport_connection_t * tc)
451 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
452 return svm_fifo_max_enqueue (s->server_rx_fifo);
456 stream_session_rx_fifo_size (transport_connection_t * tc)
458 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
459 return s->server_rx_fifo->nitems;
463 session_get_index (stream_session_t * s)
465 return (s - session_manager_main.sessions[s->thread_index]);
468 always_inline stream_session_t *
469 session_clone_safe (u32 session_index, u32 thread_index)
471 stream_session_t *old_s, *new_s;
472 u32 current_thread_index = vlib_get_thread_index ();
474 /* If during the memcpy pool is reallocated AND the memory allocator
475 * decides to give the old chunk of memory to somebody in a hurry to
476 * scribble something on it, we have a problem. So add this thread as
477 * a session pool peeker.
479 session_pool_add_peeker (thread_index);
480 new_s = session_alloc (current_thread_index);
481 old_s = session_manager_main.sessions[thread_index] + session_index;
482 clib_memcpy (new_s, old_s, sizeof (*new_s));
483 session_pool_remove_peeker (thread_index);
484 new_s->thread_index = current_thread_index;
485 new_s->session_index = session_get_index (new_s);
489 transport_connection_t *session_get_transport (stream_session_t * s);
491 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
494 session_enqueue_stream_connection (transport_connection_t * tc,
495 vlib_buffer_t * b, u32 offset,
496 u8 queue_event, u8 is_in_order);
497 int session_enqueue_dgram_connection (stream_session_t * s,
498 session_dgram_hdr_t * hdr,
499 vlib_buffer_t * b, u8 proto,
501 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
502 u32 offset, u32 max_bytes);
503 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
505 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
506 int session_dgram_connect_notify (transport_connection_t * tc,
507 u32 old_thread_index,
508 stream_session_t ** new_session);
509 void stream_session_init_fifos_pointers (transport_connection_t * tc,
510 u32 rx_pointer, u32 tx_pointer);
512 void stream_session_accept_notify (transport_connection_t * tc);
513 void stream_session_disconnect_notify (transport_connection_t * tc);
514 void stream_session_delete_notify (transport_connection_t * tc);
515 void stream_session_reset_notify (transport_connection_t * tc);
516 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
518 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
519 int stream_session_listen (stream_session_t * s, session_endpoint_t * tep);
520 int stream_session_stop_listen (stream_session_t * s);
521 void stream_session_disconnect (stream_session_t * s);
522 void stream_session_disconnect_transport (stream_session_t * s);
523 void stream_session_cleanup (stream_session_t * s);
524 void session_send_session_evt_to_thread (u64 session_handle,
525 fifo_event_type_t evt_type,
527 ssvm_private_t *session_manager_get_evt_q_segment (void);
529 u8 *format_stream_session (u8 * s, va_list * args);
530 uword unformat_stream_session (unformat_input_t * input, va_list * args);
531 uword unformat_transport_connection (unformat_input_t * input,
534 void session_register_transport (transport_proto_t transport_proto,
535 const transport_proto_vft_t * vft, u8 is_ip4,
538 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
540 always_inline svm_queue_t *
541 session_manager_get_vpp_event_queue (u32 thread_index)
543 return session_manager_main.vpp_event_queues[thread_index];
546 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
547 int session_manager_flush_all_enqueue_events (u8 transport_proto);
550 listen_session_get_handle (stream_session_t * s)
552 ASSERT (s->session_state == SESSION_STATE_LISTENING);
553 return session_handle (s);
556 always_inline stream_session_t *
557 listen_session_get_from_handle (session_handle_t handle)
559 return session_get_from_handle (handle);
563 listen_session_parse_handle (session_handle_t handle, u32 * index,
566 session_parse_handle (handle, index, thread_index);
569 always_inline stream_session_t *
570 listen_session_new (u8 thread_index, session_type_t type)
573 s = session_alloc (thread_index);
574 s->session_type = type;
575 s->session_state = SESSION_STATE_LISTENING;
579 always_inline stream_session_t *
580 listen_session_get (u32 index)
582 return session_get (index, 0);
586 listen_session_del (stream_session_t * s)
591 transport_connection_t *listen_session_get_transport (stream_session_t * s);
594 listen_session_get_local_session_endpoint (stream_session_t * listener,
595 session_endpoint_t * sep);
598 session_manager_is_enabled ()
600 return session_manager_main.is_enabled == 1;
603 #define session_cli_return_if_not_enabled() \
605 if (!session_manager_main.is_enabled) \
606 return clib_error_return(0, "session layer is not enabled"); \
609 void session_node_enable_disable (u8 is_en);
611 #endif /* __included_session_h__ */
614 * fd.io coding-style-patch-verification: ON
617 * eval: (c-set-style "gnu")