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)
35 u32 tries = 0, max_tries;
37 mq = session_main_get_vpp_event_queue (thread_index);
38 while (svm_msg_q_try_lock (mq))
40 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
41 if (tries++ == max_tries)
43 SESSION_DBG ("failed to enqueue evt");
47 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
49 svm_msg_q_unlock (mq);
52 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
53 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
55 svm_msg_q_unlock (mq);
58 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
59 evt->event_type = evt_type;
62 case SESSION_CTRL_EVT_RPC:
63 evt->rpc_args.fp = data;
64 evt->rpc_args.arg = args;
66 case SESSION_IO_EVT_TX:
67 case SESSION_IO_EVT_TX_FLUSH:
68 case SESSION_IO_EVT_BUILTIN_RX:
71 case SESSION_IO_EVT_BUILTIN_TX:
72 case SESSION_CTRL_EVT_CLOSE:
73 evt->session_handle = session_handle ((session_t *) data);
76 clib_warning ("evt unhandled!");
77 svm_msg_q_unlock (mq);
81 svm_msg_q_add_and_unlock (mq, &msg);
86 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
88 return session_send_evt_to_thread (f, 0, f->master_thread_index, evt_type);
92 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
93 session_evt_type_t evt_type)
95 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
99 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
101 /* only event supported for now is disconnect */
102 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE);
103 return session_send_evt_to_thread (s, 0, s->thread_index,
104 SESSION_CTRL_EVT_CLOSE);
108 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
110 if (thread_index != vlib_get_thread_index ())
111 session_send_evt_to_thread (fp, rpc_args, thread_index,
112 SESSION_CTRL_EVT_RPC);
115 void (*fnp) (void *) = fp;
121 session_program_transport_close (session_t * s)
123 u32 thread_index = vlib_get_thread_index ();
124 session_worker_t *wrk;
125 session_event_t *evt;
127 if (!session_has_transport (s))
129 /* Polling may not be enabled on main thread so close now */
130 session_transport_close (s);
134 /* If we are in the handler thread, or being called with the worker barrier
135 * held, just append a new event to pending disconnects vector. */
136 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
138 wrk = session_main_get_worker (s->thread_index);
139 vec_add2 (wrk->pending_disconnects, evt, 1);
140 clib_memset (evt, 0, sizeof (*evt));
141 evt->session_handle = session_handle (s);
142 evt->event_type = SESSION_CTRL_EVT_CLOSE;
145 session_send_ctrl_evt_to_thread (s, SESSION_CTRL_EVT_CLOSE);
149 session_alloc (u32 thread_index)
151 session_worker_t *wrk = &session_main.wrk[thread_index];
154 pool_get_aligned_will_expand (wrk->sessions, will_expand,
155 CLIB_CACHE_LINE_BYTES);
156 /* If we have peekers, let them finish */
157 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
159 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
160 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
161 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
165 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
167 clib_memset (s, 0, sizeof (*s));
168 s->session_index = s - wrk->sessions;
169 s->thread_index = thread_index;
174 session_free (session_t * s)
176 pool_put (session_main.wrk[s->thread_index].sessions, s);
178 clib_memset (s, 0xFA, sizeof (*s));
182 session_free_w_fifos (session_t * s)
184 segment_manager_dealloc_fifos (s->svm_segment_index, s->rx_fifo,
190 * Cleans up session and lookup table.
192 * Transport connection must still be valid.
195 session_delete (session_t * s)
199 /* Delete from the main lookup table. */
200 if ((rv = session_lookup_del_session (s)))
201 clib_warning ("hash delete error, rv %d", rv);
203 session_free_w_fifos (s);
207 session_alloc_for_connection (transport_connection_t * tc)
210 u32 thread_index = tc->thread_index;
212 ASSERT (thread_index == vlib_get_thread_index ()
213 || transport_protocol_is_cl (tc->proto));
215 s = session_alloc (thread_index);
216 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
217 s->enqueue_epoch = (u64) ~ 0;
218 s->session_state = SESSION_STATE_CLOSED;
220 /* Attach transport to session and vice versa */
221 s->connection_index = tc->c_index;
222 tc->s_index = s->session_index;
227 * Discards bytes from buffer chain
229 * It discards n_bytes_to_drop starting at first buffer after chain_b
232 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
233 vlib_buffer_t ** chain_b,
236 vlib_buffer_t *next = *chain_b;
237 u32 to_drop = n_bytes_to_drop;
238 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
239 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
241 next = vlib_get_buffer (vm, next->next_buffer);
242 if (next->current_length > to_drop)
244 vlib_buffer_advance (next, to_drop);
249 to_drop -= next->current_length;
250 next->current_length = 0;
256 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
260 * Enqueue buffer chain tail
263 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
264 u32 offset, u8 is_in_order)
266 vlib_buffer_t *chain_b;
267 u32 chain_bi, len, diff;
268 vlib_main_t *vm = vlib_get_main ();
273 if (is_in_order && offset)
275 diff = offset - b->current_length;
276 if (diff > b->total_length_not_including_first_buffer)
279 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
280 chain_bi = vlib_get_buffer_index (vm, chain_b);
283 chain_bi = b->next_buffer;
287 chain_b = vlib_get_buffer (vm, chain_bi);
288 data = vlib_buffer_get_current (chain_b);
289 len = chain_b->current_length;
294 rv = svm_fifo_enqueue_nowait (s->rx_fifo, len, data);
301 return (rv > 0) ? (written + rv) : written;
307 /* written more than what was left in chain */
308 if (written > b->total_length_not_including_first_buffer)
311 /* drop the bytes that have already been delivered */
312 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
317 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
320 clib_warning ("failed to enqueue multi-buffer seg");
326 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
327 ? chain_b->next_buffer : 0));
336 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
337 * event but on request can queue notification events for later delivery by
338 * calling stream_server_flush_enqueue_events().
340 * @param tc Transport connection which is to be enqueued data
341 * @param b Buffer to be enqueued
342 * @param offset Offset at which to start enqueueing if out-of-order
343 * @param queue_event Flag to indicate if peer is to be notified or if event
344 * is to be queued. The former is useful when more data is
345 * enqueued and only one event is to be generated.
346 * @param is_in_order Flag to indicate if data is in order
347 * @return Number of bytes enqueued or a negative value if enqueueing failed.
350 session_enqueue_stream_connection (transport_connection_t * tc,
351 vlib_buffer_t * b, u32 offset,
352 u8 queue_event, u8 is_in_order)
355 int enqueued = 0, rv, in_order_off;
357 s = session_get (tc->s_index, tc->thread_index);
361 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo,
363 vlib_buffer_get_current (b));
364 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
367 in_order_off = enqueued > b->current_length ? enqueued : 0;
368 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
375 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
377 vlib_buffer_get_current (b));
378 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
379 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
380 /* if something was enqueued, report even this as success for ooo
381 * segment handling */
387 /* Queue RX event on this fifo. Eventually these will need to be flushed
388 * by calling stream_server_flush_enqueue_events () */
389 session_worker_t *wrk;
391 wrk = session_main_get_worker (s->thread_index);
392 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
394 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
395 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
403 session_enqueue_dgram_connection (session_t * s,
404 session_dgram_hdr_t * hdr,
405 vlib_buffer_t * b, u8 proto, u8 queue_event)
407 int enqueued = 0, rv, in_order_off;
409 ASSERT (svm_fifo_max_enqueue (s->rx_fifo)
410 >= b->current_length + sizeof (*hdr));
412 svm_fifo_enqueue_nowait (s->rx_fifo, sizeof (session_dgram_hdr_t),
414 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo, b->current_length,
415 vlib_buffer_get_current (b));
416 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
418 in_order_off = enqueued > b->current_length ? enqueued : 0;
419 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
425 /* Queue RX event on this fifo. Eventually these will need to be flushed
426 * by calling stream_server_flush_enqueue_events () */
427 session_worker_t *wrk;
429 wrk = session_main_get_worker (s->thread_index);
430 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
432 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
433 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
440 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
441 u32 offset, u32 max_bytes)
443 session_t *s = session_get (tc->s_index, tc->thread_index);
444 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
448 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
450 session_t *s = session_get (tc->s_index, tc->thread_index);
451 return svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
455 session_notify_subscribers (u32 app_index, session_t * s,
456 svm_fifo_t * f, session_evt_type_t evt_type)
458 app_worker_t *app_wrk;
462 app = application_get (app_index);
466 for (i = 0; i < f->n_subscribers; i++)
468 app_wrk = application_get_worker (app, f->subscribers[i]);
471 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
479 * Notify session peer that new data has been enqueued.
481 * @param s Stream session for which the event is to be generated.
482 * @param lock Flag to indicate if call should lock message queue.
484 * @return 0 on success or negative number if failed to send notification.
487 session_enqueue_notify (session_t * s)
489 app_worker_t *app_wrk;
491 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
492 if (PREDICT_FALSE (!app_wrk))
494 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
499 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
500 ed->data[0] = SESSION_IO_EVT_RX;
501 ed->data[1] = svm_fifo_max_dequeue (s->rx_fifo);
505 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
509 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
510 return session_notify_subscribers (app_wrk->app_index, s,
511 s->rx_fifo, SESSION_IO_EVT_RX);
517 session_dequeue_notify (session_t * s)
519 app_worker_t *app_wrk;
521 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
522 if (PREDICT_FALSE (!app_wrk))
525 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
529 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
530 return session_notify_subscribers (app_wrk->app_index, s,
531 s->tx_fifo, SESSION_IO_EVT_TX);
533 svm_fifo_clear_tx_ntf (s->tx_fifo);
539 * Flushes queue of sessions that are to be notified of new data
542 * @param thread_index Thread index for which the flush is to be performed.
543 * @return 0 on success or a positive number indicating the number of
544 * failures due to API queue being full.
547 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
549 session_worker_t *wrk = session_main_get_worker (thread_index);
554 indices = wrk->session_to_enqueue[transport_proto];
556 for (i = 0; i < vec_len (indices); i++)
558 s = session_get_if_valid (indices[i], thread_index);
559 if (PREDICT_FALSE (!s))
564 if (PREDICT_FALSE (session_enqueue_notify (s)))
568 vec_reset_length (indices);
569 wrk->session_to_enqueue[transport_proto] = indices;
570 wrk->current_enqueue_epoch[transport_proto]++;
576 session_main_flush_all_enqueue_events (u8 transport_proto)
578 vlib_thread_main_t *vtm = vlib_get_thread_main ();
580 for (i = 0; i < 1 + vtm->n_threads; i++)
581 errors += session_main_flush_enqueue_events (transport_proto, i);
586 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
588 u32 opaque = 0, new_ti, new_si;
589 app_worker_t *app_wrk;
594 * Find connection handle and cleanup half-open table
596 ho_handle = session_lookup_half_open_handle (tc);
597 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
599 SESSION_DBG ("half-open was removed!");
602 session_lookup_del_half_open (tc);
604 /* Get the app's index from the handle we stored when opening connection
605 * and the opaque (api_context for external apps) from transport session
607 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
611 opaque = tc->s_index;
614 return app_worker_connect_notify (app_wrk, s, opaque);
616 s = session_alloc_for_connection (tc);
617 s->session_state = SESSION_STATE_CONNECTING;
618 s->app_wrk_index = app_wrk->wrk_index;
619 new_si = s->session_index;
620 new_ti = s->thread_index;
622 if (app_worker_init_connected (app_wrk, s))
625 app_worker_connect_notify (app_wrk, 0, opaque);
629 if (app_worker_connect_notify (app_wrk, s, opaque))
631 s = session_get (new_si, new_ti);
632 session_free_w_fifos (s);
636 s = session_get (new_si, new_ti);
637 s->session_state = SESSION_STATE_READY;
638 session_lookup_add_connection (tc, session_handle (s));
643 typedef struct _session_switch_pool_args
647 u32 new_thread_index;
648 u32 new_session_index;
649 } session_switch_pool_args_t;
652 session_switch_pool (void *cb_args)
654 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
656 ASSERT (args->thread_index == vlib_get_thread_index ());
657 s = session_get (args->session_index, args->thread_index);
658 s->tx_fifo->master_session_index = args->new_session_index;
659 s->tx_fifo->master_thread_index = args->new_thread_index;
660 transport_cleanup (session_get_transport_proto (s), s->connection_index,
663 clib_mem_free (cb_args);
667 * Move dgram session to the right thread
670 session_dgram_connect_notify (transport_connection_t * tc,
671 u32 old_thread_index, session_t ** new_session)
674 session_switch_pool_args_t *rpc_args;
677 * Clone half-open session to the right thread.
679 new_s = session_clone_safe (tc->s_index, old_thread_index);
680 new_s->connection_index = tc->c_index;
681 new_s->rx_fifo->master_session_index = new_s->session_index;
682 new_s->rx_fifo->master_thread_index = new_s->thread_index;
683 new_s->session_state = SESSION_STATE_READY;
684 session_lookup_add_connection (tc, session_handle (new_s));
687 * Ask thread owning the old session to clean it up and make us the tx
690 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
691 rpc_args->new_session_index = new_s->session_index;
692 rpc_args->new_thread_index = new_s->thread_index;
693 rpc_args->session_index = tc->s_index;
694 rpc_args->thread_index = old_thread_index;
695 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
698 tc->s_index = new_s->session_index;
699 new_s->connection_index = tc->c_index;
700 *new_session = new_s;
705 * Notification from transport that connection is being closed.
707 * A disconnect is sent to application but state is not removed. Once
708 * disconnect is acknowledged by application, session disconnect is called.
709 * Ultimately this leads to close being called on transport (passive close).
712 session_transport_closing_notify (transport_connection_t * tc)
714 app_worker_t *app_wrk;
718 s = session_get (tc->s_index, tc->thread_index);
719 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
721 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
722 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
725 app = application_get (app_wrk->app_index);
726 app->cb_fns.session_disconnect_callback (s);
730 * Notification from transport that connection is being deleted
732 * This removes the session if it is still valid. It should be called only on
733 * previously fully established sessions. For instance failed connects should
734 * call stream_session_connect_notify and indicate that the connect has
738 session_transport_delete_notify (transport_connection_t * tc)
742 /* App might've been removed already */
743 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
746 /* Make sure we don't try to send anything more */
747 svm_fifo_dequeue_drop_all (s->tx_fifo);
749 switch (s->session_state)
751 case SESSION_STATE_CREATED:
752 /* Session was created but accept notification was not yet sent to the
753 * app. Cleanup everything. */
754 session_lookup_del_session (s);
755 session_free_w_fifos (s);
757 case SESSION_STATE_ACCEPTING:
758 case SESSION_STATE_TRANSPORT_CLOSING:
759 /* If transport finishes or times out before we get a reply
760 * from the app, mark transport as closed and wait for reply
761 * before removing the session. Cleanup session table in advance
762 * because transport will soon be closed and closed sessions
763 * are assumed to have been removed from the lookup table */
764 session_lookup_del_session (s);
765 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
767 case SESSION_STATE_CLOSING:
768 case SESSION_STATE_CLOSED_WAITING:
769 /* Cleanup lookup table as transport needs to still be valid.
770 * Program transport close to ensure that all session events
771 * have been cleaned up. Once transport close is called, the
772 * session is just removed because both transport and app have
773 * confirmed the close*/
774 session_lookup_del_session (s);
775 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
776 session_program_transport_close (s);
778 case SESSION_STATE_TRANSPORT_CLOSED:
780 case SESSION_STATE_CLOSED:
784 clib_warning ("session state %u", s->session_state);
791 * Notification from transport that session can be closed
793 * Should be called by transport only if it was closed with non-empty
794 * tx fifo and once it decides to begin the closing procedure prior to
795 * issuing a delete notify. This gives the chance to the session layer
796 * to cleanup any outstanding events.
799 session_transport_closed_notify (transport_connection_t * tc)
803 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
806 /* If app close has not been received or has not yet resulted in
807 * a transport close, only mark the session transport as closed */
808 if (s->session_state <= SESSION_STATE_CLOSING)
810 session_lookup_del_session (s);
811 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
814 s->session_state = SESSION_STATE_CLOSED;
818 * Notify application that connection has been reset.
821 session_transport_reset_notify (transport_connection_t * tc)
824 app_worker_t *app_wrk;
826 s = session_get (tc->s_index, tc->thread_index);
827 svm_fifo_dequeue_drop_all (s->tx_fifo);
828 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
830 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
831 app_wrk = app_worker_get (s->app_wrk_index);
832 app = application_get (app_wrk->app_index);
833 app->cb_fns.session_reset_callback (s);
837 session_stream_accept_notify (transport_connection_t * tc)
839 app_worker_t *app_wrk;
842 s = session_get (tc->s_index, tc->thread_index);
843 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
846 s->session_state = SESSION_STATE_ACCEPTING;
847 return app_worker_accept_notify (app_wrk, s);
851 * Accept a stream session. Optionally ping the server by callback.
854 session_stream_accept (transport_connection_t * tc, u32 listener_index,
860 s = session_alloc_for_connection (tc);
861 s->listener_index = listener_index;
862 s->session_state = SESSION_STATE_CREATED;
864 if ((rv = app_worker_init_accepted (s)))
867 session_lookup_add_connection (tc, session_handle (s));
869 /* Shoulder-tap the server */
872 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
873 return app_worker_accept_notify (app_wrk, s);
880 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
882 transport_connection_t *tc;
883 transport_endpoint_cfg_t *tep;
884 app_worker_t *app_wrk;
888 tep = session_endpoint_to_transport_cfg (rmt);
889 rv = transport_connect (rmt->transport_proto, tep);
892 SESSION_DBG ("Transport failed to open connection.");
893 return VNET_API_ERROR_SESSION_CONNECT;
896 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
898 /* For dgram type of service, allocate session and fifos now */
899 app_wrk = app_worker_get (app_wrk_index);
900 s = session_alloc_for_connection (tc);
901 s->app_wrk_index = app_wrk->wrk_index;
902 s->session_state = SESSION_STATE_OPENED;
903 if (app_worker_init_connected (app_wrk, s))
909 return app_worker_connect_notify (app_wrk, s, opaque);
913 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
915 transport_connection_t *tc;
916 transport_endpoint_cfg_t *tep;
920 tep = session_endpoint_to_transport_cfg (rmt);
921 rv = transport_connect (rmt->transport_proto, tep);
924 SESSION_DBG ("Transport failed to open connection.");
925 return VNET_API_ERROR_SESSION_CONNECT;
928 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
930 /* If transport offers a stream service, only allocate session once the
931 * connection has been established.
932 * Add connection to half-open table and save app and tc index. The
933 * latter is needed to help establish the connection while the former
934 * is needed when the connect notify comes and we have to notify the
937 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
938 session_lookup_add_half_open (tc, handle);
940 /* Store api_context (opaque) for when the reply comes. Not the nicest
941 * thing but better than allocating a separate half-open pool.
943 tc->s_index = opaque;
948 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
950 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
951 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
953 sep->app_wrk_index = app_wrk_index;
954 sep->opaque = opaque;
956 return transport_connect (rmt->transport_proto, tep_cfg);
959 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
962 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
970 * Ask transport to open connection to remote transport endpoint.
972 * Stores handle for matching request with reply since the call can be
973 * asynchronous. For instance, for TCP the 3-way handshake must complete
974 * before reply comes. Session is only created once connection is established.
976 * @param app_index Index of the application requesting the connect
977 * @param st Session type requested.
978 * @param tep Remote transport endpoint
979 * @param opaque Opaque data (typically, api_context) the application expects
980 * on open completion.
983 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
985 transport_service_type_t tst;
986 tst = transport_protocol_service_type (rmt->transport_proto);
987 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
991 * Ask transport to listen on session endpoint.
993 * @param s Session for which listen will be called. Note that unlike
994 * established sessions, listen sessions are not associated to a
996 * @param sep Local endpoint to be listened on.
999 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1001 transport_endpoint_t *tep;
1002 u32 tc_index, s_index;
1004 /* Transport bind/listen */
1005 tep = session_endpoint_to_transport (sep);
1006 s_index = ls->session_index;
1007 tc_index = transport_start_listen (session_get_transport_proto (ls),
1010 if (tc_index == (u32) ~ 0)
1013 /* Attach transport to session. Lookup tables are populated by the app
1014 * worker because local tables (for ct sessions) are not backed by a fib */
1015 ls = listen_session_get (s_index);
1016 ls->connection_index = tc_index;
1022 * Ask transport to stop listening on local transport endpoint.
1024 * @param s Session to stop listening on. It must be in state LISTENING.
1027 session_stop_listen (session_t * s)
1029 transport_proto_t tp = session_get_transport_proto (s);
1030 transport_connection_t *tc;
1032 if (s->session_state != SESSION_STATE_LISTENING)
1035 tc = transport_get_listener (tp, s->connection_index);
1037 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1039 session_lookup_del_connection (tc);
1040 transport_stop_listen (tp, s->connection_index);
1045 * Initialize session closing procedure.
1047 * Request is always sent to session node to ensure that all outstanding
1048 * requests are served before transport is notified.
1051 session_close (session_t * s)
1056 if (s->session_state >= SESSION_STATE_CLOSING)
1058 /* Session will only be removed once both app and transport
1059 * acknowledge the close */
1060 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1061 session_program_transport_close (s);
1063 /* Session already closed. Clear the tx fifo */
1064 if (s->session_state == SESSION_STATE_CLOSED)
1065 svm_fifo_dequeue_drop_all (s->tx_fifo);
1069 s->session_state = SESSION_STATE_CLOSING;
1070 session_program_transport_close (s);
1074 * Notify transport the session can be disconnected. This should eventually
1075 * result in a delete notification that allows us to cleanup session state.
1076 * Called for both active/passive disconnects.
1078 * Must be called from the session's thread.
1081 session_transport_close (session_t * s)
1083 /* If transport is already closed, just free the session */
1084 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1086 session_free_w_fifos (s);
1090 /* If tx queue wasn't drained, change state to closed waiting for transport.
1091 * This way, the transport, if it so wishes, can continue to try sending the
1092 * outstanding data (in closed state it cannot). It MUST however at one
1093 * point, either after sending everything or after a timeout, call delete
1094 * notify. This will finally lead to the complete cleanup of the session.
1096 if (svm_fifo_max_dequeue (s->tx_fifo))
1097 s->session_state = SESSION_STATE_CLOSED_WAITING;
1099 s->session_state = SESSION_STATE_CLOSED;
1101 transport_close (session_get_transport_proto (s), s->connection_index,
1106 * Cleanup transport and session state.
1108 * Notify transport of the cleanup and free the session. This should
1109 * be called only if transport reported some error and is already
1113 session_transport_cleanup (session_t * s)
1115 s->session_state = SESSION_STATE_CLOSED;
1117 /* Delete from main lookup table before we axe the the transport */
1118 session_lookup_del_session (s);
1119 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1121 /* Since we called cleanup, no delete notification will come. So, make
1122 * sure the session is properly freed. */
1123 session_free_w_fifos (s);
1127 * Allocate event queues in the shared-memory segment
1129 * That can either be a newly created memfd segment, that will need to be
1130 * mapped by all stack users, or the binary api's svm region. The latter is
1131 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1132 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1133 * vpp uses api svm region for event queues.
1136 session_vpp_event_queues_allocate (session_main_t * smm)
1138 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1139 ssvm_private_t *eqs = &smm->evt_qs_segment;
1140 api_main_t *am = &api_main;
1141 uword eqs_size = 64 << 20;
1142 pid_t vpp_pid = getpid ();
1146 if (smm->configured_event_queue_length)
1147 evt_q_length = smm->configured_event_queue_length;
1149 if (smm->evt_qs_use_memfd_seg)
1151 if (smm->evt_qs_segment_size)
1152 eqs_size = smm->evt_qs_segment_size;
1154 eqs->ssvm_size = eqs_size;
1155 eqs->i_am_master = 1;
1156 eqs->my_pid = vpp_pid;
1157 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1158 eqs->requested_va = smm->session_baseva;
1160 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1162 clib_warning ("failed to initialize queue segment");
1167 if (smm->evt_qs_use_memfd_seg)
1168 oldheap = ssvm_push_heap (eqs->sh);
1170 oldheap = svm_push_data_heap (am->vlib_rp);
1172 for (i = 0; i < vec_len (smm->wrk); i++)
1174 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1175 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1176 {evt_q_length, evt_size, 0}
1178 {evt_q_length >> 1, 256, 0}
1180 cfg->consumer_pid = 0;
1182 cfg->q_nitems = evt_q_length;
1183 cfg->ring_cfgs = rc;
1184 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1185 if (smm->evt_qs_use_memfd_seg)
1187 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1188 clib_warning ("eventfd returned");
1192 if (smm->evt_qs_use_memfd_seg)
1193 ssvm_pop_heap (oldheap);
1195 svm_pop_heap (oldheap);
1199 session_main_get_evt_q_segment (void)
1201 session_main_t *smm = &session_main;
1202 if (smm->evt_qs_use_memfd_seg)
1203 return &smm->evt_qs_segment;
1208 session_segment_handle (session_t * s)
1212 if (s->session_state == SESSION_STATE_LISTENING)
1213 return SESSION_INVALID_HANDLE;
1216 return segment_manager_make_segment_handle (f->segment_manager,
1221 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1222 session_tx_fifo_peek_and_snd,
1223 session_tx_fifo_dequeue_and_snd,
1224 session_tx_fifo_dequeue_internal,
1225 session_tx_fifo_dequeue_and_snd
1230 * Initialize session layer for given transport proto and ip version
1232 * Allocates per session type (transport proto + ip version) data structures
1233 * and adds arc from session queue node to session type output node.
1236 session_register_transport (transport_proto_t transport_proto,
1237 const transport_proto_vft_t * vft, u8 is_ip4,
1240 session_main_t *smm = &session_main;
1241 session_type_t session_type;
1242 u32 next_index = ~0;
1244 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1246 vec_validate (smm->session_type_to_next, session_type);
1247 vec_validate (smm->session_tx_fns, session_type);
1250 if (output_node != ~0)
1252 foreach_vlib_main (({
1253 next_index = vlib_node_add_next (this_vlib_main,
1254 session_queue_node.index,
1260 smm->session_type_to_next[session_type] = next_index;
1261 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1264 transport_connection_t *
1265 session_get_transport (session_t * s)
1267 if (s->session_state != SESSION_STATE_LISTENING)
1268 return transport_get_connection (session_get_transport_proto (s),
1269 s->connection_index, s->thread_index);
1271 return transport_get_listener (session_get_transport_proto (s),
1272 s->connection_index);
1275 transport_connection_t *
1276 listen_session_get_transport (session_t * s)
1278 return transport_get_listener (session_get_transport_proto (s),
1279 s->connection_index);
1283 session_flush_frames_main_thread (vlib_main_t * vm)
1285 ASSERT (vlib_get_thread_index () == 0);
1286 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1287 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1290 static clib_error_t *
1291 session_manager_main_enable (vlib_main_t * vm)
1293 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1294 session_main_t *smm = &session_main;
1295 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1296 u32 num_threads, preallocated_sessions_per_worker;
1297 session_worker_t *wrk;
1300 num_threads = 1 /* main thread */ + vtm->n_threads;
1302 if (num_threads < 1)
1303 return clib_error_return (0, "n_thread_stacks not set");
1305 /* Allocate cache line aligned worker contexts */
1306 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1308 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1310 for (j = 0; j < num_threads; j++)
1311 smm->wrk[j].current_enqueue_epoch[i] = 1;
1314 for (i = 0; i < num_threads; i++)
1317 vec_validate (wrk->free_event_vector, 128);
1318 _vec_len (wrk->free_event_vector) = 0;
1319 vec_validate (wrk->pending_event_vector, 128);
1320 _vec_len (wrk->pending_event_vector) = 0;
1321 vec_validate (wrk->pending_disconnects, 128);
1322 _vec_len (wrk->pending_disconnects) = 0;
1323 vec_validate (wrk->postponed_event_vector, 128);
1324 _vec_len (wrk->postponed_event_vector) = 0;
1326 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1327 wrk->dispatch_period = 500e-6;
1329 if (num_threads > 1)
1330 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1334 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1337 /* Allocate vpp event queues segment and queue */
1338 session_vpp_event_queues_allocate (smm);
1340 /* Initialize fifo segment main baseva and timeout */
1341 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1342 sm_args->size = smm->session_va_space_size;
1343 segment_manager_main_init (sm_args);
1345 /* Preallocate sessions */
1346 if (smm->preallocated_sessions)
1348 if (num_threads == 1)
1350 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1355 preallocated_sessions_per_worker =
1356 (1.1 * (f64) smm->preallocated_sessions /
1357 (f64) (num_threads - 1));
1359 for (j = 1; j < num_threads; j++)
1361 pool_init_fixed (smm->wrk[j].sessions,
1362 preallocated_sessions_per_worker);
1367 session_lookup_init ();
1368 app_namespaces_init ();
1371 smm->is_enabled = 1;
1373 /* Enable transports */
1374 transport_enable_disable (vm, 1);
1375 transport_init_tx_pacers_period ();
1380 session_node_enable_disable (u8 is_en)
1382 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1383 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1384 u8 have_workers = vtm->n_threads != 0;
1387 foreach_vlib_main (({
1388 if (have_workers && ii == 0)
1390 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1394 vlib_node_t *n = vlib_get_node (this_vlib_main,
1395 session_queue_process_node.index);
1396 vlib_start_process (this_vlib_main, n->runtime_index);
1400 vlib_process_signal_event_mt (this_vlib_main,
1401 session_queue_process_node.index,
1402 SESSION_Q_PROCESS_STOP, 0);
1407 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1414 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1416 clib_error_t *error = 0;
1419 if (session_main.is_enabled)
1422 session_node_enable_disable (is_en);
1423 error = session_manager_main_enable (vm);
1427 session_main.is_enabled = 0;
1428 session_node_enable_disable (is_en);
1435 session_manager_main_init (vlib_main_t * vm)
1437 session_main_t *smm = &session_main;
1438 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1439 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1440 smm->session_va_space_size = 128ULL << 30;
1441 smm->evt_qs_segment_size = 64 << 20;
1443 smm->session_va_space_size = 128 << 20;
1444 smm->evt_qs_segment_size = 1 << 20;
1446 smm->is_enabled = 0;
1450 VLIB_INIT_FUNCTION (session_manager_main_init);
1452 static clib_error_t *
1453 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1455 session_main_t *smm = &session_main;
1459 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1461 if (unformat (input, "event-queue-length %d", &nitems))
1464 smm->configured_event_queue_length = nitems;
1466 clib_warning ("event queue length %d too small, ignored", nitems);
1468 else if (unformat (input, "preallocated-sessions %d",
1469 &smm->preallocated_sessions))
1471 else if (unformat (input, "v4-session-table-buckets %d",
1472 &smm->configured_v4_session_table_buckets))
1474 else if (unformat (input, "v4-halfopen-table-buckets %d",
1475 &smm->configured_v4_halfopen_table_buckets))
1477 else if (unformat (input, "v6-session-table-buckets %d",
1478 &smm->configured_v6_session_table_buckets))
1480 else if (unformat (input, "v6-halfopen-table-buckets %d",
1481 &smm->configured_v6_halfopen_table_buckets))
1483 else if (unformat (input, "v4-session-table-memory %U",
1484 unformat_memory_size, &tmp))
1486 if (tmp >= 0x100000000)
1487 return clib_error_return (0, "memory size %llx (%lld) too large",
1489 smm->configured_v4_session_table_memory = tmp;
1491 else if (unformat (input, "v4-halfopen-table-memory %U",
1492 unformat_memory_size, &tmp))
1494 if (tmp >= 0x100000000)
1495 return clib_error_return (0, "memory size %llx (%lld) too large",
1497 smm->configured_v4_halfopen_table_memory = tmp;
1499 else if (unformat (input, "v6-session-table-memory %U",
1500 unformat_memory_size, &tmp))
1502 if (tmp >= 0x100000000)
1503 return clib_error_return (0, "memory size %llx (%lld) too large",
1505 smm->configured_v6_session_table_memory = tmp;
1507 else if (unformat (input, "v6-halfopen-table-memory %U",
1508 unformat_memory_size, &tmp))
1510 if (tmp >= 0x100000000)
1511 return clib_error_return (0, "memory size %llx (%lld) too large",
1513 smm->configured_v6_halfopen_table_memory = tmp;
1515 else if (unformat (input, "local-endpoints-table-memory %U",
1516 unformat_memory_size, &tmp))
1518 if (tmp >= 0x100000000)
1519 return clib_error_return (0, "memory size %llx (%lld) too large",
1521 smm->local_endpoints_table_memory = tmp;
1523 else if (unformat (input, "local-endpoints-table-buckets %d",
1524 &smm->local_endpoints_table_buckets))
1526 else if (unformat (input, "evt_qs_memfd_seg"))
1527 smm->evt_qs_use_memfd_seg = 1;
1528 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1529 &smm->evt_qs_segment_size))
1532 return clib_error_return (0, "unknown input `%U'",
1533 format_unformat_error, input);
1538 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1541 * fd.io coding-style-patch-verification: ON
1544 * eval: (c-set-style "gnu")