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 <vlibmemory/unix_shared_memory_queue.h>
22 #include <vnet/session/session_debug.h>
23 #include <vnet/session/segment_manager.h>
25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
26 #define INVALID_INDEX ((u32)~0)
28 /* TODO decide how much since we have pre-data as well */
29 #define MAX_HDRS_LEN 100 /* Max number of bytes for headers */
36 FIFO_EVENT_DISCONNECT,
37 FIFO_EVENT_BUILTIN_RX,
41 #define foreach_session_input_error \
42 _(NO_SESSION, "No session drops") \
43 _(NO_LISTENER, "No listener for dst port drops") \
44 _(ENQUEUED, "Packets pushed into rx fifo") \
45 _(NOT_READY, "Session not ready packets") \
46 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
47 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
48 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
49 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
50 _(NO_SPACE, "Couldn't allocate a fifo pair")
54 #define _(sym,str) SESSION_ERROR_##sym,
55 foreach_session_input_error
60 /* Event queue input node static next indices */
63 SESSION_QUEUE_NEXT_DROP,
64 SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT,
65 SESSION_QUEUE_NEXT_IP4_LOOKUP,
66 SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT,
67 SESSION_QUEUE_NEXT_IP6_LOOKUP,
69 } session_queue_next_t;
78 typedef CLIB_PACKED (struct {
87 }) session_fifo_event_t;
90 /* Forward definition */
91 typedef struct _session_manager_main session_manager_main_t;
94 (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
95 session_manager_main_t * smm,
96 session_fifo_event_t * e0, stream_session_t * s0,
97 u32 thread_index, int *n_tx_pkts);
99 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
100 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
102 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e);
104 struct _session_manager_main
106 /** Per worker thread session pools */
107 stream_session_t **sessions;
109 /** Pool of listen sessions. Same type as stream sessions to ease lookups */
110 stream_session_t *listen_sessions[SESSION_N_TYPES];
112 /** Sparse vector to map dst port to stream server */
113 u16 *stream_server_by_dst_port[SESSION_N_TYPES];
115 /** per-worker enqueue epoch counters */
116 u8 *current_enqueue_epoch;
118 /** Per-worker thread vector of sessions to enqueue */
119 u32 **session_indices_to_enqueue_by_thread;
121 /** per-worker tx buffer free lists */
124 /** Per worker-thread vector of partially read events */
125 session_fifo_event_t **free_event_vector;
127 /** per-worker active event vectors */
128 session_fifo_event_t **pending_event_vector;
130 /** vpp fifo event queue */
131 unix_shared_memory_queue_t **vpp_event_queues;
133 /** vpp fifo event queue configured length */
134 u32 configured_event_queue_length;
136 /** session table size parameters */
137 u32 configured_v4_session_table_buckets;
138 u32 configured_v4_session_table_memory;
139 u32 configured_v4_halfopen_table_buckets;
140 u32 configured_v4_halfopen_table_memory;
141 u32 configured_v6_session_table_buckets;
142 u32 configured_v6_session_table_memory;
143 u32 configured_v6_halfopen_table_buckets;
144 u32 configured_v6_halfopen_table_memory;
146 /** Unique segment name counter */
147 u32 unique_segment_name_counter;
149 /** Per transport rx function that can either dequeue or peek */
150 session_fifo_rx_fn *session_tx_fns[SESSION_N_TYPES];
152 /** Session manager is enabled */
155 /** Preallocate session config parameter */
156 u32 preallocated_sessions;
160 * last event poll time by thread
161 * Debug only. Will cause false cache-line sharing as-is
163 f64 *last_event_poll_by_thread;
168 extern session_manager_main_t session_manager_main;
169 extern vlib_node_registration_t session_queue_node;
172 * Session manager function
174 always_inline session_manager_main_t *
175 vnet_get_session_manager_main ()
177 return &session_manager_main;
181 stream_session_is_valid (u32 si, u8 thread_index)
184 s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
185 if (s->thread_index != thread_index || s->session_index != si
186 /* || s->server_rx_fifo->master_session_index != si
187 || s->server_tx_fifo->master_session_index != si
188 || s->server_rx_fifo->master_thread_index != thread_index
189 || s->server_tx_fifo->master_thread_index != thread_index */ )
194 always_inline stream_session_t *
195 stream_session_get (u32 si, u32 thread_index)
197 ASSERT (stream_session_is_valid (si, thread_index));
198 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
201 always_inline stream_session_t *
202 stream_session_get_if_valid (u64 si, u32 thread_index)
204 if (thread_index >= vec_len (session_manager_main.sessions))
207 if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
210 ASSERT (stream_session_is_valid (si, thread_index));
211 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
215 stream_session_handle (stream_session_t * s)
217 return ((u64) s->thread_index << 32) | (u64) s->session_index;
221 stream_session_index_from_handle (u64 handle)
223 return handle & 0xFFFFFFFF;
227 stream_session_thread_from_handle (u64 handle)
233 stream_session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
235 *index = stream_session_index_from_handle (handle);
236 *thread_index = stream_session_thread_from_handle (handle);
239 always_inline stream_session_t *
240 stream_session_get_from_handle (u64 handle)
242 session_manager_main_t *smm = &session_manager_main;
243 return pool_elt_at_index (smm->sessions[stream_session_thread_from_handle
245 stream_session_index_from_handle (handle));
248 always_inline stream_session_t *
249 stream_session_listener_get (u8 sst, u64 si)
251 return pool_elt_at_index (session_manager_main.listen_sessions[sst], si);
255 stream_session_get_index (stream_session_t * s)
257 if (s->session_state == SESSION_STATE_LISTENING)
258 return s - session_manager_main.listen_sessions[s->session_type];
260 return s - session_manager_main.sessions[s->thread_index];
264 stream_session_max_rx_enqueue (transport_connection_t * tc)
266 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
267 return svm_fifo_max_enqueue (s->server_rx_fifo);
271 stream_session_rx_fifo_size (transport_connection_t * tc)
273 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
274 return s->server_rx_fifo->nitems;
277 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
280 stream_session_enqueue_data (transport_connection_t * tc, vlib_buffer_t * b,
281 u32 offset, u8 queue_event, u8 is_in_order);
283 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
284 u32 offset, u32 max_bytes);
285 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
287 int stream_session_connect_notify (transport_connection_t * tc, u8 is_fail);
288 void stream_session_init_fifos_pointers (transport_connection_t * tc,
289 u32 rx_pointer, u32 tx_pointer);
291 void stream_session_accept_notify (transport_connection_t * tc);
292 void stream_session_disconnect_notify (transport_connection_t * tc);
293 void stream_session_delete_notify (transport_connection_t * tc);
294 void stream_session_reset_notify (transport_connection_t * tc);
296 stream_session_accept (transport_connection_t * tc, u32 listener_index,
299 stream_session_open (u32 app_index, session_type_t st,
300 transport_endpoint_t * tep,
301 transport_connection_t ** tc);
302 int stream_session_listen (stream_session_t * s, transport_endpoint_t * tep);
303 int stream_session_stop_listen (stream_session_t * s);
304 void stream_session_disconnect (stream_session_t * s);
305 void stream_session_cleanup (stream_session_t * s);
306 void session_send_session_evt_to_thread (u64 session_handle,
307 fifo_event_type_t evt_type,
310 u8 *format_stream_session (u8 * s, va_list * args);
311 uword unformat_stream_session (unformat_input_t * input, va_list * args);
312 uword unformat_transport_connection (unformat_input_t * input,
316 send_session_connected_callback (u32 app_index, u32 api_context,
317 stream_session_t * s, u8 is_fail);
320 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
322 always_inline unix_shared_memory_queue_t *
323 session_manager_get_vpp_event_queue (u32 thread_index)
325 return session_manager_main.vpp_event_queues[thread_index];
328 int session_manager_flush_enqueue_events (u32 thread_index);
331 listen_session_get_handle (stream_session_t * s)
333 ASSERT (s->session_state == SESSION_STATE_LISTENING);
334 return ((u64) s->session_type << 32) | s->session_index;
337 always_inline stream_session_t *
338 listen_session_get_from_handle (u64 handle)
340 session_manager_main_t *smm = &session_manager_main;
344 index = handle & 0xFFFFFFFF;
346 if (pool_is_free_index (smm->listen_sessions[type], index))
349 s = pool_elt_at_index (smm->listen_sessions[type], index);
350 ASSERT (s->session_state == SESSION_STATE_LISTENING);
354 always_inline stream_session_t *
355 listen_session_new (session_type_t type)
358 pool_get_aligned (session_manager_main.listen_sessions[type], s,
359 CLIB_CACHE_LINE_BYTES);
360 memset (s, 0, sizeof (*s));
362 s->session_type = type;
363 s->session_state = SESSION_STATE_LISTENING;
364 s->session_index = s - session_manager_main.listen_sessions[type];
369 always_inline stream_session_t *
370 listen_session_get (session_type_t type, u32 index)
372 return pool_elt_at_index (session_manager_main.listen_sessions[type],
377 listen_session_del (stream_session_t * s)
379 pool_put (session_manager_main.listen_sessions[s->session_type], s);
382 always_inline stream_session_t *
383 session_manager_get_listener (u8 type, u32 index)
385 return pool_elt_at_index (session_manager_main.listen_sessions[type],
390 session_manager_set_transport_rx_fn (u8 type, u8 is_peek)
392 /* If an offset function is provided, then peek instead of dequeue */
393 session_manager_main.session_tx_fns[type] = (is_peek) ?
394 session_tx_fifo_peek_and_snd : session_tx_fifo_dequeue_and_snd;
398 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4);
401 session_manager_is_enabled ()
403 return session_manager_main.is_enabled == 1;
406 #endif /* __included_session_h__ */
409 * fd.io coding-style-patch-verification: ON
412 * eval: (c-set-style "gnu")