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 <vppinfra/llist.h>
19 #include <vnet/session/session_types.h>
20 #include <vnet/session/session_lookup.h>
21 #include <vnet/session/session_debug.h>
22 #include <svm/message_queue.h>
25 #define foreach_session_input_error \
26 _(NO_SESSION, "No session drops") \
27 _(NO_LISTENER, "No listener for dst port drops") \
28 _(ENQUEUED, "Packets pushed into rx fifo") \
29 _(NOT_READY, "Session not ready packets") \
30 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
31 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
32 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
33 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
34 _(NO_SPACE, "Couldn't allocate a fifo pair") \
35 _(SEG_CREATE, "Couldn't create a new segment")
39 #define _(sym,str) SESSION_ERROR_##sym,
40 foreach_session_input_error
45 typedef struct session_tx_context_
47 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
49 transport_proto_vft_t *transport_vft;
50 transport_connection_t *tc;
51 transport_send_params_t sp;
55 u16 deq_per_first_buf;
59 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
60 session_dgram_hdr_t hdr;
61 } session_tx_context_t;
63 typedef struct session_evt_elt
65 clib_llist_anchor_t evt_list;
69 typedef struct session_ctrl_evt_data_
71 u8 data[SESSION_CTRL_MSG_MAX_SIZE];
72 } session_evt_ctrl_data_t;
74 typedef struct session_worker_
76 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
78 /** Worker session pool */
81 /** vpp event message queue for worker */
82 svm_msg_q_t *vpp_event_queue;
84 /** vlib_time_now last time around the track */
85 clib_time_type_t last_vlib_time;
87 /** vlib_time_now rounded to us precision and as u64 */
88 clib_us_time_t last_vlib_us_time;
90 /** Convenience pointer to this worker's vlib_main */
93 /** Per-proto vector of sessions to enqueue */
94 u32 *session_to_enqueue[TRANSPORT_N_PROTO];
96 /** Context for session tx */
97 session_tx_context_t ctx;
99 /** Vector of tx buffer free lists */
102 /** Pool of session event list elements */
103 session_evt_elt_t *event_elts;
105 /** Pool of ctrl events data buffers */
106 session_evt_ctrl_data_t *ctrl_evts_data;
108 /** Head of control events list */
109 clib_llist_index_t ctrl_head;
111 /** Head of list of elements */
112 clib_llist_index_t new_head;
114 /** Head of list of pending events */
115 clib_llist_index_t old_head;
117 /** Peekers rw lock */
118 clib_rwlock_t peekers_rw_locks;
120 /** Vector of buffers to be sent */
121 u32 *pending_tx_buffers;
123 /** Vector of nexts for the pending tx buffers */
124 u16 *pending_tx_nexts;
127 /** last event poll time by thread */
128 clib_time_type_t last_event_poll;
132 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
133 vlib_node_runtime_t * node,
134 session_evt_elt_t * e, int *n_tx_packets);
136 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
137 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
138 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
140 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
142 typedef struct session_main_
144 /** Worker contexts */
145 session_worker_t *wrk;
147 /** Event queues memfd segment initialized only if so configured */
148 ssvm_private_t evt_qs_segment;
150 /** Unique segment name counter */
151 u32 unique_segment_name_counter;
153 /** Per transport rx function that can either dequeue or peek */
154 session_fifo_rx_fn **session_tx_fns;
156 /** Per session type output nodes. Could optimize to group nodes by
157 * fib but lookup would then require session type parsing in session node.
158 * Trade memory for speed, for now */
159 u32 *session_type_to_next;
165 /** Session manager is enabled */
167 /** Enable session manager at startup */
168 u8 session_enable_asap;
170 /** vpp fifo event queue configured length */
171 u32 configured_event_queue_length;
173 /** Session ssvm segment configs*/
174 uword session_baseva;
175 uword session_va_space_size;
176 uword evt_qs_segment_size;
177 u8 evt_qs_use_memfd_seg;
179 /** Session table size parameters */
180 u32 configured_v4_session_table_buckets;
181 u32 configured_v4_session_table_memory;
182 u32 configured_v4_halfopen_table_buckets;
183 u32 configured_v4_halfopen_table_memory;
184 u32 configured_v6_session_table_buckets;
185 u32 configured_v6_session_table_memory;
186 u32 configured_v6_halfopen_table_buckets;
187 u32 configured_v6_halfopen_table_memory;
189 /** Transport table (preallocation) size parameters */
190 u32 local_endpoints_table_memory;
191 u32 local_endpoints_table_buckets;
193 /** Preallocate session config parameter */
194 u32 preallocated_sessions;
198 extern session_main_t session_main;
199 extern vlib_node_registration_t session_queue_node;
200 extern vlib_node_registration_t session_queue_process_node;
201 extern vlib_node_registration_t session_queue_pre_input_node;
203 #define SESSION_Q_PROCESS_FLUSH_FRAMES 1
204 #define SESSION_Q_PROCESS_STOP 2
206 static inline session_evt_elt_t *
207 session_evt_elt_alloc (session_worker_t * wrk)
209 session_evt_elt_t *elt;
210 pool_get (wrk->event_elts, elt);
215 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
217 pool_put (wrk->event_elts, elt);
221 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
223 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
224 pool_elt_at_index (wrk->event_elts, wrk->old_head));
228 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
230 clib_llist_add (wrk->event_elts, evt_list, elt,
231 pool_elt_at_index (wrk->event_elts, wrk->old_head));
236 session_evt_ctrl_data_alloc (session_worker_t * wrk)
238 session_evt_ctrl_data_t *data;
239 pool_get (wrk->ctrl_evts_data, data);
240 return (data - wrk->ctrl_evts_data);
243 static inline session_evt_elt_t *
244 session_evt_alloc_ctrl (session_worker_t * wrk)
246 session_evt_elt_t *elt;
247 elt = session_evt_elt_alloc (wrk);
248 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
249 pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
254 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
256 return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
257 elt->evt.ctrl_data_index));
261 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
263 ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
264 pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
267 static inline session_evt_elt_t *
268 session_evt_alloc_new (session_worker_t * wrk)
270 session_evt_elt_t *elt;
271 elt = session_evt_elt_alloc (wrk);
272 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
273 pool_elt_at_index (wrk->event_elts, wrk->new_head));
277 static inline session_evt_elt_t *
278 session_evt_alloc_old (session_worker_t * wrk)
280 session_evt_elt_t *elt;
281 elt = session_evt_elt_alloc (wrk);
282 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
283 pool_elt_at_index (wrk->event_elts, wrk->old_head));
287 session_t *session_alloc (u32 thread_index);
288 void session_free (session_t * s);
289 void session_free_w_fifos (session_t * s);
290 u8 session_is_valid (u32 si, u8 thread_index);
292 always_inline session_t *
293 session_get (u32 si, u32 thread_index)
295 ASSERT (session_is_valid (si, thread_index));
296 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
299 always_inline session_t *
300 session_get_if_valid (u64 si, u32 thread_index)
302 if (thread_index >= vec_len (session_main.wrk))
305 if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
308 ASSERT (session_is_valid (si, thread_index));
309 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
312 always_inline session_t *
313 session_get_from_handle (session_handle_t handle)
315 session_main_t *smm = &session_main;
316 u32 session_index, thread_index;
317 session_parse_handle (handle, &session_index, &thread_index);
318 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
321 always_inline session_t *
322 session_get_from_handle_if_valid (session_handle_t handle)
324 u32 session_index, thread_index;
325 session_parse_handle (handle, &session_index, &thread_index);
326 return session_get_if_valid (session_index, thread_index);
329 u64 session_segment_handle (session_t * s);
332 * Acquires a lock that blocks a session pool from expanding.
334 * This is typically used for safely peeking into other threads'
335 * pools in order to clone elements. Lock should be dropped as soon
336 * as possible by calling @ref session_pool_remove_peeker.
338 * NOTE: Avoid using pool_elt_at_index while the lock is held because
339 * it may lead to free elt bitmap expansion/contraction!
342 session_pool_add_peeker (u32 thread_index)
344 session_worker_t *wrk = &session_main.wrk[thread_index];
345 if (thread_index == vlib_get_thread_index ())
347 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
351 session_pool_remove_peeker (u32 thread_index)
353 session_worker_t *wrk = &session_main.wrk[thread_index];
354 if (thread_index == vlib_get_thread_index ())
356 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
360 * Get session from handle and 'lock' pool resize if not in same thread
362 * Caller should drop the peek 'lock' as soon as possible.
364 always_inline session_t *
365 session_get_from_handle_safe (u64 handle)
367 u32 thread_index = session_thread_from_handle (handle);
368 session_worker_t *wrk = &session_main.wrk[thread_index];
370 if (thread_index == vlib_get_thread_index ())
372 return pool_elt_at_index (wrk->sessions,
373 session_index_from_handle (handle));
377 session_pool_add_peeker (thread_index);
378 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
379 return wrk->sessions + session_index_from_handle (handle);
384 session_get_index (session_t * s)
386 return (s - session_main.wrk[s->thread_index].sessions);
389 always_inline session_t *
390 session_clone_safe (u32 session_index, u32 thread_index)
392 session_t *old_s, *new_s;
393 u32 current_thread_index = vlib_get_thread_index ();
395 /* If during the memcpy pool is reallocated AND the memory allocator
396 * decides to give the old chunk of memory to somebody in a hurry to
397 * scribble something on it, we have a problem. So add this thread as
398 * a session pool peeker.
400 session_pool_add_peeker (thread_index);
401 new_s = session_alloc (current_thread_index);
402 old_s = session_main.wrk[thread_index].sessions + session_index;
403 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
404 session_pool_remove_peeker (thread_index);
405 new_s->thread_index = current_thread_index;
406 new_s->session_index = session_get_index (new_s);
410 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
411 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
412 int session_stop_listen (session_t * s);
413 void session_close (session_t * s);
414 void session_reset (session_t * s);
415 void session_transport_close (session_t * s);
416 void session_transport_reset (session_t * s);
417 void session_transport_cleanup (session_t * s);
418 int session_send_io_evt_to_thread (svm_fifo_t * f,
419 session_evt_type_t evt_type);
420 int session_enqueue_notify (session_t * s);
421 int session_dequeue_notify (session_t * s);
422 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
423 session_evt_type_t evt_type);
424 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
426 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
428 void session_add_self_custom_tx_evt (transport_connection_t * tc,
430 void sesssion_reschedule_tx (transport_connection_t * tc);
431 transport_connection_t *session_get_transport (session_t * s);
432 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
435 u8 *format_session (u8 * s, va_list * args);
436 uword unformat_session (unformat_input_t * input, va_list * args);
437 uword unformat_transport_connection (unformat_input_t * input,
441 * Interface to transport protos
444 int session_enqueue_stream_connection (transport_connection_t * tc,
445 vlib_buffer_t * b, u32 offset,
446 u8 queue_event, u8 is_in_order);
447 int session_enqueue_dgram_connection (session_t * s,
448 session_dgram_hdr_t * hdr,
449 vlib_buffer_t * b, u8 proto,
451 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
452 int session_dgram_connect_notify (transport_connection_t * tc,
453 u32 old_thread_index,
454 session_t ** new_session);
455 int session_stream_accept_notify (transport_connection_t * tc);
456 void session_transport_closing_notify (transport_connection_t * tc);
457 void session_transport_delete_notify (transport_connection_t * tc);
458 void session_transport_closed_notify (transport_connection_t * tc);
459 void session_transport_reset_notify (transport_connection_t * tc);
460 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
461 u32 thread_index, u8 notify);
462 void session_register_transport (transport_proto_t transport_proto,
463 const transport_proto_vft_t * vft, u8 is_ip4,
465 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
466 u32 offset, u32 max_bytes);
467 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
470 transport_max_rx_enqueue (transport_connection_t * tc)
472 session_t *s = session_get (tc->s_index, tc->thread_index);
473 return svm_fifo_max_enqueue_prod (s->rx_fifo);
477 transport_max_tx_dequeue (transport_connection_t * tc)
479 session_t *s = session_get (tc->s_index, tc->thread_index);
480 return svm_fifo_max_dequeue_cons (s->tx_fifo);
484 transport_max_rx_dequeue (transport_connection_t * tc)
486 session_t *s = session_get (tc->s_index, tc->thread_index);
487 return svm_fifo_max_dequeue (s->rx_fifo);
491 transport_rx_fifo_size (transport_connection_t * tc)
493 session_t *s = session_get (tc->s_index, tc->thread_index);
494 return svm_fifo_size (s->rx_fifo);
498 transport_tx_fifo_size (transport_connection_t * tc)
500 session_t *s = session_get (tc->s_index, tc->thread_index);
501 return svm_fifo_size (s->tx_fifo);
505 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
507 session_t *s = session_get (tc->c_index, tc->thread_index);
508 return svm_fifo_has_ooo_data (s->rx_fifo);
511 always_inline clib_time_type_t
512 transport_time_now (u32 thread_index)
514 return session_main.wrk[thread_index].last_vlib_time;
517 always_inline clib_us_time_t
518 transport_us_time_now (u32 thread_index)
520 return session_main.wrk[thread_index].last_vlib_us_time;
524 transport_add_tx_event (transport_connection_t * tc)
526 session_t *s = session_get (tc->s_index, tc->thread_index);
527 if (svm_fifo_has_event (s->tx_fifo))
529 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
537 listen_session_get_handle (session_t * s)
539 ASSERT (s->session_state == SESSION_STATE_LISTENING ||
540 session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
541 return session_handle (s);
544 always_inline session_t *
545 listen_session_get_from_handle (session_handle_t handle)
547 return session_get_from_handle (handle);
551 listen_session_parse_handle (session_handle_t handle, u32 * index,
554 session_parse_handle (handle, index, thread_index);
557 always_inline session_t *
558 listen_session_alloc (u8 thread_index, session_type_t type)
561 s = session_alloc (thread_index);
562 s->session_type = type;
563 s->session_state = SESSION_STATE_LISTENING;
567 always_inline session_t *
568 listen_session_get (u32 ls_index)
570 return session_get (ls_index, 0);
574 listen_session_free (session_t * s)
579 transport_connection_t *listen_session_get_transport (session_t * s);
582 * Session layer functions
585 always_inline session_main_t *
586 vnet_get_session_main ()
588 return &session_main;
591 always_inline session_worker_t *
592 session_main_get_worker (u32 thread_index)
594 return &session_main.wrk[thread_index];
597 static inline session_worker_t *
598 session_main_get_worker_if_valid (u32 thread_index)
600 if (thread_index > vec_len (session_main.wrk))
602 return &session_main.wrk[thread_index];
605 always_inline svm_msg_q_t *
606 session_main_get_vpp_event_queue (u32 thread_index)
608 return session_main.wrk[thread_index].vpp_event_queue;
612 session_main_is_enabled ()
614 return session_main.is_enabled == 1;
617 #define session_cli_return_if_not_enabled() \
619 if (!session_main.is_enabled) \
620 return clib_error_return (0, "session layer is not enabled"); \
623 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
624 int session_main_flush_all_enqueue_events (u8 transport_proto);
625 void session_flush_frames_main_thread (vlib_main_t * vm);
628 session_add_pending_tx_buffer (session_type_t st, u32 thread_index, u32 bi)
630 session_worker_t *wrk = session_main_get_worker (thread_index);
631 vec_add1 (wrk->pending_tx_buffers, bi);
632 vec_add1 (wrk->pending_tx_nexts, session_main.session_type_to_next[st]);
635 ssvm_private_t *session_main_get_evt_q_segment (void);
636 void session_node_enable_disable (u8 is_en);
637 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
639 #endif /* __included_session_h__ */
642 * fd.io coding-style-patch-verification: ON
645 * eval: (c-set-style "gnu")