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)
36 mq = session_main_get_vpp_event_queue (thread_index);
37 if (PREDICT_FALSE (svm_msg_q_lock (mq)))
39 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
41 svm_msg_q_unlock (mq);
44 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
45 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
47 svm_msg_q_unlock (mq);
50 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
51 evt->event_type = evt_type;
54 case SESSION_CTRL_EVT_RPC:
55 evt->rpc_args.fp = data;
56 evt->rpc_args.arg = args;
58 case SESSION_IO_EVT_RX:
59 case SESSION_IO_EVT_TX:
60 case SESSION_IO_EVT_TX_FLUSH:
61 case SESSION_IO_EVT_BUILTIN_RX:
62 evt->session_index = *(u32 *) data;
64 case SESSION_IO_EVT_BUILTIN_TX:
65 case SESSION_CTRL_EVT_CLOSE:
66 evt->session_handle = session_handle ((session_t *) data);
69 clib_warning ("evt unhandled!");
70 svm_msg_q_unlock (mq);
74 svm_msg_q_add_and_unlock (mq, &msg);
79 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
81 return session_send_evt_to_thread (&f->master_session_index, 0,
82 f->master_thread_index, evt_type);
86 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
87 session_evt_type_t evt_type)
89 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
93 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
95 /* only events supported are disconnect and reset */
96 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE
97 || evt_type == SESSION_CTRL_EVT_RESET);
98 return session_send_evt_to_thread (s, 0, s->thread_index, evt_type);
102 session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
105 session_send_evt_to_thread (fp, rpc_args, thread_index,
106 SESSION_CTRL_EVT_RPC);
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_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
116 void (*fnp) (void *) = fp;
122 session_add_self_custom_tx_evt (transport_connection_t * tc, u8 has_prio)
126 s = session_get (tc->s_index, tc->thread_index);
127 ASSERT (s->thread_index == vlib_get_thread_index ());
128 if (!(s->flags & SESSION_F_CUSTOM_TX))
130 s->flags |= SESSION_F_CUSTOM_TX;
131 if (svm_fifo_set_event (s->tx_fifo))
133 session_worker_t *wrk;
134 session_evt_elt_t *elt;
135 wrk = session_main_get_worker (tc->thread_index);
137 elt = session_evt_alloc_new (wrk);
139 elt = session_evt_alloc_old (wrk);
140 elt->evt.session_index = tc->s_index;
141 elt->evt.event_type = SESSION_IO_EVT_TX;
147 session_program_transport_ctrl_evt (session_t * s, session_evt_type_t evt)
149 u32 thread_index = vlib_get_thread_index ();
150 session_evt_elt_t *elt;
151 session_worker_t *wrk;
153 /* If we are in the handler thread, or being called with the worker barrier
154 * held, just append a new event to pending disconnects vector. */
155 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
157 wrk = session_main_get_worker (s->thread_index);
158 elt = session_evt_alloc_ctrl (wrk);
159 clib_memset (&elt->evt, 0, sizeof (session_event_t));
160 elt->evt.session_handle = session_handle (s);
161 elt->evt.event_type = evt;
164 session_send_ctrl_evt_to_thread (s, evt);
168 session_alloc (u32 thread_index)
170 session_worker_t *wrk = &session_main.wrk[thread_index];
173 pool_get_aligned_will_expand (wrk->sessions, will_expand,
174 CLIB_CACHE_LINE_BYTES);
175 /* If we have peekers, let them finish */
176 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
178 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
179 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
180 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
184 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
186 clib_memset (s, 0, sizeof (*s));
187 s->session_index = s - wrk->sessions;
188 s->thread_index = thread_index;
189 s->app_index = APP_INVALID_INDEX;
194 session_free (session_t * s)
198 u8 thread_index = s->thread_index;
199 clib_memset (s, 0xFA, sizeof (*s));
200 pool_put (session_main.wrk[thread_index].sessions, s);
203 SESSION_EVT (SESSION_EVT_FREE, s);
204 pool_put (session_main.wrk[s->thread_index].sessions, s);
208 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
210 app_worker_t *app_wrk;
212 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
215 app_worker_cleanup_notify (app_wrk, s, ntf);
219 session_free_w_fifos (session_t * s)
221 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
222 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
227 * Cleans up session and lookup table.
229 * Transport connection must still be valid.
232 session_delete (session_t * s)
236 /* Delete from the main lookup table. */
237 if ((rv = session_lookup_del_session (s)))
238 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
240 session_free_w_fifos (s);
244 session_alloc_for_connection (transport_connection_t * tc)
247 u32 thread_index = tc->thread_index;
249 ASSERT (thread_index == vlib_get_thread_index ()
250 || transport_protocol_is_cl (tc->proto));
252 s = session_alloc (thread_index);
253 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
254 s->session_state = SESSION_STATE_CLOSED;
256 /* Attach transport to session and vice versa */
257 s->connection_index = tc->c_index;
258 tc->s_index = s->session_index;
263 * Discards bytes from buffer chain
265 * It discards n_bytes_to_drop starting at first buffer after chain_b
268 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
269 vlib_buffer_t ** chain_b,
272 vlib_buffer_t *next = *chain_b;
273 u32 to_drop = n_bytes_to_drop;
274 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
275 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
277 next = vlib_get_buffer (vm, next->next_buffer);
278 if (next->current_length > to_drop)
280 vlib_buffer_advance (next, to_drop);
285 to_drop -= next->current_length;
286 next->current_length = 0;
292 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
296 * Enqueue buffer chain tail
299 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
300 u32 offset, u8 is_in_order)
302 vlib_buffer_t *chain_b;
303 u32 chain_bi, len, diff;
304 vlib_main_t *vm = vlib_get_main ();
309 if (is_in_order && offset)
311 diff = offset - b->current_length;
312 if (diff > b->total_length_not_including_first_buffer)
315 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
316 chain_bi = vlib_get_buffer_index (vm, chain_b);
319 chain_bi = b->next_buffer;
323 chain_b = vlib_get_buffer (vm, chain_bi);
324 data = vlib_buffer_get_current (chain_b);
325 len = chain_b->current_length;
330 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
337 return (rv > 0) ? (written + rv) : written;
343 /* written more than what was left in chain */
344 if (written > b->total_length_not_including_first_buffer)
347 /* drop the bytes that have already been delivered */
348 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
353 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
356 clib_warning ("failed to enqueue multi-buffer seg");
362 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
363 ? chain_b->next_buffer : 0));
372 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
373 * event but on request can queue notification events for later delivery by
374 * calling stream_server_flush_enqueue_events().
376 * @param tc Transport connection which is to be enqueued data
377 * @param b Buffer to be enqueued
378 * @param offset Offset at which to start enqueueing if out-of-order
379 * @param queue_event Flag to indicate if peer is to be notified or if event
380 * is to be queued. The former is useful when more data is
381 * enqueued and only one event is to be generated.
382 * @param is_in_order Flag to indicate if data is in order
383 * @return Number of bytes enqueued or a negative value if enqueueing failed.
386 session_enqueue_stream_connection (transport_connection_t * tc,
387 vlib_buffer_t * b, u32 offset,
388 u8 queue_event, u8 is_in_order)
391 int enqueued = 0, rv, in_order_off;
393 s = session_get (tc->s_index, tc->thread_index);
397 enqueued = svm_fifo_enqueue (s->rx_fifo,
399 vlib_buffer_get_current (b));
400 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
403 in_order_off = enqueued > b->current_length ? enqueued : 0;
404 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
411 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
413 vlib_buffer_get_current (b));
414 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
415 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
416 /* if something was enqueued, report even this as success for ooo
417 * segment handling */
423 /* Queue RX event on this fifo. Eventually these will need to be flushed
424 * by calling stream_server_flush_enqueue_events () */
425 session_worker_t *wrk;
427 wrk = session_main_get_worker (s->thread_index);
428 if (!(s->flags & SESSION_F_RX_EVT))
430 s->flags |= SESSION_F_RX_EVT;
431 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
439 session_enqueue_dgram_connection (session_t * s,
440 session_dgram_hdr_t * hdr,
441 vlib_buffer_t * b, u8 proto, u8 queue_event)
443 int enqueued = 0, rv, in_order_off;
445 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
446 >= b->current_length + sizeof (*hdr));
448 svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
449 enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
450 vlib_buffer_get_current (b));
451 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
453 in_order_off = enqueued > b->current_length ? enqueued : 0;
454 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
460 /* Queue RX event on this fifo. Eventually these will need to be flushed
461 * by calling stream_server_flush_enqueue_events () */
462 session_worker_t *wrk;
464 wrk = session_main_get_worker (s->thread_index);
465 if (!(s->flags & SESSION_F_RX_EVT))
467 s->flags |= SESSION_F_RX_EVT;
468 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
475 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
476 u32 offset, u32 max_bytes)
478 session_t *s = session_get (tc->s_index, tc->thread_index);
479 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
483 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
485 session_t *s = session_get (tc->s_index, tc->thread_index);
488 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
490 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
491 session_dequeue_notify (s);
497 session_notify_subscribers (u32 app_index, session_t * s,
498 svm_fifo_t * f, session_evt_type_t evt_type)
500 app_worker_t *app_wrk;
504 app = application_get (app_index);
508 for (i = 0; i < f->n_subscribers; i++)
510 app_wrk = application_get_worker (app, f->subscribers[i]);
513 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
521 * Notify session peer that new data has been enqueued.
523 * @param s Stream session for which the event is to be generated.
524 * @param lock Flag to indicate if call should lock message queue.
526 * @return 0 on success or negative number if failed to send notification.
529 session_enqueue_notify_inline (session_t * s)
531 app_worker_t *app_wrk;
535 session_index = s->session_index;
536 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
538 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
539 if (PREDICT_FALSE (!app_wrk))
541 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
545 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
547 s->flags &= ~SESSION_F_RX_EVT;
548 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
552 if (PREDICT_FALSE (n_subscribers))
554 s = session_get (session_index, vlib_get_thread_index ());
555 return session_notify_subscribers (app_wrk->app_index, s,
556 s->rx_fifo, SESSION_IO_EVT_RX);
563 session_enqueue_notify (session_t * s)
565 return session_enqueue_notify_inline (s);
569 session_enqueue_notify_rpc (void *arg)
571 u32 session_index = pointer_to_uword (arg);
574 s = session_get_if_valid (session_index, vlib_get_thread_index ());
578 session_enqueue_notify (s);
582 * Like session_enqueue_notify, but can be called from a thread that does not
586 session_enqueue_notify_thread (session_handle_t sh)
588 u32 thread_index = session_thread_from_handle (sh);
589 u32 session_index = session_index_from_handle (sh);
592 * Pass session index (u32) as opposed to handle (u64) in case pointers
595 session_send_rpc_evt_to_thread (thread_index,
596 session_enqueue_notify_rpc,
597 uword_to_pointer (session_index, void *));
601 session_dequeue_notify (session_t * s)
603 app_worker_t *app_wrk;
605 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
606 if (PREDICT_FALSE (!app_wrk))
609 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
613 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
614 return session_notify_subscribers (app_wrk->app_index, s,
615 s->tx_fifo, SESSION_IO_EVT_TX);
617 svm_fifo_clear_deq_ntf (s->tx_fifo);
623 * Flushes queue of sessions that are to be notified of new data
626 * @param thread_index Thread index for which the flush is to be performed.
627 * @return 0 on success or a positive number indicating the number of
628 * failures due to API queue being full.
631 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
633 session_worker_t *wrk = session_main_get_worker (thread_index);
638 indices = wrk->session_to_enqueue[transport_proto];
640 for (i = 0; i < vec_len (indices); i++)
642 s = session_get_if_valid (indices[i], thread_index);
643 if (PREDICT_FALSE (!s))
649 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
653 vec_reset_length (indices);
654 wrk->session_to_enqueue[transport_proto] = indices;
660 session_main_flush_all_enqueue_events (u8 transport_proto)
662 vlib_thread_main_t *vtm = vlib_get_thread_main ();
664 for (i = 0; i < 1 + vtm->n_threads; i++)
665 errors += session_main_flush_enqueue_events (transport_proto, i);
670 session_stream_connect_notify_inline (transport_connection_t * tc, u8 is_fail,
671 session_state_t opened_state)
673 u32 opaque = 0, new_ti, new_si;
674 app_worker_t *app_wrk;
679 * Find connection handle and cleanup half-open table
681 ho_handle = session_lookup_half_open_handle (tc);
682 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
684 SESSION_DBG ("half-open was removed!");
687 session_lookup_del_half_open (tc);
689 /* Get the app's index from the handle we stored when opening connection
690 * and the opaque (api_context for external apps) from transport session
692 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
696 opaque = tc->s_index;
699 return app_worker_connect_notify (app_wrk, s, opaque);
701 s = session_alloc_for_connection (tc);
702 s->session_state = SESSION_STATE_CONNECTING;
703 s->app_wrk_index = app_wrk->wrk_index;
704 new_si = s->session_index;
705 new_ti = s->thread_index;
707 if (app_worker_init_connected (app_wrk, s))
710 app_worker_connect_notify (app_wrk, 0, opaque);
714 s = session_get (new_si, new_ti);
715 s->session_state = opened_state;
716 session_lookup_add_connection (tc, session_handle (s));
718 if (app_worker_connect_notify (app_wrk, s, opaque))
720 s = session_get (new_si, new_ti);
721 session_free_w_fifos (s);
729 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
731 return session_stream_connect_notify_inline (tc, is_fail,
732 SESSION_STATE_READY);
736 session_ho_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
738 return session_stream_connect_notify_inline (tc, is_fail,
739 SESSION_STATE_OPENED);
742 typedef struct _session_switch_pool_args
746 u32 new_thread_index;
747 u32 new_session_index;
748 } session_switch_pool_args_t;
751 * Notify old thread of the session pool switch
754 session_switch_pool (void *cb_args)
756 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
757 app_worker_t *app_wrk;
760 ASSERT (args->thread_index == vlib_get_thread_index ());
761 s = session_get (args->session_index, args->thread_index);
762 s->tx_fifo->master_session_index = args->new_session_index;
763 s->tx_fifo->master_thread_index = args->new_thread_index;
764 transport_cleanup (session_get_transport_proto (s), s->connection_index,
767 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
770 session_handle_t new_sh;
771 new_sh = session_make_handle (args->new_session_index,
772 args->new_thread_index);
773 app_worker_migrate_notify (app_wrk, s, new_sh);
775 /* Trigger app read on the new thread */
776 session_enqueue_notify_thread (new_sh);
780 clib_mem_free (cb_args);
784 * Move dgram session to the right thread
787 session_dgram_connect_notify (transport_connection_t * tc,
788 u32 old_thread_index, session_t ** new_session)
791 session_switch_pool_args_t *rpc_args;
794 * Clone half-open session to the right thread.
796 new_s = session_clone_safe (tc->s_index, old_thread_index);
797 new_s->connection_index = tc->c_index;
798 new_s->rx_fifo->master_session_index = new_s->session_index;
799 new_s->rx_fifo->master_thread_index = new_s->thread_index;
800 new_s->session_state = SESSION_STATE_READY;
801 session_lookup_add_connection (tc, session_handle (new_s));
804 * Ask thread owning the old session to clean it up and make us the tx
807 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
808 rpc_args->new_session_index = new_s->session_index;
809 rpc_args->new_thread_index = new_s->thread_index;
810 rpc_args->session_index = tc->s_index;
811 rpc_args->thread_index = old_thread_index;
812 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
815 tc->s_index = new_s->session_index;
816 new_s->connection_index = tc->c_index;
817 *new_session = new_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;
834 s = session_get (tc->s_index, tc->thread_index);
835 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
837 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
838 app_wrk = app_worker_get (s->app_wrk_index);
839 app_worker_close_notify (app_wrk, s);
843 * Notification from transport that connection is being deleted
845 * This removes the session if it is still valid. It should be called only on
846 * previously fully established sessions. For instance failed connects should
847 * call stream_session_connect_notify and indicate that the connect has
851 session_transport_delete_notify (transport_connection_t * tc)
855 /* App might've been removed already */
856 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
859 switch (s->session_state)
861 case SESSION_STATE_CREATED:
862 /* Session was created but accept notification was not yet sent to the
863 * app. Cleanup everything. */
864 session_lookup_del_session (s);
865 session_free_w_fifos (s);
867 case SESSION_STATE_ACCEPTING:
868 case SESSION_STATE_TRANSPORT_CLOSING:
869 case SESSION_STATE_CLOSING:
870 case SESSION_STATE_TRANSPORT_CLOSED:
871 /* If transport finishes or times out before we get a reply
872 * from the app, mark transport as closed and wait for reply
873 * before removing the session. Cleanup session table in advance
874 * because transport will soon be closed and closed sessions
875 * are assumed to have been removed from the lookup table */
876 session_lookup_del_session (s);
877 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
878 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
879 svm_fifo_dequeue_drop_all (s->tx_fifo);
881 case SESSION_STATE_APP_CLOSED:
882 /* Cleanup lookup table as transport needs to still be valid.
883 * Program transport close to ensure that all session events
884 * have been cleaned up. Once transport close is called, the
885 * session is just removed because both transport and app have
886 * confirmed the close*/
887 session_lookup_del_session (s);
888 s->session_state = SESSION_STATE_CLOSED;
889 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
890 svm_fifo_dequeue_drop_all (s->tx_fifo);
891 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
893 case SESSION_STATE_TRANSPORT_DELETED:
895 case SESSION_STATE_CLOSED:
896 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
900 clib_warning ("session state %u", s->session_state);
901 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
908 * Notification from transport that it is closed
910 * Should be called by transport, prior to calling delete notify, once it
911 * knows that no more data will be exchanged. This could serve as an
912 * early acknowledgment of an active close especially if transport delete
913 * can be delayed a long time, e.g., tcp time-wait.
916 session_transport_closed_notify (transport_connection_t * tc)
918 app_worker_t *app_wrk;
921 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
924 /* Transport thinks that app requested close but it actually didn't.
925 * Can happen for tcp if fin and rst are received in close succession. */
926 if (s->session_state == SESSION_STATE_READY)
928 session_transport_closing_notify (tc);
929 svm_fifo_dequeue_drop_all (s->tx_fifo);
930 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
932 /* If app close has not been received or has not yet resulted in
933 * a transport close, only mark the session transport as closed */
934 else if (s->session_state <= SESSION_STATE_CLOSING)
936 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
938 /* If app also closed, switch to closed */
939 else if (s->session_state == SESSION_STATE_APP_CLOSED)
940 s->session_state = SESSION_STATE_CLOSED;
942 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
944 app_worker_transport_closed_notify (app_wrk, s);
948 * Notify application that connection has been reset.
951 session_transport_reset_notify (transport_connection_t * tc)
953 app_worker_t *app_wrk;
956 s = session_get (tc->s_index, tc->thread_index);
957 svm_fifo_dequeue_drop_all (s->tx_fifo);
958 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
960 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
961 app_wrk = app_worker_get (s->app_wrk_index);
962 app_worker_reset_notify (app_wrk, s);
966 session_stream_accept_notify (transport_connection_t * tc)
968 app_worker_t *app_wrk;
971 s = session_get (tc->s_index, tc->thread_index);
972 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
975 s->session_state = SESSION_STATE_ACCEPTING;
976 return app_worker_accept_notify (app_wrk, s);
980 * Accept a stream session. Optionally ping the server by callback.
983 session_stream_accept (transport_connection_t * tc, u32 listener_index,
984 u32 thread_index, u8 notify)
989 s = session_alloc_for_connection (tc);
990 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
991 s->session_state = SESSION_STATE_CREATED;
993 if ((rv = app_worker_init_accepted (s)))
996 session_lookup_add_connection (tc, session_handle (s));
998 /* Shoulder-tap the server */
1001 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1002 return app_worker_accept_notify (app_wrk, s);
1009 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1011 transport_connection_t *tc;
1012 transport_endpoint_cfg_t *tep;
1013 app_worker_t *app_wrk;
1014 session_handle_t sh;
1018 tep = session_endpoint_to_transport_cfg (rmt);
1019 rv = transport_connect (rmt->transport_proto, tep);
1022 SESSION_DBG ("Transport failed to open connection.");
1023 return VNET_API_ERROR_SESSION_CONNECT;
1026 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1028 /* For dgram type of service, allocate session and fifos now */
1029 app_wrk = app_worker_get (app_wrk_index);
1030 s = session_alloc_for_connection (tc);
1031 s->app_wrk_index = app_wrk->wrk_index;
1032 s->session_state = SESSION_STATE_OPENED;
1033 if (app_worker_init_connected (app_wrk, s))
1039 sh = session_handle (s);
1040 session_lookup_add_connection (tc, sh);
1041 return app_worker_connect_notify (app_wrk, s, opaque);
1045 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1047 transport_connection_t *tc;
1048 transport_endpoint_cfg_t *tep;
1052 tep = session_endpoint_to_transport_cfg (rmt);
1053 rv = transport_connect (rmt->transport_proto, tep);
1056 SESSION_DBG ("Transport failed to open connection.");
1057 return VNET_API_ERROR_SESSION_CONNECT;
1060 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1062 /* If transport offers a stream service, only allocate session once the
1063 * connection has been established.
1064 * Add connection to half-open table and save app and tc index. The
1065 * latter is needed to help establish the connection while the former
1066 * is needed when the connect notify comes and we have to notify the
1069 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1070 session_lookup_add_half_open (tc, handle);
1072 /* Store api_context (opaque) for when the reply comes. Not the nicest
1073 * thing but better than allocating a separate half-open pool.
1075 tc->s_index = opaque;
1076 if (transport_half_open_has_fifos (rmt->transport_proto))
1077 return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1082 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1084 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1085 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1087 sep->app_wrk_index = app_wrk_index;
1088 sep->opaque = opaque;
1090 return transport_connect (rmt->transport_proto, tep_cfg);
1093 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1096 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1104 * Ask transport to open connection to remote transport endpoint.
1106 * Stores handle for matching request with reply since the call can be
1107 * asynchronous. For instance, for TCP the 3-way handshake must complete
1108 * before reply comes. Session is only created once connection is established.
1110 * @param app_index Index of the application requesting the connect
1111 * @param st Session type requested.
1112 * @param tep Remote transport endpoint
1113 * @param opaque Opaque data (typically, api_context) the application expects
1114 * on open completion.
1117 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1119 transport_service_type_t tst;
1120 tst = transport_protocol_service_type (rmt->transport_proto);
1121 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1125 * Ask transport to listen on session endpoint.
1127 * @param s Session for which listen will be called. Note that unlike
1128 * established sessions, listen sessions are not associated to a
1130 * @param sep Local endpoint to be listened on.
1133 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1135 transport_endpoint_t *tep;
1136 u32 tc_index, s_index;
1138 /* Transport bind/listen */
1139 tep = session_endpoint_to_transport (sep);
1140 s_index = ls->session_index;
1141 tc_index = transport_start_listen (session_get_transport_proto (ls),
1144 if (tc_index == (u32) ~ 0)
1147 /* Attach transport to session. Lookup tables are populated by the app
1148 * worker because local tables (for ct sessions) are not backed by a fib */
1149 ls = listen_session_get (s_index);
1150 ls->connection_index = tc_index;
1156 * Ask transport to stop listening on local transport endpoint.
1158 * @param s Session to stop listening on. It must be in state LISTENING.
1161 session_stop_listen (session_t * s)
1163 transport_proto_t tp = session_get_transport_proto (s);
1164 transport_connection_t *tc;
1166 if (s->session_state != SESSION_STATE_LISTENING)
1169 tc = transport_get_listener (tp, s->connection_index);
1171 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1173 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1174 session_lookup_del_connection (tc);
1175 transport_stop_listen (tp, s->connection_index);
1180 * Initialize session closing procedure.
1182 * Request is always sent to session node to ensure that all outstanding
1183 * requests are served before transport is notified.
1186 session_close (session_t * s)
1191 if (s->session_state >= SESSION_STATE_CLOSING)
1193 /* Session will only be removed once both app and transport
1194 * acknowledge the close */
1195 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1196 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1197 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1201 s->session_state = SESSION_STATE_CLOSING;
1202 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1206 * Force a close without waiting for data to be flushed
1209 session_reset (session_t * s)
1211 if (s->session_state >= SESSION_STATE_CLOSING)
1213 /* Drop all outstanding tx data */
1214 svm_fifo_dequeue_drop_all (s->tx_fifo);
1215 s->session_state = SESSION_STATE_CLOSING;
1216 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1220 * Notify transport the session can be disconnected. This should eventually
1221 * result in a delete notification that allows us to cleanup session state.
1222 * Called for both active/passive disconnects.
1224 * Must be called from the session's thread.
1227 session_transport_close (session_t * s)
1229 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1231 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1232 s->session_state = SESSION_STATE_CLOSED;
1233 /* If transport is already deleted, just free the session */
1234 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1235 session_free_w_fifos (s);
1239 /* If the tx queue wasn't drained, the transport can continue to try
1240 * sending the outstanding data (in closed state it cannot). It MUST however
1241 * at one point, either after sending everything or after a timeout, call
1242 * delete notify. This will finally lead to the complete cleanup of the
1245 s->session_state = SESSION_STATE_APP_CLOSED;
1247 transport_close (session_get_transport_proto (s), s->connection_index,
1252 * Force transport close
1255 session_transport_reset (session_t * s)
1257 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1259 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1260 s->session_state = SESSION_STATE_CLOSED;
1261 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1262 session_free_w_fifos (s);
1266 s->session_state = SESSION_STATE_APP_CLOSED;
1267 transport_reset (session_get_transport_proto (s), s->connection_index,
1272 * Cleanup transport and session state.
1274 * Notify transport of the cleanup and free the session. This should
1275 * be called only if transport reported some error and is already
1279 session_transport_cleanup (session_t * s)
1281 s->session_state = SESSION_STATE_CLOSED;
1283 /* Delete from main lookup table before we axe the the transport */
1284 session_lookup_del_session (s);
1285 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1287 /* Since we called cleanup, no delete notification will come. So, make
1288 * sure the session is properly freed. */
1289 session_free_w_fifos (s);
1293 * Allocate event queues in the shared-memory segment
1295 * That can either be a newly created memfd segment, that will need to be
1296 * mapped by all stack users, or the binary api's svm region. The latter is
1297 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1298 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1299 * vpp uses api svm region for event queues.
1302 session_vpp_event_queues_allocate (session_main_t * smm)
1304 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1305 ssvm_private_t *eqs = &smm->evt_qs_segment;
1306 api_main_t *am = &api_main;
1307 uword eqs_size = 64 << 20;
1308 pid_t vpp_pid = getpid ();
1312 if (smm->configured_event_queue_length)
1313 evt_q_length = smm->configured_event_queue_length;
1315 if (smm->evt_qs_use_memfd_seg)
1317 if (smm->evt_qs_segment_size)
1318 eqs_size = smm->evt_qs_segment_size;
1320 eqs->ssvm_size = eqs_size;
1321 eqs->i_am_master = 1;
1322 eqs->my_pid = vpp_pid;
1323 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1324 eqs->requested_va = smm->session_baseva;
1326 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1328 clib_warning ("failed to initialize queue segment");
1333 if (smm->evt_qs_use_memfd_seg)
1334 oldheap = ssvm_push_heap (eqs->sh);
1336 oldheap = svm_push_data_heap (am->vlib_rp);
1338 for (i = 0; i < vec_len (smm->wrk); i++)
1340 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1341 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1342 {evt_q_length, evt_size, 0}
1344 {evt_q_length >> 1, 256, 0}
1346 cfg->consumer_pid = 0;
1348 cfg->q_nitems = evt_q_length;
1349 cfg->ring_cfgs = rc;
1350 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1351 if (smm->evt_qs_use_memfd_seg)
1353 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1354 clib_warning ("eventfd returned");
1358 if (smm->evt_qs_use_memfd_seg)
1359 ssvm_pop_heap (oldheap);
1361 svm_pop_heap (oldheap);
1365 session_main_get_evt_q_segment (void)
1367 session_main_t *smm = &session_main;
1368 if (smm->evt_qs_use_memfd_seg)
1369 return &smm->evt_qs_segment;
1374 session_segment_handle (session_t * s)
1379 return SESSION_INVALID_HANDLE;
1382 return segment_manager_make_segment_handle (f->segment_manager,
1387 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1388 session_tx_fifo_peek_and_snd,
1389 session_tx_fifo_dequeue_and_snd,
1390 session_tx_fifo_dequeue_internal,
1391 session_tx_fifo_dequeue_and_snd
1396 * Initialize session layer for given transport proto and ip version
1398 * Allocates per session type (transport proto + ip version) data structures
1399 * and adds arc from session queue node to session type output node.
1402 session_register_transport (transport_proto_t transport_proto,
1403 const transport_proto_vft_t * vft, u8 is_ip4,
1406 session_main_t *smm = &session_main;
1407 session_type_t session_type;
1408 u32 next_index = ~0;
1410 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1412 vec_validate (smm->session_type_to_next, session_type);
1413 vec_validate (smm->session_tx_fns, session_type);
1416 if (output_node != ~0)
1418 foreach_vlib_main (({
1419 next_index = vlib_node_add_next (this_vlib_main,
1420 session_queue_node.index,
1426 smm->session_type_to_next[session_type] = next_index;
1427 smm->session_tx_fns[session_type] =
1428 session_tx_fns[vft->transport_options.tx_type];
1431 transport_connection_t *
1432 session_get_transport (session_t * s)
1434 if (s->session_state != SESSION_STATE_LISTENING)
1435 return transport_get_connection (session_get_transport_proto (s),
1436 s->connection_index, s->thread_index);
1438 return transport_get_listener (session_get_transport_proto (s),
1439 s->connection_index);
1443 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1445 if (s->session_state != SESSION_STATE_LISTENING)
1446 return transport_get_endpoint (session_get_transport_proto (s),
1447 s->connection_index, s->thread_index, tep,
1450 return transport_get_listener_endpoint (session_get_transport_proto (s),
1451 s->connection_index, tep, is_lcl);
1454 transport_connection_t *
1455 listen_session_get_transport (session_t * s)
1457 return transport_get_listener (session_get_transport_proto (s),
1458 s->connection_index);
1462 session_flush_frames_main_thread (vlib_main_t * vm)
1464 ASSERT (vlib_get_thread_index () == 0);
1465 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1466 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1469 static clib_error_t *
1470 session_manager_main_enable (vlib_main_t * vm)
1472 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1473 session_main_t *smm = &session_main;
1474 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1475 u32 num_threads, preallocated_sessions_per_worker;
1476 session_worker_t *wrk;
1479 num_threads = 1 /* main thread */ + vtm->n_threads;
1481 if (num_threads < 1)
1482 return clib_error_return (0, "n_thread_stacks not set");
1484 /* Allocate cache line aligned worker contexts */
1485 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1487 for (i = 0; i < num_threads; i++)
1490 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1491 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1492 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1493 wrk->vm = vlib_mains[i];
1494 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1496 if (num_threads > 1)
1497 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1500 /* Allocate vpp event queues segment and queue */
1501 session_vpp_event_queues_allocate (smm);
1503 /* Initialize fifo segment main baseva and timeout */
1504 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1505 sm_args->size = smm->session_va_space_size;
1506 segment_manager_main_init (sm_args);
1508 /* Preallocate sessions */
1509 if (smm->preallocated_sessions)
1511 if (num_threads == 1)
1513 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1518 preallocated_sessions_per_worker =
1519 (1.1 * (f64) smm->preallocated_sessions /
1520 (f64) (num_threads - 1));
1522 for (j = 1; j < num_threads; j++)
1524 pool_init_fixed (smm->wrk[j].sessions,
1525 preallocated_sessions_per_worker);
1530 session_lookup_init ();
1531 app_namespaces_init ();
1534 smm->is_enabled = 1;
1536 /* Enable transports */
1537 transport_enable_disable (vm, 1);
1538 transport_init_tx_pacers_period ();
1543 session_node_enable_disable (u8 is_en)
1545 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1546 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1547 u8 have_workers = vtm->n_threads != 0;
1550 foreach_vlib_main (({
1551 if (have_workers && ii == 0)
1553 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1557 vlib_node_t *n = vlib_get_node (this_vlib_main,
1558 session_queue_process_node.index);
1559 vlib_start_process (this_vlib_main, n->runtime_index);
1563 vlib_process_signal_event_mt (this_vlib_main,
1564 session_queue_process_node.index,
1565 SESSION_Q_PROCESS_STOP, 0);
1570 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1577 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1579 clib_error_t *error = 0;
1582 if (session_main.is_enabled)
1585 error = session_manager_main_enable (vm);
1586 session_node_enable_disable (is_en);
1590 session_main.is_enabled = 0;
1591 session_node_enable_disable (is_en);
1598 session_manager_main_init (vlib_main_t * vm)
1600 session_main_t *smm = &session_main;
1601 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1602 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1603 smm->session_va_space_size = 128ULL << 30;
1604 smm->evt_qs_segment_size = 64 << 20;
1606 smm->session_va_space_size = 128 << 20;
1607 smm->evt_qs_segment_size = 1 << 20;
1609 smm->is_enabled = 0;
1613 VLIB_INIT_FUNCTION (session_manager_main_init);
1615 static clib_error_t *
1616 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1618 session_main_t *smm = &session_main;
1622 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1624 if (unformat (input, "event-queue-length %d", &nitems))
1627 smm->configured_event_queue_length = nitems;
1629 clib_warning ("event queue length %d too small, ignored", nitems);
1631 else if (unformat (input, "preallocated-sessions %d",
1632 &smm->preallocated_sessions))
1634 else if (unformat (input, "v4-session-table-buckets %d",
1635 &smm->configured_v4_session_table_buckets))
1637 else if (unformat (input, "v4-halfopen-table-buckets %d",
1638 &smm->configured_v4_halfopen_table_buckets))
1640 else if (unformat (input, "v6-session-table-buckets %d",
1641 &smm->configured_v6_session_table_buckets))
1643 else if (unformat (input, "v6-halfopen-table-buckets %d",
1644 &smm->configured_v6_halfopen_table_buckets))
1646 else if (unformat (input, "v4-session-table-memory %U",
1647 unformat_memory_size, &tmp))
1649 if (tmp >= 0x100000000)
1650 return clib_error_return (0, "memory size %llx (%lld) too large",
1652 smm->configured_v4_session_table_memory = tmp;
1654 else if (unformat (input, "v4-halfopen-table-memory %U",
1655 unformat_memory_size, &tmp))
1657 if (tmp >= 0x100000000)
1658 return clib_error_return (0, "memory size %llx (%lld) too large",
1660 smm->configured_v4_halfopen_table_memory = tmp;
1662 else if (unformat (input, "v6-session-table-memory %U",
1663 unformat_memory_size, &tmp))
1665 if (tmp >= 0x100000000)
1666 return clib_error_return (0, "memory size %llx (%lld) too large",
1668 smm->configured_v6_session_table_memory = tmp;
1670 else if (unformat (input, "v6-halfopen-table-memory %U",
1671 unformat_memory_size, &tmp))
1673 if (tmp >= 0x100000000)
1674 return clib_error_return (0, "memory size %llx (%lld) too large",
1676 smm->configured_v6_halfopen_table_memory = tmp;
1678 else if (unformat (input, "local-endpoints-table-memory %U",
1679 unformat_memory_size, &tmp))
1681 if (tmp >= 0x100000000)
1682 return clib_error_return (0, "memory size %llx (%lld) too large",
1684 smm->local_endpoints_table_memory = tmp;
1686 else if (unformat (input, "local-endpoints-table-buckets %d",
1687 &smm->local_endpoints_table_buckets))
1689 else if (unformat (input, "evt_qs_memfd_seg"))
1690 smm->evt_qs_use_memfd_seg = 1;
1691 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1692 &smm->evt_qs_segment_size))
1695 return clib_error_return (0, "unknown input `%U'",
1696 format_unformat_error, input);
1701 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1704 * fd.io coding-style-patch-verification: ON
1707 * eval: (c-set-style "gnu")