2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
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 <vnet/dpo/load_balance.h>
24 #include <vnet/fib/ip4_fib.h>
26 session_manager_main_t session_manager_main;
29 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
30 session_evt_type_t evt_type)
35 u32 tries = 0, max_tries;
37 mq = session_manager_get_vpp_event_queue (thread_index);
38 while (svm_msg_q_try_lock (mq))
40 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
41 if (tries++ == max_tries)
43 SESSION_DBG ("failed to enqueue evt");
47 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
49 svm_msg_q_unlock (mq);
52 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
53 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
55 svm_msg_q_unlock (mq);
58 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
59 evt->event_type = evt_type;
63 evt->rpc_args.fp = data;
64 evt->rpc_args.arg = args;
66 case FIFO_EVENT_APP_TX:
67 case SESSION_IO_EVT_TX_FLUSH:
68 case FIFO_EVENT_BUILTIN_RX:
71 case FIFO_EVENT_BUILTIN_TX:
72 case FIFO_EVENT_DISCONNECT:
73 evt->session_handle = session_handle ((session_t *) data);
76 clib_warning ("evt unhandled!");
77 svm_msg_q_unlock (mq);
81 svm_msg_q_add_and_unlock (mq, &msg);
86 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
88 return session_send_evt_to_thread (f, 0, f->master_thread_index, evt_type);
92 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
93 session_evt_type_t evt_type)
95 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
99 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
101 /* only event supported for now is disconnect */
102 ASSERT (evt_type == FIFO_EVENT_DISCONNECT);
103 return session_send_evt_to_thread (s, 0, s->thread_index,
104 FIFO_EVENT_DISCONNECT);
108 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
110 if (thread_index != vlib_get_thread_index ())
111 session_send_evt_to_thread (fp, rpc_args, thread_index, FIFO_EVENT_RPC);
114 void (*fnp) (void *) = fp;
120 session_program_transport_close (session_t * s)
122 u32 thread_index = vlib_get_thread_index ();
123 session_manager_worker_t *wrk;
124 session_event_t *evt;
126 if (!session_has_transport (s))
128 /* Polling may not be enabled on main thread so close now */
129 session_transport_close (s);
133 /* If we are in the handler thread, or being called with the worker barrier
134 * held, just append a new event to pending disconnects vector. */
135 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
137 wrk = session_manager_get_worker (s->thread_index);
138 vec_add2 (wrk->pending_disconnects, evt, 1);
139 clib_memset (evt, 0, sizeof (*evt));
140 evt->session_handle = session_handle (s);
141 evt->event_type = FIFO_EVENT_DISCONNECT;
144 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
148 session_alloc (u32 thread_index)
150 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
153 pool_get_aligned_will_expand (wrk->sessions, will_expand,
154 CLIB_CACHE_LINE_BYTES);
155 /* If we have peekers, let them finish */
156 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
158 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
159 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
160 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
164 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
166 clib_memset (s, 0, sizeof (*s));
167 s->session_index = s - wrk->sessions;
168 s->thread_index = thread_index;
173 session_free (session_t * s)
175 pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
177 clib_memset (s, 0xFA, sizeof (*s));
181 session_free_w_fifos (session_t * s)
183 segment_manager_dealloc_fifos (s->svm_segment_index, s->rx_fifo,
189 * Cleans up session and lookup table.
191 * Transport connection must still be valid.
194 session_delete (session_t * s)
198 /* Delete from the main lookup table. */
199 if ((rv = session_lookup_del_session (s)))
200 clib_warning ("hash delete error, rv %d", rv);
202 session_free_w_fifos (s);
206 session_alloc_for_connection (transport_connection_t * tc)
209 u32 thread_index = tc->thread_index;
211 ASSERT (thread_index == vlib_get_thread_index ()
212 || transport_protocol_is_cl (tc->proto));
214 s = session_alloc (thread_index);
215 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
216 s->enqueue_epoch = (u64) ~ 0;
217 s->session_state = SESSION_STATE_CLOSED;
219 /* Attach transport to session and vice versa */
220 s->connection_index = tc->c_index;
221 tc->s_index = s->session_index;
226 * Discards bytes from buffer chain
228 * It discards n_bytes_to_drop starting at first buffer after chain_b
231 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
232 vlib_buffer_t ** chain_b,
235 vlib_buffer_t *next = *chain_b;
236 u32 to_drop = n_bytes_to_drop;
237 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
238 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
240 next = vlib_get_buffer (vm, next->next_buffer);
241 if (next->current_length > to_drop)
243 vlib_buffer_advance (next, to_drop);
248 to_drop -= next->current_length;
249 next->current_length = 0;
255 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
259 * Enqueue buffer chain tail
262 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
263 u32 offset, u8 is_in_order)
265 vlib_buffer_t *chain_b;
266 u32 chain_bi, len, diff;
267 vlib_main_t *vm = vlib_get_main ();
272 if (is_in_order && offset)
274 diff = offset - b->current_length;
275 if (diff > b->total_length_not_including_first_buffer)
278 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
279 chain_bi = vlib_get_buffer_index (vm, chain_b);
282 chain_bi = b->next_buffer;
286 chain_b = vlib_get_buffer (vm, chain_bi);
287 data = vlib_buffer_get_current (chain_b);
288 len = chain_b->current_length;
293 rv = svm_fifo_enqueue_nowait (s->rx_fifo, len, data);
300 return (rv > 0) ? (written + rv) : written;
306 /* written more than what was left in chain */
307 if (written > b->total_length_not_including_first_buffer)
310 /* drop the bytes that have already been delivered */
311 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
316 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
319 clib_warning ("failed to enqueue multi-buffer seg");
325 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
326 ? chain_b->next_buffer : 0));
335 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
336 * event but on request can queue notification events for later delivery by
337 * calling stream_server_flush_enqueue_events().
339 * @param tc Transport connection which is to be enqueued data
340 * @param b Buffer to be enqueued
341 * @param offset Offset at which to start enqueueing if out-of-order
342 * @param queue_event Flag to indicate if peer is to be notified or if event
343 * is to be queued. The former is useful when more data is
344 * enqueued and only one event is to be generated.
345 * @param is_in_order Flag to indicate if data is in order
346 * @return Number of bytes enqueued or a negative value if enqueueing failed.
349 session_enqueue_stream_connection (transport_connection_t * tc,
350 vlib_buffer_t * b, u32 offset,
351 u8 queue_event, u8 is_in_order)
354 int enqueued = 0, rv, in_order_off;
356 s = session_get (tc->s_index, tc->thread_index);
360 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo,
362 vlib_buffer_get_current (b));
363 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
366 in_order_off = enqueued > b->current_length ? enqueued : 0;
367 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
374 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
376 vlib_buffer_get_current (b));
377 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
378 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
379 /* if something was enqueued, report even this as success for ooo
380 * segment handling */
386 /* Queue RX event on this fifo. Eventually these will need to be flushed
387 * by calling stream_server_flush_enqueue_events () */
388 session_manager_worker_t *wrk;
390 wrk = session_manager_get_worker (s->thread_index);
391 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
393 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
394 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
402 session_enqueue_dgram_connection (session_t * s,
403 session_dgram_hdr_t * hdr,
404 vlib_buffer_t * b, u8 proto, u8 queue_event)
406 int enqueued = 0, rv, in_order_off;
408 ASSERT (svm_fifo_max_enqueue (s->rx_fifo)
409 >= b->current_length + sizeof (*hdr));
411 svm_fifo_enqueue_nowait (s->rx_fifo, sizeof (session_dgram_hdr_t),
413 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo, b->current_length,
414 vlib_buffer_get_current (b));
415 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
417 in_order_off = enqueued > b->current_length ? enqueued : 0;
418 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
424 /* Queue RX event on this fifo. Eventually these will need to be flushed
425 * by calling stream_server_flush_enqueue_events () */
426 session_manager_worker_t *wrk;
428 wrk = session_manager_get_worker (s->thread_index);
429 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
431 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
432 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
438 /** Check if we have space in rx fifo to push more bytes */
440 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
443 session_t *s = session_get (tc->s_index, thread_index);
445 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
448 if (data_len > svm_fifo_max_enqueue (s->rx_fifo))
455 session_tx_fifo_max_dequeue (transport_connection_t * tc)
457 session_t *s = session_get (tc->s_index, tc->thread_index);
460 return svm_fifo_max_dequeue (s->tx_fifo);
464 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
465 u32 offset, u32 max_bytes)
467 session_t *s = session_get (tc->s_index, tc->thread_index);
468 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
472 session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
474 session_t *s = session_get (tc->s_index, tc->thread_index);
475 return svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
479 session_notify_subscribers (u32 app_index, session_t * s,
480 svm_fifo_t * f, session_evt_type_t evt_type)
482 app_worker_t *app_wrk;
486 app = application_get (app_index);
490 for (i = 0; i < f->n_subscribers; i++)
492 app_wrk = application_get_worker (app, f->subscribers[i]);
495 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
503 * Notify session peer that new data has been enqueued.
505 * @param s Stream session for which the event is to be generated.
506 * @param lock Flag to indicate if call should lock message queue.
508 * @return 0 on success or negative number if failed to send notification.
511 session_enqueue_notify (session_t * s)
513 app_worker_t *app_wrk;
515 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
516 if (PREDICT_FALSE (!app_wrk))
518 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
523 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
524 ed->data[0] = FIFO_EVENT_APP_RX;
525 ed->data[1] = svm_fifo_max_dequeue (s->rx_fifo);
529 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
533 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
534 return session_notify_subscribers (app_wrk->app_index, s,
535 s->rx_fifo, FIFO_EVENT_APP_RX);
541 session_dequeue_notify (session_t * s)
543 app_worker_t *app_wrk;
545 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
546 if (PREDICT_FALSE (!app_wrk))
549 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
553 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
554 return session_notify_subscribers (app_wrk->app_index, s,
555 s->tx_fifo, FIFO_EVENT_APP_TX);
557 svm_fifo_clear_tx_ntf (s->tx_fifo);
563 * Flushes queue of sessions that are to be notified of new data
566 * @param thread_index Thread index for which the flush is to be performed.
567 * @return 0 on success or a positive number indicating the number of
568 * failures due to API queue being full.
571 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
573 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
578 indices = wrk->session_to_enqueue[transport_proto];
580 for (i = 0; i < vec_len (indices); i++)
582 s = session_get_if_valid (indices[i], thread_index);
583 if (PREDICT_FALSE (!s))
588 if (PREDICT_FALSE (session_enqueue_notify (s)))
592 vec_reset_length (indices);
593 wrk->session_to_enqueue[transport_proto] = indices;
594 wrk->current_enqueue_epoch[transport_proto]++;
600 session_manager_flush_all_enqueue_events (u8 transport_proto)
602 vlib_thread_main_t *vtm = vlib_get_thread_main ();
604 for (i = 0; i < 1 + vtm->n_threads; i++)
605 errors += session_manager_flush_enqueue_events (transport_proto, i);
610 * Init fifo tail and head pointers
612 * Useful if transport uses absolute offsets for tracking ooo segments.
615 stream_session_init_fifos_pointers (transport_connection_t * tc,
616 u32 rx_pointer, u32 tx_pointer)
619 s = session_get (tc->s_index, tc->thread_index);
620 svm_fifo_init_pointers (s->rx_fifo, rx_pointer);
621 svm_fifo_init_pointers (s->tx_fifo, tx_pointer);
625 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
627 u32 opaque = 0, new_ti, new_si;
628 app_worker_t *app_wrk;
633 * Find connection handle and cleanup half-open table
635 ho_handle = session_lookup_half_open_handle (tc);
636 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
638 SESSION_DBG ("half-open was removed!");
641 session_lookup_del_half_open (tc);
643 /* Get the app's index from the handle we stored when opening connection
644 * and the opaque (api_context for external apps) from transport session
646 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
650 opaque = tc->s_index;
653 return app_worker_connect_notify (app_wrk, s, opaque);
655 s = session_alloc_for_connection (tc);
656 s->session_state = SESSION_STATE_CONNECTING;
657 s->app_wrk_index = app_wrk->wrk_index;
658 new_si = s->session_index;
659 new_ti = s->thread_index;
661 if (app_worker_init_connected (app_wrk, s))
664 app_worker_connect_notify (app_wrk, 0, opaque);
668 if (app_worker_connect_notify (app_wrk, s, opaque))
670 s = session_get (new_si, new_ti);
671 session_free_w_fifos (s);
675 s = session_get (new_si, new_ti);
676 s->session_state = SESSION_STATE_READY;
677 session_lookup_add_connection (tc, session_handle (s));
682 typedef struct _session_switch_pool_args
686 u32 new_thread_index;
687 u32 new_session_index;
688 } session_switch_pool_args_t;
691 session_switch_pool (void *cb_args)
693 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
695 ASSERT (args->thread_index == vlib_get_thread_index ());
696 s = session_get (args->session_index, args->thread_index);
697 s->tx_fifo->master_session_index = args->new_session_index;
698 s->tx_fifo->master_thread_index = args->new_thread_index;
699 transport_cleanup (session_get_transport_proto (s), s->connection_index,
702 clib_mem_free (cb_args);
706 * Move dgram session to the right thread
709 session_dgram_connect_notify (transport_connection_t * tc,
710 u32 old_thread_index, session_t ** new_session)
713 session_switch_pool_args_t *rpc_args;
716 * Clone half-open session to the right thread.
718 new_s = session_clone_safe (tc->s_index, old_thread_index);
719 new_s->connection_index = tc->c_index;
720 new_s->rx_fifo->master_session_index = new_s->session_index;
721 new_s->rx_fifo->master_thread_index = new_s->thread_index;
722 new_s->session_state = SESSION_STATE_READY;
723 session_lookup_add_connection (tc, session_handle (new_s));
726 * Ask thread owning the old session to clean it up and make us the tx
729 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
730 rpc_args->new_session_index = new_s->session_index;
731 rpc_args->new_thread_index = new_s->thread_index;
732 rpc_args->session_index = tc->s_index;
733 rpc_args->thread_index = old_thread_index;
734 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
737 tc->s_index = new_s->session_index;
738 new_s->connection_index = tc->c_index;
739 *new_session = new_s;
744 * Notification from transport that connection is being closed.
746 * A disconnect is sent to application but state is not removed. Once
747 * disconnect is acknowledged by application, session disconnect is called.
748 * Ultimately this leads to close being called on transport (passive close).
751 session_transport_closing_notify (transport_connection_t * tc)
753 app_worker_t *app_wrk;
757 s = session_get (tc->s_index, tc->thread_index);
758 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
760 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
761 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
764 app = application_get (app_wrk->app_index);
765 app->cb_fns.session_disconnect_callback (s);
769 * Notification from transport that connection is being deleted
771 * This removes the session if it is still valid. It should be called only on
772 * previously fully established sessions. For instance failed connects should
773 * call stream_session_connect_notify and indicate that the connect has
777 session_transport_delete_notify (transport_connection_t * tc)
781 /* App might've been removed already */
782 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
785 /* Make sure we don't try to send anything more */
786 svm_fifo_dequeue_drop_all (s->tx_fifo);
788 switch (s->session_state)
790 case SESSION_STATE_CREATED:
791 /* Session was created but accept notification was not yet sent to the
792 * app. Cleanup everything. */
793 session_lookup_del_session (s);
794 session_free_w_fifos (s);
796 case SESSION_STATE_ACCEPTING:
797 case SESSION_STATE_TRANSPORT_CLOSING:
798 /* If transport finishes or times out before we get a reply
799 * from the app, mark transport as closed and wait for reply
800 * before removing the session. Cleanup session table in advance
801 * because transport will soon be closed and closed sessions
802 * are assumed to have been removed from the lookup table */
803 session_lookup_del_session (s);
804 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
806 case SESSION_STATE_CLOSING:
807 case SESSION_STATE_CLOSED_WAITING:
808 /* Cleanup lookup table as transport needs to still be valid.
809 * Program transport close to ensure that all session events
810 * have been cleaned up. Once transport close is called, the
811 * session is just removed because both transport and app have
812 * confirmed the close*/
813 session_lookup_del_session (s);
814 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
815 session_program_transport_close (s);
817 case SESSION_STATE_TRANSPORT_CLOSED:
819 case SESSION_STATE_CLOSED:
823 clib_warning ("session state %u", s->session_state);
830 * Notification from transport that session can be closed
832 * Should be called by transport only if it was closed with non-empty
833 * tx fifo and once it decides to begin the closing procedure prior to
834 * issuing a delete notify. This gives the chance to the session layer
835 * to cleanup any outstanding events.
838 session_transport_closed_notify (transport_connection_t * tc)
842 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
845 /* If app close has not been received or has not yet resulted in
846 * a transport close, only mark the session transport as closed */
847 if (s->session_state <= SESSION_STATE_CLOSING)
849 session_lookup_del_session (s);
850 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
853 s->session_state = SESSION_STATE_CLOSED;
857 * Notify application that connection has been reset.
860 session_transport_reset_notify (transport_connection_t * tc)
863 app_worker_t *app_wrk;
865 s = session_get (tc->s_index, tc->thread_index);
866 svm_fifo_dequeue_drop_all (s->tx_fifo);
867 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
869 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
870 app_wrk = app_worker_get (s->app_wrk_index);
871 app = application_get (app_wrk->app_index);
872 app->cb_fns.session_reset_callback (s);
876 session_stream_accept_notify (transport_connection_t * tc)
878 app_worker_t *app_wrk;
881 s = session_get (tc->s_index, tc->thread_index);
882 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
885 s->session_state = SESSION_STATE_ACCEPTING;
886 return app_worker_accept_notify (app_wrk, s);
890 * Accept a stream session. Optionally ping the server by callback.
893 session_stream_accept (transport_connection_t * tc, u32 listener_index,
899 s = session_alloc_for_connection (tc);
900 s->listener_index = listener_index;
901 s->session_state = SESSION_STATE_CREATED;
903 if ((rv = app_worker_init_accepted (s)))
906 session_lookup_add_connection (tc, session_handle (s));
908 /* Shoulder-tap the server */
911 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
912 return app_worker_accept_notify (app_wrk, s);
919 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
921 transport_connection_t *tc;
922 transport_endpoint_cfg_t *tep;
923 app_worker_t *app_wrk;
927 tep = session_endpoint_to_transport_cfg (rmt);
928 rv = transport_connect (rmt->transport_proto, tep);
931 SESSION_DBG ("Transport failed to open connection.");
932 return VNET_API_ERROR_SESSION_CONNECT;
935 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
937 /* For dgram type of service, allocate session and fifos now */
938 app_wrk = app_worker_get (app_wrk_index);
939 s = session_alloc_for_connection (tc);
940 s->app_wrk_index = app_wrk->wrk_index;
941 s->session_state = SESSION_STATE_OPENED;
942 if (app_worker_init_connected (app_wrk, s))
948 return app_worker_connect_notify (app_wrk, s, opaque);
952 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
954 transport_connection_t *tc;
955 transport_endpoint_cfg_t *tep;
959 tep = session_endpoint_to_transport_cfg (rmt);
960 rv = transport_connect (rmt->transport_proto, tep);
963 SESSION_DBG ("Transport failed to open connection.");
964 return VNET_API_ERROR_SESSION_CONNECT;
967 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
969 /* If transport offers a stream service, only allocate session once the
970 * connection has been established.
971 * Add connection to half-open table and save app and tc index. The
972 * latter is needed to help establish the connection while the former
973 * is needed when the connect notify comes and we have to notify the
976 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
977 session_lookup_add_half_open (tc, handle);
979 /* Store api_context (opaque) for when the reply comes. Not the nicest
980 * thing but better than allocating a separate half-open pool.
982 tc->s_index = opaque;
987 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
989 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
990 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
992 sep->app_wrk_index = app_wrk_index;
993 sep->opaque = opaque;
995 return transport_connect (rmt->transport_proto, tep_cfg);
998 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1001 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1009 * Ask transport to open connection to remote transport endpoint.
1011 * Stores handle for matching request with reply since the call can be
1012 * asynchronous. For instance, for TCP the 3-way handshake must complete
1013 * before reply comes. Session is only created once connection is established.
1015 * @param app_index Index of the application requesting the connect
1016 * @param st Session type requested.
1017 * @param tep Remote transport endpoint
1018 * @param opaque Opaque data (typically, api_context) the application expects
1019 * on open completion.
1022 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1024 transport_service_type_t tst;
1025 tst = transport_protocol_service_type (rmt->transport_proto);
1026 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1030 * Ask transport to listen on session endpoint.
1032 * @param s Session for which listen will be called. Note that unlike
1033 * established sessions, listen sessions are not associated to a
1035 * @param sep Local endpoint to be listened on.
1038 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1040 transport_endpoint_t *tep;
1041 u32 tc_index, s_index;
1043 /* Transport bind/listen */
1044 tep = session_endpoint_to_transport (sep);
1045 s_index = ls->session_index;
1046 tc_index = transport_start_listen (session_get_transport_proto (ls),
1049 if (tc_index == (u32) ~ 0)
1052 /* Attach transport to session. Lookup tables are populated by the app
1053 * worker because local tables (for ct sessions) are not backed by a fib */
1054 ls = listen_session_get (s_index);
1055 ls->connection_index = tc_index;
1061 * Ask transport to stop listening on local transport endpoint.
1063 * @param s Session to stop listening on. It must be in state LISTENING.
1066 session_stop_listen (session_t * s)
1068 transport_proto_t tp = session_get_transport_proto (s);
1069 transport_connection_t *tc;
1071 if (s->session_state != SESSION_STATE_LISTENING)
1074 tc = transport_get_listener (tp, s->connection_index);
1076 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1078 session_lookup_del_connection (tc);
1079 transport_stop_listen (tp, s->connection_index);
1084 * Initialize session closing procedure.
1086 * Request is always sent to session node to ensure that all outstanding
1087 * requests are served before transport is notified.
1090 session_close (session_t * s)
1095 if (s->session_state >= SESSION_STATE_CLOSING)
1097 /* Session will only be removed once both app and transport
1098 * acknowledge the close */
1099 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1100 session_program_transport_close (s);
1102 /* Session already closed. Clear the tx fifo */
1103 if (s->session_state == SESSION_STATE_CLOSED)
1104 svm_fifo_dequeue_drop_all (s->tx_fifo);
1108 s->session_state = SESSION_STATE_CLOSING;
1109 session_program_transport_close (s);
1113 * Notify transport the session can be disconnected. This should eventually
1114 * result in a delete notification that allows us to cleanup session state.
1115 * Called for both active/passive disconnects.
1117 * Must be called from the session's thread.
1120 session_transport_close (session_t * s)
1122 /* If transport is already closed, just free the session */
1123 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1125 session_free_w_fifos (s);
1129 /* If tx queue wasn't drained, change state to closed waiting for transport.
1130 * This way, the transport, if it so wishes, can continue to try sending the
1131 * outstanding data (in closed state it cannot). It MUST however at one
1132 * point, either after sending everything or after a timeout, call delete
1133 * notify. This will finally lead to the complete cleanup of the session.
1135 if (svm_fifo_max_dequeue (s->tx_fifo))
1136 s->session_state = SESSION_STATE_CLOSED_WAITING;
1138 s->session_state = SESSION_STATE_CLOSED;
1140 transport_close (session_get_transport_proto (s), s->connection_index,
1145 * Cleanup transport and session state.
1147 * Notify transport of the cleanup and free the session. This should
1148 * be called only if transport reported some error and is already
1152 session_transport_cleanup (session_t * s)
1154 s->session_state = SESSION_STATE_CLOSED;
1156 /* Delete from main lookup table before we axe the the transport */
1157 session_lookup_del_session (s);
1158 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1160 /* Since we called cleanup, no delete notification will come. So, make
1161 * sure the session is properly freed. */
1162 session_free_w_fifos (s);
1166 * Allocate event queues in the shared-memory segment
1168 * That can either be a newly created memfd segment, that will need to be
1169 * mapped by all stack users, or the binary api's svm region. The latter is
1170 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1171 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1172 * vpp uses api svm region for event queues.
1175 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1177 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1178 ssvm_private_t *eqs = &smm->evt_qs_segment;
1179 api_main_t *am = &api_main;
1180 uword eqs_size = 64 << 20;
1181 pid_t vpp_pid = getpid ();
1185 if (smm->configured_event_queue_length)
1186 evt_q_length = smm->configured_event_queue_length;
1188 if (smm->evt_qs_use_memfd_seg)
1190 if (smm->evt_qs_segment_size)
1191 eqs_size = smm->evt_qs_segment_size;
1193 eqs->ssvm_size = eqs_size;
1194 eqs->i_am_master = 1;
1195 eqs->my_pid = vpp_pid;
1196 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1197 eqs->requested_va = smm->session_baseva;
1199 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1201 clib_warning ("failed to initialize queue segment");
1206 if (smm->evt_qs_use_memfd_seg)
1207 oldheap = ssvm_push_heap (eqs->sh);
1209 oldheap = svm_push_data_heap (am->vlib_rp);
1211 for (i = 0; i < vec_len (smm->wrk); i++)
1213 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1214 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1215 {evt_q_length, evt_size, 0}
1217 {evt_q_length >> 1, 256, 0}
1219 cfg->consumer_pid = 0;
1221 cfg->q_nitems = evt_q_length;
1222 cfg->ring_cfgs = rc;
1223 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1224 if (smm->evt_qs_use_memfd_seg)
1226 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1227 clib_warning ("eventfd returned");
1231 if (smm->evt_qs_use_memfd_seg)
1232 ssvm_pop_heap (oldheap);
1234 svm_pop_heap (oldheap);
1238 session_manager_get_evt_q_segment (void)
1240 session_manager_main_t *smm = &session_manager_main;
1241 if (smm->evt_qs_use_memfd_seg)
1242 return &smm->evt_qs_segment;
1247 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1248 session_tx_fifo_peek_and_snd,
1249 session_tx_fifo_dequeue_and_snd,
1250 session_tx_fifo_dequeue_internal,
1251 session_tx_fifo_dequeue_and_snd
1256 * Initialize session layer for given transport proto and ip version
1258 * Allocates per session type (transport proto + ip version) data structures
1259 * and adds arc from session queue node to session type output node.
1262 session_register_transport (transport_proto_t transport_proto,
1263 const transport_proto_vft_t * vft, u8 is_ip4,
1266 session_manager_main_t *smm = &session_manager_main;
1267 session_type_t session_type;
1268 u32 next_index = ~0;
1270 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1272 vec_validate (smm->session_type_to_next, session_type);
1273 vec_validate (smm->session_tx_fns, session_type);
1276 if (output_node != ~0)
1278 foreach_vlib_main (({
1279 next_index = vlib_node_add_next (this_vlib_main,
1280 session_queue_node.index,
1286 smm->session_type_to_next[session_type] = next_index;
1287 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1290 transport_connection_t *
1291 session_get_transport (session_t * s)
1293 if (s->session_state != SESSION_STATE_LISTENING)
1294 return transport_get_connection (session_get_transport_proto (s),
1295 s->connection_index, s->thread_index);
1297 return transport_get_listener (session_get_transport_proto (s),
1298 s->connection_index);
1301 transport_connection_t *
1302 listen_session_get_transport (session_t * s)
1304 return transport_get_listener (session_get_transport_proto (s),
1305 s->connection_index);
1309 listen_session_get_local_session_endpoint (session_t * listener,
1310 session_endpoint_t * sep)
1312 transport_connection_t *tc;
1313 tc = listen_session_get_transport (listener);
1316 clib_warning ("no transport");
1320 /* N.B. The ip should not be copied because this is the local endpoint */
1321 sep->port = tc->lcl_port;
1322 sep->transport_proto = tc->proto;
1323 sep->is_ip4 = tc->is_ip4;
1328 session_flush_frames_main_thread (vlib_main_t * vm)
1330 ASSERT (vlib_get_thread_index () == 0);
1331 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1332 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1335 static clib_error_t *
1336 session_manager_main_enable (vlib_main_t * vm)
1338 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1339 session_manager_main_t *smm = &session_manager_main;
1340 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1341 u32 num_threads, preallocated_sessions_per_worker;
1342 session_manager_worker_t *wrk;
1345 num_threads = 1 /* main thread */ + vtm->n_threads;
1347 if (num_threads < 1)
1348 return clib_error_return (0, "n_thread_stacks not set");
1350 /* Allocate cache line aligned worker contexts */
1351 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1353 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1355 for (j = 0; j < num_threads; j++)
1356 smm->wrk[j].current_enqueue_epoch[i] = 1;
1359 for (i = 0; i < num_threads; i++)
1362 vec_validate (wrk->free_event_vector, 128);
1363 _vec_len (wrk->free_event_vector) = 0;
1364 vec_validate (wrk->pending_event_vector, 128);
1365 _vec_len (wrk->pending_event_vector) = 0;
1366 vec_validate (wrk->pending_disconnects, 128);
1367 _vec_len (wrk->pending_disconnects) = 0;
1368 vec_validate (wrk->postponed_event_vector, 128);
1369 _vec_len (wrk->postponed_event_vector) = 0;
1371 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1372 wrk->dispatch_period = 500e-6;
1374 if (num_threads > 1)
1375 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1379 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1382 /* Allocate vpp event queues segment and queue */
1383 session_vpp_event_queues_allocate (smm);
1385 /* Initialize fifo segment main baseva and timeout */
1386 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1387 sm_args->size = smm->session_va_space_size;
1388 segment_manager_main_init (sm_args);
1390 /* Preallocate sessions */
1391 if (smm->preallocated_sessions)
1393 if (num_threads == 1)
1395 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1400 preallocated_sessions_per_worker =
1401 (1.1 * (f64) smm->preallocated_sessions /
1402 (f64) (num_threads - 1));
1404 for (j = 1; j < num_threads; j++)
1406 pool_init_fixed (smm->wrk[j].sessions,
1407 preallocated_sessions_per_worker);
1412 session_lookup_init ();
1413 app_namespaces_init ();
1416 smm->is_enabled = 1;
1418 /* Enable transports */
1419 transport_enable_disable (vm, 1);
1420 transport_init_tx_pacers_period ();
1425 session_node_enable_disable (u8 is_en)
1427 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1428 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1429 u8 have_workers = vtm->n_threads != 0;
1432 foreach_vlib_main (({
1433 if (have_workers && ii == 0)
1435 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1439 vlib_node_t *n = vlib_get_node (this_vlib_main,
1440 session_queue_process_node.index);
1441 vlib_start_process (this_vlib_main, n->runtime_index);
1445 vlib_process_signal_event_mt (this_vlib_main,
1446 session_queue_process_node.index,
1447 SESSION_Q_PROCESS_STOP, 0);
1452 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1459 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1461 clib_error_t *error = 0;
1464 if (session_manager_main.is_enabled)
1467 session_node_enable_disable (is_en);
1468 error = session_manager_main_enable (vm);
1472 session_manager_main.is_enabled = 0;
1473 session_node_enable_disable (is_en);
1480 session_manager_main_init (vlib_main_t * vm)
1482 session_manager_main_t *smm = &session_manager_main;
1483 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1484 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1485 smm->session_va_space_size = 128ULL << 30;
1486 smm->evt_qs_segment_size = 64 << 20;
1488 smm->session_va_space_size = 128 << 20;
1489 smm->evt_qs_segment_size = 1 << 20;
1491 smm->is_enabled = 0;
1495 VLIB_INIT_FUNCTION (session_manager_main_init);
1497 static clib_error_t *
1498 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1500 session_manager_main_t *smm = &session_manager_main;
1504 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1506 if (unformat (input, "event-queue-length %d", &nitems))
1509 smm->configured_event_queue_length = nitems;
1511 clib_warning ("event queue length %d too small, ignored", nitems);
1513 else if (unformat (input, "preallocated-sessions %d",
1514 &smm->preallocated_sessions))
1516 else if (unformat (input, "v4-session-table-buckets %d",
1517 &smm->configured_v4_session_table_buckets))
1519 else if (unformat (input, "v4-halfopen-table-buckets %d",
1520 &smm->configured_v4_halfopen_table_buckets))
1522 else if (unformat (input, "v6-session-table-buckets %d",
1523 &smm->configured_v6_session_table_buckets))
1525 else if (unformat (input, "v6-halfopen-table-buckets %d",
1526 &smm->configured_v6_halfopen_table_buckets))
1528 else if (unformat (input, "v4-session-table-memory %U",
1529 unformat_memory_size, &tmp))
1531 if (tmp >= 0x100000000)
1532 return clib_error_return (0, "memory size %llx (%lld) too large",
1534 smm->configured_v4_session_table_memory = tmp;
1536 else if (unformat (input, "v4-halfopen-table-memory %U",
1537 unformat_memory_size, &tmp))
1539 if (tmp >= 0x100000000)
1540 return clib_error_return (0, "memory size %llx (%lld) too large",
1542 smm->configured_v4_halfopen_table_memory = tmp;
1544 else if (unformat (input, "v6-session-table-memory %U",
1545 unformat_memory_size, &tmp))
1547 if (tmp >= 0x100000000)
1548 return clib_error_return (0, "memory size %llx (%lld) too large",
1550 smm->configured_v6_session_table_memory = tmp;
1552 else if (unformat (input, "v6-halfopen-table-memory %U",
1553 unformat_memory_size, &tmp))
1555 if (tmp >= 0x100000000)
1556 return clib_error_return (0, "memory size %llx (%lld) too large",
1558 smm->configured_v6_halfopen_table_memory = tmp;
1560 else if (unformat (input, "local-endpoints-table-memory %U",
1561 unformat_memory_size, &tmp))
1563 if (tmp >= 0x100000000)
1564 return clib_error_return (0, "memory size %llx (%lld) too large",
1566 smm->local_endpoints_table_memory = tmp;
1568 else if (unformat (input, "local-endpoints-table-buckets %d",
1569 &smm->local_endpoints_table_buckets))
1571 else if (unformat (input, "evt_qs_memfd_seg"))
1572 smm->evt_qs_use_memfd_seg = 1;
1573 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1574 &smm->evt_qs_segment_size))
1577 return clib_error_return (0, "unknown input `%U'",
1578 format_unformat_error, input);
1583 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1586 * fd.io coding-style-patch-verification: ON
1589 * eval: (c-set-style "gnu")