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_worker_t *wrk;
126 session_event_t *evt;
128 /* If we are in the handler thread, or being called with the worker barrier
129 * held, just append a new event to pending disconnects vector. */
130 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
132 wrk = session_main_get_worker (s->thread_index);
133 vec_add2 (wrk->pending_disconnects, evt, 1);
134 clib_memset (evt, 0, sizeof (*evt));
135 evt->session_handle = session_handle (s);
136 evt->event_type = SESSION_CTRL_EVT_CLOSE;
139 session_send_ctrl_evt_to_thread (s, SESSION_CTRL_EVT_CLOSE);
143 session_alloc (u32 thread_index)
145 session_worker_t *wrk = &session_main.wrk[thread_index];
148 pool_get_aligned_will_expand (wrk->sessions, will_expand,
149 CLIB_CACHE_LINE_BYTES);
150 /* If we have peekers, let them finish */
151 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
153 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
154 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
155 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
159 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
161 clib_memset (s, 0, sizeof (*s));
162 s->session_index = s - wrk->sessions;
163 s->thread_index = thread_index;
164 s->app_index = APP_INVALID_INDEX;
169 session_free (session_t * s)
173 u8 thread_index = s->thread_index;
174 clib_memset (s, 0xFA, sizeof (*s));
175 pool_put (session_main.wrk[thread_index].sessions, s);
178 SESSION_EVT_DBG (SESSION_EVT_FREE, s);
179 pool_put (session_main.wrk[s->thread_index].sessions, s);
183 session_free_w_fifos (session_t * s)
185 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_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->session_state = SESSION_STATE_CLOSED;
219 /* Attach transport to session and vice versa */
220 s->connection_index = tc->c_index;
221 tc->s_index = s->session_index;
226 * Discards bytes from buffer chain
228 * It discards n_bytes_to_drop starting at first buffer after chain_b
231 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
232 vlib_buffer_t ** chain_b,
235 vlib_buffer_t *next = *chain_b;
236 u32 to_drop = n_bytes_to_drop;
237 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
238 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
240 next = vlib_get_buffer (vm, next->next_buffer);
241 if (next->current_length > to_drop)
243 vlib_buffer_advance (next, to_drop);
248 to_drop -= next->current_length;
249 next->current_length = 0;
255 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
259 * Enqueue buffer chain tail
262 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
263 u32 offset, u8 is_in_order)
265 vlib_buffer_t *chain_b;
266 u32 chain_bi, len, diff;
267 vlib_main_t *vm = vlib_get_main ();
272 if (is_in_order && offset)
274 diff = offset - b->current_length;
275 if (diff > b->total_length_not_including_first_buffer)
278 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
279 chain_bi = vlib_get_buffer_index (vm, chain_b);
282 chain_bi = b->next_buffer;
286 chain_b = vlib_get_buffer (vm, chain_bi);
287 data = vlib_buffer_get_current (chain_b);
288 len = chain_b->current_length;
293 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
300 return (rv > 0) ? (written + rv) : written;
306 /* written more than what was left in chain */
307 if (written > b->total_length_not_including_first_buffer)
310 /* drop the bytes that have already been delivered */
311 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
316 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
319 clib_warning ("failed to enqueue multi-buffer seg");
325 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
326 ? chain_b->next_buffer : 0));
335 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
336 * event but on request can queue notification events for later delivery by
337 * calling stream_server_flush_enqueue_events().
339 * @param tc Transport connection which is to be enqueued data
340 * @param b Buffer to be enqueued
341 * @param offset Offset at which to start enqueueing if out-of-order
342 * @param queue_event Flag to indicate if peer is to be notified or if event
343 * is to be queued. The former is useful when more data is
344 * enqueued and only one event is to be generated.
345 * @param is_in_order Flag to indicate if data is in order
346 * @return Number of bytes enqueued or a negative value if enqueueing failed.
349 session_enqueue_stream_connection (transport_connection_t * tc,
350 vlib_buffer_t * b, u32 offset,
351 u8 queue_event, u8 is_in_order)
354 int enqueued = 0, rv, in_order_off;
356 s = session_get (tc->s_index, tc->thread_index);
360 enqueued = svm_fifo_enqueue (s->rx_fifo,
362 vlib_buffer_get_current (b));
363 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
366 in_order_off = enqueued > b->current_length ? enqueued : 0;
367 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
374 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
376 vlib_buffer_get_current (b));
377 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
378 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
379 /* if something was enqueued, report even this as success for ooo
380 * segment handling */
386 /* Queue RX event on this fifo. Eventually these will need to be flushed
387 * by calling stream_server_flush_enqueue_events () */
388 session_worker_t *wrk;
390 wrk = session_main_get_worker (s->thread_index);
391 if (!(s->flags & SESSION_F_RX_EVT))
393 s->flags |= SESSION_F_RX_EVT;
394 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
402 session_enqueue_dgram_connection (session_t * s,
403 session_dgram_hdr_t * hdr,
404 vlib_buffer_t * b, u8 proto, u8 queue_event)
406 int enqueued = 0, rv, in_order_off;
408 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
409 >= b->current_length + sizeof (*hdr));
411 svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
412 enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
413 vlib_buffer_get_current (b));
414 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
416 in_order_off = enqueued > b->current_length ? enqueued : 0;
417 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
423 /* Queue RX event on this fifo. Eventually these will need to be flushed
424 * by calling stream_server_flush_enqueue_events () */
425 session_worker_t *wrk;
427 wrk = session_main_get_worker (s->thread_index);
428 if (!(s->flags & SESSION_F_RX_EVT))
430 s->flags |= SESSION_F_RX_EVT;
431 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
438 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
439 u32 offset, u32 max_bytes)
441 session_t *s = session_get (tc->s_index, tc->thread_index);
442 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
446 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
448 session_t *s = session_get (tc->s_index, tc->thread_index);
451 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
453 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
454 session_dequeue_notify (s);
460 session_notify_subscribers (u32 app_index, session_t * s,
461 svm_fifo_t * f, session_evt_type_t evt_type)
463 app_worker_t *app_wrk;
467 app = application_get (app_index);
471 for (i = 0; i < f->n_subscribers; i++)
473 app_wrk = application_get_worker (app, f->subscribers[i]);
476 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
484 * Notify session peer that new data has been enqueued.
486 * @param s Stream session for which the event is to be generated.
487 * @param lock Flag to indicate if call should lock message queue.
489 * @return 0 on success or negative number if failed to send notification.
492 session_enqueue_notify_inline (session_t * s)
494 app_worker_t *app_wrk;
498 session_index = s->session_index;
499 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
501 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
502 if (PREDICT_FALSE (!app_wrk))
504 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
509 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
510 ed->data[0] = SESSION_IO_EVT_RX;
511 ed->data[1] = svm_fifo_max_dequeue_prod (s->rx_fifo);
515 s->flags &= ~SESSION_F_RX_EVT;
516 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
520 if (PREDICT_FALSE (n_subscribers))
522 s = session_get (session_index, vlib_get_thread_index ());
523 return session_notify_subscribers (app_wrk->app_index, s,
524 s->rx_fifo, SESSION_IO_EVT_RX);
531 session_enqueue_notify (session_t * s)
533 return session_enqueue_notify_inline (s);
537 session_dequeue_notify (session_t * s)
539 app_worker_t *app_wrk;
541 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
542 if (PREDICT_FALSE (!app_wrk))
545 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
549 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
550 return session_notify_subscribers (app_wrk->app_index, s,
551 s->tx_fifo, SESSION_IO_EVT_TX);
553 svm_fifo_clear_deq_ntf (s->tx_fifo);
559 * Flushes queue of sessions that are to be notified of new data
562 * @param thread_index Thread index for which the flush is to be performed.
563 * @return 0 on success or a positive number indicating the number of
564 * failures due to API queue being full.
567 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
569 session_worker_t *wrk = session_main_get_worker (thread_index);
574 indices = wrk->session_to_enqueue[transport_proto];
576 for (i = 0; i < vec_len (indices); i++)
578 s = session_get_if_valid (indices[i], thread_index);
579 if (PREDICT_FALSE (!s))
585 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
589 vec_reset_length (indices);
590 wrk->session_to_enqueue[transport_proto] = indices;
596 session_main_flush_all_enqueue_events (u8 transport_proto)
598 vlib_thread_main_t *vtm = vlib_get_thread_main ();
600 for (i = 0; i < 1 + vtm->n_threads; i++)
601 errors += session_main_flush_enqueue_events (transport_proto, i);
606 session_stream_connect_notify_inline (transport_connection_t * tc, u8 is_fail,
607 session_state_t opened_state)
609 u32 opaque = 0, new_ti, new_si;
610 app_worker_t *app_wrk;
615 * Find connection handle and cleanup half-open table
617 ho_handle = session_lookup_half_open_handle (tc);
618 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
620 SESSION_DBG ("half-open was removed!");
623 session_lookup_del_half_open (tc);
625 /* Get the app's index from the handle we stored when opening connection
626 * and the opaque (api_context for external apps) from transport session
628 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
632 opaque = tc->s_index;
635 return app_worker_connect_notify (app_wrk, s, opaque);
637 s = session_alloc_for_connection (tc);
638 s->session_state = SESSION_STATE_CONNECTING;
639 s->app_wrk_index = app_wrk->wrk_index;
640 new_si = s->session_index;
641 new_ti = s->thread_index;
643 if (app_worker_init_connected (app_wrk, s))
646 app_worker_connect_notify (app_wrk, 0, opaque);
650 s = session_get (new_si, new_ti);
651 s->session_state = opened_state;
652 session_lookup_add_connection (tc, session_handle (s));
654 if (app_worker_connect_notify (app_wrk, s, opaque))
656 s = session_get (new_si, new_ti);
657 session_free_w_fifos (s);
665 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
667 return session_stream_connect_notify_inline (tc, is_fail,
668 SESSION_STATE_READY);
672 session_ho_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
674 return session_stream_connect_notify_inline (tc, is_fail,
675 SESSION_STATE_OPENED);
678 typedef struct _session_switch_pool_args
682 u32 new_thread_index;
683 u32 new_session_index;
684 } session_switch_pool_args_t;
687 session_switch_pool (void *cb_args)
689 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
691 ASSERT (args->thread_index == vlib_get_thread_index ());
692 s = session_get (args->session_index, args->thread_index);
693 s->tx_fifo->master_session_index = args->new_session_index;
694 s->tx_fifo->master_thread_index = args->new_thread_index;
695 transport_cleanup (session_get_transport_proto (s), s->connection_index,
698 clib_mem_free (cb_args);
702 * Move dgram session to the right thread
705 session_dgram_connect_notify (transport_connection_t * tc,
706 u32 old_thread_index, session_t ** new_session)
709 session_switch_pool_args_t *rpc_args;
712 * Clone half-open session to the right thread.
714 new_s = session_clone_safe (tc->s_index, old_thread_index);
715 new_s->connection_index = tc->c_index;
716 new_s->rx_fifo->master_session_index = new_s->session_index;
717 new_s->rx_fifo->master_thread_index = new_s->thread_index;
718 new_s->session_state = SESSION_STATE_READY;
719 session_lookup_add_connection (tc, session_handle (new_s));
722 * Ask thread owning the old session to clean it up and make us the tx
725 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
726 rpc_args->new_session_index = new_s->session_index;
727 rpc_args->new_thread_index = new_s->thread_index;
728 rpc_args->session_index = tc->s_index;
729 rpc_args->thread_index = old_thread_index;
730 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
733 tc->s_index = new_s->session_index;
734 new_s->connection_index = tc->c_index;
735 *new_session = new_s;
740 * Notification from transport that connection is being closed.
742 * A disconnect is sent to application but state is not removed. Once
743 * disconnect is acknowledged by application, session disconnect is called.
744 * Ultimately this leads to close being called on transport (passive close).
747 session_transport_closing_notify (transport_connection_t * tc)
749 app_worker_t *app_wrk;
752 s = session_get (tc->s_index, tc->thread_index);
753 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
755 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
756 app_wrk = app_worker_get (s->app_wrk_index);
757 app_worker_close_notify (app_wrk, s);
761 * Notification from transport that connection is being deleted
763 * This removes the session if it is still valid. It should be called only on
764 * previously fully established sessions. For instance failed connects should
765 * call stream_session_connect_notify and indicate that the connect has
769 session_transport_delete_notify (transport_connection_t * tc)
773 /* App might've been removed already */
774 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
777 /* Make sure we don't try to send anything more */
778 svm_fifo_dequeue_drop_all (s->tx_fifo);
780 switch (s->session_state)
782 case SESSION_STATE_CREATED:
783 /* Session was created but accept notification was not yet sent to the
784 * app. Cleanup everything. */
785 session_lookup_del_session (s);
786 session_free_w_fifos (s);
788 case SESSION_STATE_ACCEPTING:
789 case SESSION_STATE_TRANSPORT_CLOSING:
790 /* If transport finishes or times out before we get a reply
791 * from the app, mark transport as closed and wait for reply
792 * before removing the session. Cleanup session table in advance
793 * because transport will soon be closed and closed sessions
794 * are assumed to have been removed from the lookup table */
795 session_lookup_del_session (s);
796 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
798 case SESSION_STATE_CLOSING:
799 case SESSION_STATE_CLOSED_WAITING:
800 /* Cleanup lookup table as transport needs to still be valid.
801 * Program transport close to ensure that all session events
802 * have been cleaned up. Once transport close is called, the
803 * session is just removed because both transport and app have
804 * confirmed the close*/
805 session_lookup_del_session (s);
806 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
807 session_program_transport_close (s);
809 case SESSION_STATE_TRANSPORT_CLOSED:
811 case SESSION_STATE_CLOSED:
815 clib_warning ("session state %u", s->session_state);
822 * Notification from transport that session can be closed
824 * Should be called by transport only if it was closed with non-empty
825 * tx fifo and once it decides to begin the closing procedure prior to
826 * issuing a delete notify. This gives the chance to the session layer
827 * to cleanup any outstanding events.
830 session_transport_closed_notify (transport_connection_t * tc)
834 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
837 /* Transport thinks that app requested close but it actually didn't.
838 * Can happen for tcp if fin and rst are received in close succession. */
839 if (s->session_state == SESSION_STATE_READY)
841 session_transport_closing_notify (tc);
842 svm_fifo_dequeue_drop_all (s->tx_fifo);
844 /* If app close has not been received or has not yet resulted in
845 * a transport close, only mark the session transport as closed */
846 else if (s->session_state <= SESSION_STATE_CLOSING)
848 session_lookup_del_session (s);
849 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
852 s->session_state = SESSION_STATE_CLOSED;
856 * Notify application that connection has been reset.
859 session_transport_reset_notify (transport_connection_t * tc)
861 app_worker_t *app_wrk;
864 s = session_get (tc->s_index, tc->thread_index);
865 svm_fifo_dequeue_drop_all (s->tx_fifo);
866 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
868 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
869 app_wrk = app_worker_get (s->app_wrk_index);
870 app_worker_reset_notify (app_wrk, s);
874 session_stream_accept_notify (transport_connection_t * tc)
876 app_worker_t *app_wrk;
879 s = session_get (tc->s_index, tc->thread_index);
880 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
883 s->session_state = SESSION_STATE_ACCEPTING;
884 return app_worker_accept_notify (app_wrk, s);
888 * Accept a stream session. Optionally ping the server by callback.
891 session_stream_accept (transport_connection_t * tc, u32 listener_index,
892 u32 thread_index, u8 notify)
897 s = session_alloc_for_connection (tc);
898 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
899 s->session_state = SESSION_STATE_CREATED;
901 if ((rv = app_worker_init_accepted (s)))
904 session_lookup_add_connection (tc, session_handle (s));
906 /* Shoulder-tap the server */
909 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
910 return app_worker_accept_notify (app_wrk, s);
917 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
919 transport_connection_t *tc;
920 transport_endpoint_cfg_t *tep;
921 app_worker_t *app_wrk;
926 tep = session_endpoint_to_transport_cfg (rmt);
927 rv = transport_connect (rmt->transport_proto, tep);
930 SESSION_DBG ("Transport failed to open connection.");
931 return VNET_API_ERROR_SESSION_CONNECT;
934 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
936 /* For dgram type of service, allocate session and fifos now */
937 app_wrk = app_worker_get (app_wrk_index);
938 s = session_alloc_for_connection (tc);
939 s->app_wrk_index = app_wrk->wrk_index;
940 s->session_state = SESSION_STATE_OPENED;
941 if (app_worker_init_connected (app_wrk, s))
947 sh = session_handle (s);
948 session_lookup_add_connection (tc, sh);
950 return app_worker_connect_notify (app_wrk, s, opaque);
954 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
956 transport_connection_t *tc;
957 transport_endpoint_cfg_t *tep;
961 tep = session_endpoint_to_transport_cfg (rmt);
962 rv = transport_connect (rmt->transport_proto, tep);
965 SESSION_DBG ("Transport failed to open connection.");
966 return VNET_API_ERROR_SESSION_CONNECT;
969 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
971 /* If transport offers a stream service, only allocate session once the
972 * connection has been established.
973 * Add connection to half-open table and save app and tc index. The
974 * latter is needed to help establish the connection while the former
975 * is needed when the connect notify comes and we have to notify the
978 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
979 session_lookup_add_half_open (tc, handle);
981 /* Store api_context (opaque) for when the reply comes. Not the nicest
982 * thing but better than allocating a separate half-open pool.
984 tc->s_index = opaque;
985 if (transport_half_open_has_fifos (rmt->transport_proto))
986 return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
991 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
993 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
994 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
996 sep->app_wrk_index = app_wrk_index;
997 sep->opaque = opaque;
999 return transport_connect (rmt->transport_proto, tep_cfg);
1002 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1005 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1013 * Ask transport to open connection to remote transport endpoint.
1015 * Stores handle for matching request with reply since the call can be
1016 * asynchronous. For instance, for TCP the 3-way handshake must complete
1017 * before reply comes. Session is only created once connection is established.
1019 * @param app_index Index of the application requesting the connect
1020 * @param st Session type requested.
1021 * @param tep Remote transport endpoint
1022 * @param opaque Opaque data (typically, api_context) the application expects
1023 * on open completion.
1026 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1028 transport_service_type_t tst;
1029 tst = transport_protocol_service_type (rmt->transport_proto);
1030 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1034 * Ask transport to listen on session endpoint.
1036 * @param s Session for which listen will be called. Note that unlike
1037 * established sessions, listen sessions are not associated to a
1039 * @param sep Local endpoint to be listened on.
1042 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1044 transport_endpoint_t *tep;
1045 u32 tc_index, s_index;
1047 /* Transport bind/listen */
1048 tep = session_endpoint_to_transport (sep);
1049 s_index = ls->session_index;
1050 tc_index = transport_start_listen (session_get_transport_proto (ls),
1053 if (tc_index == (u32) ~ 0)
1056 /* Attach transport to session. Lookup tables are populated by the app
1057 * worker because local tables (for ct sessions) are not backed by a fib */
1058 ls = listen_session_get (s_index);
1059 ls->connection_index = tc_index;
1065 * Ask transport to stop listening on local transport endpoint.
1067 * @param s Session to stop listening on. It must be in state LISTENING.
1070 session_stop_listen (session_t * s)
1072 transport_proto_t tp = session_get_transport_proto (s);
1073 transport_connection_t *tc;
1075 if (s->session_state != SESSION_STATE_LISTENING)
1078 tc = transport_get_listener (tp, s->connection_index);
1080 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1082 session_lookup_del_connection (tc);
1083 transport_stop_listen (tp, s->connection_index);
1088 * Initialize session closing procedure.
1090 * Request is always sent to session node to ensure that all outstanding
1091 * requests are served before transport is notified.
1094 session_close (session_t * s)
1099 if (s->session_state >= SESSION_STATE_CLOSING)
1101 /* Session will only be removed once both app and transport
1102 * acknowledge the close */
1103 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1104 session_program_transport_close (s);
1106 /* Session already closed. Clear the tx fifo */
1107 if (s->session_state == SESSION_STATE_CLOSED)
1108 svm_fifo_dequeue_drop_all (s->tx_fifo);
1112 s->session_state = SESSION_STATE_CLOSING;
1113 session_program_transport_close (s);
1117 * Notify transport the session can be disconnected. This should eventually
1118 * result in a delete notification that allows us to cleanup session state.
1119 * Called for both active/passive disconnects.
1121 * Must be called from the session's thread.
1124 session_transport_close (session_t * s)
1126 /* If transport is already closed, just free the session */
1127 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1129 session_free_w_fifos (s);
1133 /* If tx queue wasn't drained, change state to closed waiting for transport.
1134 * This way, the transport, if it so wishes, can continue to try sending the
1135 * outstanding data (in closed state it cannot). It MUST however at one
1136 * point, either after sending everything or after a timeout, call delete
1137 * notify. This will finally lead to the complete cleanup of the session.
1139 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1140 s->session_state = SESSION_STATE_CLOSED_WAITING;
1142 s->session_state = SESSION_STATE_CLOSED;
1144 transport_close (session_get_transport_proto (s), s->connection_index,
1149 * Cleanup transport and session state.
1151 * Notify transport of the cleanup and free the session. This should
1152 * be called only if transport reported some error and is already
1156 session_transport_cleanup (session_t * s)
1158 s->session_state = SESSION_STATE_CLOSED;
1160 /* Delete from main lookup table before we axe the the transport */
1161 session_lookup_del_session (s);
1162 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1164 /* Since we called cleanup, no delete notification will come. So, make
1165 * sure the session is properly freed. */
1166 session_free_w_fifos (s);
1170 * Allocate event queues in the shared-memory segment
1172 * That can either be a newly created memfd segment, that will need to be
1173 * mapped by all stack users, or the binary api's svm region. The latter is
1174 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1175 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1176 * vpp uses api svm region for event queues.
1179 session_vpp_event_queues_allocate (session_main_t * smm)
1181 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1182 ssvm_private_t *eqs = &smm->evt_qs_segment;
1183 api_main_t *am = &api_main;
1184 uword eqs_size = 64 << 20;
1185 pid_t vpp_pid = getpid ();
1189 if (smm->configured_event_queue_length)
1190 evt_q_length = smm->configured_event_queue_length;
1192 if (smm->evt_qs_use_memfd_seg)
1194 if (smm->evt_qs_segment_size)
1195 eqs_size = smm->evt_qs_segment_size;
1197 eqs->ssvm_size = eqs_size;
1198 eqs->i_am_master = 1;
1199 eqs->my_pid = vpp_pid;
1200 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1201 eqs->requested_va = smm->session_baseva;
1203 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1205 clib_warning ("failed to initialize queue segment");
1210 if (smm->evt_qs_use_memfd_seg)
1211 oldheap = ssvm_push_heap (eqs->sh);
1213 oldheap = svm_push_data_heap (am->vlib_rp);
1215 for (i = 0; i < vec_len (smm->wrk); i++)
1217 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1218 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1219 {evt_q_length, evt_size, 0}
1221 {evt_q_length >> 1, 256, 0}
1223 cfg->consumer_pid = 0;
1225 cfg->q_nitems = evt_q_length;
1226 cfg->ring_cfgs = rc;
1227 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1228 if (smm->evt_qs_use_memfd_seg)
1230 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1231 clib_warning ("eventfd returned");
1235 if (smm->evt_qs_use_memfd_seg)
1236 ssvm_pop_heap (oldheap);
1238 svm_pop_heap (oldheap);
1242 session_main_get_evt_q_segment (void)
1244 session_main_t *smm = &session_main;
1245 if (smm->evt_qs_use_memfd_seg)
1246 return &smm->evt_qs_segment;
1251 session_segment_handle (session_t * s)
1256 return SESSION_INVALID_HANDLE;
1259 return segment_manager_make_segment_handle (f->segment_manager,
1264 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1265 session_tx_fifo_peek_and_snd,
1266 session_tx_fifo_dequeue_and_snd,
1267 session_tx_fifo_dequeue_internal,
1268 session_tx_fifo_dequeue_and_snd
1273 * Initialize session layer for given transport proto and ip version
1275 * Allocates per session type (transport proto + ip version) data structures
1276 * and adds arc from session queue node to session type output node.
1279 session_register_transport (transport_proto_t transport_proto,
1280 const transport_proto_vft_t * vft, u8 is_ip4,
1283 session_main_t *smm = &session_main;
1284 session_type_t session_type;
1285 u32 next_index = ~0;
1287 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1289 vec_validate (smm->session_type_to_next, session_type);
1290 vec_validate (smm->session_tx_fns, session_type);
1293 if (output_node != ~0)
1295 foreach_vlib_main (({
1296 next_index = vlib_node_add_next (this_vlib_main,
1297 session_queue_node.index,
1303 smm->session_type_to_next[session_type] = next_index;
1304 smm->session_tx_fns[session_type] =
1305 session_tx_fns[vft->transport_options.tx_type];
1308 transport_connection_t *
1309 session_get_transport (session_t * s)
1311 if (s->session_state != SESSION_STATE_LISTENING)
1312 return transport_get_connection (session_get_transport_proto (s),
1313 s->connection_index, s->thread_index);
1315 return transport_get_listener (session_get_transport_proto (s),
1316 s->connection_index);
1320 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1322 if (s->session_state != SESSION_STATE_LISTENING)
1323 return transport_get_endpoint (session_get_transport_proto (s),
1324 s->connection_index, s->thread_index, tep,
1327 return transport_get_listener_endpoint (session_get_transport_proto (s),
1328 s->connection_index, tep, is_lcl);
1331 transport_connection_t *
1332 listen_session_get_transport (session_t * s)
1334 return transport_get_listener (session_get_transport_proto (s),
1335 s->connection_index);
1339 session_flush_frames_main_thread (vlib_main_t * vm)
1341 ASSERT (vlib_get_thread_index () == 0);
1342 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1343 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1346 static clib_error_t *
1347 session_manager_main_enable (vlib_main_t * vm)
1349 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1350 session_main_t *smm = &session_main;
1351 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1352 u32 num_threads, preallocated_sessions_per_worker;
1353 session_worker_t *wrk;
1356 num_threads = 1 /* main thread */ + vtm->n_threads;
1358 if (num_threads < 1)
1359 return clib_error_return (0, "n_thread_stacks not set");
1361 /* Allocate cache line aligned worker contexts */
1362 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1364 for (i = 0; i < num_threads; i++)
1367 vec_validate (wrk->free_event_vector, 128);
1368 _vec_len (wrk->free_event_vector) = 0;
1369 vec_validate (wrk->pending_event_vector, 128);
1370 _vec_len (wrk->pending_event_vector) = 0;
1371 vec_validate (wrk->pending_disconnects, 128);
1372 _vec_len (wrk->pending_disconnects) = 0;
1373 vec_validate (wrk->postponed_event_vector, 128);
1374 _vec_len (wrk->postponed_event_vector) = 0;
1376 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1377 wrk->dispatch_period = 500e-6;
1379 if (num_threads > 1)
1380 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1384 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1387 /* Allocate vpp event queues segment and queue */
1388 session_vpp_event_queues_allocate (smm);
1390 /* Initialize fifo segment main baseva and timeout */
1391 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1392 sm_args->size = smm->session_va_space_size;
1393 segment_manager_main_init (sm_args);
1395 /* Preallocate sessions */
1396 if (smm->preallocated_sessions)
1398 if (num_threads == 1)
1400 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1405 preallocated_sessions_per_worker =
1406 (1.1 * (f64) smm->preallocated_sessions /
1407 (f64) (num_threads - 1));
1409 for (j = 1; j < num_threads; j++)
1411 pool_init_fixed (smm->wrk[j].sessions,
1412 preallocated_sessions_per_worker);
1417 session_lookup_init ();
1418 app_namespaces_init ();
1421 smm->is_enabled = 1;
1423 /* Enable transports */
1424 transport_enable_disable (vm, 1);
1425 transport_init_tx_pacers_period ();
1430 session_node_enable_disable (u8 is_en)
1432 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1433 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1434 u8 have_workers = vtm->n_threads != 0;
1437 foreach_vlib_main (({
1438 if (have_workers && ii == 0)
1440 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1444 vlib_node_t *n = vlib_get_node (this_vlib_main,
1445 session_queue_process_node.index);
1446 vlib_start_process (this_vlib_main, n->runtime_index);
1450 vlib_process_signal_event_mt (this_vlib_main,
1451 session_queue_process_node.index,
1452 SESSION_Q_PROCESS_STOP, 0);
1457 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1464 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1466 clib_error_t *error = 0;
1469 if (session_main.is_enabled)
1472 session_node_enable_disable (is_en);
1473 error = session_manager_main_enable (vm);
1477 session_main.is_enabled = 0;
1478 session_node_enable_disable (is_en);
1485 session_manager_main_init (vlib_main_t * vm)
1487 session_main_t *smm = &session_main;
1488 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1489 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1490 smm->session_va_space_size = 128ULL << 30;
1491 smm->evt_qs_segment_size = 64 << 20;
1493 smm->session_va_space_size = 128 << 20;
1494 smm->evt_qs_segment_size = 1 << 20;
1496 smm->is_enabled = 0;
1500 VLIB_INIT_FUNCTION (session_manager_main_init);
1502 static clib_error_t *
1503 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1505 session_main_t *smm = &session_main;
1509 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1511 if (unformat (input, "event-queue-length %d", &nitems))
1514 smm->configured_event_queue_length = nitems;
1516 clib_warning ("event queue length %d too small, ignored", nitems);
1518 else if (unformat (input, "preallocated-sessions %d",
1519 &smm->preallocated_sessions))
1521 else if (unformat (input, "v4-session-table-buckets %d",
1522 &smm->configured_v4_session_table_buckets))
1524 else if (unformat (input, "v4-halfopen-table-buckets %d",
1525 &smm->configured_v4_halfopen_table_buckets))
1527 else if (unformat (input, "v6-session-table-buckets %d",
1528 &smm->configured_v6_session_table_buckets))
1530 else if (unformat (input, "v6-halfopen-table-buckets %d",
1531 &smm->configured_v6_halfopen_table_buckets))
1533 else if (unformat (input, "v4-session-table-memory %U",
1534 unformat_memory_size, &tmp))
1536 if (tmp >= 0x100000000)
1537 return clib_error_return (0, "memory size %llx (%lld) too large",
1539 smm->configured_v4_session_table_memory = tmp;
1541 else if (unformat (input, "v4-halfopen-table-memory %U",
1542 unformat_memory_size, &tmp))
1544 if (tmp >= 0x100000000)
1545 return clib_error_return (0, "memory size %llx (%lld) too large",
1547 smm->configured_v4_halfopen_table_memory = tmp;
1549 else if (unformat (input, "v6-session-table-memory %U",
1550 unformat_memory_size, &tmp))
1552 if (tmp >= 0x100000000)
1553 return clib_error_return (0, "memory size %llx (%lld) too large",
1555 smm->configured_v6_session_table_memory = tmp;
1557 else if (unformat (input, "v6-halfopen-table-memory %U",
1558 unformat_memory_size, &tmp))
1560 if (tmp >= 0x100000000)
1561 return clib_error_return (0, "memory size %llx (%lld) too large",
1563 smm->configured_v6_halfopen_table_memory = tmp;
1565 else if (unformat (input, "local-endpoints-table-memory %U",
1566 unformat_memory_size, &tmp))
1568 if (tmp >= 0x100000000)
1569 return clib_error_return (0, "memory size %llx (%lld) too large",
1571 smm->local_endpoints_table_memory = tmp;
1573 else if (unformat (input, "local-endpoints-table-buckets %d",
1574 &smm->local_endpoints_table_buckets))
1576 else if (unformat (input, "evt_qs_memfd_seg"))
1577 smm->evt_qs_use_memfd_seg = 1;
1578 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1579 &smm->evt_qs_segment_size))
1582 return clib_error_return (0, "unknown input `%U'",
1583 format_unformat_error, input);
1588 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1591 * fd.io coding-style-patch-verification: ON
1594 * eval: (c-set-style "gnu")