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>
23 #include <svm/fifo_segment.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") \
36 #define _(sym,str) SESSION_ERROR_##sym,
37 foreach_session_input_error
40 } session_input_error_t;
42 typedef struct session_tx_context_
44 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
46 transport_proto_vft_t *transport_vft;
47 transport_connection_t *tc;
48 transport_send_params_t sp;
52 u16 deq_per_first_buf;
57 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
58 session_dgram_hdr_t hdr;
59 } session_tx_context_t;
61 typedef struct session_evt_elt
63 clib_llist_anchor_t evt_list;
67 typedef struct session_ctrl_evt_data_
69 u8 data[SESSION_CTRL_MSG_MAX_SIZE];
70 } session_evt_ctrl_data_t;
72 typedef struct session_worker_
74 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
76 /** Worker session pool */
79 /** vpp event message queue for worker */
80 svm_msg_q_t *vpp_event_queue;
82 /** vlib_time_now last time around the track */
83 clib_time_type_t last_vlib_time;
85 /** vlib_time_now rounded to us precision and as u64 */
86 clib_us_time_t last_vlib_us_time;
88 /** Convenience pointer to this worker's vlib_main */
91 /** Per-proto vector of sessions to enqueue */
92 u32 **session_to_enqueue;
94 /** Context for session tx */
95 session_tx_context_t ctx;
97 /** Vector of tx buffer free lists */
100 /** Pool of session event list elements */
101 session_evt_elt_t *event_elts;
103 /** Pool of ctrl events data buffers */
104 session_evt_ctrl_data_t *ctrl_evts_data;
106 /** Head of control events list */
107 clib_llist_index_t ctrl_head;
109 /** Head of list of elements */
110 clib_llist_index_t new_head;
112 /** Head of list of pending events */
113 clib_llist_index_t old_head;
115 /** Peekers rw lock */
116 clib_rwlock_t peekers_rw_locks;
118 /** Vector of buffers to be sent */
119 u32 *pending_tx_buffers;
121 /** Vector of nexts for the pending tx buffers */
122 u16 *pending_tx_nexts;
125 /** last event poll time by thread */
126 clib_time_type_t last_event_poll;
130 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
131 vlib_node_runtime_t * node,
132 session_evt_elt_t * e, int *n_tx_packets);
134 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
135 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
136 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
138 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
140 typedef struct session_main_
142 /** Worker contexts */
143 session_worker_t *wrk;
145 /** Event queues memfd segment */
146 fifo_segment_t evt_qs_segment;
148 /** Unique segment name counter */
149 u32 unique_segment_name_counter;
151 /** Per transport rx function that can either dequeue or peek */
152 session_fifo_rx_fn **session_tx_fns;
154 /** Per session type output nodes. Could optimize to group nodes by
155 * fib but lookup would then require session type parsing in session node.
156 * Trade memory for speed, for now */
157 u32 *session_type_to_next;
159 transport_proto_t last_transport_proto_type;
165 /** Session manager is enabled */
168 /** Session manager initialized (not necessarily enabled) */
171 /** Enable session manager at startup */
172 u8 session_enable_asap;
174 /** Poll session node in main thread */
177 /** Allocate private rx mqs for external apps */
178 u8 use_private_rx_mqs;
180 /** vpp fifo event queue configured length */
181 u32 configured_event_queue_length;
183 /** Session ssvm segment configs*/
184 uword session_baseva;
185 uword session_va_space_size;
186 uword evt_qs_segment_size;
188 /** Session table size parameters */
189 u32 configured_v4_session_table_buckets;
190 u32 configured_v4_session_table_memory;
191 u32 configured_v4_halfopen_table_buckets;
192 u32 configured_v4_halfopen_table_memory;
193 u32 configured_v6_session_table_buckets;
194 u32 configured_v6_session_table_memory;
195 u32 configured_v6_halfopen_table_buckets;
196 u32 configured_v6_halfopen_table_memory;
198 /** Transport table (preallocation) size parameters */
199 u32 local_endpoints_table_memory;
200 u32 local_endpoints_table_buckets;
202 /** Preallocate session config parameter */
203 u32 preallocated_sessions;
207 extern session_main_t session_main;
208 extern vlib_node_registration_t session_queue_node;
209 extern vlib_node_registration_t session_queue_process_node;
210 extern vlib_node_registration_t session_queue_pre_input_node;
212 typedef enum session_q_process_evt_
214 SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
215 SESSION_Q_PROCESS_STOP
216 } session_q_process_evt_t;
218 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
219 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
221 static inline session_evt_elt_t *
222 session_evt_elt_alloc (session_worker_t * wrk)
224 session_evt_elt_t *elt;
225 pool_get (wrk->event_elts, elt);
230 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
232 pool_put (wrk->event_elts, elt);
236 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
238 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
239 pool_elt_at_index (wrk->event_elts, wrk->old_head));
243 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
245 clib_llist_add (wrk->event_elts, evt_list, elt,
246 pool_elt_at_index (wrk->event_elts, wrk->old_head));
251 session_evt_ctrl_data_alloc (session_worker_t * wrk)
253 session_evt_ctrl_data_t *data;
254 pool_get (wrk->ctrl_evts_data, data);
255 return (data - wrk->ctrl_evts_data);
258 static inline session_evt_elt_t *
259 session_evt_alloc_ctrl (session_worker_t * wrk)
261 session_evt_elt_t *elt;
262 elt = session_evt_elt_alloc (wrk);
263 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
264 pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
269 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
271 return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
272 elt->evt.ctrl_data_index));
276 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
278 ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
279 pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
282 static inline session_evt_elt_t *
283 session_evt_alloc_new (session_worker_t * wrk)
285 session_evt_elt_t *elt;
286 elt = session_evt_elt_alloc (wrk);
287 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
288 pool_elt_at_index (wrk->event_elts, wrk->new_head));
292 static inline session_evt_elt_t *
293 session_evt_alloc_old (session_worker_t * wrk)
295 session_evt_elt_t *elt;
296 elt = session_evt_elt_alloc (wrk);
297 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
298 pool_elt_at_index (wrk->event_elts, wrk->old_head));
302 int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
304 session_t *session_alloc (u32 thread_index);
305 void session_free (session_t * s);
306 void session_free_w_fifos (session_t * s);
307 void session_cleanup_half_open (transport_proto_t tp,
308 session_handle_t ho_handle);
309 u8 session_is_valid (u32 si, u8 thread_index);
311 always_inline session_t *
312 session_get (u32 si, u32 thread_index)
314 ASSERT (session_is_valid (si, thread_index));
315 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
318 always_inline session_t *
319 session_get_if_valid (u64 si, u32 thread_index)
321 if (thread_index >= vec_len (session_main.wrk))
324 if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
327 ASSERT (session_is_valid (si, thread_index));
328 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
331 always_inline session_t *
332 session_get_from_handle (session_handle_t handle)
334 session_main_t *smm = &session_main;
335 u32 session_index, thread_index;
336 session_parse_handle (handle, &session_index, &thread_index);
337 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
340 always_inline session_t *
341 session_get_from_handle_if_valid (session_handle_t handle)
343 u32 session_index, thread_index;
344 session_parse_handle (handle, &session_index, &thread_index);
345 return session_get_if_valid (session_index, thread_index);
348 u64 session_segment_handle (session_t * s);
351 * Acquires a lock that blocks a session pool from expanding.
353 * This is typically used for safely peeking into other threads'
354 * pools in order to clone elements. Lock should be dropped as soon
355 * as possible by calling @ref session_pool_remove_peeker.
357 * NOTE: Avoid using pool_elt_at_index while the lock is held because
358 * it may lead to free elt bitmap expansion/contraction!
361 session_pool_add_peeker (u32 thread_index)
363 session_worker_t *wrk = &session_main.wrk[thread_index];
364 if (thread_index == vlib_get_thread_index ())
366 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
370 session_pool_remove_peeker (u32 thread_index)
372 session_worker_t *wrk = &session_main.wrk[thread_index];
373 if (thread_index == vlib_get_thread_index ())
375 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
379 * Get session from handle and 'lock' pool resize if not in same thread
381 * Caller should drop the peek 'lock' as soon as possible.
383 always_inline session_t *
384 session_get_from_handle_safe (u64 handle)
386 u32 thread_index = session_thread_from_handle (handle);
387 session_worker_t *wrk = &session_main.wrk[thread_index];
389 if (thread_index == vlib_get_thread_index ())
391 return pool_elt_at_index (wrk->sessions,
392 session_index_from_handle (handle));
396 session_pool_add_peeker (thread_index);
397 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
398 return wrk->sessions + session_index_from_handle (handle);
403 session_get_index (session_t * s)
405 return (s - session_main.wrk[s->thread_index].sessions);
408 always_inline session_t *
409 session_clone_safe (u32 session_index, u32 thread_index)
411 session_t *old_s, *new_s;
412 u32 current_thread_index = vlib_get_thread_index ();
414 /* If during the memcpy pool is reallocated AND the memory allocator
415 * decides to give the old chunk of memory to somebody in a hurry to
416 * scribble something on it, we have a problem. So add this thread as
417 * a session pool peeker.
419 session_pool_add_peeker (thread_index);
420 new_s = session_alloc (current_thread_index);
421 old_s = session_main.wrk[thread_index].sessions + session_index;
422 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
423 session_pool_remove_peeker (thread_index);
424 new_s->thread_index = current_thread_index;
425 new_s->session_index = session_get_index (new_s);
429 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
430 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
431 int session_stop_listen (session_t * s);
432 void session_close (session_t * s);
433 void session_reset (session_t * s);
434 void session_transport_close (session_t * s);
435 void session_transport_reset (session_t * s);
436 void session_transport_cleanup (session_t * s);
437 int session_send_io_evt_to_thread (svm_fifo_t * f,
438 session_evt_type_t evt_type);
439 int session_enqueue_notify (session_t * s);
440 int session_dequeue_notify (session_t * s);
441 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
442 session_evt_type_t evt_type);
443 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
445 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
447 void session_add_self_custom_tx_evt (transport_connection_t * tc,
449 void sesssion_reschedule_tx (transport_connection_t * tc);
450 transport_connection_t *session_get_transport (session_t * s);
451 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
454 u8 *format_session (u8 * s, va_list * args);
455 uword unformat_session (unformat_input_t * input, va_list * args);
456 uword unformat_transport_connection (unformat_input_t * input,
460 * Interface to transport protos
463 int session_enqueue_stream_connection (transport_connection_t * tc,
464 vlib_buffer_t * b, u32 offset,
465 u8 queue_event, u8 is_in_order);
466 int session_enqueue_dgram_connection (session_t * s,
467 session_dgram_hdr_t * hdr,
468 vlib_buffer_t * b, u8 proto,
470 int session_stream_connect_notify (transport_connection_t * tc,
471 session_error_t err);
472 int session_dgram_connect_notify (transport_connection_t * tc,
473 u32 old_thread_index,
474 session_t ** new_session);
475 int session_stream_accept_notify (transport_connection_t * tc);
476 void session_transport_closing_notify (transport_connection_t * tc);
477 void session_transport_delete_notify (transport_connection_t * tc);
478 void session_half_open_delete_notify (transport_proto_t tp,
479 session_handle_t ho_handle);
480 void session_transport_closed_notify (transport_connection_t * tc);
481 void session_transport_reset_notify (transport_connection_t * tc);
482 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
483 u32 thread_index, u8 notify);
484 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
487 * Initialize session layer for given transport proto and ip version
489 * Allocates per session type (transport proto + ip version) data structures
490 * and adds arc from session queue node to session type output node.
492 * @param transport_proto transport proto to be registered
493 * @param vft virtual function table for transport
494 * @param is_ip4 flag that indicates if transports uses ipv4
495 * as underlying network layer
496 * @param output_node output node for transport
498 void session_register_transport (transport_proto_t transport_proto,
499 const transport_proto_vft_t * vft, u8 is_ip4,
501 transport_proto_t session_add_transport_proto (void);
502 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
503 u32 offset, u32 max_bytes);
504 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
507 transport_max_rx_enqueue (transport_connection_t * tc)
509 session_t *s = session_get (tc->s_index, tc->thread_index);
510 return svm_fifo_max_enqueue_prod (s->rx_fifo);
514 transport_max_tx_dequeue (transport_connection_t * tc)
516 session_t *s = session_get (tc->s_index, tc->thread_index);
517 return svm_fifo_max_dequeue_cons (s->tx_fifo);
521 transport_max_rx_dequeue (transport_connection_t * tc)
523 session_t *s = session_get (tc->s_index, tc->thread_index);
524 return svm_fifo_max_dequeue (s->rx_fifo);
528 transport_rx_fifo_size (transport_connection_t * tc)
530 session_t *s = session_get (tc->s_index, tc->thread_index);
531 return svm_fifo_size (s->rx_fifo);
535 transport_tx_fifo_size (transport_connection_t * tc)
537 session_t *s = session_get (tc->s_index, tc->thread_index);
538 return svm_fifo_size (s->tx_fifo);
542 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
544 session_t *s = session_get (tc->c_index, tc->thread_index);
545 return svm_fifo_has_ooo_data (s->rx_fifo);
548 always_inline clib_time_type_t
549 transport_time_now (u32 thread_index)
551 return session_main.wrk[thread_index].last_vlib_time;
554 always_inline clib_us_time_t
555 transport_us_time_now (u32 thread_index)
557 return session_main.wrk[thread_index].last_vlib_us_time;
560 always_inline clib_time_type_t
561 transport_seconds_per_loop (u32 thread_index)
563 return session_main.wrk[thread_index].vm->seconds_per_loop;
567 transport_add_tx_event (transport_connection_t * tc)
569 session_t *s = session_get (tc->s_index, tc->thread_index);
570 if (svm_fifo_has_event (s->tx_fifo))
572 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
580 listen_session_get_handle (session_t * s)
582 ASSERT (s->session_state == SESSION_STATE_LISTENING ||
583 session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
584 return session_handle (s);
587 always_inline session_t *
588 listen_session_get_from_handle (session_handle_t handle)
590 return session_get_from_handle (handle);
594 listen_session_parse_handle (session_handle_t handle, u32 * index,
597 session_parse_handle (handle, index, thread_index);
600 always_inline session_t *
601 listen_session_alloc (u8 thread_index, session_type_t type)
604 s = session_alloc (thread_index);
605 s->session_type = type;
606 s->session_state = SESSION_STATE_LISTENING;
610 always_inline session_t *
611 listen_session_get (u32 ls_index)
613 return session_get (ls_index, 0);
617 listen_session_free (session_t * s)
619 ASSERT (!s->rx_fifo);
623 transport_connection_t *listen_session_get_transport (session_t * s);
626 * Session layer functions
629 always_inline session_main_t *
630 vnet_get_session_main ()
632 return &session_main;
635 always_inline session_worker_t *
636 session_main_get_worker (u32 thread_index)
638 return &session_main.wrk[thread_index];
641 static inline session_worker_t *
642 session_main_get_worker_if_valid (u32 thread_index)
644 if (thread_index > vec_len (session_main.wrk))
646 return &session_main.wrk[thread_index];
649 always_inline svm_msg_q_t *
650 session_main_get_vpp_event_queue (u32 thread_index)
652 return session_main.wrk[thread_index].vpp_event_queue;
656 session_main_is_enabled ()
658 return session_main.is_enabled == 1;
661 #define session_cli_return_if_not_enabled() \
663 if (!session_main.is_enabled) \
664 return clib_error_return (0, "session layer is not enabled"); \
667 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
668 int session_main_flush_all_enqueue_events (u8 transport_proto);
669 void session_queue_run_on_main_thread (vlib_main_t * vm);
672 * Add session node pending buffer with custom node
674 * @param thread_index worker thread expected to send the buffer
675 * @param bi buffer index
676 * @param next_node next node edge index for buffer. Edge to next node
680 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
682 session_worker_t *wrk = session_main_get_worker (thread_index);
683 vec_add1 (wrk->pending_tx_buffers, bi);
684 vec_add1 (wrk->pending_tx_nexts, next_node);
688 session_wrk_update_time (session_worker_t *wrk, f64 now)
690 wrk->last_vlib_time = now;
691 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
694 fifo_segment_t *session_main_get_evt_q_segment (void);
695 void session_node_enable_disable (u8 is_en);
696 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
698 session_t *session_alloc_for_connection (transport_connection_t * tc);
700 #endif /* __included_session_h__ */
703 * fd.io coding-style-patch-verification: ON
706 * eval: (c-set-style "gnu")