2 * Copyright (c) 2017-2019 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/session_types.h>
19 #include <vnet/session/session_lookup.h>
20 #include <vnet/session/session_debug.h>
21 #include <svm/message_queue.h>
24 #define foreach_session_input_error \
25 _(NO_SESSION, "No session drops") \
26 _(NO_LISTENER, "No listener for dst port drops") \
27 _(ENQUEUED, "Packets pushed into rx fifo") \
28 _(NOT_READY, "Session not ready packets") \
29 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
30 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
31 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
32 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
33 _(NO_SPACE, "Couldn't allocate a fifo pair") \
34 _(SEG_CREATE, "Couldn't create a new segment")
38 #define _(sym,str) SESSION_ERROR_##sym,
39 foreach_session_input_error
44 typedef struct session_tx_context_
46 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
48 transport_proto_vft_t *transport_vft;
49 transport_connection_t *tc;
55 u16 deq_per_first_buf;
60 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
61 session_dgram_hdr_t hdr;
62 } session_tx_context_t;
64 typedef struct session_worker_
66 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
68 /** Worker session pool */
71 /** vpp event message queue for worker */
72 svm_msg_q_t *vpp_event_queue;
74 /** Our approximation of a "complete" dispatch loop period */
77 /** vlib_time_now last time around the track */
80 /** Per-proto vector of sessions to enqueue */
81 u32 *session_to_enqueue[TRANSPORT_N_PROTO];
83 /** Context for session tx */
84 session_tx_context_t ctx;
86 /** Vector of tx buffer free lists */
89 /** Vector of partially read events */
90 session_event_t *free_event_vector;
92 /** Vector of active event vectors */
93 session_event_t *pending_event_vector;
95 /** Vector of postponed disconnects */
96 session_event_t *pending_disconnects;
98 /** Vector of postponed events */
99 session_event_t *postponed_event_vector;
101 /** Peekers rw lock */
102 clib_rwlock_t peekers_rw_locks;
108 typedef int (session_fifo_rx_fn) (vlib_main_t * vm,
109 vlib_node_runtime_t * node,
110 session_worker_t * wrk,
111 session_event_t * e, int *n_tx_pkts);
113 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
114 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
115 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
117 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
119 typedef struct session_main_
121 /** Worker contexts */
122 session_worker_t *wrk;
124 /** Event queues memfd segment initialized only if so configured */
125 ssvm_private_t evt_qs_segment;
127 /** Unique segment name counter */
128 u32 unique_segment_name_counter;
130 /** Per transport rx function that can either dequeue or peek */
131 session_fifo_rx_fn **session_tx_fns;
133 /** Per session type output nodes. Could optimize to group nodes by
134 * fib but lookup would then require session type parsing in session node.
135 * Trade memory for speed, for now */
136 u32 *session_type_to_next;
142 /** Session manager is enabled */
145 /** vpp fifo event queue configured length */
146 u32 configured_event_queue_length;
148 /** Session ssvm segment configs*/
149 uword session_baseva;
150 uword session_va_space_size;
151 uword evt_qs_segment_size;
152 u8 evt_qs_use_memfd_seg;
154 /** Session table size parameters */
155 u32 configured_v4_session_table_buckets;
156 u32 configured_v4_session_table_memory;
157 u32 configured_v4_halfopen_table_buckets;
158 u32 configured_v4_halfopen_table_memory;
159 u32 configured_v6_session_table_buckets;
160 u32 configured_v6_session_table_memory;
161 u32 configured_v6_halfopen_table_buckets;
162 u32 configured_v6_halfopen_table_memory;
164 /** Transport table (preallocation) size parameters */
165 u32 local_endpoints_table_memory;
166 u32 local_endpoints_table_buckets;
168 /** Preallocate session config parameter */
169 u32 preallocated_sessions;
173 * last event poll time by thread
174 * Debug only. Will cause false cache-line sharing as-is
176 f64 *last_event_poll_by_thread;
181 extern session_main_t session_main;
182 extern vlib_node_registration_t session_queue_node;
183 extern vlib_node_registration_t session_queue_process_node;
184 extern vlib_node_registration_t session_queue_pre_input_node;
186 #define SESSION_Q_PROCESS_FLUSH_FRAMES 1
187 #define SESSION_Q_PROCESS_STOP 2
190 session_is_valid (u32 si, u8 thread_index)
193 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
194 if (s->session_state == SESSION_STATE_CLOSED)
197 if (s->thread_index != thread_index || s->session_index != si)
202 session_t *session_alloc (u32 thread_index);
203 void session_free (session_t * s);
204 void session_free_w_fifos (session_t * s);
206 always_inline session_t *
207 session_get (u32 si, u32 thread_index)
209 ASSERT (session_is_valid (si, thread_index));
210 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
213 always_inline session_t *
214 session_get_if_valid (u64 si, u32 thread_index)
216 if (thread_index >= vec_len (session_main.wrk))
219 if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
222 ASSERT (session_is_valid (si, thread_index));
223 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
226 always_inline session_t *
227 session_get_from_handle (session_handle_t handle)
229 session_main_t *smm = &session_main;
230 u32 session_index, thread_index;
231 session_parse_handle (handle, &session_index, &thread_index);
232 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
235 always_inline session_t *
236 session_get_from_handle_if_valid (session_handle_t handle)
238 u32 session_index, thread_index;
239 session_parse_handle (handle, &session_index, &thread_index);
240 return session_get_if_valid (session_index, thread_index);
243 u64 session_segment_handle (session_t * s);
246 * Acquires a lock that blocks a session pool from expanding.
248 * This is typically used for safely peeking into other threads'
249 * pools in order to clone elements. Lock should be dropped as soon
250 * as possible by calling @ref session_pool_remove_peeker.
252 * NOTE: Avoid using pool_elt_at_index while the lock is held because
253 * it may lead to free elt bitmap expansion/contraction!
256 session_pool_add_peeker (u32 thread_index)
258 session_worker_t *wrk = &session_main.wrk[thread_index];
259 if (thread_index == vlib_get_thread_index ())
261 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
265 session_pool_remove_peeker (u32 thread_index)
267 session_worker_t *wrk = &session_main.wrk[thread_index];
268 if (thread_index == vlib_get_thread_index ())
270 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
274 * Get session from handle and 'lock' pool resize if not in same thread
276 * Caller should drop the peek 'lock' as soon as possible.
278 always_inline session_t *
279 session_get_from_handle_safe (u64 handle)
281 u32 thread_index = session_thread_from_handle (handle);
282 session_worker_t *wrk = &session_main.wrk[thread_index];
284 if (thread_index == vlib_get_thread_index ())
286 return pool_elt_at_index (wrk->sessions,
287 session_index_from_handle (handle));
291 session_pool_add_peeker (thread_index);
292 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
293 return wrk->sessions + session_index_from_handle (handle);
298 session_get_index (session_t * s)
300 return (s - session_main.wrk[s->thread_index].sessions);
303 always_inline session_t *
304 session_clone_safe (u32 session_index, u32 thread_index)
306 session_t *old_s, *new_s;
307 u32 current_thread_index = vlib_get_thread_index ();
309 /* If during the memcpy pool is reallocated AND the memory allocator
310 * decides to give the old chunk of memory to somebody in a hurry to
311 * scribble something on it, we have a problem. So add this thread as
312 * a session pool peeker.
314 session_pool_add_peeker (thread_index);
315 new_s = session_alloc (current_thread_index);
316 old_s = session_main.wrk[thread_index].sessions + session_index;
317 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
318 session_pool_remove_peeker (thread_index);
319 new_s->thread_index = current_thread_index;
320 new_s->session_index = session_get_index (new_s);
324 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
325 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
326 int session_stop_listen (session_t * s);
327 void session_close (session_t * s);
328 void session_transport_close (session_t * s);
329 void session_transport_cleanup (session_t * s);
330 int session_send_io_evt_to_thread (svm_fifo_t * f,
331 session_evt_type_t evt_type);
332 int session_enqueue_notify (session_t * s);
333 int session_dequeue_notify (session_t * s);
334 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
335 session_evt_type_t evt_type);
336 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
338 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
340 transport_connection_t *session_get_transport (session_t * s);
343 u8 *format_session (u8 * s, va_list * args);
344 uword unformat_session (unformat_input_t * input, va_list * args);
345 uword unformat_transport_connection (unformat_input_t * input,
349 * Interface to transport protos
352 int session_enqueue_stream_connection (transport_connection_t * tc,
353 vlib_buffer_t * b, u32 offset,
354 u8 queue_event, u8 is_in_order);
355 int session_enqueue_dgram_connection (session_t * s,
356 session_dgram_hdr_t * hdr,
357 vlib_buffer_t * b, u8 proto,
359 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
360 int session_dgram_connect_notify (transport_connection_t * tc,
361 u32 old_thread_index,
362 session_t ** new_session);
363 int session_stream_accept_notify (transport_connection_t * tc);
364 void session_transport_closing_notify (transport_connection_t * tc);
365 void session_transport_delete_notify (transport_connection_t * tc);
366 void session_transport_closed_notify (transport_connection_t * tc);
367 void session_transport_reset_notify (transport_connection_t * tc);
368 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
370 void session_register_transport (transport_proto_t transport_proto,
371 const transport_proto_vft_t * vft, u8 is_ip4,
373 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
374 u32 offset, u32 max_bytes);
375 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
378 transport_max_rx_enqueue (transport_connection_t * tc)
380 session_t *s = session_get (tc->s_index, tc->thread_index);
381 return svm_fifo_max_enqueue (s->rx_fifo);
385 transport_max_tx_dequeue (transport_connection_t * tc)
387 session_t *s = session_get (tc->s_index, tc->thread_index);
388 return svm_fifo_max_dequeue (s->tx_fifo);
392 transport_rx_fifo_size (transport_connection_t * tc)
394 session_t *s = session_get (tc->s_index, tc->thread_index);
395 return s->rx_fifo->nitems;
399 transport_tx_fifo_size (transport_connection_t * tc)
401 session_t *s = session_get (tc->s_index, tc->thread_index);
402 return s->tx_fifo->nitems;
406 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
408 session_t *s = session_get (tc->c_index, tc->thread_index);
409 return svm_fifo_has_ooo_data (s->rx_fifo);
413 transport_dispatch_period (u32 thread_index)
415 return session_main.wrk[thread_index].dispatch_period;
419 transport_time_now (u32 thread_index)
421 return session_main.wrk[thread_index].last_vlib_time;
425 transport_add_tx_event (transport_connection_t * tc)
427 session_t *s = session_get (tc->s_index, tc->thread_index);
428 if (svm_fifo_has_event (s->tx_fifo))
430 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
438 listen_session_get_handle (session_t * s)
440 ASSERT (s->session_state == SESSION_STATE_LISTENING);
441 return session_handle (s);
444 always_inline session_t *
445 listen_session_get_from_handle (session_handle_t handle)
447 return session_get_from_handle (handle);
451 listen_session_parse_handle (session_handle_t handle, u32 * index,
454 session_parse_handle (handle, index, thread_index);
457 always_inline session_t *
458 listen_session_alloc (u8 thread_index, session_type_t type)
461 s = session_alloc (thread_index);
462 s->session_type = type;
463 s->session_state = SESSION_STATE_LISTENING;
467 always_inline session_t *
468 listen_session_get (u32 ls_index)
470 return session_get (ls_index, 0);
474 listen_session_free (session_t * s)
479 transport_connection_t *listen_session_get_transport (session_t * s);
482 * Session layer functions
485 always_inline session_main_t *
486 vnet_get_session_main ()
488 return &session_main;
491 always_inline session_worker_t *
492 session_main_get_worker (u32 thread_index)
494 return &session_main.wrk[thread_index];
497 always_inline svm_msg_q_t *
498 session_main_get_vpp_event_queue (u32 thread_index)
500 return session_main.wrk[thread_index].vpp_event_queue;
504 session_main_is_enabled ()
506 return session_main.is_enabled == 1;
509 #define session_cli_return_if_not_enabled() \
511 if (!session_main.is_enabled) \
512 return clib_error_return(0, "session layer is not enabled"); \
515 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
516 int session_main_flush_all_enqueue_events (u8 transport_proto);
517 void session_flush_frames_main_thread (vlib_main_t * vm);
518 ssvm_private_t *session_main_get_evt_q_segment (void);
519 void session_node_enable_disable (u8 is_en);
520 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
522 #endif /* __included_session_h__ */
525 * fd.io coding-style-patch-verification: ON
528 * eval: (c-set-style "gnu")