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);
46 case SESSION_CTRL_EVT_RPC:
47 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
48 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
49 evt->rpc_args.fp = data;
50 evt->rpc_args.arg = args;
52 case SESSION_IO_EVT_RX:
53 case SESSION_IO_EVT_TX:
54 case SESSION_IO_EVT_TX_FLUSH:
55 case SESSION_IO_EVT_BUILTIN_RX:
56 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
57 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
58 evt->session_index = *(u32 *) data;
60 case SESSION_IO_EVT_BUILTIN_TX:
61 case SESSION_CTRL_EVT_CLOSE:
62 case SESSION_CTRL_EVT_RESET:
63 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
64 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
65 evt->session_handle = session_handle ((session_t *) data);
68 clib_warning ("evt unhandled!");
69 svm_msg_q_unlock (mq);
72 evt->event_type = evt_type;
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 ASSERT (s->session_state < SESSION_STATE_TRANSPORT_DELETED);
129 if (!(s->flags & SESSION_F_CUSTOM_TX))
131 s->flags |= SESSION_F_CUSTOM_TX;
132 if (svm_fifo_set_event (s->tx_fifo))
134 session_worker_t *wrk;
135 session_evt_elt_t *elt;
136 wrk = session_main_get_worker (tc->thread_index);
138 elt = session_evt_alloc_new (wrk);
140 elt = session_evt_alloc_old (wrk);
141 elt->evt.session_index = tc->s_index;
142 elt->evt.event_type = SESSION_IO_EVT_TX;
148 session_program_transport_ctrl_evt (session_t * s, session_evt_type_t evt)
150 u32 thread_index = vlib_get_thread_index ();
151 session_evt_elt_t *elt;
152 session_worker_t *wrk;
154 /* If we are in the handler thread, or being called with the worker barrier
155 * held, just append a new event to pending disconnects vector. */
156 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
158 wrk = session_main_get_worker (s->thread_index);
159 elt = session_evt_alloc_ctrl (wrk);
160 clib_memset (&elt->evt, 0, sizeof (session_event_t));
161 elt->evt.session_handle = session_handle (s);
162 elt->evt.event_type = evt;
165 session_send_ctrl_evt_to_thread (s, evt);
169 session_alloc (u32 thread_index)
171 session_worker_t *wrk = &session_main.wrk[thread_index];
174 pool_get_aligned_will_expand (wrk->sessions, will_expand,
175 CLIB_CACHE_LINE_BYTES);
176 /* If we have peekers, let them finish */
177 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
179 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
180 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
181 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
185 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
187 clib_memset (s, 0, sizeof (*s));
188 s->session_index = s - wrk->sessions;
189 s->thread_index = thread_index;
190 s->app_index = APP_INVALID_INDEX;
195 session_free (session_t * s)
199 u8 thread_index = s->thread_index;
200 clib_memset (s, 0xFA, sizeof (*s));
201 pool_put (session_main.wrk[thread_index].sessions, s);
204 SESSION_EVT (SESSION_EVT_FREE, s);
205 pool_put (session_main.wrk[s->thread_index].sessions, s);
209 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
211 app_worker_t *app_wrk;
213 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
216 app_worker_cleanup_notify (app_wrk, s, ntf);
220 session_free_w_fifos (session_t * s)
222 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
223 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
228 * Cleans up session and lookup table.
230 * Transport connection must still be valid.
233 session_delete (session_t * s)
237 /* Delete from the main lookup table. */
238 if ((rv = session_lookup_del_session (s)))
239 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
241 session_free_w_fifos (s);
245 session_alloc_for_connection (transport_connection_t * tc)
248 u32 thread_index = tc->thread_index;
250 ASSERT (thread_index == vlib_get_thread_index ()
251 || transport_protocol_is_cl (tc->proto));
253 s = session_alloc (thread_index);
254 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
255 s->session_state = SESSION_STATE_CLOSED;
257 /* Attach transport to session and vice versa */
258 s->connection_index = tc->c_index;
259 tc->s_index = s->session_index;
264 * Discards bytes from buffer chain
266 * It discards n_bytes_to_drop starting at first buffer after chain_b
269 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
270 vlib_buffer_t ** chain_b,
273 vlib_buffer_t *next = *chain_b;
274 u32 to_drop = n_bytes_to_drop;
275 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
276 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
278 next = vlib_get_buffer (vm, next->next_buffer);
279 if (next->current_length > to_drop)
281 vlib_buffer_advance (next, to_drop);
286 to_drop -= next->current_length;
287 next->current_length = 0;
293 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
297 * Enqueue buffer chain tail
300 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
301 u32 offset, u8 is_in_order)
303 vlib_buffer_t *chain_b;
304 u32 chain_bi, len, diff;
305 vlib_main_t *vm = vlib_get_main ();
310 if (is_in_order && offset)
312 diff = offset - b->current_length;
313 if (diff > b->total_length_not_including_first_buffer)
316 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
317 chain_bi = vlib_get_buffer_index (vm, chain_b);
320 chain_bi = b->next_buffer;
324 chain_b = vlib_get_buffer (vm, chain_bi);
325 data = vlib_buffer_get_current (chain_b);
326 len = chain_b->current_length;
331 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
338 return (rv > 0) ? (written + rv) : written;
344 /* written more than what was left in chain */
345 if (written > b->total_length_not_including_first_buffer)
348 /* drop the bytes that have already been delivered */
349 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
354 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
357 clib_warning ("failed to enqueue multi-buffer seg");
363 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
364 ? chain_b->next_buffer : 0));
373 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
374 * event but on request can queue notification events for later delivery by
375 * calling stream_server_flush_enqueue_events().
377 * @param tc Transport connection which is to be enqueued data
378 * @param b Buffer to be enqueued
379 * @param offset Offset at which to start enqueueing if out-of-order
380 * @param queue_event Flag to indicate if peer is to be notified or if event
381 * is to be queued. The former is useful when more data is
382 * enqueued and only one event is to be generated.
383 * @param is_in_order Flag to indicate if data is in order
384 * @return Number of bytes enqueued or a negative value if enqueueing failed.
387 session_enqueue_stream_connection (transport_connection_t * tc,
388 vlib_buffer_t * b, u32 offset,
389 u8 queue_event, u8 is_in_order)
392 int enqueued = 0, rv, in_order_off;
394 s = session_get (tc->s_index, tc->thread_index);
398 enqueued = svm_fifo_enqueue (s->rx_fifo,
400 vlib_buffer_get_current (b));
401 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
404 in_order_off = enqueued > b->current_length ? enqueued : 0;
405 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
412 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
414 vlib_buffer_get_current (b));
415 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
416 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
417 /* if something was enqueued, report even this as success for ooo
418 * segment handling */
424 /* Queue RX event on this fifo. Eventually these will need to be flushed
425 * by calling stream_server_flush_enqueue_events () */
426 session_worker_t *wrk;
428 wrk = session_main_get_worker (s->thread_index);
429 if (!(s->flags & SESSION_F_RX_EVT))
431 s->flags |= SESSION_F_RX_EVT;
432 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
440 session_enqueue_dgram_connection (session_t * s,
441 session_dgram_hdr_t * hdr,
442 vlib_buffer_t * b, u8 proto, u8 queue_event)
444 int enqueued = 0, rv, in_order_off;
446 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
447 >= b->current_length + sizeof (*hdr));
449 svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
450 enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
451 vlib_buffer_get_current (b));
452 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
454 in_order_off = enqueued > b->current_length ? enqueued : 0;
455 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
461 /* Queue RX event on this fifo. Eventually these will need to be flushed
462 * by calling stream_server_flush_enqueue_events () */
463 session_worker_t *wrk;
465 wrk = session_main_get_worker (s->thread_index);
466 if (!(s->flags & SESSION_F_RX_EVT))
468 s->flags |= SESSION_F_RX_EVT;
469 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
476 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
477 u32 offset, u32 max_bytes)
479 session_t *s = session_get (tc->s_index, tc->thread_index);
480 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
484 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
486 session_t *s = session_get (tc->s_index, tc->thread_index);
489 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
491 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
492 session_dequeue_notify (s);
498 session_notify_subscribers (u32 app_index, session_t * s,
499 svm_fifo_t * f, session_evt_type_t evt_type)
501 app_worker_t *app_wrk;
505 app = application_get (app_index);
509 for (i = 0; i < f->n_subscribers; i++)
511 app_wrk = application_get_worker (app, f->subscribers[i]);
514 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
522 * Notify session peer that new data has been enqueued.
524 * @param s Stream session for which the event is to be generated.
525 * @param lock Flag to indicate if call should lock message queue.
527 * @return 0 on success or negative number if failed to send notification.
530 session_enqueue_notify_inline (session_t * s)
532 app_worker_t *app_wrk;
536 session_index = s->session_index;
537 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
539 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
540 if (PREDICT_FALSE (!app_wrk))
542 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
546 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
548 s->flags &= ~SESSION_F_RX_EVT;
549 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
553 if (PREDICT_FALSE (n_subscribers))
555 s = session_get (session_index, vlib_get_thread_index ());
556 return session_notify_subscribers (app_wrk->app_index, s,
557 s->rx_fifo, SESSION_IO_EVT_RX);
564 session_enqueue_notify (session_t * s)
566 return session_enqueue_notify_inline (s);
570 session_enqueue_notify_rpc (void *arg)
572 u32 session_index = pointer_to_uword (arg);
575 s = session_get_if_valid (session_index, vlib_get_thread_index ());
579 session_enqueue_notify (s);
583 * Like session_enqueue_notify, but can be called from a thread that does not
587 session_enqueue_notify_thread (session_handle_t sh)
589 u32 thread_index = session_thread_from_handle (sh);
590 u32 session_index = session_index_from_handle (sh);
593 * Pass session index (u32) as opposed to handle (u64) in case pointers
596 session_send_rpc_evt_to_thread (thread_index,
597 session_enqueue_notify_rpc,
598 uword_to_pointer (session_index, void *));
602 session_dequeue_notify (session_t * s)
604 app_worker_t *app_wrk;
606 svm_fifo_clear_deq_ntf (s->tx_fifo);
608 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
609 if (PREDICT_FALSE (!app_wrk))
612 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
616 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
617 return session_notify_subscribers (app_wrk->app_index, s,
618 s->tx_fifo, SESSION_IO_EVT_TX);
624 * Flushes queue of sessions that are to be notified of new data
627 * @param thread_index Thread index for which the flush is to be performed.
628 * @return 0 on success or a positive number indicating the number of
629 * failures due to API queue being full.
632 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
634 session_worker_t *wrk = session_main_get_worker (thread_index);
639 indices = wrk->session_to_enqueue[transport_proto];
641 for (i = 0; i < vec_len (indices); i++)
643 s = session_get_if_valid (indices[i], thread_index);
644 if (PREDICT_FALSE (!s))
650 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
654 vec_reset_length (indices);
655 wrk->session_to_enqueue[transport_proto] = indices;
661 session_main_flush_all_enqueue_events (u8 transport_proto)
663 vlib_thread_main_t *vtm = vlib_get_thread_main ();
665 for (i = 0; i < 1 + vtm->n_threads; i++)
666 errors += session_main_flush_enqueue_events (transport_proto, i);
671 session_stream_connect_notify_inline (transport_connection_t * tc, u8 is_fail,
672 session_state_t opened_state)
674 u32 opaque = 0, new_ti, new_si;
675 app_worker_t *app_wrk;
680 * Find connection handle and cleanup half-open table
682 ho_handle = session_lookup_half_open_handle (tc);
683 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
685 SESSION_DBG ("half-open was removed!");
688 session_lookup_del_half_open (tc);
690 /* Get the app's index from the handle we stored when opening connection
691 * and the opaque (api_context for external apps) from transport session
693 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
697 opaque = tc->s_index;
700 return app_worker_connect_notify (app_wrk, s, opaque);
702 s = session_alloc_for_connection (tc);
703 s->session_state = SESSION_STATE_CONNECTING;
704 s->app_wrk_index = app_wrk->wrk_index;
705 new_si = s->session_index;
706 new_ti = s->thread_index;
708 if (app_worker_init_connected (app_wrk, s))
711 app_worker_connect_notify (app_wrk, 0, opaque);
715 s = session_get (new_si, new_ti);
716 s->session_state = opened_state;
717 session_lookup_add_connection (tc, session_handle (s));
719 if (app_worker_connect_notify (app_wrk, s, opaque))
721 s = session_get (new_si, new_ti);
722 session_free_w_fifos (s);
730 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
732 return session_stream_connect_notify_inline (tc, is_fail,
733 SESSION_STATE_READY);
737 session_ho_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
739 return session_stream_connect_notify_inline (tc, is_fail,
740 SESSION_STATE_OPENED);
743 typedef struct _session_switch_pool_args
747 u32 new_thread_index;
748 u32 new_session_index;
749 } session_switch_pool_args_t;
752 * Notify old thread of the session pool switch
755 session_switch_pool (void *cb_args)
757 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
758 app_worker_t *app_wrk;
761 ASSERT (args->thread_index == vlib_get_thread_index ());
762 s = session_get (args->session_index, args->thread_index);
763 s->tx_fifo->master_session_index = args->new_session_index;
764 s->tx_fifo->master_thread_index = args->new_thread_index;
765 transport_cleanup (session_get_transport_proto (s), s->connection_index,
768 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
771 session_handle_t new_sh;
772 new_sh = session_make_handle (args->new_session_index,
773 args->new_thread_index);
774 app_worker_migrate_notify (app_wrk, s, new_sh);
776 /* Trigger app read on the new thread */
777 session_enqueue_notify_thread (new_sh);
781 clib_mem_free (cb_args);
785 * Move dgram session to the right thread
788 session_dgram_connect_notify (transport_connection_t * tc,
789 u32 old_thread_index, session_t ** new_session)
792 session_switch_pool_args_t *rpc_args;
795 * Clone half-open session to the right thread.
797 new_s = session_clone_safe (tc->s_index, old_thread_index);
798 new_s->connection_index = tc->c_index;
799 new_s->rx_fifo->master_session_index = new_s->session_index;
800 new_s->rx_fifo->master_thread_index = new_s->thread_index;
801 new_s->session_state = SESSION_STATE_READY;
802 new_s->flags |= SESSION_F_IS_MIGRATING;
803 session_lookup_add_connection (tc, session_handle (new_s));
806 * Ask thread owning the old session to clean it up and make us the tx
809 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
810 rpc_args->new_session_index = new_s->session_index;
811 rpc_args->new_thread_index = new_s->thread_index;
812 rpc_args->session_index = tc->s_index;
813 rpc_args->thread_index = old_thread_index;
814 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
817 tc->s_index = new_s->session_index;
818 new_s->connection_index = tc->c_index;
819 *new_session = new_s;
824 * Notification from transport that connection is being closed.
826 * A disconnect is sent to application but state is not removed. Once
827 * disconnect is acknowledged by application, session disconnect is called.
828 * Ultimately this leads to close being called on transport (passive close).
831 session_transport_closing_notify (transport_connection_t * tc)
833 app_worker_t *app_wrk;
836 s = session_get (tc->s_index, tc->thread_index);
837 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
839 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
840 app_wrk = app_worker_get (s->app_wrk_index);
841 app_worker_close_notify (app_wrk, s);
845 * Notification from transport that connection is being deleted
847 * This removes the session if it is still valid. It should be called only on
848 * previously fully established sessions. For instance failed connects should
849 * call stream_session_connect_notify and indicate that the connect has
853 session_transport_delete_notify (transport_connection_t * tc)
857 /* App might've been removed already */
858 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
861 switch (s->session_state)
863 case SESSION_STATE_CREATED:
864 /* Session was created but accept notification was not yet sent to the
865 * app. Cleanup everything. */
866 session_lookup_del_session (s);
867 session_free_w_fifos (s);
869 case SESSION_STATE_ACCEPTING:
870 case SESSION_STATE_TRANSPORT_CLOSING:
871 case SESSION_STATE_CLOSING:
872 case SESSION_STATE_TRANSPORT_CLOSED:
873 /* If transport finishes or times out before we get a reply
874 * from the app, mark transport as closed and wait for reply
875 * before removing the session. Cleanup session table in advance
876 * because transport will soon be closed and closed sessions
877 * are assumed to have been removed from the lookup table */
878 session_lookup_del_session (s);
879 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
880 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
881 svm_fifo_dequeue_drop_all (s->tx_fifo);
883 case SESSION_STATE_APP_CLOSED:
884 /* Cleanup lookup table as transport needs to still be valid.
885 * Program transport close to ensure that all session events
886 * have been cleaned up. Once transport close is called, the
887 * session is just removed because both transport and app have
888 * confirmed the close*/
889 session_lookup_del_session (s);
890 s->session_state = SESSION_STATE_CLOSED;
891 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
892 svm_fifo_dequeue_drop_all (s->tx_fifo);
893 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
895 case SESSION_STATE_TRANSPORT_DELETED:
897 case SESSION_STATE_CLOSED:
898 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
902 clib_warning ("session state %u", s->session_state);
903 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
910 * Notification from transport that it is closed
912 * Should be called by transport, prior to calling delete notify, once it
913 * knows that no more data will be exchanged. This could serve as an
914 * early acknowledgment of an active close especially if transport delete
915 * can be delayed a long time, e.g., tcp time-wait.
918 session_transport_closed_notify (transport_connection_t * tc)
920 app_worker_t *app_wrk;
923 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
926 /* Transport thinks that app requested close but it actually didn't.
927 * Can happen for tcp if fin and rst are received in close succession. */
928 if (s->session_state == SESSION_STATE_READY)
930 session_transport_closing_notify (tc);
931 svm_fifo_dequeue_drop_all (s->tx_fifo);
932 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
934 /* If app close has not been received or has not yet resulted in
935 * a transport close, only mark the session transport as closed */
936 else if (s->session_state <= SESSION_STATE_CLOSING)
938 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
940 /* If app also closed, switch to closed */
941 else if (s->session_state == SESSION_STATE_APP_CLOSED)
942 s->session_state = SESSION_STATE_CLOSED;
944 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
946 app_worker_transport_closed_notify (app_wrk, s);
950 * Notify application that connection has been reset.
953 session_transport_reset_notify (transport_connection_t * tc)
955 app_worker_t *app_wrk;
958 s = session_get (tc->s_index, tc->thread_index);
959 svm_fifo_dequeue_drop_all (s->tx_fifo);
960 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
962 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
963 app_wrk = app_worker_get (s->app_wrk_index);
964 app_worker_reset_notify (app_wrk, s);
968 session_stream_accept_notify (transport_connection_t * tc)
970 app_worker_t *app_wrk;
973 s = session_get (tc->s_index, tc->thread_index);
974 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
977 s->session_state = SESSION_STATE_ACCEPTING;
978 return app_worker_accept_notify (app_wrk, s);
982 * Accept a stream session. Optionally ping the server by callback.
985 session_stream_accept (transport_connection_t * tc, u32 listener_index,
986 u32 thread_index, u8 notify)
991 s = session_alloc_for_connection (tc);
992 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
993 s->session_state = SESSION_STATE_CREATED;
995 if ((rv = app_worker_init_accepted (s)))
998 session_lookup_add_connection (tc, session_handle (s));
1000 /* Shoulder-tap the server */
1003 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1004 return app_worker_accept_notify (app_wrk, s);
1011 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1013 transport_connection_t *tc;
1014 transport_endpoint_cfg_t *tep;
1015 app_worker_t *app_wrk;
1016 session_handle_t sh;
1020 tep = session_endpoint_to_transport_cfg (rmt);
1021 rv = transport_connect (rmt->transport_proto, tep);
1024 SESSION_DBG ("Transport failed to open connection.");
1025 return VNET_API_ERROR_SESSION_CONNECT;
1028 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1030 /* For dgram type of service, allocate session and fifos now */
1031 app_wrk = app_worker_get (app_wrk_index);
1032 s = session_alloc_for_connection (tc);
1033 s->app_wrk_index = app_wrk->wrk_index;
1034 s->session_state = SESSION_STATE_OPENED;
1035 if (app_worker_init_connected (app_wrk, s))
1041 sh = session_handle (s);
1042 session_lookup_add_connection (tc, sh);
1043 return app_worker_connect_notify (app_wrk, s, opaque);
1047 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1049 transport_connection_t *tc;
1050 transport_endpoint_cfg_t *tep;
1054 tep = session_endpoint_to_transport_cfg (rmt);
1055 rv = transport_connect (rmt->transport_proto, tep);
1058 SESSION_DBG ("Transport failed to open connection.");
1059 return VNET_API_ERROR_SESSION_CONNECT;
1062 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1064 /* If transport offers a stream service, only allocate session once the
1065 * connection has been established.
1066 * Add connection to half-open table and save app and tc index. The
1067 * latter is needed to help establish the connection while the former
1068 * is needed when the connect notify comes and we have to notify the
1071 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1072 session_lookup_add_half_open (tc, handle);
1074 /* Store api_context (opaque) for when the reply comes. Not the nicest
1075 * thing but better than allocating a separate half-open pool.
1077 tc->s_index = opaque;
1078 if (transport_half_open_has_fifos (rmt->transport_proto))
1079 return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1084 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1086 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1087 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1089 sep->app_wrk_index = app_wrk_index;
1090 sep->opaque = opaque;
1092 return transport_connect (rmt->transport_proto, tep_cfg);
1095 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1098 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1106 * Ask transport to open connection to remote transport endpoint.
1108 * Stores handle for matching request with reply since the call can be
1109 * asynchronous. For instance, for TCP the 3-way handshake must complete
1110 * before reply comes. Session is only created once connection is established.
1112 * @param app_index Index of the application requesting the connect
1113 * @param st Session type requested.
1114 * @param tep Remote transport endpoint
1115 * @param opaque Opaque data (typically, api_context) the application expects
1116 * on open completion.
1119 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1121 transport_service_type_t tst;
1122 tst = transport_protocol_service_type (rmt->transport_proto);
1123 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1127 * Ask transport to listen on session endpoint.
1129 * @param s Session for which listen will be called. Note that unlike
1130 * established sessions, listen sessions are not associated to a
1132 * @param sep Local endpoint to be listened on.
1135 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1137 transport_endpoint_t *tep;
1138 u32 tc_index, s_index;
1140 /* Transport bind/listen */
1141 tep = session_endpoint_to_transport (sep);
1142 s_index = ls->session_index;
1143 tc_index = transport_start_listen (session_get_transport_proto (ls),
1146 if (tc_index == (u32) ~ 0)
1149 /* Attach transport to session. Lookup tables are populated by the app
1150 * worker because local tables (for ct sessions) are not backed by a fib */
1151 ls = listen_session_get (s_index);
1152 ls->connection_index = tc_index;
1158 * Ask transport to stop listening on local transport endpoint.
1160 * @param s Session to stop listening on. It must be in state LISTENING.
1163 session_stop_listen (session_t * s)
1165 transport_proto_t tp = session_get_transport_proto (s);
1166 transport_connection_t *tc;
1168 if (s->session_state != SESSION_STATE_LISTENING)
1171 tc = transport_get_listener (tp, s->connection_index);
1173 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1175 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1176 session_lookup_del_connection (tc);
1177 transport_stop_listen (tp, s->connection_index);
1182 * Initialize session closing procedure.
1184 * Request is always sent to session node to ensure that all outstanding
1185 * requests are served before transport is notified.
1188 session_close (session_t * s)
1193 if (s->session_state >= SESSION_STATE_CLOSING)
1195 /* Session will only be removed once both app and transport
1196 * acknowledge the close */
1197 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1198 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1199 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1203 s->session_state = SESSION_STATE_CLOSING;
1204 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1208 * Force a close without waiting for data to be flushed
1211 session_reset (session_t * s)
1213 if (s->session_state >= SESSION_STATE_CLOSING)
1215 /* Drop all outstanding tx data */
1216 svm_fifo_dequeue_drop_all (s->tx_fifo);
1217 s->session_state = SESSION_STATE_CLOSING;
1218 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1222 * Notify transport the session can be disconnected. This should eventually
1223 * result in a delete notification that allows us to cleanup session state.
1224 * Called for both active/passive disconnects.
1226 * Must be called from the session's thread.
1229 session_transport_close (session_t * s)
1231 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1233 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1234 s->session_state = SESSION_STATE_CLOSED;
1235 /* If transport is already deleted, just free the session */
1236 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1237 session_free_w_fifos (s);
1241 /* If the tx queue wasn't drained, the transport can continue to try
1242 * sending the outstanding data (in closed state it cannot). It MUST however
1243 * at one point, either after sending everything or after a timeout, call
1244 * delete notify. This will finally lead to the complete cleanup of the
1247 s->session_state = SESSION_STATE_APP_CLOSED;
1249 transport_close (session_get_transport_proto (s), s->connection_index,
1254 * Force transport close
1257 session_transport_reset (session_t * s)
1259 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1261 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1262 s->session_state = SESSION_STATE_CLOSED;
1263 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1264 session_free_w_fifos (s);
1268 s->session_state = SESSION_STATE_APP_CLOSED;
1269 transport_reset (session_get_transport_proto (s), s->connection_index,
1274 * Cleanup transport and session state.
1276 * Notify transport of the cleanup and free the session. This should
1277 * be called only if transport reported some error and is already
1281 session_transport_cleanup (session_t * s)
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))
1694 else if (unformat (input, "enable"))
1695 vnet_session_enable_disable (vm, 1 /* is_en */ );
1697 return clib_error_return (0, "unknown input `%U'",
1698 format_unformat_error, input);
1703 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1706 * fd.io coding-style-patch-verification: ON
1709 * eval: (c-set-style "gnu")