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_alloc (u32 thread_index)
125 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
128 pool_get_aligned_will_expand (wrk->sessions, will_expand,
129 CLIB_CACHE_LINE_BYTES);
130 /* If we have peekers, let them finish */
131 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
133 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
134 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
135 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
139 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
141 clib_memset (s, 0, sizeof (*s));
142 s->session_index = s - wrk->sessions;
143 s->thread_index = thread_index;
148 session_free (stream_session_t * s)
150 pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
152 clib_memset (s, 0xFA, sizeof (*s));
156 session_free_w_fifos (stream_session_t * s)
158 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
164 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
166 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
167 u32 fifo_segment_index;
170 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
172 &fifo_segment_index)))
174 /* Initialize backpointers */
175 server_rx_fifo->master_session_index = s->session_index;
176 server_rx_fifo->master_thread_index = s->thread_index;
178 server_tx_fifo->master_session_index = s->session_index;
179 server_tx_fifo->master_thread_index = s->thread_index;
181 s->server_rx_fifo = server_rx_fifo;
182 s->server_tx_fifo = server_tx_fifo;
183 s->svm_segment_index = fifo_segment_index;
187 static stream_session_t *
188 session_alloc_for_connection (transport_connection_t * tc)
191 u32 thread_index = tc->thread_index;
193 ASSERT (thread_index == vlib_get_thread_index ()
194 || transport_protocol_is_cl (tc->proto));
196 s = session_alloc (thread_index);
197 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
198 s->enqueue_epoch = (u64) ~ 0;
200 /* Attach transport to session and vice versa */
201 s->connection_index = tc->c_index;
202 tc->s_index = s->session_index;
207 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
208 u8 alloc_fifos, stream_session_t ** ret_s)
213 s = session_alloc_for_connection (tc);
214 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
221 /* Add to the main lookup table */
222 session_lookup_add_connection (tc, session_handle (s));
229 * Discards bytes from buffer chain
231 * It discards n_bytes_to_drop starting at first buffer after chain_b
234 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
235 vlib_buffer_t ** chain_b,
238 vlib_buffer_t *next = *chain_b;
239 u32 to_drop = n_bytes_to_drop;
240 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
241 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
243 next = vlib_get_buffer (vm, next->next_buffer);
244 if (next->current_length > to_drop)
246 vlib_buffer_advance (next, to_drop);
251 to_drop -= next->current_length;
252 next->current_length = 0;
258 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
262 * Enqueue buffer chain tail
265 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
266 u32 offset, u8 is_in_order)
268 vlib_buffer_t *chain_b;
269 u32 chain_bi, len, diff;
270 vlib_main_t *vm = vlib_get_main ();
275 if (is_in_order && offset)
277 diff = offset - b->current_length;
278 if (diff > b->total_length_not_including_first_buffer)
281 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
282 chain_bi = vlib_get_buffer_index (vm, chain_b);
285 chain_bi = b->next_buffer;
289 chain_b = vlib_get_buffer (vm, chain_bi);
290 data = vlib_buffer_get_current (chain_b);
291 len = chain_b->current_length;
296 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
303 return (rv > 0) ? (written + rv) : written;
309 /* written more than what was left in chain */
310 if (written > b->total_length_not_including_first_buffer)
313 /* drop the bytes that have already been delivered */
314 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
319 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
323 clib_warning ("failed to enqueue multi-buffer seg");
329 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
330 ? chain_b->next_buffer : 0));
339 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
340 * event but on request can queue notification events for later delivery by
341 * calling stream_server_flush_enqueue_events().
343 * @param tc Transport connection which is to be enqueued data
344 * @param b Buffer to be enqueued
345 * @param offset Offset at which to start enqueueing if out-of-order
346 * @param queue_event Flag to indicate if peer is to be notified or if event
347 * is to be queued. The former is useful when more data is
348 * enqueued and only one event is to be generated.
349 * @param is_in_order Flag to indicate if data is in order
350 * @return Number of bytes enqueued or a negative value if enqueueing failed.
353 session_enqueue_stream_connection (transport_connection_t * tc,
354 vlib_buffer_t * b, u32 offset,
355 u8 queue_event, u8 is_in_order)
358 int enqueued = 0, rv, in_order_off;
360 s = session_get (tc->s_index, tc->thread_index);
364 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
366 vlib_buffer_get_current (b));
367 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
370 in_order_off = enqueued > b->current_length ? enqueued : 0;
371 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
378 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
380 vlib_buffer_get_current (b));
381 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
382 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
383 /* if something was enqueued, report even this as success for ooo
384 * segment handling */
390 /* Queue RX event on this fifo. Eventually these will need to be flushed
391 * by calling stream_server_flush_enqueue_events () */
392 session_manager_worker_t *wrk;
394 wrk = session_manager_get_worker (s->thread_index);
395 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
397 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
398 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
406 session_enqueue_dgram_connection (stream_session_t * s,
407 session_dgram_hdr_t * hdr,
408 vlib_buffer_t * b, u8 proto, u8 queue_event)
410 int enqueued = 0, rv, in_order_off;
412 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
413 >= b->current_length + sizeof (*hdr));
415 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
417 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
418 vlib_buffer_get_current (b));
419 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
421 in_order_off = enqueued > b->current_length ? enqueued : 0;
422 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
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[proto])
435 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
436 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
442 /** Check if we have space in rx fifo to push more bytes */
444 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
447 stream_session_t *s = session_get (tc->s_index, thread_index);
449 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
452 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
459 session_tx_fifo_max_dequeue (transport_connection_t * tc)
461 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
462 if (!s->server_tx_fifo)
464 return svm_fifo_max_dequeue (s->server_tx_fifo);
468 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
469 u32 offset, u32 max_bytes)
471 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
472 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
476 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
478 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
479 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
483 * Notify session peer that new data has been enqueued.
485 * @param s Stream session for which the event is to be generated.
486 * @param lock Flag to indicate if call should lock message queue.
488 * @return 0 on success or negative number if failed to send notification.
491 session_enqueue_notify (stream_session_t * s)
495 app = app_worker_get_if_valid (s->app_wrk_index);
496 if (PREDICT_FALSE (!app))
498 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
503 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
504 ed->data[0] = FIFO_EVENT_APP_RX;
505 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
509 return app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_RX);
513 session_dequeue_notify (stream_session_t * s)
517 app = app_worker_get_if_valid (s->app_wrk_index);
518 if (PREDICT_FALSE (!app))
521 return app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_TX);
525 * Flushes queue of sessions that are to be notified of new data
528 * @param thread_index Thread index for which the flush is to be performed.
529 * @return 0 on success or a positive number indicating the number of
530 * failures due to API queue being full.
533 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
535 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
540 indices = wrk->session_to_enqueue[transport_proto];
542 for (i = 0; i < vec_len (indices); i++)
544 s = session_get_if_valid (indices[i], thread_index);
545 if (PREDICT_FALSE (!s))
550 if (PREDICT_FALSE (session_enqueue_notify (s)))
554 vec_reset_length (indices);
555 wrk->session_to_enqueue[transport_proto] = indices;
556 wrk->current_enqueue_epoch[transport_proto]++;
562 session_manager_flush_all_enqueue_events (u8 transport_proto)
564 vlib_thread_main_t *vtm = vlib_get_thread_main ();
566 for (i = 0; i < 1 + vtm->n_threads; i++)
567 errors += session_manager_flush_enqueue_events (transport_proto, i);
572 * Init fifo tail and head pointers
574 * Useful if transport uses absolute offsets for tracking ooo segments.
577 stream_session_init_fifos_pointers (transport_connection_t * tc,
578 u32 rx_pointer, u32 tx_pointer)
581 s = session_get (tc->s_index, tc->thread_index);
582 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
583 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
587 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
589 u32 opaque = 0, new_ti, new_si;
590 stream_session_t *new_s = 0;
591 segment_manager_t *sm;
592 app_worker_t *app_wrk;
599 * Find connection handle and cleanup half-open table
601 handle = session_lookup_half_open_handle (tc);
602 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
604 SESSION_DBG ("half-open was removed!");
607 session_lookup_del_half_open (tc);
609 /* Get the app's index from the handle we stored when opening connection
610 * and the opaque (api_context for external apps) from transport session
612 app_wrk = app_worker_get_if_valid (handle >> 32);
615 opaque = tc->s_index;
616 app = application_get (app_wrk->app_index);
619 * Allocate new session with fifos (svm segments are allocated if needed)
623 sm = app_worker_get_connect_segment_manager (app_wrk);
624 alloc_fifos = !application_is_builtin_proxy (app);
625 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
632 new_s->session_state = SESSION_STATE_CONNECTING;
633 new_s->app_wrk_index = app_wrk->wrk_index;
634 new_si = new_s->session_index;
635 new_ti = new_s->thread_index;
640 * Notify client application
642 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
645 SESSION_DBG ("failed to notify app");
648 new_s = session_get (new_si, new_ti);
649 stream_session_disconnect_transport (new_s);
656 new_s = session_get (new_si, new_ti);
657 new_s->session_state = SESSION_STATE_READY;
664 typedef struct _session_switch_pool_args
668 u32 new_thread_index;
669 u32 new_session_index;
670 } session_switch_pool_args_t;
673 session_switch_pool (void *cb_args)
675 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
676 transport_proto_t tp;
678 ASSERT (args->thread_index == vlib_get_thread_index ());
679 s = session_get (args->session_index, args->thread_index);
680 s->server_tx_fifo->master_session_index = args->new_session_index;
681 s->server_tx_fifo->master_thread_index = args->new_thread_index;
682 tp = session_get_transport_proto (s);
683 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
685 clib_mem_free (cb_args);
689 * Move dgram session to the right thread
692 session_dgram_connect_notify (transport_connection_t * tc,
693 u32 old_thread_index,
694 stream_session_t ** new_session)
696 stream_session_t *new_s;
697 session_switch_pool_args_t *rpc_args;
700 * Clone half-open session to the right thread.
702 new_s = session_clone_safe (tc->s_index, old_thread_index);
703 new_s->connection_index = tc->c_index;
704 new_s->server_rx_fifo->master_session_index = new_s->session_index;
705 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
706 new_s->session_state = SESSION_STATE_READY;
707 session_lookup_add_connection (tc, session_handle (new_s));
710 * Ask thread owning the old session to clean it up and make us the tx
713 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
714 rpc_args->new_session_index = new_s->session_index;
715 rpc_args->new_thread_index = new_s->thread_index;
716 rpc_args->session_index = tc->s_index;
717 rpc_args->thread_index = old_thread_index;
718 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
721 tc->s_index = new_s->session_index;
722 new_s->connection_index = tc->c_index;
723 *new_session = new_s;
728 stream_session_accept_notify (transport_connection_t * tc)
730 app_worker_t *app_wrk;
734 s = session_get (tc->s_index, tc->thread_index);
735 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
738 app = application_get (app_wrk->app_index);
739 return app->cb_fns.session_accept_callback (s);
743 * Notification from transport that connection is being closed.
745 * A disconnect is sent to application but state is not removed. Once
746 * disconnect is acknowledged by application, session disconnect is called.
747 * Ultimately this leads to close being called on transport (passive close).
750 stream_session_disconnect_notify (transport_connection_t * tc)
752 app_worker_t *app_wrk;
756 s = session_get (tc->s_index, tc->thread_index);
757 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
759 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
760 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
763 app = application_get (app_wrk->app_index);
764 app->cb_fns.session_disconnect_callback (s);
768 * Cleans up session and lookup table.
770 * Transport connection must still be valid.
773 stream_session_delete (stream_session_t * s)
777 /* Delete from the main lookup table. */
778 if ((rv = session_lookup_del_session (s)))
779 clib_warning ("hash delete error, rv %d", rv);
781 session_free_w_fifos (s);
785 * Notification from transport that connection is being deleted
787 * This removes the session if it is still valid. It should be called only on
788 * previously fully established sessions. For instance failed connects should
789 * call stream_session_connect_notify and indicate that the connect has
793 stream_session_delete_notify (transport_connection_t * tc)
797 /* App might've been removed already */
798 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
801 /* Make sure we don't try to send anything more */
802 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
804 switch (s->session_state)
806 case SESSION_STATE_TRANSPORT_CLOSING:
807 /* If transport finishes or times out before we get a reply
808 * from the app, do the whole disconnect since we might still
809 * have lingering events. Cleanup session table in advance
810 * because transport will soon be closed and closed sessions
811 * are assumed to have been removed from the lookup table */
812 session_lookup_del_session (s);
813 stream_session_disconnect (s);
814 s->session_state = SESSION_STATE_CLOSED;
816 case SESSION_STATE_CLOSING:
817 /* Cleanup lookup table. Transport needs to still be valid */
818 session_lookup_del_session (s);
819 s->session_state = SESSION_STATE_CLOSED;
821 case SESSION_STATE_CLOSED:
822 case SESSION_STATE_ACCEPTING:
823 case SESSION_STATE_CLOSED_WAITING:
824 stream_session_delete (s);
827 stream_session_delete (s);
833 * Notification from transport that session can be closed
835 * Should be called by transport only if it was closed with non-empty
836 * tx fifo and once it decides to begin the closing procedure prior to
837 * issuing a delete notify. This gives the chance to the session layer
838 * to cleanup any outstanding events.
841 session_stream_close_notify (transport_connection_t * tc)
845 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
847 s->session_state = SESSION_STATE_CLOSED;
851 * Notify application that connection has been reset.
854 stream_session_reset_notify (transport_connection_t * tc)
857 app_worker_t *app_wrk;
859 s = session_get (tc->s_index, tc->thread_index);
860 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
861 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
863 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
864 app_wrk = app_worker_get (s->app_wrk_index);
865 app = application_get (app_wrk->app_index);
866 app->cb_fns.session_reset_callback (s);
870 * Accept a stream session. Optionally ping the server by callback.
873 stream_session_accept (transport_connection_t * tc, u32 listener_index,
876 stream_session_t *s, *listener;
877 app_worker_t *app_wrk;
878 segment_manager_t *sm;
881 /* Find the server */
882 listener = listen_session_get (listener_index);
883 app_wrk = application_listener_select_worker (listener, 0);
885 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
886 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
889 s->app_wrk_index = app_wrk->wrk_index;
890 s->listener_index = listener_index;
891 s->session_state = SESSION_STATE_ACCEPTING;
893 /* Shoulder-tap the server */
896 application_t *app = application_get (app_wrk->app_index);
897 return app->cb_fns.session_accept_callback (s);
904 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
906 transport_connection_t *tc;
907 transport_endpoint_cfg_t *tep;
908 segment_manager_t *sm;
909 app_worker_t *app_wrk;
914 tep = session_endpoint_to_transport_cfg (rmt);
915 rv = tp_vfts[rmt->transport_proto].open (tep);
918 SESSION_DBG ("Transport failed to open connection.");
919 return VNET_API_ERROR_SESSION_CONNECT;
922 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
924 /* For dgram type of service, allocate session and fifos now.
926 app_wrk = app_worker_get (app_wrk_index);
927 sm = app_worker_get_connect_segment_manager (app_wrk);
929 if (session_alloc_and_init (sm, tc, 1, &s))
931 s->app_wrk_index = app_wrk->wrk_index;
932 s->session_state = SESSION_STATE_OPENED;
934 /* Tell the app about the new event fifo for this session */
935 app = application_get (app_wrk->app_index);
936 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
942 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
944 transport_connection_t *tc;
945 transport_endpoint_cfg_t *tep;
949 tep = session_endpoint_to_transport_cfg (rmt);
950 rv = tp_vfts[rmt->transport_proto].open (tep);
953 SESSION_DBG ("Transport failed to open connection.");
954 return VNET_API_ERROR_SESSION_CONNECT;
957 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
959 /* If transport offers a stream service, only allocate session once the
960 * connection has been established.
961 * Add connection to half-open table and save app and tc index. The
962 * latter is needed to help establish the connection while the former
963 * is needed when the connect notify comes and we have to notify the
966 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
967 session_lookup_add_half_open (tc, handle);
969 /* Store api_context (opaque) for when the reply comes. Not the nicest
970 * thing but better than allocating a separate half-open pool.
972 tc->s_index = opaque;
977 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
979 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
980 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
982 sep->app_wrk_index = app_wrk_index;
983 sep->opaque = opaque;
985 return tp_vfts[rmt->transport_proto].open (tep_cfg);
988 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
991 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
999 * Ask transport to open connection to remote transport endpoint.
1001 * Stores handle for matching request with reply since the call can be
1002 * asynchronous. For instance, for TCP the 3-way handshake must complete
1003 * before reply comes. Session is only created once connection is established.
1005 * @param app_index Index of the application requesting the connect
1006 * @param st Session type requested.
1007 * @param tep Remote transport endpoint
1008 * @param opaque Opaque data (typically, api_context) the application expects
1009 * on open completion.
1012 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1014 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
1015 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1019 * Ask transport to listen on session endpoint.
1021 * @param s Session for which listen will be called. Note that unlike
1022 * established sessions, listen sessions are not associated to a
1024 * @param sep Local endpoint to be listened on.
1027 session_listen (stream_session_t * ls, session_endpoint_cfg_t * sep)
1029 transport_connection_t *tc;
1030 transport_endpoint_t *tep;
1031 u32 tc_index, s_index;
1033 /* Transport bind/listen */
1034 tep = session_endpoint_to_transport (sep);
1035 s_index = ls->session_index;
1036 tc_index = tp_vfts[sep->transport_proto].bind (s_index, tep);
1038 if (tc_index == (u32) ~ 0)
1041 /* Attach transport to session */
1042 ls = listen_session_get (s_index);
1043 ls->connection_index = tc_index;
1045 /* Add to the main lookup table after transport was initialized */
1046 tc = tp_vfts[sep->transport_proto].get_listener (tc_index);
1047 session_lookup_add_connection (tc, s_index);
1052 * Ask transport to stop listening on local transport endpoint.
1054 * @param s Session to stop listening on. It must be in state LISTENING.
1057 session_stop_listen (stream_session_t * s)
1059 transport_proto_t tp = session_get_transport_proto (s);
1060 transport_connection_t *tc;
1061 if (s->session_state != SESSION_STATE_LISTENING)
1063 clib_warning ("not a listening session");
1067 tc = tp_vfts[tp].get_listener (s->connection_index);
1070 clib_warning ("no transport");
1071 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1074 session_lookup_del_connection (tc);
1075 tp_vfts[tp].unbind (s->connection_index);
1080 * Initialize session disconnect.
1082 * Request is always sent to session node to ensure that all outstanding
1083 * requests are served before transport is notified.
1086 stream_session_disconnect (stream_session_t * s)
1088 u32 thread_index = vlib_get_thread_index ();
1089 session_manager_worker_t *wrk;
1090 session_event_t *evt;
1095 if (s->session_state >= SESSION_STATE_CLOSING)
1097 /* Session already closed. Clear the tx fifo */
1098 if (s->session_state == SESSION_STATE_CLOSED)
1099 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1103 s->session_state = SESSION_STATE_CLOSING;
1105 /* If we are in the handler thread, or being called with the worker barrier
1106 * held, just append a new event to pending disconnects vector. */
1107 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
1109 wrk = session_manager_get_worker (s->thread_index);
1110 vec_add2 (wrk->pending_disconnects, evt, 1);
1111 clib_memset (evt, 0, sizeof (*evt));
1112 evt->session_handle = session_handle (s);
1113 evt->event_type = FIFO_EVENT_DISCONNECT;
1116 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
1120 * Notify transport the session can be disconnected. This should eventually
1121 * result in a delete notification that allows us to cleanup session state.
1122 * Called for both active/passive disconnects.
1124 * Must be called from the session's thread.
1127 stream_session_disconnect_transport (stream_session_t * s)
1129 /* If transport is already closed, just free the session */
1130 if (s->session_state == SESSION_STATE_CLOSED)
1132 session_free_w_fifos (s);
1136 /* If tx queue wasn't drained, change state to closed waiting for transport.
1137 * This way, the transport, if it so wishes, can continue to try sending the
1138 * outstanding data (in closed state it cannot). It MUST however at one
1139 * point, either after sending everything or after a timeout, call delete
1140 * notify. This will finally lead to the complete cleanup of the session.
1142 if (svm_fifo_max_dequeue (s->server_tx_fifo))
1143 s->session_state = SESSION_STATE_CLOSED_WAITING;
1145 s->session_state = SESSION_STATE_CLOSED;
1147 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1152 * Cleanup transport and session state.
1154 * Notify transport of the cleanup and free the session. This should
1155 * be called only if transport reported some error and is already
1159 stream_session_cleanup (stream_session_t * s)
1161 s->session_state = SESSION_STATE_CLOSED;
1163 /* Delete from main lookup table before we axe the the transport */
1164 session_lookup_del_session (s);
1165 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1167 /* Since we called cleanup, no delete notification will come. So, make
1168 * sure the session is properly freed. */
1169 session_free_w_fifos (s);
1172 transport_service_type_t
1173 session_transport_service_type (stream_session_t * s)
1175 transport_proto_t tp;
1176 tp = session_get_transport_proto (s);
1177 return transport_protocol_service_type (tp);
1180 transport_tx_fn_type_t
1181 session_transport_tx_fn_type (stream_session_t * s)
1183 transport_proto_t tp;
1184 tp = session_get_transport_proto (s);
1185 return transport_protocol_tx_fn_type (tp);
1189 session_tx_is_dgram (stream_session_t * s)
1191 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1195 * Allocate event queues in the shared-memory segment
1197 * That can either be a newly created memfd segment, that will need to be
1198 * mapped by all stack users, or the binary api's svm region. The latter is
1199 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1200 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1201 * vpp uses api svm region for event queues.
1204 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1206 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1207 ssvm_private_t *eqs = &smm->evt_qs_segment;
1208 api_main_t *am = &api_main;
1209 u64 eqs_size = 64 << 20;
1210 pid_t vpp_pid = getpid ();
1214 if (smm->configured_event_queue_length)
1215 evt_q_length = smm->configured_event_queue_length;
1217 if (smm->evt_qs_use_memfd_seg)
1219 if (smm->evt_qs_segment_size)
1220 eqs_size = smm->evt_qs_segment_size;
1222 eqs->ssvm_size = eqs_size;
1223 eqs->i_am_master = 1;
1224 eqs->my_pid = vpp_pid;
1225 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1226 eqs->requested_va = smm->session_baseva;
1228 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1230 clib_warning ("failed to initialize queue segment");
1235 if (smm->evt_qs_use_memfd_seg)
1236 oldheap = ssvm_push_heap (eqs->sh);
1238 oldheap = svm_push_data_heap (am->vlib_rp);
1240 for (i = 0; i < vec_len (smm->wrk); i++)
1242 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1243 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1244 {evt_q_length, evt_size, 0}
1246 {evt_q_length << 1, 256, 0}
1248 cfg->consumer_pid = 0;
1250 cfg->q_nitems = evt_q_length;
1251 cfg->ring_cfgs = rc;
1252 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1253 if (smm->evt_qs_use_memfd_seg)
1255 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1256 clib_warning ("eventfd returned");
1260 if (smm->evt_qs_use_memfd_seg)
1261 ssvm_pop_heap (oldheap);
1263 svm_pop_heap (oldheap);
1267 session_manager_get_evt_q_segment (void)
1269 session_manager_main_t *smm = &session_manager_main;
1270 if (smm->evt_qs_use_memfd_seg)
1271 return &smm->evt_qs_segment;
1276 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1277 session_tx_fifo_peek_and_snd,
1278 session_tx_fifo_dequeue_and_snd,
1279 session_tx_fifo_dequeue_internal,
1280 session_tx_fifo_dequeue_and_snd
1285 * Initialize session layer for given transport proto and ip version
1287 * Allocates per session type (transport proto + ip version) data structures
1288 * and adds arc from session queue node to session type output node.
1291 session_register_transport (transport_proto_t transport_proto,
1292 const transport_proto_vft_t * vft, u8 is_ip4,
1295 session_manager_main_t *smm = &session_manager_main;
1296 session_type_t session_type;
1297 u32 next_index = ~0;
1299 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1301 vec_validate (smm->session_type_to_next, session_type);
1302 vec_validate (smm->session_tx_fns, session_type);
1305 if (output_node != ~0)
1307 foreach_vlib_main (({
1308 next_index = vlib_node_add_next (this_vlib_main,
1309 session_queue_node.index,
1315 smm->session_type_to_next[session_type] = next_index;
1316 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1319 transport_connection_t *
1320 session_get_transport (stream_session_t * s)
1322 transport_proto_t tp;
1323 if (s->session_state != SESSION_STATE_LISTENING)
1325 tp = session_get_transport_proto (s);
1326 return tp_vfts[tp].get_connection (s->connection_index,
1332 transport_connection_t *
1333 listen_session_get_transport (stream_session_t * s)
1335 transport_proto_t tp = session_get_transport_proto (s);
1336 return tp_vfts[tp].get_listener (s->connection_index);
1340 listen_session_get_local_session_endpoint (stream_session_t * listener,
1341 session_endpoint_t * sep)
1343 transport_proto_t tp = session_get_transport_proto (listener);
1344 transport_connection_t *tc;
1345 tc = tp_vfts[tp].get_listener (listener->connection_index);
1348 clib_warning ("no transport");
1352 /* N.B. The ip should not be copied because this is the local endpoint */
1353 sep->port = tc->lcl_port;
1354 sep->transport_proto = tc->proto;
1355 sep->is_ip4 = tc->is_ip4;
1360 session_flush_frames_main_thread (vlib_main_t * vm)
1362 ASSERT (vlib_get_thread_index () == 0);
1363 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1364 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1367 static clib_error_t *
1368 session_manager_main_enable (vlib_main_t * vm)
1370 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1371 session_manager_main_t *smm = &session_manager_main;
1372 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1373 u32 num_threads, preallocated_sessions_per_worker;
1374 session_manager_worker_t *wrk;
1377 num_threads = 1 /* main thread */ + vtm->n_threads;
1379 if (num_threads < 1)
1380 return clib_error_return (0, "n_thread_stacks not set");
1382 /* Allocate cache line aligned worker contexts */
1383 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1385 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1387 for (j = 0; j < num_threads; j++)
1388 smm->wrk[j].current_enqueue_epoch[i] = 1;
1391 for (i = 0; i < num_threads; i++)
1394 vec_validate (wrk->free_event_vector, 128);
1395 _vec_len (wrk->free_event_vector) = 0;
1396 vec_validate (wrk->pending_event_vector, 128);
1397 _vec_len (wrk->pending_event_vector) = 0;
1398 vec_validate (wrk->pending_disconnects, 128);
1399 _vec_len (wrk->pending_disconnects) = 0;
1400 vec_validate (wrk->postponed_event_vector, 128);
1401 _vec_len (wrk->postponed_event_vector) = 0;
1403 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1404 wrk->dispatch_period = 500e-6;
1406 if (num_threads > 1)
1407 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1411 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1414 /* Allocate vpp event queues segment and queue */
1415 session_vpp_event_queues_allocate (smm);
1417 /* Initialize fifo segment main baseva and timeout */
1418 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1419 sm_args->size = smm->session_va_space_size;
1420 segment_manager_main_init (sm_args);
1422 /* Preallocate sessions */
1423 if (smm->preallocated_sessions)
1425 if (num_threads == 1)
1427 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1432 preallocated_sessions_per_worker =
1433 (1.1 * (f64) smm->preallocated_sessions /
1434 (f64) (num_threads - 1));
1436 for (j = 1; j < num_threads; j++)
1438 pool_init_fixed (smm->wrk[j].sessions,
1439 preallocated_sessions_per_worker);
1444 session_lookup_init ();
1445 app_namespaces_init ();
1448 smm->is_enabled = 1;
1450 /* Enable transports */
1451 transport_enable_disable (vm, 1);
1452 transport_init_tx_pacers_period ();
1457 session_node_enable_disable (u8 is_en)
1459 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1460 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1461 u8 have_workers = vtm->n_threads != 0;
1464 foreach_vlib_main (({
1465 if (have_workers && ii == 0)
1467 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1471 vlib_node_t *n = vlib_get_node (this_vlib_main,
1472 session_queue_process_node.index);
1473 vlib_start_process (this_vlib_main, n->runtime_index);
1477 vlib_process_signal_event_mt (this_vlib_main,
1478 session_queue_process_node.index,
1479 SESSION_Q_PROCESS_STOP, 0);
1484 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1491 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1493 clib_error_t *error = 0;
1496 if (session_manager_main.is_enabled)
1499 session_node_enable_disable (is_en);
1500 error = session_manager_main_enable (vm);
1504 session_manager_main.is_enabled = 0;
1505 session_node_enable_disable (is_en);
1512 session_manager_main_init (vlib_main_t * vm)
1514 session_manager_main_t *smm = &session_manager_main;
1515 smm->session_baseva = 0x200000000ULL;
1516 smm->session_va_space_size = (u64) 128 << 30;
1517 smm->evt_qs_segment_size = 64 << 20;
1518 smm->is_enabled = 0;
1522 VLIB_INIT_FUNCTION (session_manager_main_init);
1524 static clib_error_t *
1525 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1527 session_manager_main_t *smm = &session_manager_main;
1531 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1533 if (unformat (input, "event-queue-length %d", &nitems))
1536 smm->configured_event_queue_length = nitems;
1538 clib_warning ("event queue length %d too small, ignored", nitems);
1540 else if (unformat (input, "preallocated-sessions %d",
1541 &smm->preallocated_sessions))
1543 else if (unformat (input, "v4-session-table-buckets %d",
1544 &smm->configured_v4_session_table_buckets))
1546 else if (unformat (input, "v4-halfopen-table-buckets %d",
1547 &smm->configured_v4_halfopen_table_buckets))
1549 else if (unformat (input, "v6-session-table-buckets %d",
1550 &smm->configured_v6_session_table_buckets))
1552 else if (unformat (input, "v6-halfopen-table-buckets %d",
1553 &smm->configured_v6_halfopen_table_buckets))
1555 else if (unformat (input, "v4-session-table-memory %U",
1556 unformat_memory_size, &tmp))
1558 if (tmp >= 0x100000000)
1559 return clib_error_return (0, "memory size %llx (%lld) too large",
1561 smm->configured_v4_session_table_memory = tmp;
1563 else if (unformat (input, "v4-halfopen-table-memory %U",
1564 unformat_memory_size, &tmp))
1566 if (tmp >= 0x100000000)
1567 return clib_error_return (0, "memory size %llx (%lld) too large",
1569 smm->configured_v4_halfopen_table_memory = tmp;
1571 else if (unformat (input, "v6-session-table-memory %U",
1572 unformat_memory_size, &tmp))
1574 if (tmp >= 0x100000000)
1575 return clib_error_return (0, "memory size %llx (%lld) too large",
1577 smm->configured_v6_session_table_memory = tmp;
1579 else if (unformat (input, "v6-halfopen-table-memory %U",
1580 unformat_memory_size, &tmp))
1582 if (tmp >= 0x100000000)
1583 return clib_error_return (0, "memory size %llx (%lld) too large",
1585 smm->configured_v6_halfopen_table_memory = tmp;
1587 else if (unformat (input, "local-endpoints-table-memory %U",
1588 unformat_memory_size, &tmp))
1590 if (tmp >= 0x100000000)
1591 return clib_error_return (0, "memory size %llx (%lld) too large",
1593 smm->local_endpoints_table_memory = tmp;
1595 else if (unformat (input, "local-endpoints-table-buckets %d",
1596 &smm->local_endpoints_table_buckets))
1598 else if (unformat (input, "evt_qs_memfd_seg"))
1599 smm->evt_qs_use_memfd_seg = 1;
1601 return clib_error_return (0, "unknown input `%U'",
1602 format_unformat_error, input);
1607 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1610 * fd.io coding-style-patch-verification: ON
1613 * eval: (c-set-style "gnu")