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 <vlibmemory/api.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/fib/ip4_fib.h>
27 session_manager_main_t session_manager_main;
28 extern transport_proto_vft_t *tp_vfts;
31 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
32 session_evt_type_t evt_type)
37 u32 tries = 0, max_tries;
39 mq = session_manager_get_vpp_event_queue (thread_index);
40 while (svm_msg_q_try_lock (mq))
42 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
43 if (tries++ == max_tries)
45 SESSION_DBG ("failed to enqueue evt");
49 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
51 svm_msg_q_unlock (mq);
54 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
55 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
57 svm_msg_q_unlock (mq);
60 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
61 evt->event_type = evt_type;
65 evt->rpc_args.fp = data;
66 evt->rpc_args.arg = args;
68 case FIFO_EVENT_APP_TX:
69 case SESSION_IO_EVT_TX_FLUSH:
70 case FIFO_EVENT_BUILTIN_RX:
73 case FIFO_EVENT_BUILTIN_TX:
74 case FIFO_EVENT_DISCONNECT:
75 evt->session_handle = session_handle ((session_t *) data);
78 clib_warning ("evt unhandled!");
79 svm_msg_q_unlock (mq);
83 svm_msg_q_add_and_unlock (mq, &msg);
88 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
90 return session_send_evt_to_thread (f, 0, f->master_thread_index, evt_type);
94 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
95 session_evt_type_t evt_type)
97 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
101 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
103 /* only event supported for now is disconnect */
104 ASSERT (evt_type == FIFO_EVENT_DISCONNECT);
105 return session_send_evt_to_thread (s, 0, s->thread_index,
106 FIFO_EVENT_DISCONNECT);
110 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
112 if (thread_index != vlib_get_thread_index ())
113 session_send_evt_to_thread (fp, rpc_args, thread_index, FIFO_EVENT_RPC);
116 void (*fnp) (void *) = fp;
122 session_program_transport_close (session_t * s)
124 u32 thread_index = vlib_get_thread_index ();
125 session_manager_worker_t *wrk;
126 session_event_t *evt;
128 /* If we are in the handler thread, or being called with the worker barrier
129 * held, just append a new event to pending disconnects vector. */
130 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
132 wrk = session_manager_get_worker (s->thread_index);
133 vec_add2 (wrk->pending_disconnects, evt, 1);
134 clib_memset (evt, 0, sizeof (*evt));
135 evt->session_handle = session_handle (s);
136 evt->event_type = FIFO_EVENT_DISCONNECT;
139 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
143 session_alloc (u32 thread_index)
145 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
148 pool_get_aligned_will_expand (wrk->sessions, will_expand,
149 CLIB_CACHE_LINE_BYTES);
150 /* If we have peekers, let them finish */
151 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
153 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
154 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
155 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
159 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
161 clib_memset (s, 0, sizeof (*s));
162 s->session_index = s - wrk->sessions;
163 s->thread_index = thread_index;
168 session_free (session_t * s)
170 pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
172 clib_memset (s, 0xFA, sizeof (*s));
176 session_free_w_fifos (session_t * s)
178 segment_manager_dealloc_fifos (s->svm_segment_index, s->rx_fifo,
184 * Cleans up session and lookup table.
186 * Transport connection must still be valid.
189 session_delete (session_t * s)
193 /* Delete from the main lookup table. */
194 if ((rv = session_lookup_del_session (s)))
195 clib_warning ("hash delete error, rv %d", rv);
197 session_free_w_fifos (s);
201 session_alloc_fifos (segment_manager_t * sm, session_t * s)
203 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
204 u32 fifo_segment_index;
207 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
209 &fifo_segment_index)))
211 /* Initialize backpointers */
212 server_rx_fifo->master_session_index = s->session_index;
213 server_rx_fifo->master_thread_index = s->thread_index;
215 server_tx_fifo->master_session_index = s->session_index;
216 server_tx_fifo->master_thread_index = s->thread_index;
218 s->rx_fifo = server_rx_fifo;
219 s->tx_fifo = server_tx_fifo;
220 s->svm_segment_index = fifo_segment_index;
225 session_alloc_for_connection (transport_connection_t * tc)
228 u32 thread_index = tc->thread_index;
230 ASSERT (thread_index == vlib_get_thread_index ()
231 || transport_protocol_is_cl (tc->proto));
233 s = session_alloc (thread_index);
234 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
235 s->enqueue_epoch = (u64) ~ 0;
236 s->session_state = SESSION_STATE_CLOSED;
238 /* Attach transport to session and vice versa */
239 s->connection_index = tc->c_index;
240 tc->s_index = s->session_index;
245 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
246 u8 alloc_fifos, session_t ** ret_s)
251 s = session_alloc_for_connection (tc);
252 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
259 /* Add to the main lookup table */
260 session_lookup_add_connection (tc, session_handle (s));
267 * Discards bytes from buffer chain
269 * It discards n_bytes_to_drop starting at first buffer after chain_b
272 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
273 vlib_buffer_t ** chain_b,
276 vlib_buffer_t *next = *chain_b;
277 u32 to_drop = n_bytes_to_drop;
278 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
279 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
281 next = vlib_get_buffer (vm, next->next_buffer);
282 if (next->current_length > to_drop)
284 vlib_buffer_advance (next, to_drop);
289 to_drop -= next->current_length;
290 next->current_length = 0;
296 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
300 * Enqueue buffer chain tail
303 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
304 u32 offset, u8 is_in_order)
306 vlib_buffer_t *chain_b;
307 u32 chain_bi, len, diff;
308 vlib_main_t *vm = vlib_get_main ();
313 if (is_in_order && offset)
315 diff = offset - b->current_length;
316 if (diff > b->total_length_not_including_first_buffer)
319 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
320 chain_bi = vlib_get_buffer_index (vm, chain_b);
323 chain_bi = b->next_buffer;
327 chain_b = vlib_get_buffer (vm, chain_bi);
328 data = vlib_buffer_get_current (chain_b);
329 len = chain_b->current_length;
334 rv = svm_fifo_enqueue_nowait (s->rx_fifo, len, data);
341 return (rv > 0) ? (written + rv) : written;
347 /* written more than what was left in chain */
348 if (written > b->total_length_not_including_first_buffer)
351 /* drop the bytes that have already been delivered */
352 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
357 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
360 clib_warning ("failed to enqueue multi-buffer seg");
366 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
367 ? chain_b->next_buffer : 0));
376 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
377 * event but on request can queue notification events for later delivery by
378 * calling stream_server_flush_enqueue_events().
380 * @param tc Transport connection which is to be enqueued data
381 * @param b Buffer to be enqueued
382 * @param offset Offset at which to start enqueueing if out-of-order
383 * @param queue_event Flag to indicate if peer is to be notified or if event
384 * is to be queued. The former is useful when more data is
385 * enqueued and only one event is to be generated.
386 * @param is_in_order Flag to indicate if data is in order
387 * @return Number of bytes enqueued or a negative value if enqueueing failed.
390 session_enqueue_stream_connection (transport_connection_t * tc,
391 vlib_buffer_t * b, u32 offset,
392 u8 queue_event, u8 is_in_order)
395 int enqueued = 0, rv, in_order_off;
397 s = session_get (tc->s_index, tc->thread_index);
401 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo,
403 vlib_buffer_get_current (b));
404 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
407 in_order_off = enqueued > b->current_length ? enqueued : 0;
408 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
415 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
417 vlib_buffer_get_current (b));
418 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
419 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
420 /* if something was enqueued, report even this as success for ooo
421 * segment handling */
427 /* Queue RX event on this fifo. Eventually these will need to be flushed
428 * by calling stream_server_flush_enqueue_events () */
429 session_manager_worker_t *wrk;
431 wrk = session_manager_get_worker (s->thread_index);
432 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
434 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
435 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
443 session_enqueue_dgram_connection (session_t * s,
444 session_dgram_hdr_t * hdr,
445 vlib_buffer_t * b, u8 proto, u8 queue_event)
447 int enqueued = 0, rv, in_order_off;
449 ASSERT (svm_fifo_max_enqueue (s->rx_fifo)
450 >= b->current_length + sizeof (*hdr));
452 svm_fifo_enqueue_nowait (s->rx_fifo, sizeof (session_dgram_hdr_t),
454 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo, b->current_length,
455 vlib_buffer_get_current (b));
456 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
458 in_order_off = enqueued > b->current_length ? enqueued : 0;
459 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
465 /* Queue RX event on this fifo. Eventually these will need to be flushed
466 * by calling stream_server_flush_enqueue_events () */
467 session_manager_worker_t *wrk;
469 wrk = session_manager_get_worker (s->thread_index);
470 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
472 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
473 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
479 /** Check if we have space in rx fifo to push more bytes */
481 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
484 session_t *s = session_get (tc->s_index, thread_index);
486 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
489 if (data_len > svm_fifo_max_enqueue (s->rx_fifo))
496 session_tx_fifo_max_dequeue (transport_connection_t * tc)
498 session_t *s = session_get (tc->s_index, tc->thread_index);
501 return svm_fifo_max_dequeue (s->tx_fifo);
505 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
506 u32 offset, u32 max_bytes)
508 session_t *s = session_get (tc->s_index, tc->thread_index);
509 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
513 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
515 session_t *s = session_get (tc->s_index, tc->thread_index);
516 return svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
520 session_notify_subscribers (u32 app_index, session_t * s,
521 svm_fifo_t * f, session_evt_type_t evt_type)
523 app_worker_t *app_wrk;
527 app = application_get (app_index);
531 for (i = 0; i < f->n_subscribers; i++)
533 app_wrk = application_get_worker (app, f->subscribers[i]);
536 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
544 * Notify session peer that new data has been enqueued.
546 * @param s Stream session for which the event is to be generated.
547 * @param lock Flag to indicate if call should lock message queue.
549 * @return 0 on success or negative number if failed to send notification.
552 session_enqueue_notify (session_t * s)
554 app_worker_t *app_wrk;
556 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
557 if (PREDICT_FALSE (!app_wrk))
559 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
564 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
565 ed->data[0] = FIFO_EVENT_APP_RX;
566 ed->data[1] = svm_fifo_max_dequeue (s->rx_fifo);
570 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
574 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
575 return session_notify_subscribers (app_wrk->app_index, s,
576 s->rx_fifo, FIFO_EVENT_APP_RX);
582 session_dequeue_notify (session_t * s)
584 app_worker_t *app_wrk;
586 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
587 if (PREDICT_FALSE (!app_wrk))
590 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
594 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
595 return session_notify_subscribers (app_wrk->app_index, s,
596 s->tx_fifo, FIFO_EVENT_APP_TX);
598 svm_fifo_clear_tx_ntf (s->tx_fifo);
604 * Flushes queue of sessions that are to be notified of new data
607 * @param thread_index Thread index for which the flush is to be performed.
608 * @return 0 on success or a positive number indicating the number of
609 * failures due to API queue being full.
612 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
614 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
619 indices = wrk->session_to_enqueue[transport_proto];
621 for (i = 0; i < vec_len (indices); i++)
623 s = session_get_if_valid (indices[i], thread_index);
624 if (PREDICT_FALSE (!s))
629 if (PREDICT_FALSE (session_enqueue_notify (s)))
633 vec_reset_length (indices);
634 wrk->session_to_enqueue[transport_proto] = indices;
635 wrk->current_enqueue_epoch[transport_proto]++;
641 session_manager_flush_all_enqueue_events (u8 transport_proto)
643 vlib_thread_main_t *vtm = vlib_get_thread_main ();
645 for (i = 0; i < 1 + vtm->n_threads; i++)
646 errors += session_manager_flush_enqueue_events (transport_proto, i);
651 * Init fifo tail and head pointers
653 * Useful if transport uses absolute offsets for tracking ooo segments.
656 stream_session_init_fifos_pointers (transport_connection_t * tc,
657 u32 rx_pointer, u32 tx_pointer)
660 s = session_get (tc->s_index, tc->thread_index);
661 svm_fifo_init_pointers (s->rx_fifo, rx_pointer);
662 svm_fifo_init_pointers (s->tx_fifo, tx_pointer);
666 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
668 u32 opaque = 0, new_ti, new_si;
669 session_t *new_s = 0;
670 segment_manager_t *sm;
671 app_worker_t *app_wrk;
678 * Find connection handle and cleanup half-open table
680 handle = session_lookup_half_open_handle (tc);
681 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
683 SESSION_DBG ("half-open was removed!");
686 session_lookup_del_half_open (tc);
688 /* Get the app's index from the handle we stored when opening connection
689 * and the opaque (api_context for external apps) from transport session
691 app_wrk = app_worker_get_if_valid (handle >> 32);
694 opaque = tc->s_index;
695 app = application_get (app_wrk->app_index);
698 * Allocate new session with fifos (svm segments are allocated if needed)
702 sm = app_worker_get_connect_segment_manager (app_wrk);
703 alloc_fifos = !application_is_builtin_proxy (app);
704 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
711 new_s->session_state = SESSION_STATE_CONNECTING;
712 new_s->app_wrk_index = app_wrk->wrk_index;
713 new_si = new_s->session_index;
714 new_ti = new_s->thread_index;
719 * Notify client application
721 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
724 SESSION_DBG ("failed to notify app");
727 new_s = session_get (new_si, new_ti);
728 session_transport_close (new_s);
735 new_s = session_get (new_si, new_ti);
736 new_s->session_state = SESSION_STATE_READY;
743 typedef struct _session_switch_pool_args
747 u32 new_thread_index;
748 u32 new_session_index;
749 } session_switch_pool_args_t;
752 session_switch_pool (void *cb_args)
754 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
755 transport_proto_t tp;
757 ASSERT (args->thread_index == vlib_get_thread_index ());
758 s = session_get (args->session_index, args->thread_index);
759 s->tx_fifo->master_session_index = args->new_session_index;
760 s->tx_fifo->master_thread_index = args->new_thread_index;
761 tp = session_get_transport_proto (s);
762 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
764 clib_mem_free (cb_args);
768 * Move dgram session to the right thread
771 session_dgram_connect_notify (transport_connection_t * tc,
772 u32 old_thread_index, session_t ** new_session)
775 session_switch_pool_args_t *rpc_args;
778 * Clone half-open session to the right thread.
780 new_s = session_clone_safe (tc->s_index, old_thread_index);
781 new_s->connection_index = tc->c_index;
782 new_s->rx_fifo->master_session_index = new_s->session_index;
783 new_s->rx_fifo->master_thread_index = new_s->thread_index;
784 new_s->session_state = SESSION_STATE_READY;
785 session_lookup_add_connection (tc, session_handle (new_s));
788 * Ask thread owning the old session to clean it up and make us the tx
791 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
792 rpc_args->new_session_index = new_s->session_index;
793 rpc_args->new_thread_index = new_s->thread_index;
794 rpc_args->session_index = tc->s_index;
795 rpc_args->thread_index = old_thread_index;
796 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
799 tc->s_index = new_s->session_index;
800 new_s->connection_index = tc->c_index;
801 *new_session = new_s;
806 stream_session_accept_notify (transport_connection_t * tc)
808 app_worker_t *app_wrk;
812 s = session_get (tc->s_index, tc->thread_index);
813 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
816 s->session_state = SESSION_STATE_ACCEPTING;
817 app = application_get (app_wrk->app_index);
818 return app->cb_fns.session_accept_callback (s);
822 * Notification from transport that connection is being closed.
824 * A disconnect is sent to application but state is not removed. Once
825 * disconnect is acknowledged by application, session disconnect is called.
826 * Ultimately this leads to close being called on transport (passive close).
829 session_transport_closing_notify (transport_connection_t * tc)
831 app_worker_t *app_wrk;
835 s = session_get (tc->s_index, tc->thread_index);
836 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
838 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
839 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
842 app = application_get (app_wrk->app_index);
843 app->cb_fns.session_disconnect_callback (s);
847 * Notification from transport that connection is being deleted
849 * This removes the session if it is still valid. It should be called only on
850 * previously fully established sessions. For instance failed connects should
851 * call stream_session_connect_notify and indicate that the connect has
855 session_transport_delete_notify (transport_connection_t * tc)
859 /* App might've been removed already */
860 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
863 /* Make sure we don't try to send anything more */
864 svm_fifo_dequeue_drop_all (s->tx_fifo);
866 switch (s->session_state)
868 case SESSION_STATE_ACCEPTING:
869 case SESSION_STATE_TRANSPORT_CLOSING:
870 /* If transport finishes or times out before we get a reply
871 * from the app, mark transport as closed and wait for reply
872 * before removing the session. Cleanup session table in advance
873 * because transport will soon be closed and closed sessions
874 * are assumed to have been removed from the lookup table */
875 session_lookup_del_session (s);
876 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
878 case SESSION_STATE_CLOSING:
879 case SESSION_STATE_CLOSED_WAITING:
880 /* Cleanup lookup table as transport needs to still be valid.
881 * Program transport close to ensure that all session events
882 * have been cleaned up. Once transport close is called, the
883 * session is just removed because both transport and app have
884 * confirmed the close*/
885 session_lookup_del_session (s);
886 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
887 session_program_transport_close (s);
889 case SESSION_STATE_TRANSPORT_CLOSED:
891 case SESSION_STATE_CLOSED:
895 clib_warning ("session state %u", s->session_state);
902 * Notification from transport that session can be closed
904 * Should be called by transport only if it was closed with non-empty
905 * tx fifo and once it decides to begin the closing procedure prior to
906 * issuing a delete notify. This gives the chance to the session layer
907 * to cleanup any outstanding events.
910 session_transport_closed_notify (transport_connection_t * tc)
914 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
917 /* If app close has not been received or has not yet resulted in
918 * a transport close, only mark the session transport as closed */
919 if (s->session_state <= SESSION_STATE_CLOSING)
921 session_lookup_del_session (s);
922 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
925 s->session_state = SESSION_STATE_CLOSED;
929 * Notify application that connection has been reset.
932 session_transport_reset_notify (transport_connection_t * tc)
935 app_worker_t *app_wrk;
937 s = session_get (tc->s_index, tc->thread_index);
938 svm_fifo_dequeue_drop_all (s->tx_fifo);
939 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
941 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
942 app_wrk = app_worker_get (s->app_wrk_index);
943 app = application_get (app_wrk->app_index);
944 app->cb_fns.session_reset_callback (s);
948 * Accept a stream session. Optionally ping the server by callback.
951 stream_session_accept (transport_connection_t * tc, u32 listener_index,
954 session_t *s, *listener;
955 app_worker_t *app_wrk;
956 segment_manager_t *sm;
959 /* Find the server */
960 listener = listen_session_get (listener_index);
961 app_wrk = application_listener_select_worker (listener, 0);
963 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
964 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
967 s->app_wrk_index = app_wrk->wrk_index;
968 s->listener_index = listener_index;
970 /* Shoulder-tap the server */
973 application_t *app = application_get (app_wrk->app_index);
974 return app->cb_fns.session_accept_callback (s);
981 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
983 transport_connection_t *tc;
984 transport_endpoint_cfg_t *tep;
985 segment_manager_t *sm;
986 app_worker_t *app_wrk;
991 tep = session_endpoint_to_transport_cfg (rmt);
992 rv = tp_vfts[rmt->transport_proto].open (tep);
995 SESSION_DBG ("Transport failed to open connection.");
996 return VNET_API_ERROR_SESSION_CONNECT;
999 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
1001 /* For dgram type of service, allocate session and fifos now.
1003 app_wrk = app_worker_get (app_wrk_index);
1004 sm = app_worker_get_connect_segment_manager (app_wrk);
1006 if (session_alloc_and_init (sm, tc, 1, &s))
1008 s->app_wrk_index = app_wrk->wrk_index;
1009 s->session_state = SESSION_STATE_OPENED;
1011 /* Tell the app about the new event fifo for this session */
1012 app = application_get (app_wrk->app_index);
1013 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
1019 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1021 transport_connection_t *tc;
1022 transport_endpoint_cfg_t *tep;
1026 tep = session_endpoint_to_transport_cfg (rmt);
1027 rv = tp_vfts[rmt->transport_proto].open (tep);
1030 SESSION_DBG ("Transport failed to open connection.");
1031 return VNET_API_ERROR_SESSION_CONNECT;
1034 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
1036 /* If transport offers a stream service, only allocate session once the
1037 * connection has been established.
1038 * Add connection to half-open table and save app and tc index. The
1039 * latter is needed to help establish the connection while the former
1040 * is needed when the connect notify comes and we have to notify the
1043 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1044 session_lookup_add_half_open (tc, handle);
1046 /* Store api_context (opaque) for when the reply comes. Not the nicest
1047 * thing but better than allocating a separate half-open pool.
1049 tc->s_index = opaque;
1054 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1056 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1057 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1059 sep->app_wrk_index = app_wrk_index;
1060 sep->opaque = opaque;
1062 return tp_vfts[rmt->transport_proto].open (tep_cfg);
1065 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1068 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1076 * Ask transport to open connection to remote transport endpoint.
1078 * Stores handle for matching request with reply since the call can be
1079 * asynchronous. For instance, for TCP the 3-way handshake must complete
1080 * before reply comes. Session is only created once connection is established.
1082 * @param app_index Index of the application requesting the connect
1083 * @param st Session type requested.
1084 * @param tep Remote transport endpoint
1085 * @param opaque Opaque data (typically, api_context) the application expects
1086 * on open completion.
1089 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1091 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
1092 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1096 * Ask transport to listen on session endpoint.
1098 * @param s Session for which listen will be called. Note that unlike
1099 * established sessions, listen sessions are not associated to a
1101 * @param sep Local endpoint to be listened on.
1104 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1106 transport_connection_t *tc;
1107 transport_endpoint_t *tep;
1108 u32 tc_index, s_index;
1110 /* Transport bind/listen */
1111 tep = session_endpoint_to_transport (sep);
1112 s_index = ls->session_index;
1113 tc_index = tp_vfts[sep->transport_proto].bind (s_index, tep);
1115 if (tc_index == (u32) ~ 0)
1118 /* Attach transport to session */
1119 ls = listen_session_get (s_index);
1120 ls->connection_index = tc_index;
1122 /* Add to the main lookup table after transport was initialized */
1123 tc = tp_vfts[sep->transport_proto].get_listener (tc_index);
1124 session_lookup_add_connection (tc, s_index);
1129 * Ask transport to stop listening on local transport endpoint.
1131 * @param s Session to stop listening on. It must be in state LISTENING.
1134 session_stop_listen (session_t * s)
1136 transport_proto_t tp = session_get_transport_proto (s);
1137 transport_connection_t *tc;
1138 if (s->session_state != SESSION_STATE_LISTENING)
1140 clib_warning ("not a listening session");
1144 tc = tp_vfts[tp].get_listener (s->connection_index);
1147 clib_warning ("no transport");
1148 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1151 session_lookup_del_connection (tc);
1152 tp_vfts[tp].unbind (s->connection_index);
1157 * Initialize session closing procedure.
1159 * Request is always sent to session node to ensure that all outstanding
1160 * requests are served before transport is notified.
1163 session_close (session_t * s)
1168 if (s->session_state >= SESSION_STATE_CLOSING)
1170 /* Session will only be removed once both app and transport
1171 * acknowledge the close */
1172 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1173 session_program_transport_close (s);
1175 /* Session already closed. Clear the tx fifo */
1176 if (s->session_state == SESSION_STATE_CLOSED)
1177 svm_fifo_dequeue_drop_all (s->tx_fifo);
1181 s->session_state = SESSION_STATE_CLOSING;
1182 session_program_transport_close (s);
1186 * Notify transport the session can be disconnected. This should eventually
1187 * result in a delete notification that allows us to cleanup session state.
1188 * Called for both active/passive disconnects.
1190 * Must be called from the session's thread.
1193 session_transport_close (session_t * s)
1195 /* If transport is already closed, just free the session */
1196 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1198 session_free_w_fifos (s);
1202 /* If tx queue wasn't drained, change state to closed waiting for transport.
1203 * This way, the transport, if it so wishes, can continue to try sending the
1204 * outstanding data (in closed state it cannot). It MUST however at one
1205 * point, either after sending everything or after a timeout, call delete
1206 * notify. This will finally lead to the complete cleanup of the session.
1208 if (svm_fifo_max_dequeue (s->tx_fifo))
1209 s->session_state = SESSION_STATE_CLOSED_WAITING;
1211 s->session_state = SESSION_STATE_CLOSED;
1213 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1218 * Cleanup transport and session state.
1220 * Notify transport of the cleanup and free the session. This should
1221 * be called only if transport reported some error and is already
1225 session_transport_cleanup (session_t * s)
1227 s->session_state = SESSION_STATE_CLOSED;
1229 /* Delete from main lookup table before we axe the the transport */
1230 session_lookup_del_session (s);
1231 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1233 /* Since we called cleanup, no delete notification will come. So, make
1234 * sure the session is properly freed. */
1235 session_free_w_fifos (s);
1238 transport_service_type_t
1239 session_transport_service_type (session_t * s)
1241 transport_proto_t tp;
1242 tp = session_get_transport_proto (s);
1243 return transport_protocol_service_type (tp);
1246 transport_tx_fn_type_t
1247 session_transport_tx_fn_type (session_t * s)
1249 transport_proto_t tp;
1250 tp = session_get_transport_proto (s);
1251 return transport_protocol_tx_fn_type (tp);
1255 session_tx_is_dgram (session_t * s)
1257 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1261 * Allocate event queues in the shared-memory segment
1263 * That can either be a newly created memfd segment, that will need to be
1264 * mapped by all stack users, or the binary api's svm region. The latter is
1265 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1266 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1267 * vpp uses api svm region for event queues.
1270 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1272 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1273 ssvm_private_t *eqs = &smm->evt_qs_segment;
1274 api_main_t *am = &api_main;
1275 u64 eqs_size = 64 << 20;
1276 pid_t vpp_pid = getpid ();
1280 if (smm->configured_event_queue_length)
1281 evt_q_length = smm->configured_event_queue_length;
1283 if (smm->evt_qs_use_memfd_seg)
1285 if (smm->evt_qs_segment_size)
1286 eqs_size = smm->evt_qs_segment_size;
1288 eqs->ssvm_size = eqs_size;
1289 eqs->i_am_master = 1;
1290 eqs->my_pid = vpp_pid;
1291 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1292 eqs->requested_va = smm->session_baseva;
1294 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1296 clib_warning ("failed to initialize queue segment");
1301 if (smm->evt_qs_use_memfd_seg)
1302 oldheap = ssvm_push_heap (eqs->sh);
1304 oldheap = svm_push_data_heap (am->vlib_rp);
1306 for (i = 0; i < vec_len (smm->wrk); i++)
1308 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1309 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1310 {evt_q_length, evt_size, 0}
1312 {evt_q_length << 1, 256, 0}
1314 cfg->consumer_pid = 0;
1316 cfg->q_nitems = evt_q_length;
1317 cfg->ring_cfgs = rc;
1318 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1319 if (smm->evt_qs_use_memfd_seg)
1321 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1322 clib_warning ("eventfd returned");
1326 if (smm->evt_qs_use_memfd_seg)
1327 ssvm_pop_heap (oldheap);
1329 svm_pop_heap (oldheap);
1333 session_manager_get_evt_q_segment (void)
1335 session_manager_main_t *smm = &session_manager_main;
1336 if (smm->evt_qs_use_memfd_seg)
1337 return &smm->evt_qs_segment;
1342 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1343 session_tx_fifo_peek_and_snd,
1344 session_tx_fifo_dequeue_and_snd,
1345 session_tx_fifo_dequeue_internal,
1346 session_tx_fifo_dequeue_and_snd
1351 * Initialize session layer for given transport proto and ip version
1353 * Allocates per session type (transport proto + ip version) data structures
1354 * and adds arc from session queue node to session type output node.
1357 session_register_transport (transport_proto_t transport_proto,
1358 const transport_proto_vft_t * vft, u8 is_ip4,
1361 session_manager_main_t *smm = &session_manager_main;
1362 session_type_t session_type;
1363 u32 next_index = ~0;
1365 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1367 vec_validate (smm->session_type_to_next, session_type);
1368 vec_validate (smm->session_tx_fns, session_type);
1371 if (output_node != ~0)
1373 foreach_vlib_main (({
1374 next_index = vlib_node_add_next (this_vlib_main,
1375 session_queue_node.index,
1381 smm->session_type_to_next[session_type] = next_index;
1382 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1385 transport_connection_t *
1386 session_get_transport (session_t * s)
1388 transport_proto_t tp;
1389 if (s->session_state != SESSION_STATE_LISTENING)
1391 tp = session_get_transport_proto (s);
1392 return tp_vfts[tp].get_connection (s->connection_index,
1398 transport_connection_t *
1399 listen_session_get_transport (session_t * s)
1401 transport_proto_t tp = session_get_transport_proto (s);
1402 return tp_vfts[tp].get_listener (s->connection_index);
1406 listen_session_get_local_session_endpoint (session_t * listener,
1407 session_endpoint_t * sep)
1409 transport_proto_t tp = session_get_transport_proto (listener);
1410 transport_connection_t *tc;
1411 tc = tp_vfts[tp].get_listener (listener->connection_index);
1414 clib_warning ("no transport");
1418 /* N.B. The ip should not be copied because this is the local endpoint */
1419 sep->port = tc->lcl_port;
1420 sep->transport_proto = tc->proto;
1421 sep->is_ip4 = tc->is_ip4;
1426 session_flush_frames_main_thread (vlib_main_t * vm)
1428 ASSERT (vlib_get_thread_index () == 0);
1429 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1430 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1433 static clib_error_t *
1434 session_manager_main_enable (vlib_main_t * vm)
1436 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1437 session_manager_main_t *smm = &session_manager_main;
1438 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1439 u32 num_threads, preallocated_sessions_per_worker;
1440 session_manager_worker_t *wrk;
1443 num_threads = 1 /* main thread */ + vtm->n_threads;
1445 if (num_threads < 1)
1446 return clib_error_return (0, "n_thread_stacks not set");
1448 /* Allocate cache line aligned worker contexts */
1449 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1451 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1453 for (j = 0; j < num_threads; j++)
1454 smm->wrk[j].current_enqueue_epoch[i] = 1;
1457 for (i = 0; i < num_threads; i++)
1460 vec_validate (wrk->free_event_vector, 128);
1461 _vec_len (wrk->free_event_vector) = 0;
1462 vec_validate (wrk->pending_event_vector, 128);
1463 _vec_len (wrk->pending_event_vector) = 0;
1464 vec_validate (wrk->pending_disconnects, 128);
1465 _vec_len (wrk->pending_disconnects) = 0;
1466 vec_validate (wrk->postponed_event_vector, 128);
1467 _vec_len (wrk->postponed_event_vector) = 0;
1469 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1470 wrk->dispatch_period = 500e-6;
1472 if (num_threads > 1)
1473 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1477 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1480 /* Allocate vpp event queues segment and queue */
1481 session_vpp_event_queues_allocate (smm);
1483 /* Initialize fifo segment main baseva and timeout */
1484 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1485 sm_args->size = smm->session_va_space_size;
1486 segment_manager_main_init (sm_args);
1488 /* Preallocate sessions */
1489 if (smm->preallocated_sessions)
1491 if (num_threads == 1)
1493 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1498 preallocated_sessions_per_worker =
1499 (1.1 * (f64) smm->preallocated_sessions /
1500 (f64) (num_threads - 1));
1502 for (j = 1; j < num_threads; j++)
1504 pool_init_fixed (smm->wrk[j].sessions,
1505 preallocated_sessions_per_worker);
1510 session_lookup_init ();
1511 app_namespaces_init ();
1514 smm->is_enabled = 1;
1516 /* Enable transports */
1517 transport_enable_disable (vm, 1);
1518 transport_init_tx_pacers_period ();
1523 session_node_enable_disable (u8 is_en)
1525 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1526 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1527 u8 have_workers = vtm->n_threads != 0;
1530 foreach_vlib_main (({
1531 if (have_workers && ii == 0)
1533 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1537 vlib_node_t *n = vlib_get_node (this_vlib_main,
1538 session_queue_process_node.index);
1539 vlib_start_process (this_vlib_main, n->runtime_index);
1543 vlib_process_signal_event_mt (this_vlib_main,
1544 session_queue_process_node.index,
1545 SESSION_Q_PROCESS_STOP, 0);
1550 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1557 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1559 clib_error_t *error = 0;
1562 if (session_manager_main.is_enabled)
1565 session_node_enable_disable (is_en);
1566 error = session_manager_main_enable (vm);
1570 session_manager_main.is_enabled = 0;
1571 session_node_enable_disable (is_en);
1578 session_manager_main_init (vlib_main_t * vm)
1580 session_manager_main_t *smm = &session_manager_main;
1581 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1582 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1583 smm->session_va_space_size = 128ULL << 30;
1584 smm->evt_qs_segment_size = 64 << 20;
1586 smm->session_va_space_size = 128 << 20;
1587 smm->evt_qs_segment_size = 1 << 20;
1589 smm->is_enabled = 0;
1593 VLIB_INIT_FUNCTION (session_manager_main_init);
1595 static clib_error_t *
1596 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1598 session_manager_main_t *smm = &session_manager_main;
1602 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1604 if (unformat (input, "event-queue-length %d", &nitems))
1607 smm->configured_event_queue_length = nitems;
1609 clib_warning ("event queue length %d too small, ignored", nitems);
1611 else if (unformat (input, "preallocated-sessions %d",
1612 &smm->preallocated_sessions))
1614 else if (unformat (input, "v4-session-table-buckets %d",
1615 &smm->configured_v4_session_table_buckets))
1617 else if (unformat (input, "v4-halfopen-table-buckets %d",
1618 &smm->configured_v4_halfopen_table_buckets))
1620 else if (unformat (input, "v6-session-table-buckets %d",
1621 &smm->configured_v6_session_table_buckets))
1623 else if (unformat (input, "v6-halfopen-table-buckets %d",
1624 &smm->configured_v6_halfopen_table_buckets))
1626 else if (unformat (input, "v4-session-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->configured_v4_session_table_memory = tmp;
1634 else if (unformat (input, "v4-halfopen-table-memory %U",
1635 unformat_memory_size, &tmp))
1637 if (tmp >= 0x100000000)
1638 return clib_error_return (0, "memory size %llx (%lld) too large",
1640 smm->configured_v4_halfopen_table_memory = tmp;
1642 else if (unformat (input, "v6-session-table-memory %U",
1643 unformat_memory_size, &tmp))
1645 if (tmp >= 0x100000000)
1646 return clib_error_return (0, "memory size %llx (%lld) too large",
1648 smm->configured_v6_session_table_memory = tmp;
1650 else if (unformat (input, "v6-halfopen-table-memory %U",
1651 unformat_memory_size, &tmp))
1653 if (tmp >= 0x100000000)
1654 return clib_error_return (0, "memory size %llx (%lld) too large",
1656 smm->configured_v6_halfopen_table_memory = tmp;
1658 else if (unformat (input, "local-endpoints-table-memory %U",
1659 unformat_memory_size, &tmp))
1661 if (tmp >= 0x100000000)
1662 return clib_error_return (0, "memory size %llx (%lld) too large",
1664 smm->local_endpoints_table_memory = tmp;
1666 else if (unformat (input, "local-endpoints-table-buckets %d",
1667 &smm->local_endpoints_table_buckets))
1669 else if (unformat (input, "evt_qs_memfd_seg"))
1670 smm->evt_qs_use_memfd_seg = 1;
1672 return clib_error_return (0, "unknown input `%U'",
1673 format_unformat_error, input);
1678 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1681 * fd.io coding-style-patch-verification: ON
1684 * eval: (c-set-style "gnu")