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.
17 * @brief Session and session manager
20 #include <vnet/session/session.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/application.h>
23 #include <vlibmemory/api.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/fib/ip4_fib.h>
27 session_manager_main_t session_manager_main;
28 extern transport_proto_vft_t *tp_vfts;
31 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
32 session_evt_type_t evt_type)
37 u32 tries = 0, max_tries;
39 mq = session_manager_get_vpp_event_queue (thread_index);
40 while (svm_msg_q_try_lock (mq))
42 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
43 if (tries++ == max_tries)
45 SESSION_DBG ("failed to enqueue evt");
49 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
51 svm_msg_q_unlock (mq);
54 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
55 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
57 svm_msg_q_unlock (mq);
60 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
61 evt->event_type = evt_type;
65 evt->rpc_args.fp = data;
66 evt->rpc_args.arg = args;
68 case FIFO_EVENT_APP_TX:
69 case SESSION_IO_EVT_TX_FLUSH:
70 case FIFO_EVENT_BUILTIN_RX:
73 case FIFO_EVENT_BUILTIN_TX:
74 case FIFO_EVENT_DISCONNECT:
75 evt->session_handle = session_handle ((stream_session_t *) data);
78 clib_warning ("evt unhandled!");
79 svm_msg_q_unlock (mq);
83 svm_msg_q_add_and_unlock (mq, &msg);
88 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
90 return session_send_evt_to_thread (f, 0, f->master_thread_index, evt_type);
94 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
95 session_evt_type_t evt_type)
97 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
101 session_send_ctrl_evt_to_thread (stream_session_t * s,
102 session_evt_type_t evt_type)
104 /* only event supported for now is disconnect */
105 ASSERT (evt_type == FIFO_EVENT_DISCONNECT);
106 return session_send_evt_to_thread (s, 0, s->thread_index,
107 FIFO_EVENT_DISCONNECT);
111 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
113 if (thread_index != vlib_get_thread_index ())
114 session_send_evt_to_thread (fp, rpc_args, thread_index, FIFO_EVENT_RPC);
117 void (*fnp) (void *) = fp;
123 session_program_transport_close (stream_session_t * s)
125 u32 thread_index = vlib_get_thread_index ();
126 session_manager_worker_t *wrk;
127 session_event_t *evt;
129 /* If we are in the handler thread, or being called with the worker barrier
130 * held, just append a new event to pending disconnects vector. */
131 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
133 wrk = session_manager_get_worker (s->thread_index);
134 vec_add2 (wrk->pending_disconnects, evt, 1);
135 clib_memset (evt, 0, sizeof (*evt));
136 evt->session_handle = session_handle (s);
137 evt->event_type = FIFO_EVENT_DISCONNECT;
140 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
144 session_alloc (u32 thread_index)
146 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
149 pool_get_aligned_will_expand (wrk->sessions, will_expand,
150 CLIB_CACHE_LINE_BYTES);
151 /* If we have peekers, let them finish */
152 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
154 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
155 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
156 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
160 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
162 clib_memset (s, 0, sizeof (*s));
163 s->session_index = s - wrk->sessions;
164 s->thread_index = thread_index;
169 session_free (stream_session_t * s)
171 pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
173 clib_memset (s, 0xFA, sizeof (*s));
177 session_free_w_fifos (stream_session_t * s)
179 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
185 * Cleans up session and lookup table.
187 * Transport connection must still be valid.
190 session_delete (stream_session_t * s)
194 /* Delete from the main lookup table. */
195 if ((rv = session_lookup_del_session (s)))
196 clib_warning ("hash delete error, rv %d", rv);
198 session_free_w_fifos (s);
202 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
204 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
205 u32 fifo_segment_index;
208 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
210 &fifo_segment_index)))
212 /* Initialize backpointers */
213 server_rx_fifo->master_session_index = s->session_index;
214 server_rx_fifo->master_thread_index = s->thread_index;
216 server_tx_fifo->master_session_index = s->session_index;
217 server_tx_fifo->master_thread_index = s->thread_index;
219 s->server_rx_fifo = server_rx_fifo;
220 s->server_tx_fifo = server_tx_fifo;
221 s->svm_segment_index = fifo_segment_index;
225 static stream_session_t *
226 session_alloc_for_connection (transport_connection_t * tc)
229 u32 thread_index = tc->thread_index;
231 ASSERT (thread_index == vlib_get_thread_index ()
232 || transport_protocol_is_cl (tc->proto));
234 s = session_alloc (thread_index);
235 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
236 s->enqueue_epoch = (u64) ~ 0;
238 /* Attach transport to session and vice versa */
239 s->connection_index = tc->c_index;
240 tc->s_index = s->session_index;
245 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
246 u8 alloc_fifos, stream_session_t ** ret_s)
251 s = session_alloc_for_connection (tc);
252 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
259 /* Add to the main lookup table */
260 session_lookup_add_connection (tc, session_handle (s));
267 * Discards bytes from buffer chain
269 * It discards n_bytes_to_drop starting at first buffer after chain_b
272 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
273 vlib_buffer_t ** chain_b,
276 vlib_buffer_t *next = *chain_b;
277 u32 to_drop = n_bytes_to_drop;
278 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
279 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
281 next = vlib_get_buffer (vm, next->next_buffer);
282 if (next->current_length > to_drop)
284 vlib_buffer_advance (next, to_drop);
289 to_drop -= next->current_length;
290 next->current_length = 0;
296 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
300 * Enqueue buffer chain tail
303 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
304 u32 offset, u8 is_in_order)
306 vlib_buffer_t *chain_b;
307 u32 chain_bi, len, diff;
308 vlib_main_t *vm = vlib_get_main ();
313 if (is_in_order && offset)
315 diff = offset - b->current_length;
316 if (diff > b->total_length_not_including_first_buffer)
319 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
320 chain_bi = vlib_get_buffer_index (vm, chain_b);
323 chain_bi = b->next_buffer;
327 chain_b = vlib_get_buffer (vm, chain_bi);
328 data = vlib_buffer_get_current (chain_b);
329 len = chain_b->current_length;
334 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
341 return (rv > 0) ? (written + rv) : written;
347 /* written more than what was left in chain */
348 if (written > b->total_length_not_including_first_buffer)
351 /* drop the bytes that have already been delivered */
352 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
357 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
361 clib_warning ("failed to enqueue multi-buffer seg");
367 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
368 ? chain_b->next_buffer : 0));
377 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
378 * event but on request can queue notification events for later delivery by
379 * calling stream_server_flush_enqueue_events().
381 * @param tc Transport connection which is to be enqueued data
382 * @param b Buffer to be enqueued
383 * @param offset Offset at which to start enqueueing if out-of-order
384 * @param queue_event Flag to indicate if peer is to be notified or if event
385 * is to be queued. The former is useful when more data is
386 * enqueued and only one event is to be generated.
387 * @param is_in_order Flag to indicate if data is in order
388 * @return Number of bytes enqueued or a negative value if enqueueing failed.
391 session_enqueue_stream_connection (transport_connection_t * tc,
392 vlib_buffer_t * b, u32 offset,
393 u8 queue_event, u8 is_in_order)
396 int enqueued = 0, rv, in_order_off;
398 s = session_get (tc->s_index, tc->thread_index);
402 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
404 vlib_buffer_get_current (b));
405 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
408 in_order_off = enqueued > b->current_length ? enqueued : 0;
409 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
416 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
418 vlib_buffer_get_current (b));
419 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
420 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
421 /* if something was enqueued, report even this as success for ooo
422 * segment handling */
428 /* Queue RX event on this fifo. Eventually these will need to be flushed
429 * by calling stream_server_flush_enqueue_events () */
430 session_manager_worker_t *wrk;
432 wrk = session_manager_get_worker (s->thread_index);
433 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
435 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
436 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
444 session_enqueue_dgram_connection (stream_session_t * s,
445 session_dgram_hdr_t * hdr,
446 vlib_buffer_t * b, u8 proto, u8 queue_event)
448 int enqueued = 0, rv, in_order_off;
450 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
451 >= b->current_length + sizeof (*hdr));
453 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
455 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
456 vlib_buffer_get_current (b));
457 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
459 in_order_off = enqueued > b->current_length ? enqueued : 0;
460 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
466 /* Queue RX event on this fifo. Eventually these will need to be flushed
467 * by calling stream_server_flush_enqueue_events () */
468 session_manager_worker_t *wrk;
470 wrk = session_manager_get_worker (s->thread_index);
471 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
473 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
474 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
480 /** Check if we have space in rx fifo to push more bytes */
482 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
485 stream_session_t *s = session_get (tc->s_index, thread_index);
487 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
490 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
497 session_tx_fifo_max_dequeue (transport_connection_t * tc)
499 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
500 if (!s->server_tx_fifo)
502 return svm_fifo_max_dequeue (s->server_tx_fifo);
506 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
507 u32 offset, u32 max_bytes)
509 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
510 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
514 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
516 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
517 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
521 * Notify session peer that new data has been enqueued.
523 * @param s Stream session for which the event is to be generated.
524 * @param lock Flag to indicate if call should lock message queue.
526 * @return 0 on success or negative number if failed to send notification.
529 session_enqueue_notify (stream_session_t * s)
533 app = app_worker_get_if_valid (s->app_wrk_index);
534 if (PREDICT_FALSE (!app))
536 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
541 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
542 ed->data[0] = FIFO_EVENT_APP_RX;
543 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
547 return app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_RX);
551 session_dequeue_notify (stream_session_t * s)
555 app = app_worker_get_if_valid (s->app_wrk_index);
556 if (PREDICT_FALSE (!app))
559 return app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_TX);
563 * Flushes queue of sessions that are to be notified of new data
566 * @param thread_index Thread index for which the flush is to be performed.
567 * @return 0 on success or a positive number indicating the number of
568 * failures due to API queue being full.
571 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
573 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
578 indices = wrk->session_to_enqueue[transport_proto];
580 for (i = 0; i < vec_len (indices); i++)
582 s = session_get_if_valid (indices[i], thread_index);
583 if (PREDICT_FALSE (!s))
588 if (PREDICT_FALSE (session_enqueue_notify (s)))
592 vec_reset_length (indices);
593 wrk->session_to_enqueue[transport_proto] = indices;
594 wrk->current_enqueue_epoch[transport_proto]++;
600 session_manager_flush_all_enqueue_events (u8 transport_proto)
602 vlib_thread_main_t *vtm = vlib_get_thread_main ();
604 for (i = 0; i < 1 + vtm->n_threads; i++)
605 errors += session_manager_flush_enqueue_events (transport_proto, i);
610 * Init fifo tail and head pointers
612 * Useful if transport uses absolute offsets for tracking ooo segments.
615 stream_session_init_fifos_pointers (transport_connection_t * tc,
616 u32 rx_pointer, u32 tx_pointer)
619 s = session_get (tc->s_index, tc->thread_index);
620 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
621 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
625 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
627 u32 opaque = 0, new_ti, new_si;
628 stream_session_t *new_s = 0;
629 segment_manager_t *sm;
630 app_worker_t *app_wrk;
637 * Find connection handle and cleanup half-open table
639 handle = session_lookup_half_open_handle (tc);
640 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
642 SESSION_DBG ("half-open was removed!");
645 session_lookup_del_half_open (tc);
647 /* Get the app's index from the handle we stored when opening connection
648 * and the opaque (api_context for external apps) from transport session
650 app_wrk = app_worker_get_if_valid (handle >> 32);
653 opaque = tc->s_index;
654 app = application_get (app_wrk->app_index);
657 * Allocate new session with fifos (svm segments are allocated if needed)
661 sm = app_worker_get_connect_segment_manager (app_wrk);
662 alloc_fifos = !application_is_builtin_proxy (app);
663 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
670 new_s->session_state = SESSION_STATE_CONNECTING;
671 new_s->app_wrk_index = app_wrk->wrk_index;
672 new_si = new_s->session_index;
673 new_ti = new_s->thread_index;
678 * Notify client application
680 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
683 SESSION_DBG ("failed to notify app");
686 new_s = session_get (new_si, new_ti);
687 session_transport_close (new_s);
694 new_s = session_get (new_si, new_ti);
695 new_s->session_state = SESSION_STATE_READY;
702 typedef struct _session_switch_pool_args
706 u32 new_thread_index;
707 u32 new_session_index;
708 } session_switch_pool_args_t;
711 session_switch_pool (void *cb_args)
713 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
714 transport_proto_t tp;
716 ASSERT (args->thread_index == vlib_get_thread_index ());
717 s = session_get (args->session_index, args->thread_index);
718 s->server_tx_fifo->master_session_index = args->new_session_index;
719 s->server_tx_fifo->master_thread_index = args->new_thread_index;
720 tp = session_get_transport_proto (s);
721 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
723 clib_mem_free (cb_args);
727 * Move dgram session to the right thread
730 session_dgram_connect_notify (transport_connection_t * tc,
731 u32 old_thread_index,
732 stream_session_t ** new_session)
734 stream_session_t *new_s;
735 session_switch_pool_args_t *rpc_args;
738 * Clone half-open session to the right thread.
740 new_s = session_clone_safe (tc->s_index, old_thread_index);
741 new_s->connection_index = tc->c_index;
742 new_s->server_rx_fifo->master_session_index = new_s->session_index;
743 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
744 new_s->session_state = SESSION_STATE_READY;
745 session_lookup_add_connection (tc, session_handle (new_s));
748 * Ask thread owning the old session to clean it up and make us the tx
751 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
752 rpc_args->new_session_index = new_s->session_index;
753 rpc_args->new_thread_index = new_s->thread_index;
754 rpc_args->session_index = tc->s_index;
755 rpc_args->thread_index = old_thread_index;
756 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
759 tc->s_index = new_s->session_index;
760 new_s->connection_index = tc->c_index;
761 *new_session = new_s;
766 stream_session_accept_notify (transport_connection_t * tc)
768 app_worker_t *app_wrk;
772 s = session_get (tc->s_index, tc->thread_index);
773 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
776 app = application_get (app_wrk->app_index);
777 return app->cb_fns.session_accept_callback (s);
781 * Notification from transport that connection is being closed.
783 * A disconnect is sent to application but state is not removed. Once
784 * disconnect is acknowledged by application, session disconnect is called.
785 * Ultimately this leads to close being called on transport (passive close).
788 session_transport_closing_notify (transport_connection_t * tc)
790 app_worker_t *app_wrk;
794 s = session_get (tc->s_index, tc->thread_index);
795 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
797 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
798 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
801 app = application_get (app_wrk->app_index);
802 app->cb_fns.session_disconnect_callback (s);
806 * Notification from transport that connection is being deleted
808 * This removes the session if it is still valid. It should be called only on
809 * previously fully established sessions. For instance failed connects should
810 * call stream_session_connect_notify and indicate that the connect has
814 session_transport_delete_notify (transport_connection_t * tc)
818 /* App might've been removed already */
819 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
822 /* Make sure we don't try to send anything more */
823 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
825 switch (s->session_state)
827 case SESSION_STATE_TRANSPORT_CLOSING:
828 /* If transport finishes or times out before we get a reply
829 * from the app, mark transport as closed and wait for reply
830 * before removing the session. Cleanup session table in advance
831 * because transport will soon be closed and closed sessions
832 * are assumed to have been removed from the lookup table */
833 session_lookup_del_session (s);
834 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
836 case SESSION_STATE_CLOSING:
837 case SESSION_STATE_CLOSED_WAITING:
838 /* Cleanup lookup table as transport needs to still be valid.
839 * Program transport close to ensure that all session events
840 * have been cleaned up. Once transport close is called, the
841 * session is just removed because both transport and app have
842 * confirmed the close*/
843 session_lookup_del_session (s);
844 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
845 session_program_transport_close (s);
847 case SESSION_STATE_CLOSED:
848 case SESSION_STATE_ACCEPTING:
858 * Notification from transport that session can be closed
860 * Should be called by transport only if it was closed with non-empty
861 * tx fifo and once it decides to begin the closing procedure prior to
862 * issuing a delete notify. This gives the chance to the session layer
863 * to cleanup any outstanding events.
866 session_transport_closed_notify (transport_connection_t * tc)
870 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
872 s->session_state = SESSION_STATE_CLOSED;
876 * Notify application that connection has been reset.
879 session_transport_reset_notify (transport_connection_t * tc)
882 app_worker_t *app_wrk;
884 s = session_get (tc->s_index, tc->thread_index);
885 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
886 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
888 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
889 app_wrk = app_worker_get (s->app_wrk_index);
890 app = application_get (app_wrk->app_index);
891 app->cb_fns.session_reset_callback (s);
895 * Accept a stream session. Optionally ping the server by callback.
898 stream_session_accept (transport_connection_t * tc, u32 listener_index,
901 stream_session_t *s, *listener;
902 app_worker_t *app_wrk;
903 segment_manager_t *sm;
906 /* Find the server */
907 listener = listen_session_get (listener_index);
908 app_wrk = application_listener_select_worker (listener, 0);
910 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
911 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
914 s->app_wrk_index = app_wrk->wrk_index;
915 s->listener_index = listener_index;
916 s->session_state = SESSION_STATE_ACCEPTING;
918 /* Shoulder-tap the server */
921 application_t *app = application_get (app_wrk->app_index);
922 return app->cb_fns.session_accept_callback (s);
929 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
931 transport_connection_t *tc;
932 transport_endpoint_cfg_t *tep;
933 segment_manager_t *sm;
934 app_worker_t *app_wrk;
939 tep = session_endpoint_to_transport_cfg (rmt);
940 rv = tp_vfts[rmt->transport_proto].open (tep);
943 SESSION_DBG ("Transport failed to open connection.");
944 return VNET_API_ERROR_SESSION_CONNECT;
947 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
949 /* For dgram type of service, allocate session and fifos now.
951 app_wrk = app_worker_get (app_wrk_index);
952 sm = app_worker_get_connect_segment_manager (app_wrk);
954 if (session_alloc_and_init (sm, tc, 1, &s))
956 s->app_wrk_index = app_wrk->wrk_index;
957 s->session_state = SESSION_STATE_OPENED;
959 /* Tell the app about the new event fifo for this session */
960 app = application_get (app_wrk->app_index);
961 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
967 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
969 transport_connection_t *tc;
970 transport_endpoint_cfg_t *tep;
974 tep = session_endpoint_to_transport_cfg (rmt);
975 rv = tp_vfts[rmt->transport_proto].open (tep);
978 SESSION_DBG ("Transport failed to open connection.");
979 return VNET_API_ERROR_SESSION_CONNECT;
982 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
984 /* If transport offers a stream service, only allocate session once the
985 * connection has been established.
986 * Add connection to half-open table and save app and tc index. The
987 * latter is needed to help establish the connection while the former
988 * is needed when the connect notify comes and we have to notify the
991 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
992 session_lookup_add_half_open (tc, handle);
994 /* Store api_context (opaque) for when the reply comes. Not the nicest
995 * thing but better than allocating a separate half-open pool.
997 tc->s_index = opaque;
1002 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1004 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1005 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1007 sep->app_wrk_index = app_wrk_index;
1008 sep->opaque = opaque;
1010 return tp_vfts[rmt->transport_proto].open (tep_cfg);
1013 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1016 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1024 * Ask transport to open connection to remote transport endpoint.
1026 * Stores handle for matching request with reply since the call can be
1027 * asynchronous. For instance, for TCP the 3-way handshake must complete
1028 * before reply comes. Session is only created once connection is established.
1030 * @param app_index Index of the application requesting the connect
1031 * @param st Session type requested.
1032 * @param tep Remote transport endpoint
1033 * @param opaque Opaque data (typically, api_context) the application expects
1034 * on open completion.
1037 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1039 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
1040 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1044 * Ask transport to listen on session endpoint.
1046 * @param s Session for which listen will be called. Note that unlike
1047 * established sessions, listen sessions are not associated to a
1049 * @param sep Local endpoint to be listened on.
1052 session_listen (stream_session_t * ls, session_endpoint_cfg_t * sep)
1054 transport_connection_t *tc;
1055 transport_endpoint_t *tep;
1056 u32 tc_index, s_index;
1058 /* Transport bind/listen */
1059 tep = session_endpoint_to_transport (sep);
1060 s_index = ls->session_index;
1061 tc_index = tp_vfts[sep->transport_proto].bind (s_index, tep);
1063 if (tc_index == (u32) ~ 0)
1066 /* Attach transport to session */
1067 ls = listen_session_get (s_index);
1068 ls->connection_index = tc_index;
1070 /* Add to the main lookup table after transport was initialized */
1071 tc = tp_vfts[sep->transport_proto].get_listener (tc_index);
1072 session_lookup_add_connection (tc, s_index);
1077 * Ask transport to stop listening on local transport endpoint.
1079 * @param s Session to stop listening on. It must be in state LISTENING.
1082 session_stop_listen (stream_session_t * s)
1084 transport_proto_t tp = session_get_transport_proto (s);
1085 transport_connection_t *tc;
1086 if (s->session_state != SESSION_STATE_LISTENING)
1088 clib_warning ("not a listening session");
1092 tc = tp_vfts[tp].get_listener (s->connection_index);
1095 clib_warning ("no transport");
1096 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1099 session_lookup_del_connection (tc);
1100 tp_vfts[tp].unbind (s->connection_index);
1105 * Initialize session closing procedure.
1107 * Request is always sent to session node to ensure that all outstanding
1108 * requests are served before transport is notified.
1111 session_close (stream_session_t * s)
1116 if (s->session_state >= SESSION_STATE_CLOSING)
1118 /* Session will only be removed once both app and transport
1119 * acknowledge the close */
1120 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1121 session_program_transport_close (s);
1123 /* Session already closed. Clear the tx fifo */
1124 if (s->session_state == SESSION_STATE_CLOSED)
1125 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1129 s->session_state = SESSION_STATE_CLOSING;
1130 session_program_transport_close (s);
1134 * Notify transport the session can be disconnected. This should eventually
1135 * result in a delete notification that allows us to cleanup session state.
1136 * Called for both active/passive disconnects.
1138 * Must be called from the session's thread.
1141 session_transport_close (stream_session_t * s)
1143 /* If transport is already closed, just free the session */
1144 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1146 session_free_w_fifos (s);
1150 /* If tx queue wasn't drained, change state to closed waiting for transport.
1151 * This way, the transport, if it so wishes, can continue to try sending the
1152 * outstanding data (in closed state it cannot). It MUST however at one
1153 * point, either after sending everything or after a timeout, call delete
1154 * notify. This will finally lead to the complete cleanup of the session.
1156 if (svm_fifo_max_dequeue (s->server_tx_fifo))
1157 s->session_state = SESSION_STATE_CLOSED_WAITING;
1159 s->session_state = SESSION_STATE_CLOSED;
1161 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1166 * Cleanup transport and session state.
1168 * Notify transport of the cleanup and free the session. This should
1169 * be called only if transport reported some error and is already
1173 session_transport_cleanup (stream_session_t * s)
1175 s->session_state = SESSION_STATE_CLOSED;
1177 /* Delete from main lookup table before we axe the the transport */
1178 session_lookup_del_session (s);
1179 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1181 /* Since we called cleanup, no delete notification will come. So, make
1182 * sure the session is properly freed. */
1183 session_free_w_fifos (s);
1186 transport_service_type_t
1187 session_transport_service_type (stream_session_t * s)
1189 transport_proto_t tp;
1190 tp = session_get_transport_proto (s);
1191 return transport_protocol_service_type (tp);
1194 transport_tx_fn_type_t
1195 session_transport_tx_fn_type (stream_session_t * s)
1197 transport_proto_t tp;
1198 tp = session_get_transport_proto (s);
1199 return transport_protocol_tx_fn_type (tp);
1203 session_tx_is_dgram (stream_session_t * s)
1205 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1209 * Allocate event queues in the shared-memory segment
1211 * That can either be a newly created memfd segment, that will need to be
1212 * mapped by all stack users, or the binary api's svm region. The latter is
1213 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1214 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1215 * vpp uses api svm region for event queues.
1218 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1220 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1221 ssvm_private_t *eqs = &smm->evt_qs_segment;
1222 api_main_t *am = &api_main;
1223 u64 eqs_size = 64 << 20;
1224 pid_t vpp_pid = getpid ();
1228 if (smm->configured_event_queue_length)
1229 evt_q_length = smm->configured_event_queue_length;
1231 if (smm->evt_qs_use_memfd_seg)
1233 if (smm->evt_qs_segment_size)
1234 eqs_size = smm->evt_qs_segment_size;
1236 eqs->ssvm_size = eqs_size;
1237 eqs->i_am_master = 1;
1238 eqs->my_pid = vpp_pid;
1239 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1240 eqs->requested_va = smm->session_baseva;
1242 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1244 clib_warning ("failed to initialize queue segment");
1249 if (smm->evt_qs_use_memfd_seg)
1250 oldheap = ssvm_push_heap (eqs->sh);
1252 oldheap = svm_push_data_heap (am->vlib_rp);
1254 for (i = 0; i < vec_len (smm->wrk); i++)
1256 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1257 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1258 {evt_q_length, evt_size, 0}
1260 {evt_q_length << 1, 256, 0}
1262 cfg->consumer_pid = 0;
1264 cfg->q_nitems = evt_q_length;
1265 cfg->ring_cfgs = rc;
1266 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1267 if (smm->evt_qs_use_memfd_seg)
1269 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1270 clib_warning ("eventfd returned");
1274 if (smm->evt_qs_use_memfd_seg)
1275 ssvm_pop_heap (oldheap);
1277 svm_pop_heap (oldheap);
1281 session_manager_get_evt_q_segment (void)
1283 session_manager_main_t *smm = &session_manager_main;
1284 if (smm->evt_qs_use_memfd_seg)
1285 return &smm->evt_qs_segment;
1290 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1291 session_tx_fifo_peek_and_snd,
1292 session_tx_fifo_dequeue_and_snd,
1293 session_tx_fifo_dequeue_internal,
1294 session_tx_fifo_dequeue_and_snd
1299 * Initialize session layer for given transport proto and ip version
1301 * Allocates per session type (transport proto + ip version) data structures
1302 * and adds arc from session queue node to session type output node.
1305 session_register_transport (transport_proto_t transport_proto,
1306 const transport_proto_vft_t * vft, u8 is_ip4,
1309 session_manager_main_t *smm = &session_manager_main;
1310 session_type_t session_type;
1311 u32 next_index = ~0;
1313 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1315 vec_validate (smm->session_type_to_next, session_type);
1316 vec_validate (smm->session_tx_fns, session_type);
1319 if (output_node != ~0)
1321 foreach_vlib_main (({
1322 next_index = vlib_node_add_next (this_vlib_main,
1323 session_queue_node.index,
1329 smm->session_type_to_next[session_type] = next_index;
1330 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1333 transport_connection_t *
1334 session_get_transport (stream_session_t * s)
1336 transport_proto_t tp;
1337 if (s->session_state != SESSION_STATE_LISTENING)
1339 tp = session_get_transport_proto (s);
1340 return tp_vfts[tp].get_connection (s->connection_index,
1346 transport_connection_t *
1347 listen_session_get_transport (stream_session_t * s)
1349 transport_proto_t tp = session_get_transport_proto (s);
1350 return tp_vfts[tp].get_listener (s->connection_index);
1354 listen_session_get_local_session_endpoint (stream_session_t * listener,
1355 session_endpoint_t * sep)
1357 transport_proto_t tp = session_get_transport_proto (listener);
1358 transport_connection_t *tc;
1359 tc = tp_vfts[tp].get_listener (listener->connection_index);
1362 clib_warning ("no transport");
1366 /* N.B. The ip should not be copied because this is the local endpoint */
1367 sep->port = tc->lcl_port;
1368 sep->transport_proto = tc->proto;
1369 sep->is_ip4 = tc->is_ip4;
1374 session_flush_frames_main_thread (vlib_main_t * vm)
1376 ASSERT (vlib_get_thread_index () == 0);
1377 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1378 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1381 static clib_error_t *
1382 session_manager_main_enable (vlib_main_t * vm)
1384 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1385 session_manager_main_t *smm = &session_manager_main;
1386 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1387 u32 num_threads, preallocated_sessions_per_worker;
1388 session_manager_worker_t *wrk;
1391 num_threads = 1 /* main thread */ + vtm->n_threads;
1393 if (num_threads < 1)
1394 return clib_error_return (0, "n_thread_stacks not set");
1396 /* Allocate cache line aligned worker contexts */
1397 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1399 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1401 for (j = 0; j < num_threads; j++)
1402 smm->wrk[j].current_enqueue_epoch[i] = 1;
1405 for (i = 0; i < num_threads; i++)
1408 vec_validate (wrk->free_event_vector, 128);
1409 _vec_len (wrk->free_event_vector) = 0;
1410 vec_validate (wrk->pending_event_vector, 128);
1411 _vec_len (wrk->pending_event_vector) = 0;
1412 vec_validate (wrk->pending_disconnects, 128);
1413 _vec_len (wrk->pending_disconnects) = 0;
1414 vec_validate (wrk->postponed_event_vector, 128);
1415 _vec_len (wrk->postponed_event_vector) = 0;
1417 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1418 wrk->dispatch_period = 500e-6;
1420 if (num_threads > 1)
1421 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1425 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1428 /* Allocate vpp event queues segment and queue */
1429 session_vpp_event_queues_allocate (smm);
1431 /* Initialize fifo segment main baseva and timeout */
1432 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1433 sm_args->size = smm->session_va_space_size;
1434 segment_manager_main_init (sm_args);
1436 /* Preallocate sessions */
1437 if (smm->preallocated_sessions)
1439 if (num_threads == 1)
1441 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1446 preallocated_sessions_per_worker =
1447 (1.1 * (f64) smm->preallocated_sessions /
1448 (f64) (num_threads - 1));
1450 for (j = 1; j < num_threads; j++)
1452 pool_init_fixed (smm->wrk[j].sessions,
1453 preallocated_sessions_per_worker);
1458 session_lookup_init ();
1459 app_namespaces_init ();
1462 smm->is_enabled = 1;
1464 /* Enable transports */
1465 transport_enable_disable (vm, 1);
1466 transport_init_tx_pacers_period ();
1471 session_node_enable_disable (u8 is_en)
1473 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1474 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1475 u8 have_workers = vtm->n_threads != 0;
1478 foreach_vlib_main (({
1479 if (have_workers && ii == 0)
1481 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1485 vlib_node_t *n = vlib_get_node (this_vlib_main,
1486 session_queue_process_node.index);
1487 vlib_start_process (this_vlib_main, n->runtime_index);
1491 vlib_process_signal_event_mt (this_vlib_main,
1492 session_queue_process_node.index,
1493 SESSION_Q_PROCESS_STOP, 0);
1498 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1505 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1507 clib_error_t *error = 0;
1510 if (session_manager_main.is_enabled)
1513 session_node_enable_disable (is_en);
1514 error = session_manager_main_enable (vm);
1518 session_manager_main.is_enabled = 0;
1519 session_node_enable_disable (is_en);
1526 session_manager_main_init (vlib_main_t * vm)
1528 session_manager_main_t *smm = &session_manager_main;
1529 smm->session_baseva = 0x200000000ULL;
1530 smm->session_va_space_size = (u64) 128 << 30;
1531 smm->evt_qs_segment_size = 64 << 20;
1532 smm->is_enabled = 0;
1536 VLIB_INIT_FUNCTION (session_manager_main_init);
1538 static clib_error_t *
1539 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1541 session_manager_main_t *smm = &session_manager_main;
1545 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1547 if (unformat (input, "event-queue-length %d", &nitems))
1550 smm->configured_event_queue_length = nitems;
1552 clib_warning ("event queue length %d too small, ignored", nitems);
1554 else if (unformat (input, "preallocated-sessions %d",
1555 &smm->preallocated_sessions))
1557 else if (unformat (input, "v4-session-table-buckets %d",
1558 &smm->configured_v4_session_table_buckets))
1560 else if (unformat (input, "v4-halfopen-table-buckets %d",
1561 &smm->configured_v4_halfopen_table_buckets))
1563 else if (unformat (input, "v6-session-table-buckets %d",
1564 &smm->configured_v6_session_table_buckets))
1566 else if (unformat (input, "v6-halfopen-table-buckets %d",
1567 &smm->configured_v6_halfopen_table_buckets))
1569 else if (unformat (input, "v4-session-table-memory %U",
1570 unformat_memory_size, &tmp))
1572 if (tmp >= 0x100000000)
1573 return clib_error_return (0, "memory size %llx (%lld) too large",
1575 smm->configured_v4_session_table_memory = tmp;
1577 else if (unformat (input, "v4-halfopen-table-memory %U",
1578 unformat_memory_size, &tmp))
1580 if (tmp >= 0x100000000)
1581 return clib_error_return (0, "memory size %llx (%lld) too large",
1583 smm->configured_v4_halfopen_table_memory = tmp;
1585 else if (unformat (input, "v6-session-table-memory %U",
1586 unformat_memory_size, &tmp))
1588 if (tmp >= 0x100000000)
1589 return clib_error_return (0, "memory size %llx (%lld) too large",
1591 smm->configured_v6_session_table_memory = tmp;
1593 else if (unformat (input, "v6-halfopen-table-memory %U",
1594 unformat_memory_size, &tmp))
1596 if (tmp >= 0x100000000)
1597 return clib_error_return (0, "memory size %llx (%lld) too large",
1599 smm->configured_v6_halfopen_table_memory = tmp;
1601 else if (unformat (input, "local-endpoints-table-memory %U",
1602 unformat_memory_size, &tmp))
1604 if (tmp >= 0x100000000)
1605 return clib_error_return (0, "memory size %llx (%lld) too large",
1607 smm->local_endpoints_table_memory = tmp;
1609 else if (unformat (input, "local-endpoints-table-buckets %d",
1610 &smm->local_endpoints_table_buckets))
1612 else if (unformat (input, "evt_qs_memfd_seg"))
1613 smm->evt_qs_use_memfd_seg = 1;
1615 return clib_error_return (0, "unknown input `%U'",
1616 format_unformat_error, input);
1621 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1624 * fd.io coding-style-patch-verification: ON
1627 * eval: (c-set-style "gnu")