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/transport.h>
19 #include <vlibmemory/unix_shared_memory_queue.h>
20 #include <vnet/session/session_debug.h>
21 #include <vnet/session/segment_manager.h>
23 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
24 #define INVALID_INDEX ((u32)~0)
26 /* TODO decide how much since we have pre-data as well */
27 #define MAX_HDRS_LEN 100 /* Max number of bytes for headers */
34 FIFO_EVENT_DISCONNECT,
35 FIFO_EVENT_BUILTIN_RX,
39 #define foreach_session_input_error \
40 _(NO_SESSION, "No session drops") \
41 _(NO_LISTENER, "No listener for dst port drops") \
42 _(ENQUEUED, "Packets pushed into rx fifo") \
43 _(NOT_READY, "Session not ready packets") \
44 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
45 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
46 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
47 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
48 _(NO_SPACE, "Couldn't allocate a fifo pair")
52 #define _(sym,str) SESSION_ERROR_##sym,
53 foreach_session_input_error
58 /* Event queue input node static next indices */
61 SESSION_QUEUE_NEXT_DROP,
62 SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT,
63 SESSION_QUEUE_NEXT_IP4_LOOKUP,
64 SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT,
65 SESSION_QUEUE_NEXT_IP6_LOOKUP,
67 } session_queue_next_t;
69 #define foreach_session_type \
77 #define _(A, a) SESSION_TYPE_##A,
84 * Application session state
88 SESSION_STATE_LISTENING,
89 SESSION_STATE_CONNECTING,
92 SESSION_STATE_N_STATES,
93 } stream_session_state_t;
102 typedef CLIB_PACKED (struct {
111 }) session_fifo_event_t;
114 typedef struct _stream_session_t
116 /** fifo pointers. Once allocated, these do not move */
117 svm_fifo_t *server_rx_fifo;
118 svm_fifo_t *server_tx_fifo;
128 /** To avoid n**2 "one event per frame" check */
131 /** Pad to a multiple of 8 octets */
134 /** svm segment index where fifos were allocated */
135 u32 svm_segment_index;
137 /** Session index in per_thread pool */
140 /** Transport specific */
141 u32 connection_index;
143 /** Application specific */
146 /** stream server pool index */
149 /** Parent listener session if the result of an accept */
152 /** Opaque, pad to a 64-octet boundary */
156 /* Forward definition */
157 typedef struct _session_manager_main session_manager_main_t;
160 (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
161 session_manager_main_t * smm,
162 session_fifo_event_t * e0, stream_session_t * s0,
163 u32 thread_index, int *n_tx_pkts);
165 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
166 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
168 struct _session_manager_main
170 /** Lookup tables for established sessions and listeners */
171 clib_bihash_16_8_t v4_session_hash;
172 clib_bihash_48_8_t v6_session_hash;
174 /** Lookup tables for half-open sessions */
175 clib_bihash_16_8_t v4_half_open_hash;
176 clib_bihash_48_8_t v6_half_open_hash;
178 /** Per worker thread session pools */
179 stream_session_t **sessions;
181 /** Pool of listen sessions. Same type as stream sessions to ease lookups */
182 stream_session_t *listen_sessions[SESSION_N_TYPES];
184 /** Sparse vector to map dst port to stream server */
185 u16 *stream_server_by_dst_port[SESSION_N_TYPES];
187 /** per-worker enqueue epoch counters */
188 u8 *current_enqueue_epoch;
190 /** Per-worker thread vector of sessions to enqueue */
191 u32 **session_indices_to_enqueue_by_thread;
193 /** per-worker tx buffer free lists */
196 /** Per worker-thread vector of partially read events */
197 session_fifo_event_t **free_event_vector;
199 /** per-worker active event vectors */
200 session_fifo_event_t **pending_event_vector;
202 /** vpp fifo event queue */
203 unix_shared_memory_queue_t **vpp_event_queues;
205 /** vpp fifo event queue configured length */
206 u32 configured_event_queue_length;
208 /** Unique segment name counter */
209 u32 unique_segment_name_counter;
211 /** Per transport rx function that can either dequeue or peek */
212 session_fifo_rx_fn *session_tx_fns[SESSION_N_TYPES];
217 vlib_main_t *vlib_main;
218 vnet_main_t *vnet_main;
222 * last event poll time by thread
223 * Debug only. Will cause false cache-line sharing as-is
225 f64 *last_event_poll_by_thread;
230 extern session_manager_main_t session_manager_main;
231 extern vlib_node_registration_t session_queue_node;
234 * Session manager function
236 always_inline session_manager_main_t *
237 vnet_get_session_manager_main ()
239 return &session_manager_main;
243 * Stream session functions
246 stream_session_t *stream_session_lookup_listener4 (ip4_address_t * lcl,
247 u16 lcl_port, u8 proto);
248 stream_session_t *stream_session_lookup4 (ip4_address_t * lcl,
249 ip4_address_t * rmt, u16 lcl_port,
250 u16 rmt_port, u8 proto,
252 stream_session_t *stream_session_lookup_listener6 (ip6_address_t * lcl,
253 u16 lcl_port, u8 proto);
254 stream_session_t *stream_session_lookup6 (ip6_address_t * lcl,
255 ip6_address_t * rmt, u16 lcl_port,
256 u16 rmt_port, u8, u32 thread_index);
257 transport_connection_t
258 * stream_session_lookup_transport4 (ip4_address_t * lcl,
259 ip4_address_t * rmt, u16 lcl_port,
260 u16 rmt_port, u8 proto,
262 transport_connection_t
263 * stream_session_lookup_transport6 (ip6_address_t * lcl,
264 ip6_address_t * rmt, u16 lcl_port,
265 u16 rmt_port, u8 proto,
267 stream_session_t *stream_session_lookup_listener (ip46_address_t * lcl,
268 u16 lcl_port, u8 proto);
269 void stream_session_table_add_for_tc (transport_connection_t * tc, u64 value);
270 int stream_session_table_del_for_tc (transport_connection_t * tc);
272 always_inline stream_session_t *
273 stream_session_get_tsi (u64 ti_and_si, u32 thread_index)
275 ASSERT ((u32) (ti_and_si >> 32) == thread_index);
276 return pool_elt_at_index (session_manager_main.sessions[thread_index],
277 ti_and_si & 0xFFFFFFFFULL);
280 always_inline stream_session_t *
281 stream_session_get (u32 si, u32 thread_index)
283 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
286 always_inline stream_session_t *
287 stream_session_get_if_valid (u64 si, u32 thread_index)
289 if (thread_index >= vec_len (session_manager_main.sessions))
292 if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
295 return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
299 stream_session_handle (stream_session_t * s)
301 return ((u64) s->thread_index << 32) | (u64) s->session_index;
305 stream_session_index_from_handle (u64 handle)
307 return handle & 0xFFFFFFFF;
311 stream_session_thread_from_handle (u64 handle)
317 stream_session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
319 *index = stream_session_index_from_handle (handle);
320 *thread_index = stream_session_thread_from_handle (handle);
323 always_inline stream_session_t *
324 stream_session_get_from_handle (u64 handle)
326 session_manager_main_t *smm = &session_manager_main;
327 return pool_elt_at_index (smm->sessions[stream_session_thread_from_handle
329 stream_session_index_from_handle (handle));
332 always_inline stream_session_t *
333 stream_session_listener_get (u8 sst, u64 si)
335 return pool_elt_at_index (session_manager_main.listen_sessions[sst], si);
339 stream_session_get_index (stream_session_t * s)
341 if (s->session_state == SESSION_STATE_LISTENING)
342 return s - session_manager_main.listen_sessions[s->session_type];
344 return s - session_manager_main.sessions[s->thread_index];
348 stream_session_max_rx_enqueue (transport_connection_t * tc)
350 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
351 return svm_fifo_max_enqueue (s->server_rx_fifo);
355 stream_session_rx_fifo_size (transport_connection_t * tc)
357 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
358 return s->server_rx_fifo->nitems;
361 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
364 stream_session_enqueue_data (transport_connection_t * tc, vlib_buffer_t * b,
365 u32 offset, u8 queue_event, u8 is_in_order);
367 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
368 u32 offset, u32 max_bytes);
369 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
371 void stream_session_connect_notify (transport_connection_t * tc, u8 sst,
373 void stream_session_init_fifos_pointers (transport_connection_t * tc,
374 u32 rx_pointer, u32 tx_pointer);
376 void stream_session_accept_notify (transport_connection_t * tc);
377 void stream_session_disconnect_notify (transport_connection_t * tc);
378 void stream_session_delete_notify (transport_connection_t * tc);
379 void stream_session_reset_notify (transport_connection_t * tc);
381 stream_session_accept (transport_connection_t * tc, u32 listener_index,
384 stream_session_open (u32 app_index, session_type_t st,
385 transport_endpoint_t * tep,
386 transport_connection_t ** tc);
387 int stream_session_listen (stream_session_t * s, transport_endpoint_t * tep);
388 int stream_session_stop_listen (stream_session_t * s);
389 void stream_session_disconnect (stream_session_t * s);
390 void stream_session_cleanup (stream_session_t * s);
391 void session_send_session_evt_to_thread (u64 session_handle,
392 fifo_event_type_t evt_type,
394 u8 *format_stream_session (u8 * s, va_list * args);
396 send_session_connected_callback (u32 app_index, u32 api_context,
397 stream_session_t * s, u8 is_fail);
400 void session_register_transport (u8 type, const transport_proto_vft_t * vft);
401 transport_proto_vft_t *session_get_transport_vft (u8 type);
403 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
405 always_inline unix_shared_memory_queue_t *
406 session_manager_get_vpp_event_queue (u32 thread_index)
408 return session_manager_main.vpp_event_queues[thread_index];
411 int session_manager_flush_enqueue_events (u32 thread_index);
414 listen_session_get_handle (stream_session_t * s)
416 ASSERT (s->session_state == SESSION_STATE_LISTENING);
417 return ((u64) s->session_type << 32) | s->session_index;
420 always_inline stream_session_t *
421 listen_session_get_from_handle (u64 handle)
423 session_manager_main_t *smm = &session_manager_main;
427 index = handle & 0xFFFFFFFF;
429 if (pool_is_free_index (smm->listen_sessions[type], index))
432 s = pool_elt_at_index (smm->listen_sessions[type], index);
433 ASSERT (s->session_state == SESSION_STATE_LISTENING);
437 always_inline stream_session_t *
438 listen_session_new (session_type_t type)
441 pool_get_aligned (session_manager_main.listen_sessions[type], s,
442 CLIB_CACHE_LINE_BYTES);
443 memset (s, 0, sizeof (*s));
445 s->session_type = type;
446 s->session_state = SESSION_STATE_LISTENING;
447 s->session_index = s - session_manager_main.listen_sessions[type];
452 always_inline stream_session_t *
453 listen_session_get (session_type_t type, u32 index)
455 return pool_elt_at_index (session_manager_main.listen_sessions[type],
460 listen_session_del (stream_session_t * s)
462 pool_put (session_manager_main.listen_sessions[s->session_type], s);
466 session_manager_is_enabled ()
468 return session_manager_main.is_enabled == 1;
471 #endif /* __included_session_h__ */
474 * fd.io coding-style-patch-verification: ON
477 * eval: (c-set-style "gnu")