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 event supported for now is disconnect */
96 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE);
97 return session_send_evt_to_thread (s, 0, s->thread_index,
98 SESSION_CTRL_EVT_CLOSE);
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_program_transport_close (session_t * s)
124 u32 thread_index = vlib_get_thread_index ();
125 session_evt_elt_t *elt;
126 session_worker_t *wrk;
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_main_get_worker (s->thread_index);
133 elt = session_evt_elt_alloc (wrk);
134 clib_memset (&elt->evt, 0, sizeof (session_event_t));
135 elt->evt.session_handle = session_handle (s);
136 elt->evt.event_type = SESSION_CTRL_EVT_CLOSE;
137 session_evt_add_pending_disconnects (wrk, elt);
140 session_send_ctrl_evt_to_thread (s, SESSION_CTRL_EVT_CLOSE);
144 session_alloc (u32 thread_index)
146 session_worker_t *wrk = &session_main.wrk[thread_index];
149 pool_get_aligned_will_expand (wrk->sessions, will_expand,
150 CLIB_CACHE_LINE_BYTES);
151 /* If we have peekers, let them finish */
152 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
154 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
155 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
156 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
160 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
162 clib_memset (s, 0, sizeof (*s));
163 s->session_index = s - wrk->sessions;
164 s->thread_index = thread_index;
165 s->app_index = APP_INVALID_INDEX;
170 session_free (session_t * s)
174 u8 thread_index = s->thread_index;
175 clib_memset (s, 0xFA, sizeof (*s));
176 pool_put (session_main.wrk[thread_index].sessions, s);
179 SESSION_EVT_DBG (SESSION_EVT_FREE, s);
180 pool_put (session_main.wrk[s->thread_index].sessions, s);
184 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
186 app_worker_t *app_wrk;
188 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
191 app_worker_cleanup_notify (app_wrk, s, ntf);
195 session_free_w_fifos (session_t * s)
197 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
198 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
203 * Cleans up session and lookup table.
205 * Transport connection must still be valid.
208 session_delete (session_t * s)
212 /* Delete from the main lookup table. */
213 if ((rv = session_lookup_del_session (s)))
214 clib_warning ("hash delete error, rv %d", rv);
216 session_free_w_fifos (s);
220 session_alloc_for_connection (transport_connection_t * tc)
223 u32 thread_index = tc->thread_index;
225 ASSERT (thread_index == vlib_get_thread_index ()
226 || transport_protocol_is_cl (tc->proto));
228 s = session_alloc (thread_index);
229 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
230 s->session_state = SESSION_STATE_CLOSED;
232 /* Attach transport to session and vice versa */
233 s->connection_index = tc->c_index;
234 tc->s_index = s->session_index;
239 * Discards bytes from buffer chain
241 * It discards n_bytes_to_drop starting at first buffer after chain_b
244 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
245 vlib_buffer_t ** chain_b,
248 vlib_buffer_t *next = *chain_b;
249 u32 to_drop = n_bytes_to_drop;
250 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
251 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
253 next = vlib_get_buffer (vm, next->next_buffer);
254 if (next->current_length > to_drop)
256 vlib_buffer_advance (next, to_drop);
261 to_drop -= next->current_length;
262 next->current_length = 0;
268 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
272 * Enqueue buffer chain tail
275 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
276 u32 offset, u8 is_in_order)
278 vlib_buffer_t *chain_b;
279 u32 chain_bi, len, diff;
280 vlib_main_t *vm = vlib_get_main ();
285 if (is_in_order && offset)
287 diff = offset - b->current_length;
288 if (diff > b->total_length_not_including_first_buffer)
291 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
292 chain_bi = vlib_get_buffer_index (vm, chain_b);
295 chain_bi = b->next_buffer;
299 chain_b = vlib_get_buffer (vm, chain_bi);
300 data = vlib_buffer_get_current (chain_b);
301 len = chain_b->current_length;
306 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
313 return (rv > 0) ? (written + rv) : written;
319 /* written more than what was left in chain */
320 if (written > b->total_length_not_including_first_buffer)
323 /* drop the bytes that have already been delivered */
324 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
329 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
332 clib_warning ("failed to enqueue multi-buffer seg");
338 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
339 ? chain_b->next_buffer : 0));
348 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
349 * event but on request can queue notification events for later delivery by
350 * calling stream_server_flush_enqueue_events().
352 * @param tc Transport connection which is to be enqueued data
353 * @param b Buffer to be enqueued
354 * @param offset Offset at which to start enqueueing if out-of-order
355 * @param queue_event Flag to indicate if peer is to be notified or if event
356 * is to be queued. The former is useful when more data is
357 * enqueued and only one event is to be generated.
358 * @param is_in_order Flag to indicate if data is in order
359 * @return Number of bytes enqueued or a negative value if enqueueing failed.
362 session_enqueue_stream_connection (transport_connection_t * tc,
363 vlib_buffer_t * b, u32 offset,
364 u8 queue_event, u8 is_in_order)
367 int enqueued = 0, rv, in_order_off;
369 s = session_get (tc->s_index, tc->thread_index);
373 enqueued = svm_fifo_enqueue (s->rx_fifo,
375 vlib_buffer_get_current (b));
376 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
379 in_order_off = enqueued > b->current_length ? enqueued : 0;
380 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
387 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
389 vlib_buffer_get_current (b));
390 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
391 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
392 /* if something was enqueued, report even this as success for ooo
393 * segment handling */
399 /* Queue RX event on this fifo. Eventually these will need to be flushed
400 * by calling stream_server_flush_enqueue_events () */
401 session_worker_t *wrk;
403 wrk = session_main_get_worker (s->thread_index);
404 if (!(s->flags & SESSION_F_RX_EVT))
406 s->flags |= SESSION_F_RX_EVT;
407 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
415 session_enqueue_dgram_connection (session_t * s,
416 session_dgram_hdr_t * hdr,
417 vlib_buffer_t * b, u8 proto, u8 queue_event)
419 int enqueued = 0, rv, in_order_off;
421 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
422 >= b->current_length + sizeof (*hdr));
424 svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
425 enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
426 vlib_buffer_get_current (b));
427 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
429 in_order_off = enqueued > b->current_length ? enqueued : 0;
430 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
436 /* Queue RX event on this fifo. Eventually these will need to be flushed
437 * by calling stream_server_flush_enqueue_events () */
438 session_worker_t *wrk;
440 wrk = session_main_get_worker (s->thread_index);
441 if (!(s->flags & SESSION_F_RX_EVT))
443 s->flags |= SESSION_F_RX_EVT;
444 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
451 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
452 u32 offset, u32 max_bytes)
454 session_t *s = session_get (tc->s_index, tc->thread_index);
455 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
459 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
461 session_t *s = session_get (tc->s_index, tc->thread_index);
464 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
466 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
467 session_dequeue_notify (s);
473 session_notify_subscribers (u32 app_index, session_t * s,
474 svm_fifo_t * f, session_evt_type_t evt_type)
476 app_worker_t *app_wrk;
480 app = application_get (app_index);
484 for (i = 0; i < f->n_subscribers; i++)
486 app_wrk = application_get_worker (app, f->subscribers[i]);
489 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
497 * Notify session peer that new data has been enqueued.
499 * @param s Stream session for which the event is to be generated.
500 * @param lock Flag to indicate if call should lock message queue.
502 * @return 0 on success or negative number if failed to send notification.
505 session_enqueue_notify_inline (session_t * s)
507 app_worker_t *app_wrk;
511 session_index = s->session_index;
512 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
514 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
515 if (PREDICT_FALSE (!app_wrk))
517 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
522 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
523 ed->data[0] = SESSION_IO_EVT_RX;
524 ed->data[1] = svm_fifo_max_dequeue_prod (s->rx_fifo);
528 s->flags &= ~SESSION_F_RX_EVT;
529 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
533 if (PREDICT_FALSE (n_subscribers))
535 s = session_get (session_index, vlib_get_thread_index ());
536 return session_notify_subscribers (app_wrk->app_index, s,
537 s->rx_fifo, SESSION_IO_EVT_RX);
544 session_enqueue_notify (session_t * s)
546 return session_enqueue_notify_inline (s);
550 session_dequeue_notify (session_t * s)
552 app_worker_t *app_wrk;
554 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
555 if (PREDICT_FALSE (!app_wrk))
558 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
562 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
563 return session_notify_subscribers (app_wrk->app_index, s,
564 s->tx_fifo, SESSION_IO_EVT_TX);
566 svm_fifo_clear_deq_ntf (s->tx_fifo);
572 * Flushes queue of sessions that are to be notified of new data
575 * @param thread_index Thread index for which the flush is to be performed.
576 * @return 0 on success or a positive number indicating the number of
577 * failures due to API queue being full.
580 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
582 session_worker_t *wrk = session_main_get_worker (thread_index);
587 indices = wrk->session_to_enqueue[transport_proto];
589 for (i = 0; i < vec_len (indices); i++)
591 s = session_get_if_valid (indices[i], thread_index);
592 if (PREDICT_FALSE (!s))
598 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
602 vec_reset_length (indices);
603 wrk->session_to_enqueue[transport_proto] = indices;
609 session_main_flush_all_enqueue_events (u8 transport_proto)
611 vlib_thread_main_t *vtm = vlib_get_thread_main ();
613 for (i = 0; i < 1 + vtm->n_threads; i++)
614 errors += session_main_flush_enqueue_events (transport_proto, i);
619 session_stream_connect_notify_inline (transport_connection_t * tc, u8 is_fail,
620 session_state_t opened_state)
622 u32 opaque = 0, new_ti, new_si;
623 app_worker_t *app_wrk;
628 * Find connection handle and cleanup half-open table
630 ho_handle = session_lookup_half_open_handle (tc);
631 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
633 SESSION_DBG ("half-open was removed!");
636 session_lookup_del_half_open (tc);
638 /* Get the app's index from the handle we stored when opening connection
639 * and the opaque (api_context for external apps) from transport session
641 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
645 opaque = tc->s_index;
648 return app_worker_connect_notify (app_wrk, s, opaque);
650 s = session_alloc_for_connection (tc);
651 s->session_state = SESSION_STATE_CONNECTING;
652 s->app_wrk_index = app_wrk->wrk_index;
653 new_si = s->session_index;
654 new_ti = s->thread_index;
656 if (app_worker_init_connected (app_wrk, s))
659 app_worker_connect_notify (app_wrk, 0, opaque);
663 s = session_get (new_si, new_ti);
664 s->session_state = opened_state;
665 session_lookup_add_connection (tc, session_handle (s));
667 if (app_worker_connect_notify (app_wrk, s, opaque))
669 s = session_get (new_si, new_ti);
670 session_free_w_fifos (s);
678 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
680 return session_stream_connect_notify_inline (tc, is_fail,
681 SESSION_STATE_READY);
685 session_ho_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
687 return session_stream_connect_notify_inline (tc, is_fail,
688 SESSION_STATE_OPENED);
691 typedef struct _session_switch_pool_args
695 u32 new_thread_index;
696 u32 new_session_index;
697 } session_switch_pool_args_t;
700 session_switch_pool (void *cb_args)
702 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
704 ASSERT (args->thread_index == vlib_get_thread_index ());
705 s = session_get (args->session_index, args->thread_index);
706 s->tx_fifo->master_session_index = args->new_session_index;
707 s->tx_fifo->master_thread_index = args->new_thread_index;
708 transport_cleanup (session_get_transport_proto (s), s->connection_index,
711 clib_mem_free (cb_args);
715 * Move dgram session to the right thread
718 session_dgram_connect_notify (transport_connection_t * tc,
719 u32 old_thread_index, session_t ** new_session)
722 session_switch_pool_args_t *rpc_args;
725 * Clone half-open session to the right thread.
727 new_s = session_clone_safe (tc->s_index, old_thread_index);
728 new_s->connection_index = tc->c_index;
729 new_s->rx_fifo->master_session_index = new_s->session_index;
730 new_s->rx_fifo->master_thread_index = new_s->thread_index;
731 new_s->session_state = SESSION_STATE_READY;
732 session_lookup_add_connection (tc, session_handle (new_s));
735 * Ask thread owning the old session to clean it up and make us the tx
738 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
739 rpc_args->new_session_index = new_s->session_index;
740 rpc_args->new_thread_index = new_s->thread_index;
741 rpc_args->session_index = tc->s_index;
742 rpc_args->thread_index = old_thread_index;
743 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
746 tc->s_index = new_s->session_index;
747 new_s->connection_index = tc->c_index;
748 *new_session = new_s;
753 * Notification from transport that connection is being closed.
755 * A disconnect is sent to application but state is not removed. Once
756 * disconnect is acknowledged by application, session disconnect is called.
757 * Ultimately this leads to close being called on transport (passive close).
760 session_transport_closing_notify (transport_connection_t * tc)
762 app_worker_t *app_wrk;
765 s = session_get (tc->s_index, tc->thread_index);
766 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
768 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
769 app_wrk = app_worker_get (s->app_wrk_index);
770 app_worker_close_notify (app_wrk, s);
774 * Notification from transport that connection is being deleted
776 * This removes the session if it is still valid. It should be called only on
777 * previously fully established sessions. For instance failed connects should
778 * call stream_session_connect_notify and indicate that the connect has
782 session_transport_delete_notify (transport_connection_t * tc)
786 /* App might've been removed already */
787 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
790 switch (s->session_state)
792 case SESSION_STATE_CREATED:
793 /* Session was created but accept notification was not yet sent to the
794 * app. Cleanup everything. */
795 session_lookup_del_session (s);
796 session_free_w_fifos (s);
798 case SESSION_STATE_ACCEPTING:
799 case SESSION_STATE_TRANSPORT_CLOSING:
800 case SESSION_STATE_CLOSING:
801 /* If transport finishes or times out before we get a reply
802 * from the app, mark transport as closed and wait for reply
803 * before removing the session. Cleanup session table in advance
804 * because transport will soon be closed and closed sessions
805 * are assumed to have been removed from the lookup table */
806 session_lookup_del_session (s);
807 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
808 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
809 svm_fifo_dequeue_drop_all (s->tx_fifo);
811 case SESSION_STATE_APP_CLOSED:
812 /* Cleanup lookup table as transport needs to still be valid.
813 * Program transport close to ensure that all session events
814 * have been cleaned up. Once transport close is called, the
815 * session is just removed because both transport and app have
816 * confirmed the close*/
817 session_lookup_del_session (s);
818 s->session_state = SESSION_STATE_CLOSED;
819 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
820 svm_fifo_dequeue_drop_all (s->tx_fifo);
821 session_program_transport_close (s);
823 case SESSION_STATE_TRANSPORT_CLOSED:
825 case SESSION_STATE_CLOSED:
826 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
830 clib_warning ("session state %u", s->session_state);
831 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
838 * Notification from transport that it is closed
840 * Should be called by transport, prior to calling delete notify, once it
841 * knows that no more data will be exchanged. This could serve as an
842 * early acknowledgment of an active close especially if transport delete
843 * can be delayed a long time, e.g., tcp time-wait.
846 session_transport_closed_notify (transport_connection_t * tc)
848 app_worker_t *app_wrk;
851 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
854 /* Transport thinks that app requested close but it actually didn't.
855 * Can happen for tcp if fin and rst are received in close succession. */
856 if (s->session_state == SESSION_STATE_READY)
858 session_transport_closing_notify (tc);
859 svm_fifo_dequeue_drop_all (s->tx_fifo);
860 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
862 /* If app close has not been received or has not yet resulted in
863 * a transport close, only mark the session transport as closed */
864 else if (s->session_state <= SESSION_STATE_CLOSING)
866 session_lookup_del_session (s);
867 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
869 /* In all closing states but transport closed switch to closed */
870 else if (s->session_state != SESSION_STATE_TRANSPORT_CLOSED)
871 s->session_state = SESSION_STATE_CLOSED;
873 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
875 app_worker_transport_closed_notify (app_wrk, s);
879 * Notify application that connection has been reset.
882 session_transport_reset_notify (transport_connection_t * tc)
884 app_worker_t *app_wrk;
887 s = session_get (tc->s_index, tc->thread_index);
888 svm_fifo_dequeue_drop_all (s->tx_fifo);
889 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
891 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
892 app_wrk = app_worker_get (s->app_wrk_index);
893 app_worker_reset_notify (app_wrk, s);
897 session_stream_accept_notify (transport_connection_t * tc)
899 app_worker_t *app_wrk;
902 s = session_get (tc->s_index, tc->thread_index);
903 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
906 s->session_state = SESSION_STATE_ACCEPTING;
907 return app_worker_accept_notify (app_wrk, s);
911 * Accept a stream session. Optionally ping the server by callback.
914 session_stream_accept (transport_connection_t * tc, u32 listener_index,
915 u32 thread_index, u8 notify)
920 s = session_alloc_for_connection (tc);
921 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
922 s->session_state = SESSION_STATE_CREATED;
924 if ((rv = app_worker_init_accepted (s)))
927 session_lookup_add_connection (tc, session_handle (s));
929 /* Shoulder-tap the server */
932 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
933 return app_worker_accept_notify (app_wrk, s);
940 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
942 transport_connection_t *tc;
943 transport_endpoint_cfg_t *tep;
944 app_worker_t *app_wrk;
949 tep = session_endpoint_to_transport_cfg (rmt);
950 rv = transport_connect (rmt->transport_proto, tep);
953 SESSION_DBG ("Transport failed to open connection.");
954 return VNET_API_ERROR_SESSION_CONNECT;
957 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
959 /* For dgram type of service, allocate session and fifos now */
960 app_wrk = app_worker_get (app_wrk_index);
961 s = session_alloc_for_connection (tc);
962 s->app_wrk_index = app_wrk->wrk_index;
963 s->session_state = SESSION_STATE_OPENED;
964 if (app_worker_init_connected (app_wrk, s))
970 sh = session_handle (s);
971 session_lookup_add_connection (tc, sh);
972 return app_worker_connect_notify (app_wrk, s, opaque);
976 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
978 transport_connection_t *tc;
979 transport_endpoint_cfg_t *tep;
983 tep = session_endpoint_to_transport_cfg (rmt);
984 rv = transport_connect (rmt->transport_proto, tep);
987 SESSION_DBG ("Transport failed to open connection.");
988 return VNET_API_ERROR_SESSION_CONNECT;
991 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
993 /* If transport offers a stream service, only allocate session once the
994 * connection has been established.
995 * Add connection to half-open table and save app and tc index. The
996 * latter is needed to help establish the connection while the former
997 * is needed when the connect notify comes and we have to notify the
1000 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1001 session_lookup_add_half_open (tc, handle);
1003 /* Store api_context (opaque) for when the reply comes. Not the nicest
1004 * thing but better than allocating a separate half-open pool.
1006 tc->s_index = opaque;
1007 if (transport_half_open_has_fifos (rmt->transport_proto))
1008 return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1013 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1015 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1016 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1018 sep->app_wrk_index = app_wrk_index;
1019 sep->opaque = opaque;
1021 return transport_connect (rmt->transport_proto, tep_cfg);
1024 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1027 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1035 * Ask transport to open connection to remote transport endpoint.
1037 * Stores handle for matching request with reply since the call can be
1038 * asynchronous. For instance, for TCP the 3-way handshake must complete
1039 * before reply comes. Session is only created once connection is established.
1041 * @param app_index Index of the application requesting the connect
1042 * @param st Session type requested.
1043 * @param tep Remote transport endpoint
1044 * @param opaque Opaque data (typically, api_context) the application expects
1045 * on open completion.
1048 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1050 transport_service_type_t tst;
1051 tst = transport_protocol_service_type (rmt->transport_proto);
1052 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1056 * Ask transport to listen on session endpoint.
1058 * @param s Session for which listen will be called. Note that unlike
1059 * established sessions, listen sessions are not associated to a
1061 * @param sep Local endpoint to be listened on.
1064 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1066 transport_endpoint_t *tep;
1067 u32 tc_index, s_index;
1069 /* Transport bind/listen */
1070 tep = session_endpoint_to_transport (sep);
1071 s_index = ls->session_index;
1072 tc_index = transport_start_listen (session_get_transport_proto (ls),
1075 if (tc_index == (u32) ~ 0)
1078 /* Attach transport to session. Lookup tables are populated by the app
1079 * worker because local tables (for ct sessions) are not backed by a fib */
1080 ls = listen_session_get (s_index);
1081 ls->connection_index = tc_index;
1087 * Ask transport to stop listening on local transport endpoint.
1089 * @param s Session to stop listening on. It must be in state LISTENING.
1092 session_stop_listen (session_t * s)
1094 transport_proto_t tp = session_get_transport_proto (s);
1095 transport_connection_t *tc;
1097 if (s->session_state != SESSION_STATE_LISTENING)
1100 tc = transport_get_listener (tp, s->connection_index);
1102 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1104 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1105 session_lookup_del_connection (tc);
1106 transport_stop_listen (tp, s->connection_index);
1111 * Initialize session closing procedure.
1113 * Request is always sent to session node to ensure that all outstanding
1114 * requests are served before transport is notified.
1117 session_close (session_t * s)
1122 if (s->session_state >= SESSION_STATE_CLOSING)
1124 /* Session will only be removed once both app and transport
1125 * acknowledge the close */
1126 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1127 session_program_transport_close (s);
1131 s->session_state = SESSION_STATE_CLOSING;
1132 session_program_transport_close (s);
1136 * Notify transport the session can be disconnected. This should eventually
1137 * result in a delete notification that allows us to cleanup session state.
1138 * Called for both active/passive disconnects.
1140 * Must be called from the session's thread.
1143 session_transport_close (session_t * s)
1145 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1147 /* If transport is already closed, just free the session */
1148 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1149 session_free_w_fifos (s);
1153 /* If the tx queue wasn't drained, the transport can continue to try
1154 * sending the outstanding data (in closed state it cannot). It MUST however
1155 * at one point, either after sending everything or after a timeout, call
1156 * delete notify. This will finally lead to the complete cleanup of the
1159 s->session_state = SESSION_STATE_APP_CLOSED;
1161 transport_close (session_get_transport_proto (s), s->connection_index,
1166 * Cleanup transport and session state.
1168 * Notify transport of the cleanup and free the session. This should
1169 * be called only if transport reported some error and is already
1173 session_transport_cleanup (session_t * s)
1175 s->session_state = SESSION_STATE_CLOSED;
1177 /* Delete from main lookup table before we axe the the transport */
1178 session_lookup_del_session (s);
1179 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1181 /* Since we called cleanup, no delete notification will come. So, make
1182 * sure the session is properly freed. */
1183 session_free_w_fifos (s);
1187 * Allocate event queues in the shared-memory segment
1189 * That can either be a newly created memfd segment, that will need to be
1190 * mapped by all stack users, or the binary api's svm region. The latter is
1191 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1192 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1193 * vpp uses api svm region for event queues.
1196 session_vpp_event_queues_allocate (session_main_t * smm)
1198 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1199 ssvm_private_t *eqs = &smm->evt_qs_segment;
1200 api_main_t *am = &api_main;
1201 uword eqs_size = 64 << 20;
1202 pid_t vpp_pid = getpid ();
1206 if (smm->configured_event_queue_length)
1207 evt_q_length = smm->configured_event_queue_length;
1209 if (smm->evt_qs_use_memfd_seg)
1211 if (smm->evt_qs_segment_size)
1212 eqs_size = smm->evt_qs_segment_size;
1214 eqs->ssvm_size = eqs_size;
1215 eqs->i_am_master = 1;
1216 eqs->my_pid = vpp_pid;
1217 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1218 eqs->requested_va = smm->session_baseva;
1220 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1222 clib_warning ("failed to initialize queue segment");
1227 if (smm->evt_qs_use_memfd_seg)
1228 oldheap = ssvm_push_heap (eqs->sh);
1230 oldheap = svm_push_data_heap (am->vlib_rp);
1232 for (i = 0; i < vec_len (smm->wrk); i++)
1234 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1235 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1236 {evt_q_length, evt_size, 0}
1238 {evt_q_length >> 1, 256, 0}
1240 cfg->consumer_pid = 0;
1242 cfg->q_nitems = evt_q_length;
1243 cfg->ring_cfgs = rc;
1244 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1245 if (smm->evt_qs_use_memfd_seg)
1247 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1248 clib_warning ("eventfd returned");
1252 if (smm->evt_qs_use_memfd_seg)
1253 ssvm_pop_heap (oldheap);
1255 svm_pop_heap (oldheap);
1259 session_main_get_evt_q_segment (void)
1261 session_main_t *smm = &session_main;
1262 if (smm->evt_qs_use_memfd_seg)
1263 return &smm->evt_qs_segment;
1268 session_segment_handle (session_t * s)
1273 return SESSION_INVALID_HANDLE;
1276 return segment_manager_make_segment_handle (f->segment_manager,
1281 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1282 session_tx_fifo_peek_and_snd,
1283 session_tx_fifo_dequeue_and_snd,
1284 session_tx_fifo_dequeue_internal,
1285 session_tx_fifo_dequeue_and_snd
1290 * Initialize session layer for given transport proto and ip version
1292 * Allocates per session type (transport proto + ip version) data structures
1293 * and adds arc from session queue node to session type output node.
1296 session_register_transport (transport_proto_t transport_proto,
1297 const transport_proto_vft_t * vft, u8 is_ip4,
1300 session_main_t *smm = &session_main;
1301 session_type_t session_type;
1302 u32 next_index = ~0;
1304 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1306 vec_validate (smm->session_type_to_next, session_type);
1307 vec_validate (smm->session_tx_fns, session_type);
1310 if (output_node != ~0)
1312 foreach_vlib_main (({
1313 next_index = vlib_node_add_next (this_vlib_main,
1314 session_queue_node.index,
1320 smm->session_type_to_next[session_type] = next_index;
1321 smm->session_tx_fns[session_type] =
1322 session_tx_fns[vft->transport_options.tx_type];
1325 transport_connection_t *
1326 session_get_transport (session_t * s)
1328 if (s->session_state != SESSION_STATE_LISTENING)
1329 return transport_get_connection (session_get_transport_proto (s),
1330 s->connection_index, s->thread_index);
1332 return transport_get_listener (session_get_transport_proto (s),
1333 s->connection_index);
1337 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1339 if (s->session_state != SESSION_STATE_LISTENING)
1340 return transport_get_endpoint (session_get_transport_proto (s),
1341 s->connection_index, s->thread_index, tep,
1344 return transport_get_listener_endpoint (session_get_transport_proto (s),
1345 s->connection_index, tep, is_lcl);
1348 transport_connection_t *
1349 listen_session_get_transport (session_t * s)
1351 return transport_get_listener (session_get_transport_proto (s),
1352 s->connection_index);
1356 session_flush_frames_main_thread (vlib_main_t * vm)
1358 ASSERT (vlib_get_thread_index () == 0);
1359 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1360 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1363 static clib_error_t *
1364 session_manager_main_enable (vlib_main_t * vm)
1366 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1367 session_main_t *smm = &session_main;
1368 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1369 u32 num_threads, preallocated_sessions_per_worker;
1370 session_worker_t *wrk;
1373 num_threads = 1 /* main thread */ + vtm->n_threads;
1375 if (num_threads < 1)
1376 return clib_error_return (0, "n_thread_stacks not set");
1378 /* Allocate cache line aligned worker contexts */
1379 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1381 for (i = 0; i < num_threads; i++)
1384 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1385 wrk->pending_head = clib_llist_make_head (wrk->event_elts, evt_list);
1386 wrk->postponed_head = clib_llist_make_head (wrk->event_elts, evt_list);
1387 wrk->disconnects_head = clib_llist_make_head (wrk->event_elts,
1389 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1390 wrk->dispatch_period = 500e-6;
1392 if (num_threads > 1)
1393 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1397 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1400 /* Allocate vpp event queues segment and queue */
1401 session_vpp_event_queues_allocate (smm);
1403 /* Initialize fifo segment main baseva and timeout */
1404 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1405 sm_args->size = smm->session_va_space_size;
1406 segment_manager_main_init (sm_args);
1408 /* Preallocate sessions */
1409 if (smm->preallocated_sessions)
1411 if (num_threads == 1)
1413 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1418 preallocated_sessions_per_worker =
1419 (1.1 * (f64) smm->preallocated_sessions /
1420 (f64) (num_threads - 1));
1422 for (j = 1; j < num_threads; j++)
1424 pool_init_fixed (smm->wrk[j].sessions,
1425 preallocated_sessions_per_worker);
1430 session_lookup_init ();
1431 app_namespaces_init ();
1434 smm->is_enabled = 1;
1436 /* Enable transports */
1437 transport_enable_disable (vm, 1);
1438 transport_init_tx_pacers_period ();
1443 session_node_enable_disable (u8 is_en)
1445 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1446 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1447 u8 have_workers = vtm->n_threads != 0;
1450 foreach_vlib_main (({
1451 if (have_workers && ii == 0)
1453 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1457 vlib_node_t *n = vlib_get_node (this_vlib_main,
1458 session_queue_process_node.index);
1459 vlib_start_process (this_vlib_main, n->runtime_index);
1463 vlib_process_signal_event_mt (this_vlib_main,
1464 session_queue_process_node.index,
1465 SESSION_Q_PROCESS_STOP, 0);
1470 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1477 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1479 clib_error_t *error = 0;
1482 if (session_main.is_enabled)
1485 error = session_manager_main_enable (vm);
1486 session_node_enable_disable (is_en);
1490 session_main.is_enabled = 0;
1491 session_node_enable_disable (is_en);
1498 session_manager_main_init (vlib_main_t * vm)
1500 session_main_t *smm = &session_main;
1501 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1502 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1503 smm->session_va_space_size = 128ULL << 30;
1504 smm->evt_qs_segment_size = 64 << 20;
1506 smm->session_va_space_size = 128 << 20;
1507 smm->evt_qs_segment_size = 1 << 20;
1509 smm->is_enabled = 0;
1513 VLIB_INIT_FUNCTION (session_manager_main_init);
1515 static clib_error_t *
1516 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1518 session_main_t *smm = &session_main;
1522 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1524 if (unformat (input, "event-queue-length %d", &nitems))
1527 smm->configured_event_queue_length = nitems;
1529 clib_warning ("event queue length %d too small, ignored", nitems);
1531 else if (unformat (input, "preallocated-sessions %d",
1532 &smm->preallocated_sessions))
1534 else if (unformat (input, "v4-session-table-buckets %d",
1535 &smm->configured_v4_session_table_buckets))
1537 else if (unformat (input, "v4-halfopen-table-buckets %d",
1538 &smm->configured_v4_halfopen_table_buckets))
1540 else if (unformat (input, "v6-session-table-buckets %d",
1541 &smm->configured_v6_session_table_buckets))
1543 else if (unformat (input, "v6-halfopen-table-buckets %d",
1544 &smm->configured_v6_halfopen_table_buckets))
1546 else if (unformat (input, "v4-session-table-memory %U",
1547 unformat_memory_size, &tmp))
1549 if (tmp >= 0x100000000)
1550 return clib_error_return (0, "memory size %llx (%lld) too large",
1552 smm->configured_v4_session_table_memory = tmp;
1554 else if (unformat (input, "v4-halfopen-table-memory %U",
1555 unformat_memory_size, &tmp))
1557 if (tmp >= 0x100000000)
1558 return clib_error_return (0, "memory size %llx (%lld) too large",
1560 smm->configured_v4_halfopen_table_memory = tmp;
1562 else if (unformat (input, "v6-session-table-memory %U",
1563 unformat_memory_size, &tmp))
1565 if (tmp >= 0x100000000)
1566 return clib_error_return (0, "memory size %llx (%lld) too large",
1568 smm->configured_v6_session_table_memory = tmp;
1570 else if (unformat (input, "v6-halfopen-table-memory %U",
1571 unformat_memory_size, &tmp))
1573 if (tmp >= 0x100000000)
1574 return clib_error_return (0, "memory size %llx (%lld) too large",
1576 smm->configured_v6_halfopen_table_memory = tmp;
1578 else if (unformat (input, "local-endpoints-table-memory %U",
1579 unformat_memory_size, &tmp))
1581 if (tmp >= 0x100000000)
1582 return clib_error_return (0, "memory size %llx (%lld) too large",
1584 smm->local_endpoints_table_memory = tmp;
1586 else if (unformat (input, "local-endpoints-table-buckets %d",
1587 &smm->local_endpoints_table_buckets))
1589 else if (unformat (input, "evt_qs_memfd_seg"))
1590 smm->evt_qs_use_memfd_seg = 1;
1591 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1592 &smm->evt_qs_segment_size))
1595 return clib_error_return (0, "unknown input `%U'",
1596 format_unformat_error, input);
1601 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1604 * fd.io coding-style-patch-verification: ON
1607 * eval: (c-set-style "gnu")