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 FIFO_EVENT_BUILTIN_RX:
72 case FIFO_EVENT_BUILTIN_TX:
73 case FIFO_EVENT_DISCONNECT:
74 evt->session_handle = session_handle ((stream_session_t *) data);
77 clib_warning ("evt unhandled!");
78 svm_msg_q_unlock (mq);
82 svm_msg_q_add_and_unlock (mq, &msg);
87 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
89 return session_send_evt_to_thread (f, 0, f->master_thread_index, evt_type);
93 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
94 session_evt_type_t evt_type)
96 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
100 session_send_ctrl_evt_to_thread (stream_session_t * s,
101 session_evt_type_t evt_type)
103 /* only event supported for now is disconnect */
104 ASSERT (evt_type == FIFO_EVENT_DISCONNECT);
105 return session_send_evt_to_thread (s, 0, s->thread_index,
106 FIFO_EVENT_DISCONNECT);
110 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
112 if (thread_index != vlib_get_thread_index ())
113 session_send_evt_to_thread (fp, rpc_args, thread_index, FIFO_EVENT_RPC);
116 void (*fnp) (void *) = fp;
122 session_alloc (u32 thread_index)
124 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
127 pool_get_aligned_will_expand (wrk->sessions, will_expand,
128 CLIB_CACHE_LINE_BYTES);
129 /* If we have peekers, let them finish */
130 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
132 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
133 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
134 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
138 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
140 clib_memset (s, 0, sizeof (*s));
141 s->session_index = s - wrk->sessions;
142 s->thread_index = thread_index;
147 session_free (stream_session_t * s)
149 pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
151 clib_memset (s, 0xFA, sizeof (*s));
155 session_free_w_fifos (stream_session_t * s)
157 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
163 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
165 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
166 u32 fifo_segment_index;
169 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
171 &fifo_segment_index)))
173 /* Initialize backpointers */
174 server_rx_fifo->master_session_index = s->session_index;
175 server_rx_fifo->master_thread_index = s->thread_index;
177 server_tx_fifo->master_session_index = s->session_index;
178 server_tx_fifo->master_thread_index = s->thread_index;
180 s->server_rx_fifo = server_rx_fifo;
181 s->server_tx_fifo = server_tx_fifo;
182 s->svm_segment_index = fifo_segment_index;
186 static stream_session_t *
187 session_alloc_for_connection (transport_connection_t * tc)
190 u32 thread_index = tc->thread_index;
192 ASSERT (thread_index == vlib_get_thread_index ()
193 || transport_protocol_is_cl (tc->proto));
195 s = session_alloc (thread_index);
196 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
197 s->enqueue_epoch = (u64) ~ 0;
199 /* Attach transport to session and vice versa */
200 s->connection_index = tc->c_index;
201 tc->s_index = s->session_index;
206 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
207 u8 alloc_fifos, stream_session_t ** ret_s)
212 s = session_alloc_for_connection (tc);
213 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
220 /* Add to the main lookup table */
221 session_lookup_add_connection (tc, session_handle (s));
228 * Discards bytes from buffer chain
230 * It discards n_bytes_to_drop starting at first buffer after chain_b
233 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
234 vlib_buffer_t ** chain_b,
237 vlib_buffer_t *next = *chain_b;
238 u32 to_drop = n_bytes_to_drop;
239 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
240 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
242 next = vlib_get_buffer (vm, next->next_buffer);
243 if (next->current_length > to_drop)
245 vlib_buffer_advance (next, to_drop);
250 to_drop -= next->current_length;
251 next->current_length = 0;
257 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
261 * Enqueue buffer chain tail
264 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
265 u32 offset, u8 is_in_order)
267 vlib_buffer_t *chain_b;
268 u32 chain_bi, len, diff;
269 vlib_main_t *vm = vlib_get_main ();
274 if (is_in_order && offset)
276 diff = offset - b->current_length;
277 if (diff > b->total_length_not_including_first_buffer)
280 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
281 chain_bi = vlib_get_buffer_index (vm, chain_b);
284 chain_bi = b->next_buffer;
288 chain_b = vlib_get_buffer (vm, chain_bi);
289 data = vlib_buffer_get_current (chain_b);
290 len = chain_b->current_length;
295 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
302 return (rv > 0) ? (written + rv) : written;
308 /* written more than what was left in chain */
309 if (written > b->total_length_not_including_first_buffer)
312 /* drop the bytes that have already been delivered */
313 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
318 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
322 clib_warning ("failed to enqueue multi-buffer seg");
328 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
329 ? chain_b->next_buffer : 0));
338 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
339 * event but on request can queue notification events for later delivery by
340 * calling stream_server_flush_enqueue_events().
342 * @param tc Transport connection which is to be enqueued data
343 * @param b Buffer to be enqueued
344 * @param offset Offset at which to start enqueueing if out-of-order
345 * @param queue_event Flag to indicate if peer is to be notified or if event
346 * is to be queued. The former is useful when more data is
347 * enqueued and only one event is to be generated.
348 * @param is_in_order Flag to indicate if data is in order
349 * @return Number of bytes enqueued or a negative value if enqueueing failed.
352 session_enqueue_stream_connection (transport_connection_t * tc,
353 vlib_buffer_t * b, u32 offset,
354 u8 queue_event, u8 is_in_order)
357 int enqueued = 0, rv, in_order_off;
359 s = session_get (tc->s_index, tc->thread_index);
363 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
365 vlib_buffer_get_current (b));
366 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
369 in_order_off = enqueued > b->current_length ? enqueued : 0;
370 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
377 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
379 vlib_buffer_get_current (b));
380 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
381 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
382 /* if something was enqueued, report even this as success for ooo
383 * segment handling */
389 /* Queue RX event on this fifo. Eventually these will need to be flushed
390 * by calling stream_server_flush_enqueue_events () */
391 session_manager_worker_t *wrk;
393 wrk = session_manager_get_worker (s->thread_index);
394 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
396 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
397 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
405 session_enqueue_dgram_connection (stream_session_t * s,
406 session_dgram_hdr_t * hdr,
407 vlib_buffer_t * b, u8 proto, u8 queue_event)
409 int enqueued = 0, rv, in_order_off;
411 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
412 >= b->current_length + sizeof (*hdr));
414 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
416 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
417 vlib_buffer_get_current (b));
418 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
420 in_order_off = enqueued > b->current_length ? enqueued : 0;
421 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
427 /* Queue RX event on this fifo. Eventually these will need to be flushed
428 * by calling stream_server_flush_enqueue_events () */
429 session_manager_worker_t *wrk;
431 wrk = session_manager_get_worker (s->thread_index);
432 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
434 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
435 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
441 /** Check if we have space in rx fifo to push more bytes */
443 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
446 stream_session_t *s = session_get (tc->s_index, thread_index);
448 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
451 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
458 session_tx_fifo_max_dequeue (transport_connection_t * tc)
460 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
461 if (!s->server_tx_fifo)
463 return svm_fifo_max_dequeue (s->server_tx_fifo);
467 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
468 u32 offset, u32 max_bytes)
470 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
471 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
475 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
477 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
478 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
482 * Notify session peer that new data has been enqueued.
484 * @param s Stream session for which the event is to be generated.
485 * @param lock Flag to indicate if call should lock message queue.
487 * @return 0 on success or negative number if failed to send notification.
490 session_enqueue_notify (stream_session_t * s)
494 app = app_worker_get_if_valid (s->app_wrk_index);
495 if (PREDICT_FALSE (!app))
497 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
502 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
503 ed->data[0] = FIFO_EVENT_APP_RX;
504 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
508 return app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_RX);
512 session_dequeue_notify (stream_session_t * s)
516 app = app_worker_get_if_valid (s->app_wrk_index);
517 if (PREDICT_FALSE (!app))
520 return app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_TX);
524 * Flushes queue of sessions that are to be notified of new data
527 * @param thread_index Thread index for which the flush is to be performed.
528 * @return 0 on success or a positive number indicating the number of
529 * failures due to API queue being full.
532 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
534 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
539 indices = wrk->session_to_enqueue[transport_proto];
541 for (i = 0; i < vec_len (indices); i++)
543 s = session_get_if_valid (indices[i], thread_index);
544 if (PREDICT_FALSE (!s))
549 if (PREDICT_FALSE (session_enqueue_notify (s)))
553 vec_reset_length (indices);
554 wrk->session_to_enqueue[transport_proto] = indices;
555 wrk->current_enqueue_epoch[transport_proto]++;
561 session_manager_flush_all_enqueue_events (u8 transport_proto)
563 vlib_thread_main_t *vtm = vlib_get_thread_main ();
565 for (i = 0; i < 1 + vtm->n_threads; i++)
566 errors += session_manager_flush_enqueue_events (transport_proto, i);
571 * Init fifo tail and head pointers
573 * Useful if transport uses absolute offsets for tracking ooo segments.
576 stream_session_init_fifos_pointers (transport_connection_t * tc,
577 u32 rx_pointer, u32 tx_pointer)
580 s = session_get (tc->s_index, tc->thread_index);
581 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
582 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
586 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
588 u32 opaque = 0, new_ti, new_si;
589 stream_session_t *new_s = 0;
590 segment_manager_t *sm;
591 app_worker_t *app_wrk;
598 * Find connection handle and cleanup half-open table
600 handle = session_lookup_half_open_handle (tc);
601 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
603 SESSION_DBG ("half-open was removed!");
606 session_lookup_del_half_open (tc);
608 /* Get the app's index from the handle we stored when opening connection
609 * and the opaque (api_context for external apps) from transport session
611 app_wrk = app_worker_get_if_valid (handle >> 32);
614 opaque = tc->s_index;
615 app = application_get (app_wrk->app_index);
618 * Allocate new session with fifos (svm segments are allocated if needed)
622 sm = app_worker_get_connect_segment_manager (app_wrk);
623 alloc_fifos = !application_is_builtin_proxy (app);
624 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
631 new_s->session_state = SESSION_STATE_CONNECTING;
632 new_s->app_wrk_index = app_wrk->wrk_index;
633 new_si = new_s->session_index;
634 new_ti = new_s->thread_index;
639 * Notify client application
641 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
644 SESSION_DBG ("failed to notify app");
647 new_s = session_get (new_si, new_ti);
648 stream_session_disconnect_transport (new_s);
655 new_s = session_get (new_si, new_ti);
656 new_s->session_state = SESSION_STATE_READY;
663 typedef struct _session_switch_pool_args
667 u32 new_thread_index;
668 u32 new_session_index;
669 } session_switch_pool_args_t;
672 session_switch_pool (void *cb_args)
674 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
675 transport_proto_t tp;
677 ASSERT (args->thread_index == vlib_get_thread_index ());
678 s = session_get (args->session_index, args->thread_index);
679 s->server_tx_fifo->master_session_index = args->new_session_index;
680 s->server_tx_fifo->master_thread_index = args->new_thread_index;
681 tp = session_get_transport_proto (s);
682 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
684 clib_mem_free (cb_args);
688 * Move dgram session to the right thread
691 session_dgram_connect_notify (transport_connection_t * tc,
692 u32 old_thread_index,
693 stream_session_t ** new_session)
695 stream_session_t *new_s;
696 session_switch_pool_args_t *rpc_args;
699 * Clone half-open session to the right thread.
701 new_s = session_clone_safe (tc->s_index, old_thread_index);
702 new_s->connection_index = tc->c_index;
703 new_s->server_rx_fifo->master_session_index = new_s->session_index;
704 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
705 new_s->session_state = SESSION_STATE_READY;
706 session_lookup_add_connection (tc, session_handle (new_s));
709 * Ask thread owning the old session to clean it up and make us the tx
712 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
713 rpc_args->new_session_index = new_s->session_index;
714 rpc_args->new_thread_index = new_s->thread_index;
715 rpc_args->session_index = tc->s_index;
716 rpc_args->thread_index = old_thread_index;
717 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
720 tc->s_index = new_s->session_index;
721 new_s->connection_index = tc->c_index;
722 *new_session = new_s;
727 stream_session_accept_notify (transport_connection_t * tc)
729 app_worker_t *app_wrk;
733 s = session_get (tc->s_index, tc->thread_index);
734 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
737 app = application_get (app_wrk->app_index);
738 return app->cb_fns.session_accept_callback (s);
742 * Notification from transport that connection is being closed.
744 * A disconnect is sent to application but state is not removed. Once
745 * disconnect is acknowledged by application, session disconnect is called.
746 * Ultimately this leads to close being called on transport (passive close).
749 stream_session_disconnect_notify (transport_connection_t * tc)
751 app_worker_t *app_wrk;
755 s = session_get (tc->s_index, tc->thread_index);
756 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
758 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
759 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
762 app = application_get (app_wrk->app_index);
763 app->cb_fns.session_disconnect_callback (s);
767 * Cleans up session and lookup table.
769 * Transport connection must still be valid.
772 stream_session_delete (stream_session_t * s)
776 /* Delete from the main lookup table. */
777 if ((rv = session_lookup_del_session (s)))
778 clib_warning ("hash delete error, rv %d", rv);
780 session_free_w_fifos (s);
784 * Notification from transport that connection is being deleted
786 * This removes the session if it is still valid. It should be called only on
787 * previously fully established sessions. For instance failed connects should
788 * call stream_session_connect_notify and indicate that the connect has
792 stream_session_delete_notify (transport_connection_t * tc)
796 /* App might've been removed already */
797 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
800 /* Make sure we don't try to send anything more */
801 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
803 switch (s->session_state)
805 case SESSION_STATE_TRANSPORT_CLOSING:
806 /* If transport finishes or times out before we get a reply
807 * from the app, do the whole disconnect since we might still
808 * have lingering events. Cleanup session table in advance
809 * because transport will soon be closed and closed sessions
810 * are assumed to have been removed from the lookup table */
811 session_lookup_del_session (s);
812 stream_session_disconnect (s);
813 s->session_state = SESSION_STATE_CLOSED;
815 case SESSION_STATE_CLOSING:
816 /* Cleanup lookup table. Transport needs to still be valid */
817 session_lookup_del_session (s);
818 s->session_state = SESSION_STATE_CLOSED;
820 case SESSION_STATE_CLOSED:
821 case SESSION_STATE_ACCEPTING:
822 stream_session_delete (s);
825 stream_session_delete (s);
831 * Notify application that connection has been reset.
834 stream_session_reset_notify (transport_connection_t * tc)
837 app_worker_t *app_wrk;
839 s = session_get (tc->s_index, tc->thread_index);
840 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
841 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
843 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
844 app_wrk = app_worker_get (s->app_wrk_index);
845 app = application_get (app_wrk->app_index);
846 app->cb_fns.session_reset_callback (s);
850 * Accept a stream session. Optionally ping the server by callback.
853 stream_session_accept (transport_connection_t * tc, u32 listener_index,
856 stream_session_t *s, *listener;
857 app_worker_t *app_wrk;
858 segment_manager_t *sm;
861 /* Find the server */
862 listener = listen_session_get (listener_index);
863 app_wrk = application_listener_select_worker (listener, 0);
865 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
866 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
869 s->app_wrk_index = app_wrk->wrk_index;
870 s->listener_index = listener_index;
871 s->session_state = SESSION_STATE_ACCEPTING;
873 /* Shoulder-tap the server */
876 application_t *app = application_get (app_wrk->app_index);
877 return app->cb_fns.session_accept_callback (s);
884 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
886 transport_connection_t *tc;
887 transport_endpoint_cfg_t *tep;
888 segment_manager_t *sm;
889 app_worker_t *app_wrk;
894 tep = session_endpoint_to_transport_cfg (rmt);
895 rv = tp_vfts[rmt->transport_proto].open (tep);
898 SESSION_DBG ("Transport failed to open connection.");
899 return VNET_API_ERROR_SESSION_CONNECT;
902 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
904 /* For dgram type of service, allocate session and fifos now.
906 app_wrk = app_worker_get (app_wrk_index);
907 sm = app_worker_get_connect_segment_manager (app_wrk);
909 if (session_alloc_and_init (sm, tc, 1, &s))
911 s->app_wrk_index = app_wrk->wrk_index;
912 s->session_state = SESSION_STATE_OPENED;
914 /* Tell the app about the new event fifo for this session */
915 app = application_get (app_wrk->app_index);
916 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
922 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
924 transport_connection_t *tc;
925 transport_endpoint_cfg_t *tep;
929 tep = session_endpoint_to_transport_cfg (rmt);
930 rv = tp_vfts[rmt->transport_proto].open (tep);
933 SESSION_DBG ("Transport failed to open connection.");
934 return VNET_API_ERROR_SESSION_CONNECT;
937 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
939 /* If transport offers a stream service, only allocate session once the
940 * connection has been established.
941 * Add connection to half-open table and save app and tc index. The
942 * latter is needed to help establish the connection while the former
943 * is needed when the connect notify comes and we have to notify the
946 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
947 session_lookup_add_half_open (tc, handle);
949 /* Store api_context (opaque) for when the reply comes. Not the nicest
950 * thing but better than allocating a separate half-open pool.
952 tc->s_index = opaque;
957 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
959 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
960 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
962 sep->app_wrk_index = app_wrk_index;
963 sep->opaque = opaque;
965 return tp_vfts[rmt->transport_proto].open (tep_cfg);
968 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
971 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
979 * Ask transport to open connection to remote transport endpoint.
981 * Stores handle for matching request with reply since the call can be
982 * asynchronous. For instance, for TCP the 3-way handshake must complete
983 * before reply comes. Session is only created once connection is established.
985 * @param app_index Index of the application requesting the connect
986 * @param st Session type requested.
987 * @param tep Remote transport endpoint
988 * @param opaque Opaque data (typically, api_context) the application expects
989 * on open completion.
992 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
994 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
995 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
999 * Ask transport to listen on session endpoint.
1001 * @param s Session for which listen will be called. Note that unlike
1002 * established sessions, listen sessions are not associated to a
1004 * @param sep Local endpoint to be listened on.
1007 session_listen (stream_session_t * ls, session_endpoint_cfg_t * sep)
1009 transport_connection_t *tc;
1010 transport_endpoint_t *tep;
1011 u32 tc_index, s_index;
1013 /* Transport bind/listen */
1014 tep = session_endpoint_to_transport (sep);
1015 s_index = ls->session_index;
1016 tc_index = tp_vfts[sep->transport_proto].bind (s_index, tep);
1018 if (tc_index == (u32) ~ 0)
1021 /* Attach transport to session */
1022 ls = listen_session_get (s_index);
1023 ls->connection_index = tc_index;
1025 /* Add to the main lookup table after transport was initialized */
1026 tc = tp_vfts[sep->transport_proto].get_listener (tc_index);
1027 session_lookup_add_connection (tc, s_index);
1032 * Ask transport to stop listening on local transport endpoint.
1034 * @param s Session to stop listening on. It must be in state LISTENING.
1037 session_stop_listen (stream_session_t * s)
1039 transport_proto_t tp = session_get_transport_proto (s);
1040 transport_connection_t *tc;
1041 if (s->session_state != SESSION_STATE_LISTENING)
1043 clib_warning ("not a listening session");
1047 tc = tp_vfts[tp].get_listener (s->connection_index);
1050 clib_warning ("no transport");
1051 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1054 session_lookup_del_connection (tc);
1055 tp_vfts[tp].unbind (s->connection_index);
1060 * Initialize session disconnect.
1062 * Request is always sent to session node to ensure that all outstanding
1063 * requests are served before transport is notified.
1066 stream_session_disconnect (stream_session_t * s)
1068 u32 thread_index = vlib_get_thread_index ();
1069 session_manager_worker_t *wrk;
1070 session_event_t *evt;
1075 if (s->session_state >= SESSION_STATE_CLOSING)
1077 /* Session already closed. Clear the tx fifo */
1078 if (s->session_state == SESSION_STATE_CLOSED)
1079 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1083 s->session_state = SESSION_STATE_CLOSING;
1085 /* If we are in the handler thread, or being called with the worker barrier
1086 * held, just append a new event to pending disconnects vector. */
1087 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
1089 wrk = session_manager_get_worker (s->thread_index);
1090 vec_add2 (wrk->pending_disconnects, evt, 1);
1091 clib_memset (evt, 0, sizeof (*evt));
1092 evt->session_handle = session_handle (s);
1093 evt->event_type = FIFO_EVENT_DISCONNECT;
1096 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
1100 * Notify transport the session can be disconnected. This should eventually
1101 * result in a delete notification that allows us to cleanup session state.
1102 * Called for both active/passive disconnects.
1104 * Must be called from the session's thread.
1107 stream_session_disconnect_transport (stream_session_t * s)
1109 /* If transport is already closed, just free the session */
1110 if (s->session_state == SESSION_STATE_CLOSED)
1112 session_free_w_fifos (s);
1115 s->session_state = SESSION_STATE_CLOSED;
1116 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1121 * Cleanup transport and session state.
1123 * Notify transport of the cleanup and free the session. This should
1124 * be called only if transport reported some error and is already
1128 stream_session_cleanup (stream_session_t * s)
1130 s->session_state = SESSION_STATE_CLOSED;
1132 /* Delete from main lookup table before we axe the the transport */
1133 session_lookup_del_session (s);
1134 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1136 /* Since we called cleanup, no delete notification will come. So, make
1137 * sure the session is properly freed. */
1138 session_free_w_fifos (s);
1141 transport_service_type_t
1142 session_transport_service_type (stream_session_t * s)
1144 transport_proto_t tp;
1145 tp = session_get_transport_proto (s);
1146 return transport_protocol_service_type (tp);
1149 transport_tx_fn_type_t
1150 session_transport_tx_fn_type (stream_session_t * s)
1152 transport_proto_t tp;
1153 tp = session_get_transport_proto (s);
1154 return transport_protocol_tx_fn_type (tp);
1158 session_tx_is_dgram (stream_session_t * s)
1160 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1164 * Allocate event queues in the shared-memory segment
1166 * That can either be a newly created memfd segment, that will need to be
1167 * mapped by all stack users, or the binary api's svm region. The latter is
1168 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1169 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1170 * vpp uses api svm region for event queues.
1173 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1175 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1176 ssvm_private_t *eqs = &smm->evt_qs_segment;
1177 api_main_t *am = &api_main;
1178 u64 eqs_size = 64 << 20;
1179 pid_t vpp_pid = getpid ();
1183 if (smm->configured_event_queue_length)
1184 evt_q_length = smm->configured_event_queue_length;
1186 if (smm->evt_qs_use_memfd_seg)
1188 if (smm->evt_qs_segment_size)
1189 eqs_size = smm->evt_qs_segment_size;
1191 eqs->ssvm_size = eqs_size;
1192 eqs->i_am_master = 1;
1193 eqs->my_pid = vpp_pid;
1194 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1195 eqs->requested_va = smm->session_baseva;
1197 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1199 clib_warning ("failed to initialize queue segment");
1204 if (smm->evt_qs_use_memfd_seg)
1205 oldheap = ssvm_push_heap (eqs->sh);
1207 oldheap = svm_push_data_heap (am->vlib_rp);
1209 for (i = 0; i < vec_len (smm->wrk); i++)
1211 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1212 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1213 {evt_q_length, evt_size, 0}
1215 {evt_q_length << 1, 256, 0}
1217 cfg->consumer_pid = 0;
1219 cfg->q_nitems = evt_q_length;
1220 cfg->ring_cfgs = rc;
1221 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1222 if (smm->evt_qs_use_memfd_seg)
1224 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1225 clib_warning ("eventfd returned");
1229 if (smm->evt_qs_use_memfd_seg)
1230 ssvm_pop_heap (oldheap);
1232 svm_pop_heap (oldheap);
1236 session_manager_get_evt_q_segment (void)
1238 session_manager_main_t *smm = &session_manager_main;
1239 if (smm->evt_qs_use_memfd_seg)
1240 return &smm->evt_qs_segment;
1245 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1246 session_tx_fifo_peek_and_snd,
1247 session_tx_fifo_dequeue_and_snd,
1248 session_tx_fifo_dequeue_internal,
1249 session_tx_fifo_dequeue_and_snd
1254 * Initialize session layer for given transport proto and ip version
1256 * Allocates per session type (transport proto + ip version) data structures
1257 * and adds arc from session queue node to session type output node.
1260 session_register_transport (transport_proto_t transport_proto,
1261 const transport_proto_vft_t * vft, u8 is_ip4,
1264 session_manager_main_t *smm = &session_manager_main;
1265 session_type_t session_type;
1266 u32 next_index = ~0;
1268 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1270 vec_validate (smm->session_type_to_next, session_type);
1271 vec_validate (smm->session_tx_fns, session_type);
1274 if (output_node != ~0)
1276 foreach_vlib_main (({
1277 next_index = vlib_node_add_next (this_vlib_main,
1278 session_queue_node.index,
1284 smm->session_type_to_next[session_type] = next_index;
1285 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1288 transport_connection_t *
1289 session_get_transport (stream_session_t * s)
1291 transport_proto_t tp;
1292 if (s->session_state != SESSION_STATE_LISTENING)
1294 tp = session_get_transport_proto (s);
1295 return tp_vfts[tp].get_connection (s->connection_index,
1301 transport_connection_t *
1302 listen_session_get_transport (stream_session_t * s)
1304 transport_proto_t tp = session_get_transport_proto (s);
1305 return tp_vfts[tp].get_listener (s->connection_index);
1309 listen_session_get_local_session_endpoint (stream_session_t * listener,
1310 session_endpoint_t * sep)
1312 transport_proto_t tp = session_get_transport_proto (listener);
1313 transport_connection_t *tc;
1314 tc = tp_vfts[tp].get_listener (listener->connection_index);
1317 clib_warning ("no transport");
1321 /* N.B. The ip should not be copied because this is the local endpoint */
1322 sep->port = tc->lcl_port;
1323 sep->transport_proto = tc->proto;
1324 sep->is_ip4 = tc->is_ip4;
1329 session_flush_frames_main_thread (vlib_main_t * vm)
1331 ASSERT (vlib_get_thread_index () == 0);
1332 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1333 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1336 static clib_error_t *
1337 session_manager_main_enable (vlib_main_t * vm)
1339 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1340 session_manager_main_t *smm = &session_manager_main;
1341 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1342 u32 num_threads, preallocated_sessions_per_worker;
1343 session_manager_worker_t *wrk;
1346 num_threads = 1 /* main thread */ + vtm->n_threads;
1348 if (num_threads < 1)
1349 return clib_error_return (0, "n_thread_stacks not set");
1351 /* Allocate cache line aligned worker contexts */
1352 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1354 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1356 for (j = 0; j < num_threads; j++)
1357 smm->wrk[j].current_enqueue_epoch[i] = 1;
1360 for (i = 0; i < num_threads; i++)
1363 vec_validate (wrk->free_event_vector, 128);
1364 _vec_len (wrk->free_event_vector) = 0;
1365 vec_validate (wrk->pending_event_vector, 128);
1366 _vec_len (wrk->pending_event_vector) = 0;
1367 vec_validate (wrk->pending_disconnects, 128);
1368 _vec_len (wrk->pending_disconnects) = 0;
1369 vec_validate (wrk->postponed_event_vector, 128);
1370 _vec_len (wrk->postponed_event_vector) = 0;
1372 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1373 wrk->dispatch_period = 500e-6;
1375 if (num_threads > 1)
1376 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1380 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1383 /* Allocate vpp event queues segment and queue */
1384 session_vpp_event_queues_allocate (smm);
1386 /* Initialize fifo segment main baseva and timeout */
1387 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1388 sm_args->size = smm->session_va_space_size;
1389 segment_manager_main_init (sm_args);
1391 /* Preallocate sessions */
1392 if (smm->preallocated_sessions)
1394 if (num_threads == 1)
1396 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1401 preallocated_sessions_per_worker =
1402 (1.1 * (f64) smm->preallocated_sessions /
1403 (f64) (num_threads - 1));
1405 for (j = 1; j < num_threads; j++)
1407 pool_init_fixed (smm->wrk[j].sessions,
1408 preallocated_sessions_per_worker);
1413 session_lookup_init ();
1414 app_namespaces_init ();
1417 smm->is_enabled = 1;
1419 /* Enable transports */
1420 transport_enable_disable (vm, 1);
1421 transport_init_tx_pacers_period ();
1426 session_node_enable_disable (u8 is_en)
1428 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1429 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1430 u8 have_workers = vtm->n_threads != 0;
1433 foreach_vlib_main (({
1434 if (have_workers && ii == 0)
1436 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1440 vlib_node_t *n = vlib_get_node (this_vlib_main,
1441 session_queue_process_node.index);
1442 vlib_start_process (this_vlib_main, n->runtime_index);
1446 vlib_process_signal_event_mt (this_vlib_main,
1447 session_queue_process_node.index,
1448 SESSION_Q_PROCESS_STOP, 0);
1453 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1460 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1462 clib_error_t *error = 0;
1465 if (session_manager_main.is_enabled)
1468 session_node_enable_disable (is_en);
1469 error = session_manager_main_enable (vm);
1473 session_manager_main.is_enabled = 0;
1474 session_node_enable_disable (is_en);
1481 session_manager_main_init (vlib_main_t * vm)
1483 session_manager_main_t *smm = &session_manager_main;
1484 smm->session_baseva = 0x200000000ULL;
1485 smm->session_va_space_size = (u64) 128 << 30;
1486 smm->evt_qs_segment_size = 64 << 20;
1487 smm->is_enabled = 0;
1491 VLIB_INIT_FUNCTION (session_manager_main_init);
1493 static clib_error_t *
1494 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1496 session_manager_main_t *smm = &session_manager_main;
1500 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1502 if (unformat (input, "event-queue-length %d", &nitems))
1505 smm->configured_event_queue_length = nitems;
1507 clib_warning ("event queue length %d too small, ignored", nitems);
1509 else if (unformat (input, "preallocated-sessions %d",
1510 &smm->preallocated_sessions))
1512 else if (unformat (input, "v4-session-table-buckets %d",
1513 &smm->configured_v4_session_table_buckets))
1515 else if (unformat (input, "v4-halfopen-table-buckets %d",
1516 &smm->configured_v4_halfopen_table_buckets))
1518 else if (unformat (input, "v6-session-table-buckets %d",
1519 &smm->configured_v6_session_table_buckets))
1521 else if (unformat (input, "v6-halfopen-table-buckets %d",
1522 &smm->configured_v6_halfopen_table_buckets))
1524 else if (unformat (input, "v4-session-table-memory %U",
1525 unformat_memory_size, &tmp))
1527 if (tmp >= 0x100000000)
1528 return clib_error_return (0, "memory size %llx (%lld) too large",
1530 smm->configured_v4_session_table_memory = tmp;
1532 else if (unformat (input, "v4-halfopen-table-memory %U",
1533 unformat_memory_size, &tmp))
1535 if (tmp >= 0x100000000)
1536 return clib_error_return (0, "memory size %llx (%lld) too large",
1538 smm->configured_v4_halfopen_table_memory = tmp;
1540 else if (unformat (input, "v6-session-table-memory %U",
1541 unformat_memory_size, &tmp))
1543 if (tmp >= 0x100000000)
1544 return clib_error_return (0, "memory size %llx (%lld) too large",
1546 smm->configured_v6_session_table_memory = tmp;
1548 else if (unformat (input, "v6-halfopen-table-memory %U",
1549 unformat_memory_size, &tmp))
1551 if (tmp >= 0x100000000)
1552 return clib_error_return (0, "memory size %llx (%lld) too large",
1554 smm->configured_v6_halfopen_table_memory = tmp;
1556 else if (unformat (input, "local-endpoints-table-memory %U",
1557 unformat_memory_size, &tmp))
1559 if (tmp >= 0x100000000)
1560 return clib_error_return (0, "memory size %llx (%lld) too large",
1562 smm->local_endpoints_table_memory = tmp;
1564 else if (unformat (input, "local-endpoints-table-buckets %d",
1565 &smm->local_endpoints_table_buckets))
1567 else if (unformat (input, "evt_qs_memfd_seg"))
1568 smm->evt_qs_use_memfd_seg = 1;
1570 return clib_error_return (0, "unknown input `%U'",
1571 format_unformat_error, input);
1576 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1579 * fd.io coding-style-patch-verification: ON
1582 * eval: (c-set-style "gnu")