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 we are in the handler thread, or being called with the worker barrier
127 * held, just append a new event to pending disconnects vector. */
128 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
130 wrk = session_manager_get_worker (s->thread_index);
131 vec_add2 (wrk->pending_disconnects, evt, 1);
132 clib_memset (evt, 0, sizeof (*evt));
133 evt->session_handle = session_handle (s);
134 evt->event_type = FIFO_EVENT_DISCONNECT;
137 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
141 session_alloc (u32 thread_index)
143 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
146 pool_get_aligned_will_expand (wrk->sessions, will_expand,
147 CLIB_CACHE_LINE_BYTES);
148 /* If we have peekers, let them finish */
149 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
151 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
152 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
153 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
157 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
159 clib_memset (s, 0, sizeof (*s));
160 s->session_index = s - wrk->sessions;
161 s->thread_index = thread_index;
166 session_free (session_t * s)
168 pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
170 clib_memset (s, 0xFA, sizeof (*s));
174 session_free_w_fifos (session_t * s)
176 segment_manager_dealloc_fifos (s->svm_segment_index, s->rx_fifo,
182 * Cleans up session and lookup table.
184 * Transport connection must still be valid.
187 session_delete (session_t * s)
191 /* Delete from the main lookup table. */
192 if ((rv = session_lookup_del_session (s)))
193 clib_warning ("hash delete error, rv %d", rv);
195 session_free_w_fifos (s);
199 session_alloc_for_connection (transport_connection_t * tc)
202 u32 thread_index = tc->thread_index;
204 ASSERT (thread_index == vlib_get_thread_index ()
205 || transport_protocol_is_cl (tc->proto));
207 s = session_alloc (thread_index);
208 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
209 s->enqueue_epoch = (u64) ~ 0;
210 s->session_state = SESSION_STATE_CLOSED;
212 /* Attach transport to session and vice versa */
213 s->connection_index = tc->c_index;
214 tc->s_index = s->session_index;
219 * Discards bytes from buffer chain
221 * It discards n_bytes_to_drop starting at first buffer after chain_b
224 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
225 vlib_buffer_t ** chain_b,
228 vlib_buffer_t *next = *chain_b;
229 u32 to_drop = n_bytes_to_drop;
230 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
231 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
233 next = vlib_get_buffer (vm, next->next_buffer);
234 if (next->current_length > to_drop)
236 vlib_buffer_advance (next, to_drop);
241 to_drop -= next->current_length;
242 next->current_length = 0;
248 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
252 * Enqueue buffer chain tail
255 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
256 u32 offset, u8 is_in_order)
258 vlib_buffer_t *chain_b;
259 u32 chain_bi, len, diff;
260 vlib_main_t *vm = vlib_get_main ();
265 if (is_in_order && offset)
267 diff = offset - b->current_length;
268 if (diff > b->total_length_not_including_first_buffer)
271 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
272 chain_bi = vlib_get_buffer_index (vm, chain_b);
275 chain_bi = b->next_buffer;
279 chain_b = vlib_get_buffer (vm, chain_bi);
280 data = vlib_buffer_get_current (chain_b);
281 len = chain_b->current_length;
286 rv = svm_fifo_enqueue_nowait (s->rx_fifo, len, data);
293 return (rv > 0) ? (written + rv) : written;
299 /* written more than what was left in chain */
300 if (written > b->total_length_not_including_first_buffer)
303 /* drop the bytes that have already been delivered */
304 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
309 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
312 clib_warning ("failed to enqueue multi-buffer seg");
318 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
319 ? chain_b->next_buffer : 0));
328 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
329 * event but on request can queue notification events for later delivery by
330 * calling stream_server_flush_enqueue_events().
332 * @param tc Transport connection which is to be enqueued data
333 * @param b Buffer to be enqueued
334 * @param offset Offset at which to start enqueueing if out-of-order
335 * @param queue_event Flag to indicate if peer is to be notified or if event
336 * is to be queued. The former is useful when more data is
337 * enqueued and only one event is to be generated.
338 * @param is_in_order Flag to indicate if data is in order
339 * @return Number of bytes enqueued or a negative value if enqueueing failed.
342 session_enqueue_stream_connection (transport_connection_t * tc,
343 vlib_buffer_t * b, u32 offset,
344 u8 queue_event, u8 is_in_order)
347 int enqueued = 0, rv, in_order_off;
349 s = session_get (tc->s_index, tc->thread_index);
353 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo,
355 vlib_buffer_get_current (b));
356 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
359 in_order_off = enqueued > b->current_length ? enqueued : 0;
360 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
367 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
369 vlib_buffer_get_current (b));
370 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
371 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
372 /* if something was enqueued, report even this as success for ooo
373 * segment handling */
379 /* Queue RX event on this fifo. Eventually these will need to be flushed
380 * by calling stream_server_flush_enqueue_events () */
381 session_manager_worker_t *wrk;
383 wrk = session_manager_get_worker (s->thread_index);
384 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
386 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
387 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
395 session_enqueue_dgram_connection (session_t * s,
396 session_dgram_hdr_t * hdr,
397 vlib_buffer_t * b, u8 proto, u8 queue_event)
399 int enqueued = 0, rv, in_order_off;
401 ASSERT (svm_fifo_max_enqueue (s->rx_fifo)
402 >= b->current_length + sizeof (*hdr));
404 svm_fifo_enqueue_nowait (s->rx_fifo, sizeof (session_dgram_hdr_t),
406 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo, b->current_length,
407 vlib_buffer_get_current (b));
408 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
410 in_order_off = enqueued > b->current_length ? enqueued : 0;
411 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
417 /* Queue RX event on this fifo. Eventually these will need to be flushed
418 * by calling stream_server_flush_enqueue_events () */
419 session_manager_worker_t *wrk;
421 wrk = session_manager_get_worker (s->thread_index);
422 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
424 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
425 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
431 /** Check if we have space in rx fifo to push more bytes */
433 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
436 session_t *s = session_get (tc->s_index, thread_index);
438 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
441 if (data_len > svm_fifo_max_enqueue (s->rx_fifo))
448 session_tx_fifo_max_dequeue (transport_connection_t * tc)
450 session_t *s = session_get (tc->s_index, tc->thread_index);
453 return svm_fifo_max_dequeue (s->tx_fifo);
457 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
458 u32 offset, u32 max_bytes)
460 session_t *s = session_get (tc->s_index, tc->thread_index);
461 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
465 session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
467 session_t *s = session_get (tc->s_index, tc->thread_index);
468 return svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
472 session_notify_subscribers (u32 app_index, session_t * s,
473 svm_fifo_t * f, session_evt_type_t evt_type)
475 app_worker_t *app_wrk;
479 app = application_get (app_index);
483 for (i = 0; i < f->n_subscribers; i++)
485 app_wrk = application_get_worker (app, f->subscribers[i]);
488 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
496 * Notify session peer that new data has been enqueued.
498 * @param s Stream session for which the event is to be generated.
499 * @param lock Flag to indicate if call should lock message queue.
501 * @return 0 on success or negative number if failed to send notification.
504 session_enqueue_notify (session_t * s)
506 app_worker_t *app_wrk;
508 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
509 if (PREDICT_FALSE (!app_wrk))
511 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
516 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
517 ed->data[0] = FIFO_EVENT_APP_RX;
518 ed->data[1] = svm_fifo_max_dequeue (s->rx_fifo);
522 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
526 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
527 return session_notify_subscribers (app_wrk->app_index, s,
528 s->rx_fifo, FIFO_EVENT_APP_RX);
534 session_dequeue_notify (session_t * s)
536 app_worker_t *app_wrk;
538 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
539 if (PREDICT_FALSE (!app_wrk))
542 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
546 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
547 return session_notify_subscribers (app_wrk->app_index, s,
548 s->tx_fifo, FIFO_EVENT_APP_TX);
550 svm_fifo_clear_tx_ntf (s->tx_fifo);
556 * Flushes queue of sessions that are to be notified of new data
559 * @param thread_index Thread index for which the flush is to be performed.
560 * @return 0 on success or a positive number indicating the number of
561 * failures due to API queue being full.
564 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
566 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
571 indices = wrk->session_to_enqueue[transport_proto];
573 for (i = 0; i < vec_len (indices); i++)
575 s = session_get_if_valid (indices[i], thread_index);
576 if (PREDICT_FALSE (!s))
581 if (PREDICT_FALSE (session_enqueue_notify (s)))
585 vec_reset_length (indices);
586 wrk->session_to_enqueue[transport_proto] = indices;
587 wrk->current_enqueue_epoch[transport_proto]++;
593 session_manager_flush_all_enqueue_events (u8 transport_proto)
595 vlib_thread_main_t *vtm = vlib_get_thread_main ();
597 for (i = 0; i < 1 + vtm->n_threads; i++)
598 errors += session_manager_flush_enqueue_events (transport_proto, i);
603 * Init fifo tail and head pointers
605 * Useful if transport uses absolute offsets for tracking ooo segments.
608 stream_session_init_fifos_pointers (transport_connection_t * tc,
609 u32 rx_pointer, u32 tx_pointer)
612 s = session_get (tc->s_index, tc->thread_index);
613 svm_fifo_init_pointers (s->rx_fifo, rx_pointer);
614 svm_fifo_init_pointers (s->tx_fifo, tx_pointer);
618 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
620 u32 opaque = 0, new_ti, new_si;
621 app_worker_t *app_wrk;
626 * Find connection handle and cleanup half-open table
628 ho_handle = session_lookup_half_open_handle (tc);
629 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
631 SESSION_DBG ("half-open was removed!");
634 session_lookup_del_half_open (tc);
636 /* Get the app's index from the handle we stored when opening connection
637 * and the opaque (api_context for external apps) from transport session
639 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
643 opaque = tc->s_index;
646 return app_worker_connect_notify (app_wrk, s, opaque);
648 s = session_alloc_for_connection (tc);
649 s->session_state = SESSION_STATE_CONNECTING;
650 s->app_wrk_index = app_wrk->wrk_index;
651 new_si = s->session_index;
652 new_ti = s->thread_index;
654 if (app_worker_init_connected (app_wrk, s))
657 app_worker_connect_notify (app_wrk, 0, opaque);
661 if (app_worker_connect_notify (app_wrk, s, opaque))
663 s = session_get (new_si, new_ti);
664 session_free_w_fifos (s);
668 s = session_get (new_si, new_ti);
669 s->session_state = SESSION_STATE_READY;
670 session_lookup_add_connection (tc, session_handle (s));
675 typedef struct _session_switch_pool_args
679 u32 new_thread_index;
680 u32 new_session_index;
681 } session_switch_pool_args_t;
684 session_switch_pool (void *cb_args)
686 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
688 ASSERT (args->thread_index == vlib_get_thread_index ());
689 s = session_get (args->session_index, args->thread_index);
690 s->tx_fifo->master_session_index = args->new_session_index;
691 s->tx_fifo->master_thread_index = args->new_thread_index;
692 transport_cleanup (session_get_transport_proto (s), s->connection_index,
695 clib_mem_free (cb_args);
699 * Move dgram session to the right thread
702 session_dgram_connect_notify (transport_connection_t * tc,
703 u32 old_thread_index, session_t ** new_session)
706 session_switch_pool_args_t *rpc_args;
709 * Clone half-open session to the right thread.
711 new_s = session_clone_safe (tc->s_index, old_thread_index);
712 new_s->connection_index = tc->c_index;
713 new_s->rx_fifo->master_session_index = new_s->session_index;
714 new_s->rx_fifo->master_thread_index = new_s->thread_index;
715 new_s->session_state = SESSION_STATE_READY;
716 session_lookup_add_connection (tc, session_handle (new_s));
719 * Ask thread owning the old session to clean it up and make us the tx
722 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
723 rpc_args->new_session_index = new_s->session_index;
724 rpc_args->new_thread_index = new_s->thread_index;
725 rpc_args->session_index = tc->s_index;
726 rpc_args->thread_index = old_thread_index;
727 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
730 tc->s_index = new_s->session_index;
731 new_s->connection_index = tc->c_index;
732 *new_session = new_s;
737 * Notification from transport that connection is being closed.
739 * A disconnect is sent to application but state is not removed. Once
740 * disconnect is acknowledged by application, session disconnect is called.
741 * Ultimately this leads to close being called on transport (passive close).
744 session_transport_closing_notify (transport_connection_t * tc)
746 app_worker_t *app_wrk;
750 s = session_get (tc->s_index, tc->thread_index);
751 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
753 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
754 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
757 app = application_get (app_wrk->app_index);
758 app->cb_fns.session_disconnect_callback (s);
762 * Notification from transport that connection is being deleted
764 * This removes the session if it is still valid. It should be called only on
765 * previously fully established sessions. For instance failed connects should
766 * call stream_session_connect_notify and indicate that the connect has
770 session_transport_delete_notify (transport_connection_t * tc)
774 /* App might've been removed already */
775 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
778 /* Make sure we don't try to send anything more */
779 svm_fifo_dequeue_drop_all (s->tx_fifo);
781 switch (s->session_state)
783 case SESSION_STATE_CREATED:
784 /* Session was created but accept notification was not yet sent to the
785 * app. Cleanup everything. */
786 session_lookup_del_session (s);
787 session_free_w_fifos (s);
789 case SESSION_STATE_ACCEPTING:
790 case SESSION_STATE_TRANSPORT_CLOSING:
791 /* If transport finishes or times out before we get a reply
792 * from the app, mark transport as closed and wait for reply
793 * before removing the session. Cleanup session table in advance
794 * because transport will soon be closed and closed sessions
795 * are assumed to have been removed from the lookup table */
796 session_lookup_del_session (s);
797 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
799 case SESSION_STATE_CLOSING:
800 case SESSION_STATE_CLOSED_WAITING:
801 /* Cleanup lookup table as transport needs to still be valid.
802 * Program transport close to ensure that all session events
803 * have been cleaned up. Once transport close is called, the
804 * session is just removed because both transport and app have
805 * confirmed the close*/
806 session_lookup_del_session (s);
807 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
808 session_program_transport_close (s);
810 case SESSION_STATE_TRANSPORT_CLOSED:
812 case SESSION_STATE_CLOSED:
816 clib_warning ("session state %u", s->session_state);
823 * Notification from transport that session can be closed
825 * Should be called by transport only if it was closed with non-empty
826 * tx fifo and once it decides to begin the closing procedure prior to
827 * issuing a delete notify. This gives the chance to the session layer
828 * to cleanup any outstanding events.
831 session_transport_closed_notify (transport_connection_t * tc)
835 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
838 /* If app close has not been received or has not yet resulted in
839 * a transport close, only mark the session transport as closed */
840 if (s->session_state <= SESSION_STATE_CLOSING)
842 session_lookup_del_session (s);
843 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
846 s->session_state = SESSION_STATE_CLOSED;
850 * Notify application that connection has been reset.
853 session_transport_reset_notify (transport_connection_t * tc)
856 app_worker_t *app_wrk;
858 s = session_get (tc->s_index, tc->thread_index);
859 svm_fifo_dequeue_drop_all (s->tx_fifo);
860 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
862 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
863 app_wrk = app_worker_get (s->app_wrk_index);
864 app = application_get (app_wrk->app_index);
865 app->cb_fns.session_reset_callback (s);
869 session_stream_accept_notify (transport_connection_t * tc)
871 app_worker_t *app_wrk;
874 s = session_get (tc->s_index, tc->thread_index);
875 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
878 s->session_state = SESSION_STATE_ACCEPTING;
879 return app_worker_accept_notify (app_wrk, s);
883 * Accept a stream session. Optionally ping the server by callback.
886 session_stream_accept (transport_connection_t * tc, u32 listener_index,
892 s = session_alloc_for_connection (tc);
893 s->listener_index = listener_index;
894 s->session_state = SESSION_STATE_CREATED;
896 if ((rv = app_worker_init_accepted (s)))
899 session_lookup_add_connection (tc, session_handle (s));
901 /* Shoulder-tap the server */
904 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
905 return app_worker_accept_notify (app_wrk, s);
912 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
914 transport_connection_t *tc;
915 transport_endpoint_cfg_t *tep;
916 app_worker_t *app_wrk;
920 tep = session_endpoint_to_transport_cfg (rmt);
921 rv = transport_connect (rmt->transport_proto, tep);
924 SESSION_DBG ("Transport failed to open connection.");
925 return VNET_API_ERROR_SESSION_CONNECT;
928 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
930 /* For dgram type of service, allocate session and fifos now */
931 app_wrk = app_worker_get (app_wrk_index);
932 s = session_alloc_for_connection (tc);
933 s->app_wrk_index = app_wrk->wrk_index;
934 s->session_state = SESSION_STATE_OPENED;
935 if (app_worker_init_connected (app_wrk, s))
941 return app_worker_connect_notify (app_wrk, s, opaque);
945 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
947 transport_connection_t *tc;
948 transport_endpoint_cfg_t *tep;
952 tep = session_endpoint_to_transport_cfg (rmt);
953 rv = transport_connect (rmt->transport_proto, tep);
956 SESSION_DBG ("Transport failed to open connection.");
957 return VNET_API_ERROR_SESSION_CONNECT;
960 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
962 /* If transport offers a stream service, only allocate session once the
963 * connection has been established.
964 * Add connection to half-open table and save app and tc index. The
965 * latter is needed to help establish the connection while the former
966 * is needed when the connect notify comes and we have to notify the
969 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
970 session_lookup_add_half_open (tc, handle);
972 /* Store api_context (opaque) for when the reply comes. Not the nicest
973 * thing but better than allocating a separate half-open pool.
975 tc->s_index = opaque;
980 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
982 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
983 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
985 sep->app_wrk_index = app_wrk_index;
986 sep->opaque = opaque;
988 return transport_connect (rmt->transport_proto, tep_cfg);
991 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
994 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1002 * Ask transport to open connection to remote transport endpoint.
1004 * Stores handle for matching request with reply since the call can be
1005 * asynchronous. For instance, for TCP the 3-way handshake must complete
1006 * before reply comes. Session is only created once connection is established.
1008 * @param app_index Index of the application requesting the connect
1009 * @param st Session type requested.
1010 * @param tep Remote transport endpoint
1011 * @param opaque Opaque data (typically, api_context) the application expects
1012 * on open completion.
1015 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1017 transport_service_type_t tst;
1018 tst = transport_protocol_service_type (rmt->transport_proto);
1019 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1023 * Ask transport to listen on session endpoint.
1025 * @param s Session for which listen will be called. Note that unlike
1026 * established sessions, listen sessions are not associated to a
1028 * @param sep Local endpoint to be listened on.
1031 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1033 transport_connection_t *tc;
1034 transport_endpoint_t *tep;
1035 u32 tc_index, s_index;
1037 /* Transport bind/listen */
1038 tep = session_endpoint_to_transport (sep);
1039 s_index = ls->session_index;
1040 tc_index = transport_start_listen (sep->transport_proto, s_index, tep);
1042 if (tc_index == (u32) ~ 0)
1045 /* Attach transport to session */
1046 ls = listen_session_get (s_index);
1047 ls->connection_index = tc_index;
1049 /* Add to the main lookup table after transport was initialized */
1050 tc = transport_get_listener (sep->transport_proto, tc_index);
1051 session_lookup_add_connection (tc, listen_session_get_handle (ls));
1056 * Ask transport to stop listening on local transport endpoint.
1058 * @param s Session to stop listening on. It must be in state LISTENING.
1061 session_stop_listen (session_t * s)
1063 transport_proto_t tp = session_get_transport_proto (s);
1064 transport_connection_t *tc;
1066 if (s->session_state != SESSION_STATE_LISTENING)
1069 tc = transport_get_listener (tp, s->connection_index);
1071 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1073 session_lookup_del_connection (tc);
1074 transport_stop_listen (tp, s->connection_index);
1079 * Initialize session closing procedure.
1081 * Request is always sent to session node to ensure that all outstanding
1082 * requests are served before transport is notified.
1085 session_close (session_t * s)
1090 if (s->session_state >= SESSION_STATE_CLOSING)
1092 /* Session will only be removed once both app and transport
1093 * acknowledge the close */
1094 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1095 session_program_transport_close (s);
1097 /* Session already closed. Clear the tx fifo */
1098 if (s->session_state == SESSION_STATE_CLOSED)
1099 svm_fifo_dequeue_drop_all (s->tx_fifo);
1103 s->session_state = SESSION_STATE_CLOSING;
1104 session_program_transport_close (s);
1108 * Notify transport the session can be disconnected. This should eventually
1109 * result in a delete notification that allows us to cleanup session state.
1110 * Called for both active/passive disconnects.
1112 * Must be called from the session's thread.
1115 session_transport_close (session_t * s)
1117 /* If transport is already closed, just free the session */
1118 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1120 session_free_w_fifos (s);
1124 /* If tx queue wasn't drained, change state to closed waiting for transport.
1125 * This way, the transport, if it so wishes, can continue to try sending the
1126 * outstanding data (in closed state it cannot). It MUST however at one
1127 * point, either after sending everything or after a timeout, call delete
1128 * notify. This will finally lead to the complete cleanup of the session.
1130 if (svm_fifo_max_dequeue (s->tx_fifo))
1131 s->session_state = SESSION_STATE_CLOSED_WAITING;
1133 s->session_state = SESSION_STATE_CLOSED;
1135 transport_close (session_get_transport_proto (s), s->connection_index,
1140 * Cleanup transport and session state.
1142 * Notify transport of the cleanup and free the session. This should
1143 * be called only if transport reported some error and is already
1147 session_transport_cleanup (session_t * s)
1149 s->session_state = SESSION_STATE_CLOSED;
1151 /* Delete from main lookup table before we axe the the transport */
1152 session_lookup_del_session (s);
1153 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1155 /* Since we called cleanup, no delete notification will come. So, make
1156 * sure the session is properly freed. */
1157 session_free_w_fifos (s);
1161 * Allocate event queues in the shared-memory segment
1163 * That can either be a newly created memfd segment, that will need to be
1164 * mapped by all stack users, or the binary api's svm region. The latter is
1165 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1166 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1167 * vpp uses api svm region for event queues.
1170 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1172 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1173 ssvm_private_t *eqs = &smm->evt_qs_segment;
1174 api_main_t *am = &api_main;
1175 uword eqs_size = 64 << 20;
1176 pid_t vpp_pid = getpid ();
1180 if (smm->configured_event_queue_length)
1181 evt_q_length = smm->configured_event_queue_length;
1183 if (smm->evt_qs_use_memfd_seg)
1185 if (smm->evt_qs_segment_size)
1186 eqs_size = smm->evt_qs_segment_size;
1188 eqs->ssvm_size = eqs_size;
1189 eqs->i_am_master = 1;
1190 eqs->my_pid = vpp_pid;
1191 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1192 eqs->requested_va = smm->session_baseva;
1194 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1196 clib_warning ("failed to initialize queue segment");
1201 if (smm->evt_qs_use_memfd_seg)
1202 oldheap = ssvm_push_heap (eqs->sh);
1204 oldheap = svm_push_data_heap (am->vlib_rp);
1206 for (i = 0; i < vec_len (smm->wrk); i++)
1208 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1209 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1210 {evt_q_length, evt_size, 0}
1212 {evt_q_length >> 1, 256, 0}
1214 cfg->consumer_pid = 0;
1216 cfg->q_nitems = evt_q_length;
1217 cfg->ring_cfgs = rc;
1218 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1219 if (smm->evt_qs_use_memfd_seg)
1221 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1222 clib_warning ("eventfd returned");
1226 if (smm->evt_qs_use_memfd_seg)
1227 ssvm_pop_heap (oldheap);
1229 svm_pop_heap (oldheap);
1233 session_manager_get_evt_q_segment (void)
1235 session_manager_main_t *smm = &session_manager_main;
1236 if (smm->evt_qs_use_memfd_seg)
1237 return &smm->evt_qs_segment;
1242 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1243 session_tx_fifo_peek_and_snd,
1244 session_tx_fifo_dequeue_and_snd,
1245 session_tx_fifo_dequeue_internal,
1246 session_tx_fifo_dequeue_and_snd
1251 * Initialize session layer for given transport proto and ip version
1253 * Allocates per session type (transport proto + ip version) data structures
1254 * and adds arc from session queue node to session type output node.
1257 session_register_transport (transport_proto_t transport_proto,
1258 const transport_proto_vft_t * vft, u8 is_ip4,
1261 session_manager_main_t *smm = &session_manager_main;
1262 session_type_t session_type;
1263 u32 next_index = ~0;
1265 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1267 vec_validate (smm->session_type_to_next, session_type);
1268 vec_validate (smm->session_tx_fns, session_type);
1271 if (output_node != ~0)
1273 foreach_vlib_main (({
1274 next_index = vlib_node_add_next (this_vlib_main,
1275 session_queue_node.index,
1281 smm->session_type_to_next[session_type] = next_index;
1282 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1285 transport_connection_t *
1286 session_get_transport (session_t * s)
1288 if (s->session_state != SESSION_STATE_LISTENING)
1289 return transport_get_connection (session_get_transport_proto (s),
1290 s->connection_index, s->thread_index);
1292 return transport_get_listener (session_get_transport_proto (s),
1293 s->connection_index);
1296 transport_connection_t *
1297 listen_session_get_transport (session_t * s)
1299 return transport_get_listener (session_get_transport_proto (s),
1300 s->connection_index);
1304 listen_session_get_local_session_endpoint (session_t * listener,
1305 session_endpoint_t * sep)
1307 transport_connection_t *tc;
1308 tc = listen_session_get_transport (listener);
1311 clib_warning ("no transport");
1315 /* N.B. The ip should not be copied because this is the local endpoint */
1316 sep->port = tc->lcl_port;
1317 sep->transport_proto = tc->proto;
1318 sep->is_ip4 = tc->is_ip4;
1323 session_flush_frames_main_thread (vlib_main_t * vm)
1325 ASSERT (vlib_get_thread_index () == 0);
1326 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1327 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1330 static clib_error_t *
1331 session_manager_main_enable (vlib_main_t * vm)
1333 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1334 session_manager_main_t *smm = &session_manager_main;
1335 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1336 u32 num_threads, preallocated_sessions_per_worker;
1337 session_manager_worker_t *wrk;
1340 num_threads = 1 /* main thread */ + vtm->n_threads;
1342 if (num_threads < 1)
1343 return clib_error_return (0, "n_thread_stacks not set");
1345 /* Allocate cache line aligned worker contexts */
1346 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1348 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1350 for (j = 0; j < num_threads; j++)
1351 smm->wrk[j].current_enqueue_epoch[i] = 1;
1354 for (i = 0; i < num_threads; i++)
1357 vec_validate (wrk->free_event_vector, 128);
1358 _vec_len (wrk->free_event_vector) = 0;
1359 vec_validate (wrk->pending_event_vector, 128);
1360 _vec_len (wrk->pending_event_vector) = 0;
1361 vec_validate (wrk->pending_disconnects, 128);
1362 _vec_len (wrk->pending_disconnects) = 0;
1363 vec_validate (wrk->postponed_event_vector, 128);
1364 _vec_len (wrk->postponed_event_vector) = 0;
1366 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1367 wrk->dispatch_period = 500e-6;
1369 if (num_threads > 1)
1370 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1374 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1377 /* Allocate vpp event queues segment and queue */
1378 session_vpp_event_queues_allocate (smm);
1380 /* Initialize fifo segment main baseva and timeout */
1381 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1382 sm_args->size = smm->session_va_space_size;
1383 segment_manager_main_init (sm_args);
1385 /* Preallocate sessions */
1386 if (smm->preallocated_sessions)
1388 if (num_threads == 1)
1390 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1395 preallocated_sessions_per_worker =
1396 (1.1 * (f64) smm->preallocated_sessions /
1397 (f64) (num_threads - 1));
1399 for (j = 1; j < num_threads; j++)
1401 pool_init_fixed (smm->wrk[j].sessions,
1402 preallocated_sessions_per_worker);
1407 session_lookup_init ();
1408 app_namespaces_init ();
1411 smm->is_enabled = 1;
1413 /* Enable transports */
1414 transport_enable_disable (vm, 1);
1415 transport_init_tx_pacers_period ();
1420 session_node_enable_disable (u8 is_en)
1422 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1423 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1424 u8 have_workers = vtm->n_threads != 0;
1427 foreach_vlib_main (({
1428 if (have_workers && ii == 0)
1430 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1434 vlib_node_t *n = vlib_get_node (this_vlib_main,
1435 session_queue_process_node.index);
1436 vlib_start_process (this_vlib_main, n->runtime_index);
1440 vlib_process_signal_event_mt (this_vlib_main,
1441 session_queue_process_node.index,
1442 SESSION_Q_PROCESS_STOP, 0);
1447 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1454 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1456 clib_error_t *error = 0;
1459 if (session_manager_main.is_enabled)
1462 session_node_enable_disable (is_en);
1463 error = session_manager_main_enable (vm);
1467 session_manager_main.is_enabled = 0;
1468 session_node_enable_disable (is_en);
1475 session_manager_main_init (vlib_main_t * vm)
1477 session_manager_main_t *smm = &session_manager_main;
1478 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1479 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1480 smm->session_va_space_size = 128ULL << 30;
1481 smm->evt_qs_segment_size = 64 << 20;
1483 smm->session_va_space_size = 128 << 20;
1484 smm->evt_qs_segment_size = 1 << 20;
1486 smm->is_enabled = 0;
1490 VLIB_INIT_FUNCTION (session_manager_main_init);
1492 static clib_error_t *
1493 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1495 session_manager_main_t *smm = &session_manager_main;
1499 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1501 if (unformat (input, "event-queue-length %d", &nitems))
1504 smm->configured_event_queue_length = nitems;
1506 clib_warning ("event queue length %d too small, ignored", nitems);
1508 else if (unformat (input, "preallocated-sessions %d",
1509 &smm->preallocated_sessions))
1511 else if (unformat (input, "v4-session-table-buckets %d",
1512 &smm->configured_v4_session_table_buckets))
1514 else if (unformat (input, "v4-halfopen-table-buckets %d",
1515 &smm->configured_v4_halfopen_table_buckets))
1517 else if (unformat (input, "v6-session-table-buckets %d",
1518 &smm->configured_v6_session_table_buckets))
1520 else if (unformat (input, "v6-halfopen-table-buckets %d",
1521 &smm->configured_v6_halfopen_table_buckets))
1523 else if (unformat (input, "v4-session-table-memory %U",
1524 unformat_memory_size, &tmp))
1526 if (tmp >= 0x100000000)
1527 return clib_error_return (0, "memory size %llx (%lld) too large",
1529 smm->configured_v4_session_table_memory = tmp;
1531 else if (unformat (input, "v4-halfopen-table-memory %U",
1532 unformat_memory_size, &tmp))
1534 if (tmp >= 0x100000000)
1535 return clib_error_return (0, "memory size %llx (%lld) too large",
1537 smm->configured_v4_halfopen_table_memory = tmp;
1539 else if (unformat (input, "v6-session-table-memory %U",
1540 unformat_memory_size, &tmp))
1542 if (tmp >= 0x100000000)
1543 return clib_error_return (0, "memory size %llx (%lld) too large",
1545 smm->configured_v6_session_table_memory = tmp;
1547 else if (unformat (input, "v6-halfopen-table-memory %U",
1548 unformat_memory_size, &tmp))
1550 if (tmp >= 0x100000000)
1551 return clib_error_return (0, "memory size %llx (%lld) too large",
1553 smm->configured_v6_halfopen_table_memory = tmp;
1555 else if (unformat (input, "local-endpoints-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->local_endpoints_table_memory = tmp;
1563 else if (unformat (input, "local-endpoints-table-buckets %d",
1564 &smm->local_endpoints_table_buckets))
1566 else if (unformat (input, "evt_qs_memfd_seg"))
1567 smm->evt_qs_use_memfd_seg = 1;
1568 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1569 &smm->evt_qs_segment_size))
1572 return clib_error_return (0, "unknown input `%U'",
1573 format_unformat_error, input);
1578 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1581 * fd.io coding-style-patch-verification: ON
1584 * eval: (c-set-style "gnu")