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 /** Unique segment name counter */
137 u32 unique_segment_name_counter;
139 /** Per transport rx function that can either dequeue or peek */
140 session_fifo_rx_fn *session_tx_fns[SESSION_N_TYPES];
142 /** Session manager is enabled */
145 /** Preallocate session config parameter */
146 u32 preallocated_sessions;
150 * last event poll time by thread
151 * Debug only. Will cause false cache-line sharing as-is
153 f64 *last_event_poll_by_thread;
158 extern session_manager_main_t session_manager_main;
159 extern vlib_node_registration_t session_queue_node;
162 * Session manager function
164 always_inline session_manager_main_t *
165 vnet_get_session_manager_main ()
167 return &session_manager_main;
171 stream_session_is_valid (u32 si, u8 thread_index)
174 s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
175 if (s->thread_index != thread_index || s->session_index != si
176 || s->server_rx_fifo->master_session_index != si
177 || s->server_tx_fifo->master_session_index != si
178 || s->server_rx_fifo->master_thread_index != thread_index
179 || s->server_tx_fifo->master_thread_index != thread_index)
184 always_inline stream_session_t *
185 stream_session_get (u32 si, u32 thread_index)
187 ASSERT (stream_session_is_valid (si, thread_index));
188 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
191 always_inline stream_session_t *
192 stream_session_get_if_valid (u64 si, u32 thread_index)
194 if (thread_index >= vec_len (session_manager_main.sessions))
197 if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
200 ASSERT (stream_session_is_valid (si, thread_index));
201 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
205 stream_session_handle (stream_session_t * s)
207 return ((u64) s->thread_index << 32) | (u64) s->session_index;
211 stream_session_index_from_handle (u64 handle)
213 return handle & 0xFFFFFFFF;
217 stream_session_thread_from_handle (u64 handle)
223 stream_session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
225 *index = stream_session_index_from_handle (handle);
226 *thread_index = stream_session_thread_from_handle (handle);
229 always_inline stream_session_t *
230 stream_session_get_from_handle (u64 handle)
232 session_manager_main_t *smm = &session_manager_main;
233 return pool_elt_at_index (smm->sessions[stream_session_thread_from_handle
235 stream_session_index_from_handle (handle));
238 always_inline stream_session_t *
239 stream_session_listener_get (u8 sst, u64 si)
241 return pool_elt_at_index (session_manager_main.listen_sessions[sst], si);
245 stream_session_get_index (stream_session_t * s)
247 if (s->session_state == SESSION_STATE_LISTENING)
248 return s - session_manager_main.listen_sessions[s->session_type];
250 return s - session_manager_main.sessions[s->thread_index];
254 stream_session_max_rx_enqueue (transport_connection_t * tc)
256 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
257 return svm_fifo_max_enqueue (s->server_rx_fifo);
261 stream_session_rx_fifo_size (transport_connection_t * tc)
263 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
264 return s->server_rx_fifo->nitems;
267 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
270 stream_session_enqueue_data (transport_connection_t * tc, vlib_buffer_t * b,
271 u32 offset, u8 queue_event, u8 is_in_order);
273 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
274 u32 offset, u32 max_bytes);
275 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
277 int stream_session_connect_notify (transport_connection_t * tc, u8 is_fail);
278 void stream_session_init_fifos_pointers (transport_connection_t * tc,
279 u32 rx_pointer, u32 tx_pointer);
281 void stream_session_accept_notify (transport_connection_t * tc);
282 void stream_session_disconnect_notify (transport_connection_t * tc);
283 void stream_session_delete_notify (transport_connection_t * tc);
284 void stream_session_reset_notify (transport_connection_t * tc);
286 stream_session_accept (transport_connection_t * tc, u32 listener_index,
289 stream_session_open (u32 app_index, session_type_t st,
290 transport_endpoint_t * tep,
291 transport_connection_t ** tc);
292 int stream_session_listen (stream_session_t * s, transport_endpoint_t * tep);
293 int stream_session_stop_listen (stream_session_t * s);
294 void stream_session_disconnect (stream_session_t * s);
295 void stream_session_cleanup (stream_session_t * s);
296 void session_send_session_evt_to_thread (u64 session_handle,
297 fifo_event_type_t evt_type,
300 u8 *format_stream_session (u8 * s, va_list * args);
301 uword unformat_stream_session (unformat_input_t * input, va_list * args);
302 uword unformat_transport_connection (unformat_input_t * input,
306 send_session_connected_callback (u32 app_index, u32 api_context,
307 stream_session_t * s, u8 is_fail);
310 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
312 always_inline unix_shared_memory_queue_t *
313 session_manager_get_vpp_event_queue (u32 thread_index)
315 return session_manager_main.vpp_event_queues[thread_index];
318 int session_manager_flush_enqueue_events (u32 thread_index);
321 listen_session_get_handle (stream_session_t * s)
323 ASSERT (s->session_state == SESSION_STATE_LISTENING);
324 return ((u64) s->session_type << 32) | s->session_index;
327 always_inline stream_session_t *
328 listen_session_get_from_handle (u64 handle)
330 session_manager_main_t *smm = &session_manager_main;
334 index = handle & 0xFFFFFFFF;
336 if (pool_is_free_index (smm->listen_sessions[type], index))
339 s = pool_elt_at_index (smm->listen_sessions[type], index);
340 ASSERT (s->session_state == SESSION_STATE_LISTENING);
344 always_inline stream_session_t *
345 listen_session_new (session_type_t type)
348 pool_get_aligned (session_manager_main.listen_sessions[type], s,
349 CLIB_CACHE_LINE_BYTES);
350 memset (s, 0, sizeof (*s));
352 s->session_type = type;
353 s->session_state = SESSION_STATE_LISTENING;
354 s->session_index = s - session_manager_main.listen_sessions[type];
359 always_inline stream_session_t *
360 listen_session_get (session_type_t type, u32 index)
362 return pool_elt_at_index (session_manager_main.listen_sessions[type],
367 listen_session_del (stream_session_t * s)
369 pool_put (session_manager_main.listen_sessions[s->session_type], s);
372 always_inline stream_session_t *
373 session_manager_get_listener (u8 type, u32 index)
375 return pool_elt_at_index (session_manager_main.listen_sessions[type],
380 session_manager_set_transport_rx_fn (u8 type, u8 is_peek)
382 /* If an offset function is provided, then peek instead of dequeue */
383 session_manager_main.session_tx_fns[type] = (is_peek) ?
384 session_tx_fifo_peek_and_snd : session_tx_fifo_dequeue_and_snd;
388 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4);
391 session_manager_is_enabled ()
393 return session_manager_main.is_enabled == 1;
396 #endif /* __included_session_h__ */
399 * fd.io coding-style-patch-verification: ON
402 * eval: (c-set-style "gnu")