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;
237 s->session_state = SESSION_STATE_CLOSED;
239 /* Attach transport to session and vice versa */
240 s->connection_index = tc->c_index;
241 tc->s_index = s->session_index;
246 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
247 u8 alloc_fifos, stream_session_t ** ret_s)
252 s = session_alloc_for_connection (tc);
253 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
260 /* Add to the main lookup table */
261 session_lookup_add_connection (tc, session_handle (s));
268 * Discards bytes from buffer chain
270 * It discards n_bytes_to_drop starting at first buffer after chain_b
273 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
274 vlib_buffer_t ** chain_b,
277 vlib_buffer_t *next = *chain_b;
278 u32 to_drop = n_bytes_to_drop;
279 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
280 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
282 next = vlib_get_buffer (vm, next->next_buffer);
283 if (next->current_length > to_drop)
285 vlib_buffer_advance (next, to_drop);
290 to_drop -= next->current_length;
291 next->current_length = 0;
297 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
301 * Enqueue buffer chain tail
304 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
305 u32 offset, u8 is_in_order)
307 vlib_buffer_t *chain_b;
308 u32 chain_bi, len, diff;
309 vlib_main_t *vm = vlib_get_main ();
314 if (is_in_order && offset)
316 diff = offset - b->current_length;
317 if (diff > b->total_length_not_including_first_buffer)
320 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
321 chain_bi = vlib_get_buffer_index (vm, chain_b);
324 chain_bi = b->next_buffer;
328 chain_b = vlib_get_buffer (vm, chain_bi);
329 data = vlib_buffer_get_current (chain_b);
330 len = chain_b->current_length;
335 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
342 return (rv > 0) ? (written + rv) : written;
348 /* written more than what was left in chain */
349 if (written > b->total_length_not_including_first_buffer)
352 /* drop the bytes that have already been delivered */
353 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
358 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
362 clib_warning ("failed to enqueue multi-buffer seg");
368 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
369 ? chain_b->next_buffer : 0));
378 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
379 * event but on request can queue notification events for later delivery by
380 * calling stream_server_flush_enqueue_events().
382 * @param tc Transport connection which is to be enqueued data
383 * @param b Buffer to be enqueued
384 * @param offset Offset at which to start enqueueing if out-of-order
385 * @param queue_event Flag to indicate if peer is to be notified or if event
386 * is to be queued. The former is useful when more data is
387 * enqueued and only one event is to be generated.
388 * @param is_in_order Flag to indicate if data is in order
389 * @return Number of bytes enqueued or a negative value if enqueueing failed.
392 session_enqueue_stream_connection (transport_connection_t * tc,
393 vlib_buffer_t * b, u32 offset,
394 u8 queue_event, u8 is_in_order)
397 int enqueued = 0, rv, in_order_off;
399 s = session_get (tc->s_index, tc->thread_index);
403 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
405 vlib_buffer_get_current (b));
406 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
409 in_order_off = enqueued > b->current_length ? enqueued : 0;
410 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
417 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
419 vlib_buffer_get_current (b));
420 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
421 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
422 /* if something was enqueued, report even this as success for ooo
423 * segment handling */
429 /* Queue RX event on this fifo. Eventually these will need to be flushed
430 * by calling stream_server_flush_enqueue_events () */
431 session_manager_worker_t *wrk;
433 wrk = session_manager_get_worker (s->thread_index);
434 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
436 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
437 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
445 session_enqueue_dgram_connection (stream_session_t * s,
446 session_dgram_hdr_t * hdr,
447 vlib_buffer_t * b, u8 proto, u8 queue_event)
449 int enqueued = 0, rv, in_order_off;
451 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
452 >= b->current_length + sizeof (*hdr));
454 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
456 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
457 vlib_buffer_get_current (b));
458 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
460 in_order_off = enqueued > b->current_length ? enqueued : 0;
461 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
467 /* Queue RX event on this fifo. Eventually these will need to be flushed
468 * by calling stream_server_flush_enqueue_events () */
469 session_manager_worker_t *wrk;
471 wrk = session_manager_get_worker (s->thread_index);
472 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
474 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
475 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
481 /** Check if we have space in rx fifo to push more bytes */
483 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
486 stream_session_t *s = session_get (tc->s_index, thread_index);
488 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
491 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
498 session_tx_fifo_max_dequeue (transport_connection_t * tc)
500 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
501 if (!s->server_tx_fifo)
503 return svm_fifo_max_dequeue (s->server_tx_fifo);
507 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
508 u32 offset, u32 max_bytes)
510 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
511 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
515 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
517 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
518 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
522 session_notify_subscribers (u32 app_index, stream_session_t * s,
523 svm_fifo_t * f, session_evt_type_t evt_type)
525 app_worker_t *app_wrk;
529 app = application_get (app_index);
533 for (i = 0; i < f->n_subscribers; i++)
535 app_wrk = application_get_worker (app, f->subscribers[i]);
538 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
546 * Notify session peer that new data has been enqueued.
548 * @param s Stream session for which the event is to be generated.
549 * @param lock Flag to indicate if call should lock message queue.
551 * @return 0 on success or negative number if failed to send notification.
554 session_enqueue_notify (stream_session_t * s)
556 app_worker_t *app_wrk;
558 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
559 if (PREDICT_FALSE (!app_wrk))
561 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
566 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
567 ed->data[0] = FIFO_EVENT_APP_RX;
568 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
572 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
576 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->server_rx_fifo)))
577 return session_notify_subscribers (app_wrk->app_index, s,
578 s->server_rx_fifo, FIFO_EVENT_APP_RX);
584 session_dequeue_notify (stream_session_t * s)
586 app_worker_t *app_wrk;
588 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
589 if (PREDICT_FALSE (!app_wrk))
592 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
596 if (PREDICT_FALSE (s->server_tx_fifo->n_subscribers))
597 return session_notify_subscribers (app_wrk->app_index, s,
598 s->server_tx_fifo, FIFO_EVENT_APP_TX);
600 svm_fifo_clear_tx_ntf (s->server_tx_fifo);
606 * Flushes queue of sessions that are to be notified of new data
609 * @param thread_index Thread index for which the flush is to be performed.
610 * @return 0 on success or a positive number indicating the number of
611 * failures due to API queue being full.
614 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
616 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
621 indices = wrk->session_to_enqueue[transport_proto];
623 for (i = 0; i < vec_len (indices); i++)
625 s = session_get_if_valid (indices[i], thread_index);
626 if (PREDICT_FALSE (!s))
631 if (PREDICT_FALSE (session_enqueue_notify (s)))
635 vec_reset_length (indices);
636 wrk->session_to_enqueue[transport_proto] = indices;
637 wrk->current_enqueue_epoch[transport_proto]++;
643 session_manager_flush_all_enqueue_events (u8 transport_proto)
645 vlib_thread_main_t *vtm = vlib_get_thread_main ();
647 for (i = 0; i < 1 + vtm->n_threads; i++)
648 errors += session_manager_flush_enqueue_events (transport_proto, i);
653 * Init fifo tail and head pointers
655 * Useful if transport uses absolute offsets for tracking ooo segments.
658 stream_session_init_fifos_pointers (transport_connection_t * tc,
659 u32 rx_pointer, u32 tx_pointer)
662 s = session_get (tc->s_index, tc->thread_index);
663 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
664 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
668 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
670 u32 opaque = 0, new_ti, new_si;
671 stream_session_t *new_s = 0;
672 segment_manager_t *sm;
673 app_worker_t *app_wrk;
680 * Find connection handle and cleanup half-open table
682 handle = session_lookup_half_open_handle (tc);
683 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
685 SESSION_DBG ("half-open was removed!");
688 session_lookup_del_half_open (tc);
690 /* Get the app's index from the handle we stored when opening connection
691 * and the opaque (api_context for external apps) from transport session
693 app_wrk = app_worker_get_if_valid (handle >> 32);
696 opaque = tc->s_index;
697 app = application_get (app_wrk->app_index);
700 * Allocate new session with fifos (svm segments are allocated if needed)
704 sm = app_worker_get_connect_segment_manager (app_wrk);
705 alloc_fifos = !application_is_builtin_proxy (app);
706 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
713 new_s->session_state = SESSION_STATE_CONNECTING;
714 new_s->app_wrk_index = app_wrk->wrk_index;
715 new_si = new_s->session_index;
716 new_ti = new_s->thread_index;
721 * Notify client application
723 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
726 SESSION_DBG ("failed to notify app");
729 new_s = session_get (new_si, new_ti);
730 session_transport_close (new_s);
737 new_s = session_get (new_si, new_ti);
738 new_s->session_state = SESSION_STATE_READY;
745 typedef struct _session_switch_pool_args
749 u32 new_thread_index;
750 u32 new_session_index;
751 } session_switch_pool_args_t;
754 session_switch_pool (void *cb_args)
756 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
757 transport_proto_t tp;
759 ASSERT (args->thread_index == vlib_get_thread_index ());
760 s = session_get (args->session_index, args->thread_index);
761 s->server_tx_fifo->master_session_index = args->new_session_index;
762 s->server_tx_fifo->master_thread_index = args->new_thread_index;
763 tp = session_get_transport_proto (s);
764 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
766 clib_mem_free (cb_args);
770 * Move dgram session to the right thread
773 session_dgram_connect_notify (transport_connection_t * tc,
774 u32 old_thread_index,
775 stream_session_t ** new_session)
777 stream_session_t *new_s;
778 session_switch_pool_args_t *rpc_args;
781 * Clone half-open session to the right thread.
783 new_s = session_clone_safe (tc->s_index, old_thread_index);
784 new_s->connection_index = tc->c_index;
785 new_s->server_rx_fifo->master_session_index = new_s->session_index;
786 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
787 new_s->session_state = SESSION_STATE_READY;
788 session_lookup_add_connection (tc, session_handle (new_s));
791 * Ask thread owning the old session to clean it up and make us the tx
794 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
795 rpc_args->new_session_index = new_s->session_index;
796 rpc_args->new_thread_index = new_s->thread_index;
797 rpc_args->session_index = tc->s_index;
798 rpc_args->thread_index = old_thread_index;
799 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
802 tc->s_index = new_s->session_index;
803 new_s->connection_index = tc->c_index;
804 *new_session = new_s;
809 stream_session_accept_notify (transport_connection_t * tc)
811 app_worker_t *app_wrk;
815 s = session_get (tc->s_index, tc->thread_index);
816 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
819 s->session_state = SESSION_STATE_ACCEPTING;
820 app = application_get (app_wrk->app_index);
821 return app->cb_fns.session_accept_callback (s);
825 * Notification from transport that connection is being closed.
827 * A disconnect is sent to application but state is not removed. Once
828 * disconnect is acknowledged by application, session disconnect is called.
829 * Ultimately this leads to close being called on transport (passive close).
832 session_transport_closing_notify (transport_connection_t * tc)
834 app_worker_t *app_wrk;
838 s = session_get (tc->s_index, tc->thread_index);
839 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
841 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
842 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
845 app = application_get (app_wrk->app_index);
846 app->cb_fns.session_disconnect_callback (s);
850 * Notification from transport that connection is being deleted
852 * This removes the session if it is still valid. It should be called only on
853 * previously fully established sessions. For instance failed connects should
854 * call stream_session_connect_notify and indicate that the connect has
858 session_transport_delete_notify (transport_connection_t * tc)
862 /* App might've been removed already */
863 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
866 /* Make sure we don't try to send anything more */
867 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
869 switch (s->session_state)
871 case SESSION_STATE_ACCEPTING:
872 case SESSION_STATE_TRANSPORT_CLOSING:
873 /* If transport finishes or times out before we get a reply
874 * from the app, mark transport as closed and wait for reply
875 * before removing the session. Cleanup session table in advance
876 * because transport will soon be closed and closed sessions
877 * are assumed to have been removed from the lookup table */
878 session_lookup_del_session (s);
879 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
881 case SESSION_STATE_CLOSING:
882 case SESSION_STATE_CLOSED_WAITING:
883 /* Cleanup lookup table as transport needs to still be valid.
884 * Program transport close to ensure that all session events
885 * have been cleaned up. Once transport close is called, the
886 * session is just removed because both transport and app have
887 * confirmed the close*/
888 session_lookup_del_session (s);
889 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
890 session_program_transport_close (s);
892 case SESSION_STATE_TRANSPORT_CLOSED:
894 case SESSION_STATE_CLOSED:
898 clib_warning ("session state %u", s->session_state);
905 * Notification from transport that session can be closed
907 * Should be called by transport only if it was closed with non-empty
908 * tx fifo and once it decides to begin the closing procedure prior to
909 * issuing a delete notify. This gives the chance to the session layer
910 * to cleanup any outstanding events.
913 session_transport_closed_notify (transport_connection_t * tc)
917 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
920 /* If app close has not been received or has not yet resulted in
921 * a transport close, only mark the session transport as closed */
922 if (s->session_state <= SESSION_STATE_CLOSING)
924 session_lookup_del_session (s);
925 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
928 s->session_state = SESSION_STATE_CLOSED;
932 * Notify application that connection has been reset.
935 session_transport_reset_notify (transport_connection_t * tc)
938 app_worker_t *app_wrk;
940 s = session_get (tc->s_index, tc->thread_index);
941 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
942 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
944 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
945 app_wrk = app_worker_get (s->app_wrk_index);
946 app = application_get (app_wrk->app_index);
947 app->cb_fns.session_reset_callback (s);
951 * Accept a stream session. Optionally ping the server by callback.
954 stream_session_accept (transport_connection_t * tc, u32 listener_index,
957 stream_session_t *s, *listener;
958 app_worker_t *app_wrk;
959 segment_manager_t *sm;
962 /* Find the server */
963 listener = listen_session_get (listener_index);
964 app_wrk = application_listener_select_worker (listener, 0);
966 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
967 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
970 s->app_wrk_index = app_wrk->wrk_index;
971 s->listener_index = listener_index;
973 /* Shoulder-tap the server */
976 application_t *app = application_get (app_wrk->app_index);
977 return app->cb_fns.session_accept_callback (s);
984 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
986 transport_connection_t *tc;
987 transport_endpoint_cfg_t *tep;
988 segment_manager_t *sm;
989 app_worker_t *app_wrk;
994 tep = session_endpoint_to_transport_cfg (rmt);
995 rv = tp_vfts[rmt->transport_proto].open (tep);
998 SESSION_DBG ("Transport failed to open connection.");
999 return VNET_API_ERROR_SESSION_CONNECT;
1002 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
1004 /* For dgram type of service, allocate session and fifos now.
1006 app_wrk = app_worker_get (app_wrk_index);
1007 sm = app_worker_get_connect_segment_manager (app_wrk);
1009 if (session_alloc_and_init (sm, tc, 1, &s))
1011 s->app_wrk_index = app_wrk->wrk_index;
1012 s->session_state = SESSION_STATE_OPENED;
1014 /* Tell the app about the new event fifo for this session */
1015 app = application_get (app_wrk->app_index);
1016 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
1022 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1024 transport_connection_t *tc;
1025 transport_endpoint_cfg_t *tep;
1029 tep = session_endpoint_to_transport_cfg (rmt);
1030 rv = tp_vfts[rmt->transport_proto].open (tep);
1033 SESSION_DBG ("Transport failed to open connection.");
1034 return VNET_API_ERROR_SESSION_CONNECT;
1037 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
1039 /* If transport offers a stream service, only allocate session once the
1040 * connection has been established.
1041 * Add connection to half-open table and save app and tc index. The
1042 * latter is needed to help establish the connection while the former
1043 * is needed when the connect notify comes and we have to notify the
1046 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1047 session_lookup_add_half_open (tc, handle);
1049 /* Store api_context (opaque) for when the reply comes. Not the nicest
1050 * thing but better than allocating a separate half-open pool.
1052 tc->s_index = opaque;
1057 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1059 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1060 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1062 sep->app_wrk_index = app_wrk_index;
1063 sep->opaque = opaque;
1065 return tp_vfts[rmt->transport_proto].open (tep_cfg);
1068 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1071 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1079 * Ask transport to open connection to remote transport endpoint.
1081 * Stores handle for matching request with reply since the call can be
1082 * asynchronous. For instance, for TCP the 3-way handshake must complete
1083 * before reply comes. Session is only created once connection is established.
1085 * @param app_index Index of the application requesting the connect
1086 * @param st Session type requested.
1087 * @param tep Remote transport endpoint
1088 * @param opaque Opaque data (typically, api_context) the application expects
1089 * on open completion.
1092 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1094 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
1095 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1099 * Ask transport to listen on session endpoint.
1101 * @param s Session for which listen will be called. Note that unlike
1102 * established sessions, listen sessions are not associated to a
1104 * @param sep Local endpoint to be listened on.
1107 session_listen (stream_session_t * ls, session_endpoint_cfg_t * sep)
1109 transport_connection_t *tc;
1110 transport_endpoint_t *tep;
1111 u32 tc_index, s_index;
1113 /* Transport bind/listen */
1114 tep = session_endpoint_to_transport (sep);
1115 s_index = ls->session_index;
1116 tc_index = tp_vfts[sep->transport_proto].bind (s_index, tep);
1118 if (tc_index == (u32) ~ 0)
1121 /* Attach transport to session */
1122 ls = listen_session_get (s_index);
1123 ls->connection_index = tc_index;
1125 /* Add to the main lookup table after transport was initialized */
1126 tc = tp_vfts[sep->transport_proto].get_listener (tc_index);
1127 session_lookup_add_connection (tc, s_index);
1132 * Ask transport to stop listening on local transport endpoint.
1134 * @param s Session to stop listening on. It must be in state LISTENING.
1137 session_stop_listen (stream_session_t * s)
1139 transport_proto_t tp = session_get_transport_proto (s);
1140 transport_connection_t *tc;
1141 if (s->session_state != SESSION_STATE_LISTENING)
1143 clib_warning ("not a listening session");
1147 tc = tp_vfts[tp].get_listener (s->connection_index);
1150 clib_warning ("no transport");
1151 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1154 session_lookup_del_connection (tc);
1155 tp_vfts[tp].unbind (s->connection_index);
1160 * Initialize session closing procedure.
1162 * Request is always sent to session node to ensure that all outstanding
1163 * requests are served before transport is notified.
1166 session_close (stream_session_t * s)
1171 if (s->session_state >= SESSION_STATE_CLOSING)
1173 /* Session will only be removed once both app and transport
1174 * acknowledge the close */
1175 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1176 session_program_transport_close (s);
1178 /* Session already closed. Clear the tx fifo */
1179 if (s->session_state == SESSION_STATE_CLOSED)
1180 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1184 s->session_state = SESSION_STATE_CLOSING;
1185 session_program_transport_close (s);
1189 * Notify transport the session can be disconnected. This should eventually
1190 * result in a delete notification that allows us to cleanup session state.
1191 * Called for both active/passive disconnects.
1193 * Must be called from the session's thread.
1196 session_transport_close (stream_session_t * s)
1198 /* If transport is already closed, just free the session */
1199 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1201 session_free_w_fifos (s);
1205 /* If tx queue wasn't drained, change state to closed waiting for transport.
1206 * This way, the transport, if it so wishes, can continue to try sending the
1207 * outstanding data (in closed state it cannot). It MUST however at one
1208 * point, either after sending everything or after a timeout, call delete
1209 * notify. This will finally lead to the complete cleanup of the session.
1211 if (svm_fifo_max_dequeue (s->server_tx_fifo))
1212 s->session_state = SESSION_STATE_CLOSED_WAITING;
1214 s->session_state = SESSION_STATE_CLOSED;
1216 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1221 * Cleanup transport and session state.
1223 * Notify transport of the cleanup and free the session. This should
1224 * be called only if transport reported some error and is already
1228 session_transport_cleanup (stream_session_t * s)
1230 s->session_state = SESSION_STATE_CLOSED;
1232 /* Delete from main lookup table before we axe the the transport */
1233 session_lookup_del_session (s);
1234 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1236 /* Since we called cleanup, no delete notification will come. So, make
1237 * sure the session is properly freed. */
1238 session_free_w_fifos (s);
1241 transport_service_type_t
1242 session_transport_service_type (stream_session_t * s)
1244 transport_proto_t tp;
1245 tp = session_get_transport_proto (s);
1246 return transport_protocol_service_type (tp);
1249 transport_tx_fn_type_t
1250 session_transport_tx_fn_type (stream_session_t * s)
1252 transport_proto_t tp;
1253 tp = session_get_transport_proto (s);
1254 return transport_protocol_tx_fn_type (tp);
1258 session_tx_is_dgram (stream_session_t * s)
1260 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1264 * Allocate event queues in the shared-memory segment
1266 * That can either be a newly created memfd segment, that will need to be
1267 * mapped by all stack users, or the binary api's svm region. The latter is
1268 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1269 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1270 * vpp uses api svm region for event queues.
1273 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1275 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1276 ssvm_private_t *eqs = &smm->evt_qs_segment;
1277 api_main_t *am = &api_main;
1278 u64 eqs_size = 64 << 20;
1279 pid_t vpp_pid = getpid ();
1283 if (smm->configured_event_queue_length)
1284 evt_q_length = smm->configured_event_queue_length;
1286 if (smm->evt_qs_use_memfd_seg)
1288 if (smm->evt_qs_segment_size)
1289 eqs_size = smm->evt_qs_segment_size;
1291 eqs->ssvm_size = eqs_size;
1292 eqs->i_am_master = 1;
1293 eqs->my_pid = vpp_pid;
1294 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1295 eqs->requested_va = smm->session_baseva;
1297 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1299 clib_warning ("failed to initialize queue segment");
1304 if (smm->evt_qs_use_memfd_seg)
1305 oldheap = ssvm_push_heap (eqs->sh);
1307 oldheap = svm_push_data_heap (am->vlib_rp);
1309 for (i = 0; i < vec_len (smm->wrk); i++)
1311 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1312 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1313 {evt_q_length, evt_size, 0}
1315 {evt_q_length << 1, 256, 0}
1317 cfg->consumer_pid = 0;
1319 cfg->q_nitems = evt_q_length;
1320 cfg->ring_cfgs = rc;
1321 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1322 if (smm->evt_qs_use_memfd_seg)
1324 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1325 clib_warning ("eventfd returned");
1329 if (smm->evt_qs_use_memfd_seg)
1330 ssvm_pop_heap (oldheap);
1332 svm_pop_heap (oldheap);
1336 session_manager_get_evt_q_segment (void)
1338 session_manager_main_t *smm = &session_manager_main;
1339 if (smm->evt_qs_use_memfd_seg)
1340 return &smm->evt_qs_segment;
1345 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1346 session_tx_fifo_peek_and_snd,
1347 session_tx_fifo_dequeue_and_snd,
1348 session_tx_fifo_dequeue_internal,
1349 session_tx_fifo_dequeue_and_snd
1354 * Initialize session layer for given transport proto and ip version
1356 * Allocates per session type (transport proto + ip version) data structures
1357 * and adds arc from session queue node to session type output node.
1360 session_register_transport (transport_proto_t transport_proto,
1361 const transport_proto_vft_t * vft, u8 is_ip4,
1364 session_manager_main_t *smm = &session_manager_main;
1365 session_type_t session_type;
1366 u32 next_index = ~0;
1368 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1370 vec_validate (smm->session_type_to_next, session_type);
1371 vec_validate (smm->session_tx_fns, session_type);
1374 if (output_node != ~0)
1376 foreach_vlib_main (({
1377 next_index = vlib_node_add_next (this_vlib_main,
1378 session_queue_node.index,
1384 smm->session_type_to_next[session_type] = next_index;
1385 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1388 transport_connection_t *
1389 session_get_transport (stream_session_t * s)
1391 transport_proto_t tp;
1392 if (s->session_state != SESSION_STATE_LISTENING)
1394 tp = session_get_transport_proto (s);
1395 return tp_vfts[tp].get_connection (s->connection_index,
1401 transport_connection_t *
1402 listen_session_get_transport (stream_session_t * s)
1404 transport_proto_t tp = session_get_transport_proto (s);
1405 return tp_vfts[tp].get_listener (s->connection_index);
1409 listen_session_get_local_session_endpoint (stream_session_t * listener,
1410 session_endpoint_t * sep)
1412 transport_proto_t tp = session_get_transport_proto (listener);
1413 transport_connection_t *tc;
1414 tc = tp_vfts[tp].get_listener (listener->connection_index);
1417 clib_warning ("no transport");
1421 /* N.B. The ip should not be copied because this is the local endpoint */
1422 sep->port = tc->lcl_port;
1423 sep->transport_proto = tc->proto;
1424 sep->is_ip4 = tc->is_ip4;
1429 session_flush_frames_main_thread (vlib_main_t * vm)
1431 ASSERT (vlib_get_thread_index () == 0);
1432 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1433 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1436 static clib_error_t *
1437 session_manager_main_enable (vlib_main_t * vm)
1439 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1440 session_manager_main_t *smm = &session_manager_main;
1441 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1442 u32 num_threads, preallocated_sessions_per_worker;
1443 session_manager_worker_t *wrk;
1446 num_threads = 1 /* main thread */ + vtm->n_threads;
1448 if (num_threads < 1)
1449 return clib_error_return (0, "n_thread_stacks not set");
1451 /* Allocate cache line aligned worker contexts */
1452 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1454 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1456 for (j = 0; j < num_threads; j++)
1457 smm->wrk[j].current_enqueue_epoch[i] = 1;
1460 for (i = 0; i < num_threads; i++)
1463 vec_validate (wrk->free_event_vector, 128);
1464 _vec_len (wrk->free_event_vector) = 0;
1465 vec_validate (wrk->pending_event_vector, 128);
1466 _vec_len (wrk->pending_event_vector) = 0;
1467 vec_validate (wrk->pending_disconnects, 128);
1468 _vec_len (wrk->pending_disconnects) = 0;
1469 vec_validate (wrk->postponed_event_vector, 128);
1470 _vec_len (wrk->postponed_event_vector) = 0;
1472 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1473 wrk->dispatch_period = 500e-6;
1475 if (num_threads > 1)
1476 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1480 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1483 /* Allocate vpp event queues segment and queue */
1484 session_vpp_event_queues_allocate (smm);
1486 /* Initialize fifo segment main baseva and timeout */
1487 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1488 sm_args->size = smm->session_va_space_size;
1489 segment_manager_main_init (sm_args);
1491 /* Preallocate sessions */
1492 if (smm->preallocated_sessions)
1494 if (num_threads == 1)
1496 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1501 preallocated_sessions_per_worker =
1502 (1.1 * (f64) smm->preallocated_sessions /
1503 (f64) (num_threads - 1));
1505 for (j = 1; j < num_threads; j++)
1507 pool_init_fixed (smm->wrk[j].sessions,
1508 preallocated_sessions_per_worker);
1513 session_lookup_init ();
1514 app_namespaces_init ();
1517 smm->is_enabled = 1;
1519 /* Enable transports */
1520 transport_enable_disable (vm, 1);
1521 transport_init_tx_pacers_period ();
1526 session_node_enable_disable (u8 is_en)
1528 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1529 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1530 u8 have_workers = vtm->n_threads != 0;
1533 foreach_vlib_main (({
1534 if (have_workers && ii == 0)
1536 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1540 vlib_node_t *n = vlib_get_node (this_vlib_main,
1541 session_queue_process_node.index);
1542 vlib_start_process (this_vlib_main, n->runtime_index);
1546 vlib_process_signal_event_mt (this_vlib_main,
1547 session_queue_process_node.index,
1548 SESSION_Q_PROCESS_STOP, 0);
1553 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1560 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1562 clib_error_t *error = 0;
1565 if (session_manager_main.is_enabled)
1568 session_node_enable_disable (is_en);
1569 error = session_manager_main_enable (vm);
1573 session_manager_main.is_enabled = 0;
1574 session_node_enable_disable (is_en);
1581 session_manager_main_init (vlib_main_t * vm)
1583 session_manager_main_t *smm = &session_manager_main;
1584 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1585 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1586 smm->session_va_space_size = 128ULL << 30;
1587 smm->evt_qs_segment_size = 64 << 20;
1589 smm->session_va_space_size = 128 << 20;
1590 smm->evt_qs_segment_size = 1 << 20;
1592 smm->is_enabled = 0;
1596 VLIB_INIT_FUNCTION (session_manager_main_init);
1598 static clib_error_t *
1599 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1601 session_manager_main_t *smm = &session_manager_main;
1605 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1607 if (unformat (input, "event-queue-length %d", &nitems))
1610 smm->configured_event_queue_length = nitems;
1612 clib_warning ("event queue length %d too small, ignored", nitems);
1614 else if (unformat (input, "preallocated-sessions %d",
1615 &smm->preallocated_sessions))
1617 else if (unformat (input, "v4-session-table-buckets %d",
1618 &smm->configured_v4_session_table_buckets))
1620 else if (unformat (input, "v4-halfopen-table-buckets %d",
1621 &smm->configured_v4_halfopen_table_buckets))
1623 else if (unformat (input, "v6-session-table-buckets %d",
1624 &smm->configured_v6_session_table_buckets))
1626 else if (unformat (input, "v6-halfopen-table-buckets %d",
1627 &smm->configured_v6_halfopen_table_buckets))
1629 else if (unformat (input, "v4-session-table-memory %U",
1630 unformat_memory_size, &tmp))
1632 if (tmp >= 0x100000000)
1633 return clib_error_return (0, "memory size %llx (%lld) too large",
1635 smm->configured_v4_session_table_memory = tmp;
1637 else if (unformat (input, "v4-halfopen-table-memory %U",
1638 unformat_memory_size, &tmp))
1640 if (tmp >= 0x100000000)
1641 return clib_error_return (0, "memory size %llx (%lld) too large",
1643 smm->configured_v4_halfopen_table_memory = tmp;
1645 else if (unformat (input, "v6-session-table-memory %U",
1646 unformat_memory_size, &tmp))
1648 if (tmp >= 0x100000000)
1649 return clib_error_return (0, "memory size %llx (%lld) too large",
1651 smm->configured_v6_session_table_memory = tmp;
1653 else if (unformat (input, "v6-halfopen-table-memory %U",
1654 unformat_memory_size, &tmp))
1656 if (tmp >= 0x100000000)
1657 return clib_error_return (0, "memory size %llx (%lld) too large",
1659 smm->configured_v6_halfopen_table_memory = tmp;
1661 else if (unformat (input, "local-endpoints-table-memory %U",
1662 unformat_memory_size, &tmp))
1664 if (tmp >= 0x100000000)
1665 return clib_error_return (0, "memory size %llx (%lld) too large",
1667 smm->local_endpoints_table_memory = tmp;
1669 else if (unformat (input, "local-endpoints-table-buckets %d",
1670 &smm->local_endpoints_table_buckets))
1672 else if (unformat (input, "evt_qs_memfd_seg"))
1673 smm->evt_qs_use_memfd_seg = 1;
1675 return clib_error_return (0, "unknown input `%U'",
1676 format_unformat_error, input);
1681 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1684 * fd.io coding-style-patch-verification: ON
1687 * eval: (c-set-style "gnu")