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_fifos (segment_manager_t * sm, session_t * s)
201 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
202 u32 fifo_segment_index;
205 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
207 &fifo_segment_index)))
209 /* Initialize backpointers */
210 server_rx_fifo->master_session_index = s->session_index;
211 server_rx_fifo->master_thread_index = s->thread_index;
213 server_tx_fifo->master_session_index = s->session_index;
214 server_tx_fifo->master_thread_index = s->thread_index;
216 s->rx_fifo = server_rx_fifo;
217 s->tx_fifo = server_tx_fifo;
218 s->svm_segment_index = fifo_segment_index;
223 session_alloc_for_connection (transport_connection_t * tc)
226 u32 thread_index = tc->thread_index;
228 ASSERT (thread_index == vlib_get_thread_index ()
229 || transport_protocol_is_cl (tc->proto));
231 s = session_alloc (thread_index);
232 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
233 s->enqueue_epoch = (u64) ~ 0;
234 s->session_state = SESSION_STATE_CLOSED;
236 /* Attach transport to session and vice versa */
237 s->connection_index = tc->c_index;
238 tc->s_index = s->session_index;
243 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
244 u8 alloc_fifos, session_t ** ret_s)
249 s = session_alloc_for_connection (tc);
250 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
257 /* Add to the main lookup table */
258 session_lookup_add_connection (tc, session_handle (s));
265 * Discards bytes from buffer chain
267 * It discards n_bytes_to_drop starting at first buffer after chain_b
270 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
271 vlib_buffer_t ** chain_b,
274 vlib_buffer_t *next = *chain_b;
275 u32 to_drop = n_bytes_to_drop;
276 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
277 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
279 next = vlib_get_buffer (vm, next->next_buffer);
280 if (next->current_length > to_drop)
282 vlib_buffer_advance (next, to_drop);
287 to_drop -= next->current_length;
288 next->current_length = 0;
294 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
298 * Enqueue buffer chain tail
301 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
302 u32 offset, u8 is_in_order)
304 vlib_buffer_t *chain_b;
305 u32 chain_bi, len, diff;
306 vlib_main_t *vm = vlib_get_main ();
311 if (is_in_order && offset)
313 diff = offset - b->current_length;
314 if (diff > b->total_length_not_including_first_buffer)
317 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
318 chain_bi = vlib_get_buffer_index (vm, chain_b);
321 chain_bi = b->next_buffer;
325 chain_b = vlib_get_buffer (vm, chain_bi);
326 data = vlib_buffer_get_current (chain_b);
327 len = chain_b->current_length;
332 rv = svm_fifo_enqueue_nowait (s->rx_fifo, len, data);
339 return (rv > 0) ? (written + rv) : written;
345 /* written more than what was left in chain */
346 if (written > b->total_length_not_including_first_buffer)
349 /* drop the bytes that have already been delivered */
350 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
355 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
358 clib_warning ("failed to enqueue multi-buffer seg");
364 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
365 ? chain_b->next_buffer : 0));
374 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
375 * event but on request can queue notification events for later delivery by
376 * calling stream_server_flush_enqueue_events().
378 * @param tc Transport connection which is to be enqueued data
379 * @param b Buffer to be enqueued
380 * @param offset Offset at which to start enqueueing if out-of-order
381 * @param queue_event Flag to indicate if peer is to be notified or if event
382 * is to be queued. The former is useful when more data is
383 * enqueued and only one event is to be generated.
384 * @param is_in_order Flag to indicate if data is in order
385 * @return Number of bytes enqueued or a negative value if enqueueing failed.
388 session_enqueue_stream_connection (transport_connection_t * tc,
389 vlib_buffer_t * b, u32 offset,
390 u8 queue_event, u8 is_in_order)
393 int enqueued = 0, rv, in_order_off;
395 s = session_get (tc->s_index, tc->thread_index);
399 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo,
401 vlib_buffer_get_current (b));
402 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
405 in_order_off = enqueued > b->current_length ? enqueued : 0;
406 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
413 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
415 vlib_buffer_get_current (b));
416 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
417 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
418 /* if something was enqueued, report even this as success for ooo
419 * segment handling */
425 /* Queue RX event on this fifo. Eventually these will need to be flushed
426 * by calling stream_server_flush_enqueue_events () */
427 session_manager_worker_t *wrk;
429 wrk = session_manager_get_worker (s->thread_index);
430 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
432 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
433 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
441 session_enqueue_dgram_connection (session_t * s,
442 session_dgram_hdr_t * hdr,
443 vlib_buffer_t * b, u8 proto, u8 queue_event)
445 int enqueued = 0, rv, in_order_off;
447 ASSERT (svm_fifo_max_enqueue (s->rx_fifo)
448 >= b->current_length + sizeof (*hdr));
450 svm_fifo_enqueue_nowait (s->rx_fifo, sizeof (session_dgram_hdr_t),
452 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo, b->current_length,
453 vlib_buffer_get_current (b));
454 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
456 in_order_off = enqueued > b->current_length ? enqueued : 0;
457 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
463 /* Queue RX event on this fifo. Eventually these will need to be flushed
464 * by calling stream_server_flush_enqueue_events () */
465 session_manager_worker_t *wrk;
467 wrk = session_manager_get_worker (s->thread_index);
468 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
470 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
471 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
477 /** Check if we have space in rx fifo to push more bytes */
479 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
482 session_t *s = session_get (tc->s_index, thread_index);
484 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
487 if (data_len > svm_fifo_max_enqueue (s->rx_fifo))
494 session_tx_fifo_max_dequeue (transport_connection_t * tc)
496 session_t *s = session_get (tc->s_index, tc->thread_index);
499 return svm_fifo_max_dequeue (s->tx_fifo);
503 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
504 u32 offset, u32 max_bytes)
506 session_t *s = session_get (tc->s_index, tc->thread_index);
507 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
511 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
513 session_t *s = session_get (tc->s_index, tc->thread_index);
514 return svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
518 session_notify_subscribers (u32 app_index, session_t * s,
519 svm_fifo_t * f, session_evt_type_t evt_type)
521 app_worker_t *app_wrk;
525 app = application_get (app_index);
529 for (i = 0; i < f->n_subscribers; i++)
531 app_wrk = application_get_worker (app, f->subscribers[i]);
534 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
542 * Notify session peer that new data has been enqueued.
544 * @param s Stream session for which the event is to be generated.
545 * @param lock Flag to indicate if call should lock message queue.
547 * @return 0 on success or negative number if failed to send notification.
550 session_enqueue_notify (session_t * s)
552 app_worker_t *app_wrk;
554 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
555 if (PREDICT_FALSE (!app_wrk))
557 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
562 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
563 ed->data[0] = FIFO_EVENT_APP_RX;
564 ed->data[1] = svm_fifo_max_dequeue (s->rx_fifo);
568 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
572 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
573 return session_notify_subscribers (app_wrk->app_index, s,
574 s->rx_fifo, FIFO_EVENT_APP_RX);
580 session_dequeue_notify (session_t * s)
582 app_worker_t *app_wrk;
584 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
585 if (PREDICT_FALSE (!app_wrk))
588 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
592 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
593 return session_notify_subscribers (app_wrk->app_index, s,
594 s->tx_fifo, FIFO_EVENT_APP_TX);
596 svm_fifo_clear_tx_ntf (s->tx_fifo);
602 * Flushes queue of sessions that are to be notified of new data
605 * @param thread_index Thread index for which the flush is to be performed.
606 * @return 0 on success or a positive number indicating the number of
607 * failures due to API queue being full.
610 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
612 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
617 indices = wrk->session_to_enqueue[transport_proto];
619 for (i = 0; i < vec_len (indices); i++)
621 s = session_get_if_valid (indices[i], thread_index);
622 if (PREDICT_FALSE (!s))
627 if (PREDICT_FALSE (session_enqueue_notify (s)))
631 vec_reset_length (indices);
632 wrk->session_to_enqueue[transport_proto] = indices;
633 wrk->current_enqueue_epoch[transport_proto]++;
639 session_manager_flush_all_enqueue_events (u8 transport_proto)
641 vlib_thread_main_t *vtm = vlib_get_thread_main ();
643 for (i = 0; i < 1 + vtm->n_threads; i++)
644 errors += session_manager_flush_enqueue_events (transport_proto, i);
649 * Init fifo tail and head pointers
651 * Useful if transport uses absolute offsets for tracking ooo segments.
654 stream_session_init_fifos_pointers (transport_connection_t * tc,
655 u32 rx_pointer, u32 tx_pointer)
658 s = session_get (tc->s_index, tc->thread_index);
659 svm_fifo_init_pointers (s->rx_fifo, rx_pointer);
660 svm_fifo_init_pointers (s->tx_fifo, tx_pointer);
664 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
666 u32 opaque = 0, new_ti, new_si;
667 session_t *new_s = 0;
668 segment_manager_t *sm;
669 app_worker_t *app_wrk;
676 * Find connection handle and cleanup half-open table
678 handle = session_lookup_half_open_handle (tc);
679 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
681 SESSION_DBG ("half-open was removed!");
684 session_lookup_del_half_open (tc);
686 /* Get the app's index from the handle we stored when opening connection
687 * and the opaque (api_context for external apps) from transport session
689 app_wrk = app_worker_get_if_valid (handle >> 32);
692 opaque = tc->s_index;
693 app = application_get (app_wrk->app_index);
696 * Allocate new session with fifos (svm segments are allocated if needed)
700 sm = app_worker_get_connect_segment_manager (app_wrk);
701 alloc_fifos = !application_is_builtin_proxy (app);
702 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
709 new_s->session_state = SESSION_STATE_CONNECTING;
710 new_s->app_wrk_index = app_wrk->wrk_index;
711 new_si = new_s->session_index;
712 new_ti = new_s->thread_index;
717 * Notify client application
719 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
722 SESSION_DBG ("failed to notify app");
725 new_s = session_get (new_si, new_ti);
726 session_transport_close (new_s);
733 new_s = session_get (new_si, new_ti);
734 new_s->session_state = SESSION_STATE_READY;
741 typedef struct _session_switch_pool_args
745 u32 new_thread_index;
746 u32 new_session_index;
747 } session_switch_pool_args_t;
750 session_switch_pool (void *cb_args)
752 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
754 ASSERT (args->thread_index == vlib_get_thread_index ());
755 s = session_get (args->session_index, args->thread_index);
756 s->tx_fifo->master_session_index = args->new_session_index;
757 s->tx_fifo->master_thread_index = args->new_thread_index;
758 transport_cleanup (session_get_transport_proto (s), s->connection_index,
761 clib_mem_free (cb_args);
765 * Move dgram session to the right thread
768 session_dgram_connect_notify (transport_connection_t * tc,
769 u32 old_thread_index, session_t ** new_session)
772 session_switch_pool_args_t *rpc_args;
775 * Clone half-open session to the right thread.
777 new_s = session_clone_safe (tc->s_index, old_thread_index);
778 new_s->connection_index = tc->c_index;
779 new_s->rx_fifo->master_session_index = new_s->session_index;
780 new_s->rx_fifo->master_thread_index = new_s->thread_index;
781 new_s->session_state = SESSION_STATE_READY;
782 session_lookup_add_connection (tc, session_handle (new_s));
785 * Ask thread owning the old session to clean it up and make us the tx
788 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
789 rpc_args->new_session_index = new_s->session_index;
790 rpc_args->new_thread_index = new_s->thread_index;
791 rpc_args->session_index = tc->s_index;
792 rpc_args->thread_index = old_thread_index;
793 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
796 tc->s_index = new_s->session_index;
797 new_s->connection_index = tc->c_index;
798 *new_session = new_s;
803 stream_session_accept_notify (transport_connection_t * tc)
805 app_worker_t *app_wrk;
809 s = session_get (tc->s_index, tc->thread_index);
810 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
813 s->session_state = SESSION_STATE_ACCEPTING;
814 app = application_get (app_wrk->app_index);
815 return app->cb_fns.session_accept_callback (s);
819 * Notification from transport that connection is being closed.
821 * A disconnect is sent to application but state is not removed. Once
822 * disconnect is acknowledged by application, session disconnect is called.
823 * Ultimately this leads to close being called on transport (passive close).
826 session_transport_closing_notify (transport_connection_t * tc)
828 app_worker_t *app_wrk;
832 s = session_get (tc->s_index, tc->thread_index);
833 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
835 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
836 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
839 app = application_get (app_wrk->app_index);
840 app->cb_fns.session_disconnect_callback (s);
844 * Notification from transport that connection is being deleted
846 * This removes the session if it is still valid. It should be called only on
847 * previously fully established sessions. For instance failed connects should
848 * call stream_session_connect_notify and indicate that the connect has
852 session_transport_delete_notify (transport_connection_t * tc)
856 /* App might've been removed already */
857 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
860 /* Make sure we don't try to send anything more */
861 svm_fifo_dequeue_drop_all (s->tx_fifo);
863 switch (s->session_state)
865 case SESSION_STATE_ACCEPTING:
866 case SESSION_STATE_TRANSPORT_CLOSING:
867 /* If transport finishes or times out before we get a reply
868 * from the app, mark transport as closed and wait for reply
869 * before removing the session. Cleanup session table in advance
870 * because transport will soon be closed and closed sessions
871 * are assumed to have been removed from the lookup table */
872 session_lookup_del_session (s);
873 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
875 case SESSION_STATE_CLOSING:
876 case SESSION_STATE_CLOSED_WAITING:
877 /* Cleanup lookup table as transport needs to still be valid.
878 * Program transport close to ensure that all session events
879 * have been cleaned up. Once transport close is called, the
880 * session is just removed because both transport and app have
881 * confirmed the close*/
882 session_lookup_del_session (s);
883 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
884 session_program_transport_close (s);
886 case SESSION_STATE_TRANSPORT_CLOSED:
888 case SESSION_STATE_CLOSED:
892 clib_warning ("session state %u", s->session_state);
899 * Notification from transport that session can be closed
901 * Should be called by transport only if it was closed with non-empty
902 * tx fifo and once it decides to begin the closing procedure prior to
903 * issuing a delete notify. This gives the chance to the session layer
904 * to cleanup any outstanding events.
907 session_transport_closed_notify (transport_connection_t * tc)
911 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
914 /* If app close has not been received or has not yet resulted in
915 * a transport close, only mark the session transport as closed */
916 if (s->session_state <= SESSION_STATE_CLOSING)
918 session_lookup_del_session (s);
919 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
922 s->session_state = SESSION_STATE_CLOSED;
926 * Notify application that connection has been reset.
929 session_transport_reset_notify (transport_connection_t * tc)
932 app_worker_t *app_wrk;
934 s = session_get (tc->s_index, tc->thread_index);
935 svm_fifo_dequeue_drop_all (s->tx_fifo);
936 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
938 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
939 app_wrk = app_worker_get (s->app_wrk_index);
940 app = application_get (app_wrk->app_index);
941 app->cb_fns.session_reset_callback (s);
945 * Accept a stream session. Optionally ping the server by callback.
948 session_stream_accept (transport_connection_t * tc, u32 listener_index,
951 session_t *s, *listener;
952 app_worker_t *app_wrk;
953 segment_manager_t *sm;
956 /* Find the server */
957 listener = listen_session_get (listener_index);
958 app_wrk = application_listener_select_worker (listener);
960 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
961 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
964 s->app_wrk_index = app_wrk->wrk_index;
965 s->listener_index = listener_index;
967 /* Shoulder-tap the server */
970 application_t *app = application_get (app_wrk->app_index);
971 return app->cb_fns.session_accept_callback (s);
978 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
980 transport_connection_t *tc;
981 transport_endpoint_cfg_t *tep;
982 segment_manager_t *sm;
983 app_worker_t *app_wrk;
988 tep = session_endpoint_to_transport_cfg (rmt);
989 rv = transport_connect (rmt->transport_proto, tep);
992 SESSION_DBG ("Transport failed to open connection.");
993 return VNET_API_ERROR_SESSION_CONNECT;
996 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
998 /* For dgram type of service, allocate session and fifos now.
1000 app_wrk = app_worker_get (app_wrk_index);
1001 sm = app_worker_get_connect_segment_manager (app_wrk);
1003 if (session_alloc_and_init (sm, tc, 1, &s))
1005 s->app_wrk_index = app_wrk->wrk_index;
1006 s->session_state = SESSION_STATE_OPENED;
1008 /* Tell the app about the new event fifo for this session */
1009 app = application_get (app_wrk->app_index);
1010 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
1016 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1018 transport_connection_t *tc;
1019 transport_endpoint_cfg_t *tep;
1023 tep = session_endpoint_to_transport_cfg (rmt);
1024 rv = transport_connect (rmt->transport_proto, tep);
1027 SESSION_DBG ("Transport failed to open connection.");
1028 return VNET_API_ERROR_SESSION_CONNECT;
1031 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1033 /* If transport offers a stream service, only allocate session once the
1034 * connection has been established.
1035 * Add connection to half-open table and save app and tc index. The
1036 * latter is needed to help establish the connection while the former
1037 * is needed when the connect notify comes and we have to notify the
1040 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1041 session_lookup_add_half_open (tc, handle);
1043 /* Store api_context (opaque) for when the reply comes. Not the nicest
1044 * thing but better than allocating a separate half-open pool.
1046 tc->s_index = opaque;
1051 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1053 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1054 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1056 sep->app_wrk_index = app_wrk_index;
1057 sep->opaque = opaque;
1059 return transport_connect (rmt->transport_proto, tep_cfg);
1062 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1065 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1073 * Ask transport to open connection to remote transport endpoint.
1075 * Stores handle for matching request with reply since the call can be
1076 * asynchronous. For instance, for TCP the 3-way handshake must complete
1077 * before reply comes. Session is only created once connection is established.
1079 * @param app_index Index of the application requesting the connect
1080 * @param st Session type requested.
1081 * @param tep Remote transport endpoint
1082 * @param opaque Opaque data (typically, api_context) the application expects
1083 * on open completion.
1086 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1088 transport_service_type_t tst;
1089 tst = transport_protocol_service_type (rmt->transport_proto);
1090 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1094 * Ask transport to listen on session endpoint.
1096 * @param s Session for which listen will be called. Note that unlike
1097 * established sessions, listen sessions are not associated to a
1099 * @param sep Local endpoint to be listened on.
1102 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1104 transport_connection_t *tc;
1105 transport_endpoint_t *tep;
1106 u32 tc_index, s_index;
1108 /* Transport bind/listen */
1109 tep = session_endpoint_to_transport (sep);
1110 s_index = ls->session_index;
1111 tc_index = transport_start_listen (sep->transport_proto, s_index, tep);
1113 if (tc_index == (u32) ~ 0)
1116 /* Attach transport to session */
1117 ls = listen_session_get (s_index);
1118 ls->connection_index = tc_index;
1120 /* Add to the main lookup table after transport was initialized */
1121 tc = transport_get_listener (sep->transport_proto, tc_index);
1122 session_lookup_add_connection (tc, listen_session_get_handle (ls));
1127 * Ask transport to stop listening on local transport endpoint.
1129 * @param s Session to stop listening on. It must be in state LISTENING.
1132 session_stop_listen (session_t * s)
1134 transport_proto_t tp = session_get_transport_proto (s);
1135 transport_connection_t *tc;
1137 if (s->session_state != SESSION_STATE_LISTENING)
1140 tc = transport_get_listener (tp, s->connection_index);
1142 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1144 session_lookup_del_connection (tc);
1145 transport_stop_listen (tp, s->connection_index);
1150 * Initialize session closing procedure.
1152 * Request is always sent to session node to ensure that all outstanding
1153 * requests are served before transport is notified.
1156 session_close (session_t * s)
1161 if (s->session_state >= SESSION_STATE_CLOSING)
1163 /* Session will only be removed once both app and transport
1164 * acknowledge the close */
1165 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1166 session_program_transport_close (s);
1168 /* Session already closed. Clear the tx fifo */
1169 if (s->session_state == SESSION_STATE_CLOSED)
1170 svm_fifo_dequeue_drop_all (s->tx_fifo);
1174 s->session_state = SESSION_STATE_CLOSING;
1175 session_program_transport_close (s);
1179 * Notify transport the session can be disconnected. This should eventually
1180 * result in a delete notification that allows us to cleanup session state.
1181 * Called for both active/passive disconnects.
1183 * Must be called from the session's thread.
1186 session_transport_close (session_t * s)
1188 /* If transport is already closed, just free the session */
1189 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1191 session_free_w_fifos (s);
1195 /* If tx queue wasn't drained, change state to closed waiting for transport.
1196 * This way, the transport, if it so wishes, can continue to try sending the
1197 * outstanding data (in closed state it cannot). It MUST however at one
1198 * point, either after sending everything or after a timeout, call delete
1199 * notify. This will finally lead to the complete cleanup of the session.
1201 if (svm_fifo_max_dequeue (s->tx_fifo))
1202 s->session_state = SESSION_STATE_CLOSED_WAITING;
1204 s->session_state = SESSION_STATE_CLOSED;
1206 transport_close (session_get_transport_proto (s), s->connection_index,
1211 * Cleanup transport and session state.
1213 * Notify transport of the cleanup and free the session. This should
1214 * be called only if transport reported some error and is already
1218 session_transport_cleanup (session_t * s)
1220 s->session_state = SESSION_STATE_CLOSED;
1222 /* Delete from main lookup table before we axe the the transport */
1223 session_lookup_del_session (s);
1224 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1226 /* Since we called cleanup, no delete notification will come. So, make
1227 * sure the session is properly freed. */
1228 session_free_w_fifos (s);
1232 * Allocate event queues in the shared-memory segment
1234 * That can either be a newly created memfd segment, that will need to be
1235 * mapped by all stack users, or the binary api's svm region. The latter is
1236 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1237 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1238 * vpp uses api svm region for event queues.
1241 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1243 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1244 ssvm_private_t *eqs = &smm->evt_qs_segment;
1245 api_main_t *am = &api_main;
1246 uword eqs_size = 64 << 20;
1247 pid_t vpp_pid = getpid ();
1251 if (smm->configured_event_queue_length)
1252 evt_q_length = smm->configured_event_queue_length;
1254 if (smm->evt_qs_use_memfd_seg)
1256 if (smm->evt_qs_segment_size)
1257 eqs_size = smm->evt_qs_segment_size;
1259 eqs->ssvm_size = eqs_size;
1260 eqs->i_am_master = 1;
1261 eqs->my_pid = vpp_pid;
1262 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1263 eqs->requested_va = smm->session_baseva;
1265 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1267 clib_warning ("failed to initialize queue segment");
1272 if (smm->evt_qs_use_memfd_seg)
1273 oldheap = ssvm_push_heap (eqs->sh);
1275 oldheap = svm_push_data_heap (am->vlib_rp);
1277 for (i = 0; i < vec_len (smm->wrk); i++)
1279 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1280 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1281 {evt_q_length, evt_size, 0}
1283 {evt_q_length >> 1, 256, 0}
1285 cfg->consumer_pid = 0;
1287 cfg->q_nitems = evt_q_length;
1288 cfg->ring_cfgs = rc;
1289 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1290 if (smm->evt_qs_use_memfd_seg)
1292 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1293 clib_warning ("eventfd returned");
1297 if (smm->evt_qs_use_memfd_seg)
1298 ssvm_pop_heap (oldheap);
1300 svm_pop_heap (oldheap);
1304 session_manager_get_evt_q_segment (void)
1306 session_manager_main_t *smm = &session_manager_main;
1307 if (smm->evt_qs_use_memfd_seg)
1308 return &smm->evt_qs_segment;
1313 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1314 session_tx_fifo_peek_and_snd,
1315 session_tx_fifo_dequeue_and_snd,
1316 session_tx_fifo_dequeue_internal,
1317 session_tx_fifo_dequeue_and_snd
1322 * Initialize session layer for given transport proto and ip version
1324 * Allocates per session type (transport proto + ip version) data structures
1325 * and adds arc from session queue node to session type output node.
1328 session_register_transport (transport_proto_t transport_proto,
1329 const transport_proto_vft_t * vft, u8 is_ip4,
1332 session_manager_main_t *smm = &session_manager_main;
1333 session_type_t session_type;
1334 u32 next_index = ~0;
1336 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1338 vec_validate (smm->session_type_to_next, session_type);
1339 vec_validate (smm->session_tx_fns, session_type);
1342 if (output_node != ~0)
1344 foreach_vlib_main (({
1345 next_index = vlib_node_add_next (this_vlib_main,
1346 session_queue_node.index,
1352 smm->session_type_to_next[session_type] = next_index;
1353 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1356 transport_connection_t *
1357 session_get_transport (session_t * s)
1359 if (s->session_state != SESSION_STATE_LISTENING)
1360 return transport_get_connection (session_get_transport_proto (s),
1361 s->connection_index, s->thread_index);
1363 return transport_get_listener (session_get_transport_proto (s),
1364 s->connection_index);
1367 transport_connection_t *
1368 listen_session_get_transport (session_t * s)
1370 return transport_get_listener (session_get_transport_proto (s),
1371 s->connection_index);
1375 listen_session_get_local_session_endpoint (session_t * listener,
1376 session_endpoint_t * sep)
1378 transport_connection_t *tc;
1379 tc = listen_session_get_transport (listener);
1382 clib_warning ("no transport");
1386 /* N.B. The ip should not be copied because this is the local endpoint */
1387 sep->port = tc->lcl_port;
1388 sep->transport_proto = tc->proto;
1389 sep->is_ip4 = tc->is_ip4;
1394 session_flush_frames_main_thread (vlib_main_t * vm)
1396 ASSERT (vlib_get_thread_index () == 0);
1397 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1398 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1401 static clib_error_t *
1402 session_manager_main_enable (vlib_main_t * vm)
1404 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1405 session_manager_main_t *smm = &session_manager_main;
1406 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1407 u32 num_threads, preallocated_sessions_per_worker;
1408 session_manager_worker_t *wrk;
1411 num_threads = 1 /* main thread */ + vtm->n_threads;
1413 if (num_threads < 1)
1414 return clib_error_return (0, "n_thread_stacks not set");
1416 /* Allocate cache line aligned worker contexts */
1417 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1419 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1421 for (j = 0; j < num_threads; j++)
1422 smm->wrk[j].current_enqueue_epoch[i] = 1;
1425 for (i = 0; i < num_threads; i++)
1428 vec_validate (wrk->free_event_vector, 128);
1429 _vec_len (wrk->free_event_vector) = 0;
1430 vec_validate (wrk->pending_event_vector, 128);
1431 _vec_len (wrk->pending_event_vector) = 0;
1432 vec_validate (wrk->pending_disconnects, 128);
1433 _vec_len (wrk->pending_disconnects) = 0;
1434 vec_validate (wrk->postponed_event_vector, 128);
1435 _vec_len (wrk->postponed_event_vector) = 0;
1437 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1438 wrk->dispatch_period = 500e-6;
1440 if (num_threads > 1)
1441 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1445 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1448 /* Allocate vpp event queues segment and queue */
1449 session_vpp_event_queues_allocate (smm);
1451 /* Initialize fifo segment main baseva and timeout */
1452 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1453 sm_args->size = smm->session_va_space_size;
1454 segment_manager_main_init (sm_args);
1456 /* Preallocate sessions */
1457 if (smm->preallocated_sessions)
1459 if (num_threads == 1)
1461 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1466 preallocated_sessions_per_worker =
1467 (1.1 * (f64) smm->preallocated_sessions /
1468 (f64) (num_threads - 1));
1470 for (j = 1; j < num_threads; j++)
1472 pool_init_fixed (smm->wrk[j].sessions,
1473 preallocated_sessions_per_worker);
1478 session_lookup_init ();
1479 app_namespaces_init ();
1482 smm->is_enabled = 1;
1484 /* Enable transports */
1485 transport_enable_disable (vm, 1);
1486 transport_init_tx_pacers_period ();
1491 session_node_enable_disable (u8 is_en)
1493 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1494 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1495 u8 have_workers = vtm->n_threads != 0;
1498 foreach_vlib_main (({
1499 if (have_workers && ii == 0)
1501 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1505 vlib_node_t *n = vlib_get_node (this_vlib_main,
1506 session_queue_process_node.index);
1507 vlib_start_process (this_vlib_main, n->runtime_index);
1511 vlib_process_signal_event_mt (this_vlib_main,
1512 session_queue_process_node.index,
1513 SESSION_Q_PROCESS_STOP, 0);
1518 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1525 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1527 clib_error_t *error = 0;
1530 if (session_manager_main.is_enabled)
1533 session_node_enable_disable (is_en);
1534 error = session_manager_main_enable (vm);
1538 session_manager_main.is_enabled = 0;
1539 session_node_enable_disable (is_en);
1546 session_manager_main_init (vlib_main_t * vm)
1548 session_manager_main_t *smm = &session_manager_main;
1549 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1550 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1551 smm->session_va_space_size = 128ULL << 30;
1552 smm->evt_qs_segment_size = 64 << 20;
1554 smm->session_va_space_size = 128 << 20;
1555 smm->evt_qs_segment_size = 1 << 20;
1557 smm->is_enabled = 0;
1561 VLIB_INIT_FUNCTION (session_manager_main_init);
1563 static clib_error_t *
1564 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1566 session_manager_main_t *smm = &session_manager_main;
1570 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1572 if (unformat (input, "event-queue-length %d", &nitems))
1575 smm->configured_event_queue_length = nitems;
1577 clib_warning ("event queue length %d too small, ignored", nitems);
1579 else if (unformat (input, "preallocated-sessions %d",
1580 &smm->preallocated_sessions))
1582 else if (unformat (input, "v4-session-table-buckets %d",
1583 &smm->configured_v4_session_table_buckets))
1585 else if (unformat (input, "v4-halfopen-table-buckets %d",
1586 &smm->configured_v4_halfopen_table_buckets))
1588 else if (unformat (input, "v6-session-table-buckets %d",
1589 &smm->configured_v6_session_table_buckets))
1591 else if (unformat (input, "v6-halfopen-table-buckets %d",
1592 &smm->configured_v6_halfopen_table_buckets))
1594 else if (unformat (input, "v4-session-table-memory %U",
1595 unformat_memory_size, &tmp))
1597 if (tmp >= 0x100000000)
1598 return clib_error_return (0, "memory size %llx (%lld) too large",
1600 smm->configured_v4_session_table_memory = tmp;
1602 else if (unformat (input, "v4-halfopen-table-memory %U",
1603 unformat_memory_size, &tmp))
1605 if (tmp >= 0x100000000)
1606 return clib_error_return (0, "memory size %llx (%lld) too large",
1608 smm->configured_v4_halfopen_table_memory = tmp;
1610 else if (unformat (input, "v6-session-table-memory %U",
1611 unformat_memory_size, &tmp))
1613 if (tmp >= 0x100000000)
1614 return clib_error_return (0, "memory size %llx (%lld) too large",
1616 smm->configured_v6_session_table_memory = tmp;
1618 else if (unformat (input, "v6-halfopen-table-memory %U",
1619 unformat_memory_size, &tmp))
1621 if (tmp >= 0x100000000)
1622 return clib_error_return (0, "memory size %llx (%lld) too large",
1624 smm->configured_v6_halfopen_table_memory = tmp;
1626 else if (unformat (input, "local-endpoints-table-memory %U",
1627 unformat_memory_size, &tmp))
1629 if (tmp >= 0x100000000)
1630 return clib_error_return (0, "memory size %llx (%lld) too large",
1632 smm->local_endpoints_table_memory = tmp;
1634 else if (unformat (input, "local-endpoints-table-buckets %d",
1635 &smm->local_endpoints_table_buckets))
1637 else if (unformat (input, "evt_qs_memfd_seg"))
1638 smm->evt_qs_use_memfd_seg = 1;
1639 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1640 &smm->evt_qs_segment_size))
1643 return clib_error_return (0, "unknown input `%U'",
1644 format_unformat_error, input);
1649 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1652 * fd.io coding-style-patch-verification: ON
1655 * eval: (c-set-style "gnu")