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_main_t session_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_main_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;
62 case SESSION_CTRL_EVT_RPC:
63 evt->rpc_args.fp = data;
64 evt->rpc_args.arg = args;
66 case SESSION_IO_EVT_TX:
67 case SESSION_IO_EVT_TX_FLUSH:
68 case SESSION_IO_EVT_BUILTIN_RX:
71 case SESSION_IO_EVT_BUILTIN_TX:
72 case SESSION_CTRL_EVT_CLOSE:
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 == SESSION_CTRL_EVT_CLOSE);
103 return session_send_evt_to_thread (s, 0, s->thread_index,
104 SESSION_CTRL_EVT_CLOSE);
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,
112 SESSION_CTRL_EVT_RPC);
115 void (*fnp) (void *) = fp;
121 session_program_transport_close (session_t * s)
123 u32 thread_index = vlib_get_thread_index ();
124 session_worker_t *wrk;
125 session_event_t *evt;
127 /* If we are in the handler thread, or being called with the worker barrier
128 * held, just append a new event to pending disconnects vector. */
129 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
131 wrk = session_main_get_worker (s->thread_index);
132 vec_add2 (wrk->pending_disconnects, evt, 1);
133 clib_memset (evt, 0, sizeof (*evt));
134 evt->session_handle = session_handle (s);
135 evt->event_type = SESSION_CTRL_EVT_CLOSE;
138 session_send_ctrl_evt_to_thread (s, SESSION_CTRL_EVT_CLOSE);
142 session_alloc (u32 thread_index)
144 session_worker_t *wrk = &session_main.wrk[thread_index];
147 pool_get_aligned_will_expand (wrk->sessions, will_expand,
148 CLIB_CACHE_LINE_BYTES);
149 /* If we have peekers, let them finish */
150 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
152 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
153 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
154 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
158 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
160 clib_memset (s, 0, sizeof (*s));
161 s->session_index = s - wrk->sessions;
162 s->thread_index = thread_index;
167 session_free (session_t * s)
169 pool_put (session_main.wrk[s->thread_index].sessions, s);
171 clib_memset (s, 0xFA, sizeof (*s));
175 session_free_w_fifos (session_t * s)
177 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_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_worker_t *wrk;
383 wrk = session_main_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_worker_t *wrk;
421 wrk = session_main_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);
432 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
433 u32 offset, u32 max_bytes)
435 session_t *s = session_get (tc->s_index, tc->thread_index);
436 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
440 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
442 session_t *s = session_get (tc->s_index, tc->thread_index);
443 return svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
447 session_notify_subscribers (u32 app_index, session_t * s,
448 svm_fifo_t * f, session_evt_type_t evt_type)
450 app_worker_t *app_wrk;
454 app = application_get (app_index);
458 for (i = 0; i < f->n_subscribers; i++)
460 app_wrk = application_get_worker (app, f->subscribers[i]);
463 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
471 * Notify session peer that new data has been enqueued.
473 * @param s Stream session for which the event is to be generated.
474 * @param lock Flag to indicate if call should lock message queue.
476 * @return 0 on success or negative number if failed to send notification.
479 session_enqueue_notify_inline (session_t * s)
481 app_worker_t *app_wrk;
483 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
484 if (PREDICT_FALSE (!app_wrk))
486 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
491 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
492 ed->data[0] = SESSION_IO_EVT_RX;
493 ed->data[1] = svm_fifo_max_dequeue (s->rx_fifo);
497 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
501 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
502 return session_notify_subscribers (app_wrk->app_index, s,
503 s->rx_fifo, SESSION_IO_EVT_RX);
509 session_enqueue_notify (session_t * s)
511 return session_enqueue_notify_inline (s);
515 session_dequeue_notify (session_t * s)
517 app_worker_t *app_wrk;
519 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
520 if (PREDICT_FALSE (!app_wrk))
523 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
527 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
528 return session_notify_subscribers (app_wrk->app_index, s,
529 s->tx_fifo, SESSION_IO_EVT_TX);
531 svm_fifo_clear_tx_ntf (s->tx_fifo);
537 * Flushes queue of sessions that are to be notified of new data
540 * @param thread_index Thread index for which the flush is to be performed.
541 * @return 0 on success or a positive number indicating the number of
542 * failures due to API queue being full.
545 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
547 session_worker_t *wrk = session_main_get_worker (thread_index);
552 indices = wrk->session_to_enqueue[transport_proto];
554 for (i = 0; i < vec_len (indices); i++)
556 s = session_get_if_valid (indices[i], thread_index);
557 if (PREDICT_FALSE (!s))
563 if (svm_fifo_is_empty (s->rx_fifo))
566 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
570 vec_reset_length (indices);
571 wrk->session_to_enqueue[transport_proto] = indices;
572 wrk->current_enqueue_epoch[transport_proto]++;
578 session_main_flush_all_enqueue_events (u8 transport_proto)
580 vlib_thread_main_t *vtm = vlib_get_thread_main ();
582 for (i = 0; i < 1 + vtm->n_threads; i++)
583 errors += session_main_flush_enqueue_events (transport_proto, i);
588 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
590 u32 opaque = 0, new_ti, new_si;
591 app_worker_t *app_wrk;
596 * Find connection handle and cleanup half-open table
598 ho_handle = session_lookup_half_open_handle (tc);
599 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
601 SESSION_DBG ("half-open was removed!");
604 session_lookup_del_half_open (tc);
606 /* Get the app's index from the handle we stored when opening connection
607 * and the opaque (api_context for external apps) from transport session
609 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
613 opaque = tc->s_index;
616 return app_worker_connect_notify (app_wrk, s, opaque);
618 s = session_alloc_for_connection (tc);
619 s->session_state = SESSION_STATE_CONNECTING;
620 s->app_wrk_index = app_wrk->wrk_index;
621 new_si = s->session_index;
622 new_ti = s->thread_index;
624 if (app_worker_init_connected (app_wrk, s))
627 app_worker_connect_notify (app_wrk, 0, opaque);
631 if (app_worker_connect_notify (app_wrk, s, opaque))
633 s = session_get (new_si, new_ti);
634 session_free_w_fifos (s);
638 s = session_get (new_si, new_ti);
639 s->session_state = SESSION_STATE_READY;
640 session_lookup_add_connection (tc, session_handle (s));
645 typedef struct _session_switch_pool_args
649 u32 new_thread_index;
650 u32 new_session_index;
651 } session_switch_pool_args_t;
654 session_switch_pool (void *cb_args)
656 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
658 ASSERT (args->thread_index == vlib_get_thread_index ());
659 s = session_get (args->session_index, args->thread_index);
660 s->tx_fifo->master_session_index = args->new_session_index;
661 s->tx_fifo->master_thread_index = args->new_thread_index;
662 transport_cleanup (session_get_transport_proto (s), s->connection_index,
665 clib_mem_free (cb_args);
669 * Move dgram session to the right thread
672 session_dgram_connect_notify (transport_connection_t * tc,
673 u32 old_thread_index, session_t ** new_session)
676 session_switch_pool_args_t *rpc_args;
679 * Clone half-open session to the right thread.
681 new_s = session_clone_safe (tc->s_index, old_thread_index);
682 new_s->connection_index = tc->c_index;
683 new_s->rx_fifo->master_session_index = new_s->session_index;
684 new_s->rx_fifo->master_thread_index = new_s->thread_index;
685 new_s->session_state = SESSION_STATE_READY;
686 session_lookup_add_connection (tc, session_handle (new_s));
689 * Ask thread owning the old session to clean it up and make us the tx
692 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
693 rpc_args->new_session_index = new_s->session_index;
694 rpc_args->new_thread_index = new_s->thread_index;
695 rpc_args->session_index = tc->s_index;
696 rpc_args->thread_index = old_thread_index;
697 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
700 tc->s_index = new_s->session_index;
701 new_s->connection_index = tc->c_index;
702 *new_session = new_s;
707 * Notification from transport that connection is being closed.
709 * A disconnect is sent to application but state is not removed. Once
710 * disconnect is acknowledged by application, session disconnect is called.
711 * Ultimately this leads to close being called on transport (passive close).
714 session_transport_closing_notify (transport_connection_t * tc)
716 app_worker_t *app_wrk;
720 s = session_get (tc->s_index, tc->thread_index);
721 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
723 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
724 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
727 app = application_get (app_wrk->app_index);
728 app->cb_fns.session_disconnect_callback (s);
732 * Notification from transport that connection is being deleted
734 * This removes the session if it is still valid. It should be called only on
735 * previously fully established sessions. For instance failed connects should
736 * call stream_session_connect_notify and indicate that the connect has
740 session_transport_delete_notify (transport_connection_t * tc)
744 /* App might've been removed already */
745 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
748 /* Make sure we don't try to send anything more */
749 svm_fifo_dequeue_drop_all (s->tx_fifo);
751 switch (s->session_state)
753 case SESSION_STATE_CREATED:
754 /* Session was created but accept notification was not yet sent to the
755 * app. Cleanup everything. */
756 session_lookup_del_session (s);
757 session_free_w_fifos (s);
759 case SESSION_STATE_ACCEPTING:
760 case SESSION_STATE_TRANSPORT_CLOSING:
761 /* If transport finishes or times out before we get a reply
762 * from the app, mark transport as closed and wait for reply
763 * before removing the session. Cleanup session table in advance
764 * because transport will soon be closed and closed sessions
765 * are assumed to have been removed from the lookup table */
766 session_lookup_del_session (s);
767 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
769 case SESSION_STATE_CLOSING:
770 case SESSION_STATE_CLOSED_WAITING:
771 /* Cleanup lookup table as transport needs to still be valid.
772 * Program transport close to ensure that all session events
773 * have been cleaned up. Once transport close is called, the
774 * session is just removed because both transport and app have
775 * confirmed the close*/
776 session_lookup_del_session (s);
777 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
778 session_program_transport_close (s);
780 case SESSION_STATE_TRANSPORT_CLOSED:
782 case SESSION_STATE_CLOSED:
786 clib_warning ("session state %u", s->session_state);
793 * Notification from transport that session can be closed
795 * Should be called by transport only if it was closed with non-empty
796 * tx fifo and once it decides to begin the closing procedure prior to
797 * issuing a delete notify. This gives the chance to the session layer
798 * to cleanup any outstanding events.
801 session_transport_closed_notify (transport_connection_t * tc)
805 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
808 /* If app close has not been received or has not yet resulted in
809 * a transport close, only mark the session transport as closed */
810 if (s->session_state <= SESSION_STATE_CLOSING)
812 session_lookup_del_session (s);
813 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
816 s->session_state = SESSION_STATE_CLOSED;
820 * Notify application that connection has been reset.
823 session_transport_reset_notify (transport_connection_t * tc)
826 app_worker_t *app_wrk;
828 s = session_get (tc->s_index, tc->thread_index);
829 svm_fifo_dequeue_drop_all (s->tx_fifo);
830 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
832 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
833 app_wrk = app_worker_get (s->app_wrk_index);
834 app = application_get (app_wrk->app_index);
835 app->cb_fns.session_reset_callback (s);
839 session_stream_accept_notify (transport_connection_t * tc)
841 app_worker_t *app_wrk;
844 s = session_get (tc->s_index, tc->thread_index);
845 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
848 s->session_state = SESSION_STATE_ACCEPTING;
849 return app_worker_accept_notify (app_wrk, s);
853 * Accept a stream session. Optionally ping the server by callback.
856 session_stream_accept (transport_connection_t * tc, u32 listener_index,
862 s = session_alloc_for_connection (tc);
863 s->listener_index = listener_index;
864 s->session_state = SESSION_STATE_CREATED;
866 if ((rv = app_worker_init_accepted (s)))
869 session_lookup_add_connection (tc, session_handle (s));
871 /* Shoulder-tap the server */
874 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
875 return app_worker_accept_notify (app_wrk, s);
882 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
884 transport_connection_t *tc;
885 transport_endpoint_cfg_t *tep;
886 app_worker_t *app_wrk;
890 tep = session_endpoint_to_transport_cfg (rmt);
891 rv = transport_connect (rmt->transport_proto, tep);
894 SESSION_DBG ("Transport failed to open connection.");
895 return VNET_API_ERROR_SESSION_CONNECT;
898 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
900 /* For dgram type of service, allocate session and fifos now */
901 app_wrk = app_worker_get (app_wrk_index);
902 s = session_alloc_for_connection (tc);
903 s->app_wrk_index = app_wrk->wrk_index;
904 s->session_state = SESSION_STATE_OPENED;
905 if (app_worker_init_connected (app_wrk, s))
911 return app_worker_connect_notify (app_wrk, s, opaque);
915 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
917 transport_connection_t *tc;
918 transport_endpoint_cfg_t *tep;
922 tep = session_endpoint_to_transport_cfg (rmt);
923 rv = transport_connect (rmt->transport_proto, tep);
926 SESSION_DBG ("Transport failed to open connection.");
927 return VNET_API_ERROR_SESSION_CONNECT;
930 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
932 /* If transport offers a stream service, only allocate session once the
933 * connection has been established.
934 * Add connection to half-open table and save app and tc index. The
935 * latter is needed to help establish the connection while the former
936 * is needed when the connect notify comes and we have to notify the
939 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
940 session_lookup_add_half_open (tc, handle);
942 /* Store api_context (opaque) for when the reply comes. Not the nicest
943 * thing but better than allocating a separate half-open pool.
945 tc->s_index = opaque;
950 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
952 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
953 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
955 sep->app_wrk_index = app_wrk_index;
956 sep->opaque = opaque;
958 return transport_connect (rmt->transport_proto, tep_cfg);
961 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
964 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
972 * Ask transport to open connection to remote transport endpoint.
974 * Stores handle for matching request with reply since the call can be
975 * asynchronous. For instance, for TCP the 3-way handshake must complete
976 * before reply comes. Session is only created once connection is established.
978 * @param app_index Index of the application requesting the connect
979 * @param st Session type requested.
980 * @param tep Remote transport endpoint
981 * @param opaque Opaque data (typically, api_context) the application expects
982 * on open completion.
985 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
987 transport_service_type_t tst;
988 tst = transport_protocol_service_type (rmt->transport_proto);
989 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
993 * Ask transport to listen on session endpoint.
995 * @param s Session for which listen will be called. Note that unlike
996 * established sessions, listen sessions are not associated to a
998 * @param sep Local endpoint to be listened on.
1001 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1003 transport_endpoint_t *tep;
1004 u32 tc_index, s_index;
1006 /* Transport bind/listen */
1007 tep = session_endpoint_to_transport (sep);
1008 s_index = ls->session_index;
1009 tc_index = transport_start_listen (session_get_transport_proto (ls),
1012 if (tc_index == (u32) ~ 0)
1015 /* Attach transport to session. Lookup tables are populated by the app
1016 * worker because local tables (for ct sessions) are not backed by a fib */
1017 ls = listen_session_get (s_index);
1018 ls->connection_index = tc_index;
1024 * Ask transport to stop listening on local transport endpoint.
1026 * @param s Session to stop listening on. It must be in state LISTENING.
1029 session_stop_listen (session_t * s)
1031 transport_proto_t tp = session_get_transport_proto (s);
1032 transport_connection_t *tc;
1034 if (s->session_state != SESSION_STATE_LISTENING)
1037 tc = transport_get_listener (tp, s->connection_index);
1039 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1041 session_lookup_del_connection (tc);
1042 transport_stop_listen (tp, s->connection_index);
1047 * Initialize session closing procedure.
1049 * Request is always sent to session node to ensure that all outstanding
1050 * requests are served before transport is notified.
1053 session_close (session_t * s)
1058 if (s->session_state >= SESSION_STATE_CLOSING)
1060 /* Session will only be removed once both app and transport
1061 * acknowledge the close */
1062 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1063 session_program_transport_close (s);
1065 /* Session already closed. Clear the tx fifo */
1066 if (s->session_state == SESSION_STATE_CLOSED)
1067 svm_fifo_dequeue_drop_all (s->tx_fifo);
1071 s->session_state = SESSION_STATE_CLOSING;
1072 session_program_transport_close (s);
1076 * Notify transport the session can be disconnected. This should eventually
1077 * result in a delete notification that allows us to cleanup session state.
1078 * Called for both active/passive disconnects.
1080 * Must be called from the session's thread.
1083 session_transport_close (session_t * s)
1085 /* If transport is already closed, just free the session */
1086 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1088 session_free_w_fifos (s);
1092 /* If tx queue wasn't drained, change state to closed waiting for transport.
1093 * This way, the transport, if it so wishes, can continue to try sending the
1094 * outstanding data (in closed state it cannot). It MUST however at one
1095 * point, either after sending everything or after a timeout, call delete
1096 * notify. This will finally lead to the complete cleanup of the session.
1098 if (svm_fifo_max_dequeue (s->tx_fifo))
1099 s->session_state = SESSION_STATE_CLOSED_WAITING;
1101 s->session_state = SESSION_STATE_CLOSED;
1103 transport_close (session_get_transport_proto (s), s->connection_index,
1108 * Cleanup transport and session state.
1110 * Notify transport of the cleanup and free the session. This should
1111 * be called only if transport reported some error and is already
1115 session_transport_cleanup (session_t * s)
1117 s->session_state = SESSION_STATE_CLOSED;
1119 /* Delete from main lookup table before we axe the the transport */
1120 session_lookup_del_session (s);
1121 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1123 /* Since we called cleanup, no delete notification will come. So, make
1124 * sure the session is properly freed. */
1125 session_free_w_fifos (s);
1129 * Allocate event queues in the shared-memory segment
1131 * That can either be a newly created memfd segment, that will need to be
1132 * mapped by all stack users, or the binary api's svm region. The latter is
1133 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1134 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1135 * vpp uses api svm region for event queues.
1138 session_vpp_event_queues_allocate (session_main_t * smm)
1140 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1141 ssvm_private_t *eqs = &smm->evt_qs_segment;
1142 api_main_t *am = &api_main;
1143 uword eqs_size = 64 << 20;
1144 pid_t vpp_pid = getpid ();
1148 if (smm->configured_event_queue_length)
1149 evt_q_length = smm->configured_event_queue_length;
1151 if (smm->evt_qs_use_memfd_seg)
1153 if (smm->evt_qs_segment_size)
1154 eqs_size = smm->evt_qs_segment_size;
1156 eqs->ssvm_size = eqs_size;
1157 eqs->i_am_master = 1;
1158 eqs->my_pid = vpp_pid;
1159 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1160 eqs->requested_va = smm->session_baseva;
1162 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1164 clib_warning ("failed to initialize queue segment");
1169 if (smm->evt_qs_use_memfd_seg)
1170 oldheap = ssvm_push_heap (eqs->sh);
1172 oldheap = svm_push_data_heap (am->vlib_rp);
1174 for (i = 0; i < vec_len (smm->wrk); i++)
1176 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1177 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1178 {evt_q_length, evt_size, 0}
1180 {evt_q_length >> 1, 256, 0}
1182 cfg->consumer_pid = 0;
1184 cfg->q_nitems = evt_q_length;
1185 cfg->ring_cfgs = rc;
1186 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1187 if (smm->evt_qs_use_memfd_seg)
1189 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1190 clib_warning ("eventfd returned");
1194 if (smm->evt_qs_use_memfd_seg)
1195 ssvm_pop_heap (oldheap);
1197 svm_pop_heap (oldheap);
1201 session_main_get_evt_q_segment (void)
1203 session_main_t *smm = &session_main;
1204 if (smm->evt_qs_use_memfd_seg)
1205 return &smm->evt_qs_segment;
1210 session_segment_handle (session_t * s)
1214 if (s->session_state == SESSION_STATE_LISTENING)
1215 return SESSION_INVALID_HANDLE;
1218 return segment_manager_make_segment_handle (f->segment_manager,
1223 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1224 session_tx_fifo_peek_and_snd,
1225 session_tx_fifo_dequeue_and_snd,
1226 session_tx_fifo_dequeue_internal,
1227 session_tx_fifo_dequeue_and_snd
1232 * Initialize session layer for given transport proto and ip version
1234 * Allocates per session type (transport proto + ip version) data structures
1235 * and adds arc from session queue node to session type output node.
1238 session_register_transport (transport_proto_t transport_proto,
1239 const transport_proto_vft_t * vft, u8 is_ip4,
1242 session_main_t *smm = &session_main;
1243 session_type_t session_type;
1244 u32 next_index = ~0;
1246 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1248 vec_validate (smm->session_type_to_next, session_type);
1249 vec_validate (smm->session_tx_fns, session_type);
1252 if (output_node != ~0)
1254 foreach_vlib_main (({
1255 next_index = vlib_node_add_next (this_vlib_main,
1256 session_queue_node.index,
1262 smm->session_type_to_next[session_type] = next_index;
1263 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1266 transport_connection_t *
1267 session_get_transport (session_t * s)
1269 if (s->session_state != SESSION_STATE_LISTENING)
1270 return transport_get_connection (session_get_transport_proto (s),
1271 s->connection_index, s->thread_index);
1273 return transport_get_listener (session_get_transport_proto (s),
1274 s->connection_index);
1277 transport_connection_t *
1278 listen_session_get_transport (session_t * s)
1280 return transport_get_listener (session_get_transport_proto (s),
1281 s->connection_index);
1285 session_flush_frames_main_thread (vlib_main_t * vm)
1287 ASSERT (vlib_get_thread_index () == 0);
1288 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1289 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1292 static clib_error_t *
1293 session_manager_main_enable (vlib_main_t * vm)
1295 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1296 session_main_t *smm = &session_main;
1297 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1298 u32 num_threads, preallocated_sessions_per_worker;
1299 session_worker_t *wrk;
1302 num_threads = 1 /* main thread */ + vtm->n_threads;
1304 if (num_threads < 1)
1305 return clib_error_return (0, "n_thread_stacks not set");
1307 /* Allocate cache line aligned worker contexts */
1308 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1310 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1312 for (j = 0; j < num_threads; j++)
1313 smm->wrk[j].current_enqueue_epoch[i] = 1;
1316 for (i = 0; i < num_threads; i++)
1319 vec_validate (wrk->free_event_vector, 128);
1320 _vec_len (wrk->free_event_vector) = 0;
1321 vec_validate (wrk->pending_event_vector, 128);
1322 _vec_len (wrk->pending_event_vector) = 0;
1323 vec_validate (wrk->pending_disconnects, 128);
1324 _vec_len (wrk->pending_disconnects) = 0;
1325 vec_validate (wrk->postponed_event_vector, 128);
1326 _vec_len (wrk->postponed_event_vector) = 0;
1328 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1329 wrk->dispatch_period = 500e-6;
1331 if (num_threads > 1)
1332 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1336 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1339 /* Allocate vpp event queues segment and queue */
1340 session_vpp_event_queues_allocate (smm);
1342 /* Initialize fifo segment main baseva and timeout */
1343 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1344 sm_args->size = smm->session_va_space_size;
1345 segment_manager_main_init (sm_args);
1347 /* Preallocate sessions */
1348 if (smm->preallocated_sessions)
1350 if (num_threads == 1)
1352 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1357 preallocated_sessions_per_worker =
1358 (1.1 * (f64) smm->preallocated_sessions /
1359 (f64) (num_threads - 1));
1361 for (j = 1; j < num_threads; j++)
1363 pool_init_fixed (smm->wrk[j].sessions,
1364 preallocated_sessions_per_worker);
1369 session_lookup_init ();
1370 app_namespaces_init ();
1373 smm->is_enabled = 1;
1375 /* Enable transports */
1376 transport_enable_disable (vm, 1);
1377 transport_init_tx_pacers_period ();
1382 session_node_enable_disable (u8 is_en)
1384 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1385 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1386 u8 have_workers = vtm->n_threads != 0;
1389 foreach_vlib_main (({
1390 if (have_workers && ii == 0)
1392 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1396 vlib_node_t *n = vlib_get_node (this_vlib_main,
1397 session_queue_process_node.index);
1398 vlib_start_process (this_vlib_main, n->runtime_index);
1402 vlib_process_signal_event_mt (this_vlib_main,
1403 session_queue_process_node.index,
1404 SESSION_Q_PROCESS_STOP, 0);
1409 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1416 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1418 clib_error_t *error = 0;
1421 if (session_main.is_enabled)
1424 session_node_enable_disable (is_en);
1425 error = session_manager_main_enable (vm);
1429 session_main.is_enabled = 0;
1430 session_node_enable_disable (is_en);
1437 session_manager_main_init (vlib_main_t * vm)
1439 session_main_t *smm = &session_main;
1440 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1441 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1442 smm->session_va_space_size = 128ULL << 30;
1443 smm->evt_qs_segment_size = 64 << 20;
1445 smm->session_va_space_size = 128 << 20;
1446 smm->evt_qs_segment_size = 1 << 20;
1448 smm->is_enabled = 0;
1452 VLIB_INIT_FUNCTION (session_manager_main_init);
1454 static clib_error_t *
1455 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1457 session_main_t *smm = &session_main;
1461 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1463 if (unformat (input, "event-queue-length %d", &nitems))
1466 smm->configured_event_queue_length = nitems;
1468 clib_warning ("event queue length %d too small, ignored", nitems);
1470 else if (unformat (input, "preallocated-sessions %d",
1471 &smm->preallocated_sessions))
1473 else if (unformat (input, "v4-session-table-buckets %d",
1474 &smm->configured_v4_session_table_buckets))
1476 else if (unformat (input, "v4-halfopen-table-buckets %d",
1477 &smm->configured_v4_halfopen_table_buckets))
1479 else if (unformat (input, "v6-session-table-buckets %d",
1480 &smm->configured_v6_session_table_buckets))
1482 else if (unformat (input, "v6-halfopen-table-buckets %d",
1483 &smm->configured_v6_halfopen_table_buckets))
1485 else if (unformat (input, "v4-session-table-memory %U",
1486 unformat_memory_size, &tmp))
1488 if (tmp >= 0x100000000)
1489 return clib_error_return (0, "memory size %llx (%lld) too large",
1491 smm->configured_v4_session_table_memory = tmp;
1493 else if (unformat (input, "v4-halfopen-table-memory %U",
1494 unformat_memory_size, &tmp))
1496 if (tmp >= 0x100000000)
1497 return clib_error_return (0, "memory size %llx (%lld) too large",
1499 smm->configured_v4_halfopen_table_memory = tmp;
1501 else if (unformat (input, "v6-session-table-memory %U",
1502 unformat_memory_size, &tmp))
1504 if (tmp >= 0x100000000)
1505 return clib_error_return (0, "memory size %llx (%lld) too large",
1507 smm->configured_v6_session_table_memory = tmp;
1509 else if (unformat (input, "v6-halfopen-table-memory %U",
1510 unformat_memory_size, &tmp))
1512 if (tmp >= 0x100000000)
1513 return clib_error_return (0, "memory size %llx (%lld) too large",
1515 smm->configured_v6_halfopen_table_memory = tmp;
1517 else if (unformat (input, "local-endpoints-table-memory %U",
1518 unformat_memory_size, &tmp))
1520 if (tmp >= 0x100000000)
1521 return clib_error_return (0, "memory size %llx (%lld) too large",
1523 smm->local_endpoints_table_memory = tmp;
1525 else if (unformat (input, "local-endpoints-table-buckets %d",
1526 &smm->local_endpoints_table_buckets))
1528 else if (unformat (input, "evt_qs_memfd_seg"))
1529 smm->evt_qs_use_memfd_seg = 1;
1530 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1531 &smm->evt_qs_segment_size))
1534 return clib_error_return (0, "unknown input `%U'",
1535 format_unformat_error, input);
1540 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1543 * fd.io coding-style-patch-verification: ON
1546 * eval: (c-set-style "gnu")