2 * Copyright (c) 2017 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 <vlibmemory/api.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/fib/ip4_fib.h>
27 session_manager_main_t session_manager_main;
28 extern transport_proto_vft_t *tp_vfts;
31 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
32 session_evt_type_t evt_type)
37 u32 tries = 0, max_tries;
39 mq = session_manager_get_vpp_event_queue (thread_index);
40 while (svm_msg_q_try_lock (mq))
42 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
43 if (tries++ == max_tries)
45 SESSION_DBG ("failed to enqueue evt");
49 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
51 svm_msg_q_unlock (mq);
54 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
55 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
57 svm_msg_q_unlock (mq);
60 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
61 evt->event_type = evt_type;
65 evt->rpc_args.fp = data;
66 evt->rpc_args.arg = args;
68 case FIFO_EVENT_APP_TX:
69 case FIFO_EVENT_BUILTIN_RX:
72 case FIFO_EVENT_DISCONNECT:
73 evt->session_handle = session_handle ((stream_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 (svm_fifo_t * f, u32 thread_index,
93 session_evt_type_t evt_type)
95 return session_send_evt_to_thread (f, 0, thread_index, evt_type);
99 session_send_ctrl_evt_to_thread (stream_session_t * s,
100 session_evt_type_t evt_type)
102 /* only event supported for now is disconnect */
103 ASSERT (evt_type == FIFO_EVENT_DISCONNECT);
104 return session_send_evt_to_thread (s, 0, s->thread_index,
105 FIFO_EVENT_DISCONNECT);
109 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
111 if (thread_index != vlib_get_thread_index ())
112 session_send_evt_to_thread (fp, rpc_args, thread_index, FIFO_EVENT_RPC);
115 void (*fnp) (void *) = fp;
121 session_alloc (u32 thread_index)
123 session_manager_main_t *smm = &session_manager_main;
126 pool_get_aligned_will_expand (smm->sessions[thread_index], will_expand,
127 CLIB_CACHE_LINE_BYTES);
128 /* If we have peekers, let them finish */
129 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
131 clib_rwlock_writer_lock (&smm->peekers_rw_locks[thread_index]);
132 pool_get_aligned (session_manager_main.sessions[thread_index], s,
133 CLIB_CACHE_LINE_BYTES);
134 clib_rwlock_writer_unlock (&smm->peekers_rw_locks[thread_index]);
138 pool_get_aligned (session_manager_main.sessions[thread_index], s,
139 CLIB_CACHE_LINE_BYTES);
141 memset (s, 0, sizeof (*s));
142 s->session_index = s - session_manager_main.sessions[thread_index];
143 s->thread_index = thread_index;
148 session_free (stream_session_t * s)
150 pool_put (session_manager_main.sessions[s->thread_index], s);
152 memset (s, 0xFA, sizeof (*s));
156 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
158 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
159 u32 fifo_segment_index;
162 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
164 &fifo_segment_index)))
166 /* Initialize backpointers */
167 server_rx_fifo->master_session_index = s->session_index;
168 server_rx_fifo->master_thread_index = s->thread_index;
170 server_tx_fifo->master_session_index = s->session_index;
171 server_tx_fifo->master_thread_index = s->thread_index;
173 s->server_rx_fifo = server_rx_fifo;
174 s->server_tx_fifo = server_tx_fifo;
175 s->svm_segment_index = fifo_segment_index;
179 static stream_session_t *
180 session_alloc_for_connection (transport_connection_t * tc)
183 u32 thread_index = tc->thread_index;
185 ASSERT (thread_index == vlib_get_thread_index ()
186 || transport_protocol_is_cl (tc->proto));
188 s = session_alloc (thread_index);
189 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
190 s->session_state = SESSION_STATE_CONNECTING;
191 s->enqueue_epoch = ~0;
193 /* Attach transport to session and vice versa */
194 s->connection_index = tc->c_index;
195 tc->s_index = s->session_index;
200 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
201 u8 alloc_fifos, stream_session_t ** ret_s)
206 s = session_alloc_for_connection (tc);
207 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
214 /* Add to the main lookup table */
215 session_lookup_add_connection (tc, session_handle (s));
222 * Discards bytes from buffer chain
224 * It discards n_bytes_to_drop starting at first buffer after chain_b
227 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
228 vlib_buffer_t ** chain_b,
231 vlib_buffer_t *next = *chain_b;
232 u32 to_drop = n_bytes_to_drop;
233 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
234 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
236 next = vlib_get_buffer (vm, next->next_buffer);
237 if (next->current_length > to_drop)
239 vlib_buffer_advance (next, to_drop);
244 to_drop -= next->current_length;
245 next->current_length = 0;
251 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
255 * Enqueue buffer chain tail
258 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
259 u32 offset, u8 is_in_order)
261 vlib_buffer_t *chain_b;
262 u32 chain_bi, len, diff;
263 vlib_main_t *vm = vlib_get_main ();
268 if (is_in_order && offset)
270 diff = offset - b->current_length;
271 if (diff > b->total_length_not_including_first_buffer)
274 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
275 chain_bi = vlib_get_buffer_index (vm, chain_b);
278 chain_bi = b->next_buffer;
282 chain_b = vlib_get_buffer (vm, chain_bi);
283 data = vlib_buffer_get_current (chain_b);
284 len = chain_b->current_length;
289 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
296 return (rv > 0) ? (written + rv) : written;
302 /* written more than what was left in chain */
303 if (written > b->total_length_not_including_first_buffer)
306 /* drop the bytes that have already been delivered */
307 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
312 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
316 clib_warning ("failed to enqueue multi-buffer seg");
322 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
323 ? chain_b->next_buffer : 0));
332 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
333 * event but on request can queue notification events for later delivery by
334 * calling stream_server_flush_enqueue_events().
336 * @param tc Transport connection which is to be enqueued data
337 * @param b Buffer to be enqueued
338 * @param offset Offset at which to start enqueueing if out-of-order
339 * @param queue_event Flag to indicate if peer is to be notified or if event
340 * is to be queued. The former is useful when more data is
341 * enqueued and only one event is to be generated.
342 * @param is_in_order Flag to indicate if data is in order
343 * @return Number of bytes enqueued or a negative value if enqueueing failed.
346 session_enqueue_stream_connection (transport_connection_t * tc,
347 vlib_buffer_t * b, u32 offset,
348 u8 queue_event, u8 is_in_order)
351 int enqueued = 0, rv, in_order_off;
353 s = session_get (tc->s_index, tc->thread_index);
357 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
359 vlib_buffer_get_current (b));
360 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
363 in_order_off = enqueued > b->current_length ? enqueued : 0;
364 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
371 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
373 vlib_buffer_get_current (b));
374 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
375 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
376 /* if something was enqueued, report even this as success for ooo
377 * segment handling */
383 /* Queue RX event on this fifo. Eventually these will need to be flushed
384 * by calling stream_server_flush_enqueue_events () */
385 session_manager_main_t *smm = vnet_get_session_manager_main ();
386 u32 thread_index = s->thread_index;
387 u32 enqueue_epoch = smm->current_enqueue_epoch[tc->proto][thread_index];
389 if (s->enqueue_epoch != enqueue_epoch)
391 s->enqueue_epoch = enqueue_epoch;
392 vec_add1 (smm->session_to_enqueue[tc->proto][thread_index],
393 s - smm->sessions[thread_index]);
402 session_enqueue_dgram_connection (stream_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 (s->server_rx_fifo)
409 >= b->current_length + sizeof (*hdr));
411 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
413 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
414 vlib_buffer_get_current (b));
415 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
417 in_order_off = enqueued > b->current_length ? enqueued : 0;
418 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
424 /* Queue RX event on this fifo. Eventually these will need to be flushed
425 * by calling stream_server_flush_enqueue_events () */
426 session_manager_main_t *smm = vnet_get_session_manager_main ();
427 u32 thread_index = s->thread_index;
428 u32 enqueue_epoch = smm->current_enqueue_epoch[proto][thread_index];
430 if (s->enqueue_epoch != enqueue_epoch)
432 s->enqueue_epoch = enqueue_epoch;
433 vec_add1 (smm->session_to_enqueue[proto][thread_index],
434 s - smm->sessions[thread_index]);
440 /** Check if we have space in rx fifo to push more bytes */
442 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
445 stream_session_t *s = session_get (tc->s_index, thread_index);
447 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
450 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
457 session_tx_fifo_max_dequeue (transport_connection_t * tc)
459 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
460 if (!s->server_tx_fifo)
462 return svm_fifo_max_dequeue (s->server_tx_fifo);
466 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
467 u32 offset, u32 max_bytes)
469 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
470 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
474 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
476 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
477 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
481 * Notify session peer that new data has been enqueued.
483 * @param s Stream session for which the event is to be generated.
484 * @param lock Flag to indicate if call should lock message queue.
486 * @return 0 on success or negative number if failed to send notification.
489 session_enqueue_notify (stream_session_t * s, u8 lock)
493 app = app_worker_get_if_valid (s->app_wrk_index);
494 if (PREDICT_FALSE (!app))
496 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
501 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
502 ed->data[0] = FIFO_EVENT_APP_RX;
503 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
508 return application_lock_and_send_event (app, s, FIFO_EVENT_APP_RX);
510 return application_send_event (app, s, FIFO_EVENT_APP_RX);
514 session_dequeue_notify (stream_session_t * s)
518 app = app_worker_get_if_valid (s->app_wrk_index);
519 if (PREDICT_FALSE (!app))
522 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL)
523 return application_lock_and_send_event (app, s, FIFO_EVENT_APP_RX);
525 return application_send_event (app, s, FIFO_EVENT_APP_TX);
529 * Flushes queue of sessions that are to be notified of new data
532 * @param thread_index Thread index for which the flush is to be performed.
533 * @return 0 on success or a positive number indicating the number of
534 * failures due to API queue being full.
537 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
539 session_manager_main_t *smm = &session_manager_main;
540 transport_service_type_t tp_service;
541 int i, errors = 0, lock;
545 indices = smm->session_to_enqueue[transport_proto][thread_index];
546 tp_service = transport_protocol_service_type (transport_proto);
547 lock = tp_service == TRANSPORT_SERVICE_CL;
549 for (i = 0; i < vec_len (indices); i++)
551 s = session_get_if_valid (indices[i], thread_index);
552 if (PREDICT_FALSE (!s))
557 if (PREDICT_FALSE (session_enqueue_notify (s, lock)))
561 vec_reset_length (indices);
562 smm->session_to_enqueue[transport_proto][thread_index] = indices;
563 smm->current_enqueue_epoch[transport_proto][thread_index]++;
569 session_manager_flush_all_enqueue_events (u8 transport_proto)
571 vlib_thread_main_t *vtm = vlib_get_thread_main ();
573 for (i = 0; i < 1 + vtm->n_threads; i++)
574 errors += session_manager_flush_enqueue_events (transport_proto, i);
579 * Init fifo tail and head pointers
581 * Useful if transport uses absolute offsets for tracking ooo segments.
584 stream_session_init_fifos_pointers (transport_connection_t * tc,
585 u32 rx_pointer, u32 tx_pointer)
588 s = session_get (tc->s_index, tc->thread_index);
589 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
590 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
594 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
596 u32 opaque = 0, new_ti, new_si;
597 stream_session_t *new_s = 0;
598 segment_manager_t *sm;
599 app_worker_t *app_wrk;
606 * Find connection handle and cleanup half-open table
608 handle = session_lookup_half_open_handle (tc);
609 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
611 SESSION_DBG ("half-open was removed!");
614 session_lookup_del_half_open (tc);
616 /* Get the app's index from the handle we stored when opening connection
617 * and the opaque (api_context for external apps) from transport session
619 app_wrk = app_worker_get_if_valid (handle >> 32);
622 opaque = tc->s_index;
623 app = application_get (app_wrk->app_index);
626 * Allocate new session with fifos (svm segments are allocated if needed)
630 sm = app_worker_get_connect_segment_manager (app_wrk);
631 alloc_fifos = !application_is_builtin_proxy (app);
632 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
639 new_s->app_wrk_index = app_wrk->wrk_index;
640 new_si = new_s->session_index;
641 new_ti = new_s->thread_index;
646 * Notify client application
648 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
651 SESSION_DBG ("failed to notify app");
654 new_s = session_get (new_si, new_ti);
655 stream_session_disconnect_transport (new_s);
662 new_s = session_get (new_si, new_ti);
663 new_s->session_state = SESSION_STATE_READY;
670 typedef struct _session_switch_pool_args
674 u32 new_thread_index;
675 u32 new_session_index;
676 } session_switch_pool_args_t;
679 session_switch_pool (void *cb_args)
681 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
682 transport_proto_t tp;
684 ASSERT (args->thread_index == vlib_get_thread_index ());
685 s = session_get (args->session_index, args->thread_index);
686 s->server_tx_fifo->master_session_index = args->new_session_index;
687 s->server_tx_fifo->master_thread_index = args->new_thread_index;
688 tp = session_get_transport_proto (s);
689 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
691 clib_mem_free (cb_args);
695 * Move dgram session to the right thread
698 session_dgram_connect_notify (transport_connection_t * tc,
699 u32 old_thread_index,
700 stream_session_t ** new_session)
702 stream_session_t *new_s;
703 session_switch_pool_args_t *rpc_args;
706 * Clone half-open session to the right thread.
708 new_s = session_clone_safe (tc->s_index, old_thread_index);
709 new_s->connection_index = tc->c_index;
710 new_s->server_rx_fifo->master_session_index = new_s->session_index;
711 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
712 new_s->session_state = SESSION_STATE_READY;
713 session_lookup_add_connection (tc, session_handle (new_s));
716 * Ask thread owning the old session to clean it up and make us the tx
719 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
720 rpc_args->new_session_index = new_s->session_index;
721 rpc_args->new_thread_index = new_s->thread_index;
722 rpc_args->session_index = tc->s_index;
723 rpc_args->thread_index = old_thread_index;
724 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
727 tc->s_index = new_s->session_index;
728 new_s->connection_index = tc->c_index;
729 *new_session = new_s;
734 stream_session_accept_notify (transport_connection_t * tc)
736 app_worker_t *app_wrk;
740 s = session_get (tc->s_index, tc->thread_index);
741 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
744 app = application_get (app_wrk->app_index);
745 app->cb_fns.session_accept_callback (s);
749 * Notification from transport that connection is being closed.
751 * A disconnect is sent to application but state is not removed. Once
752 * disconnect is acknowledged by application, session disconnect is called.
753 * Ultimately this leads to close being called on transport (passive close).
756 stream_session_disconnect_notify (transport_connection_t * tc)
758 app_worker_t *app_wrk;
762 s = session_get (tc->s_index, tc->thread_index);
763 s->session_state = SESSION_STATE_CLOSING;
764 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
767 app = application_get (app_wrk->app_index);
768 app->cb_fns.session_disconnect_callback (s);
772 * Cleans up session and lookup table.
774 * Transport connection must still be valid.
777 stream_session_delete (stream_session_t * s)
781 /* Delete from the main lookup table. */
782 if ((rv = session_lookup_del_session (s)))
783 clib_warning ("hash delete error, rv %d", rv);
785 /* Cleanup fifo segments */
786 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
792 * Notification from transport that connection is being deleted
794 * This removes the session if it is still valid. It should be called only on
795 * previously fully established sessions. For instance failed connects should
796 * call stream_session_connect_notify and indicate that the connect has
800 stream_session_delete_notify (transport_connection_t * tc)
804 /* App might've been removed already */
805 s = session_get_if_valid (tc->s_index, tc->thread_index);
808 stream_session_delete (s);
812 * Notify application that connection has been reset.
815 stream_session_reset_notify (transport_connection_t * tc)
818 app_worker_t *app_wrk;
820 s = session_get (tc->s_index, tc->thread_index);
821 s->session_state = SESSION_STATE_CLOSED;
822 app_wrk = app_worker_get (s->app_wrk_index);
823 app = application_get (app_wrk->app_index);
824 app->cb_fns.session_reset_callback (s);
828 * Accept a stream session. Optionally ping the server by callback.
831 stream_session_accept (transport_connection_t * tc, u32 listener_index,
834 stream_session_t *s, *listener;
835 app_worker_t *app_wrk;
836 segment_manager_t *sm;
839 /* Find the server */
840 listener = listen_session_get (listener_index);
841 app_wrk = app_worker_get (listener->app_wrk_index);
843 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
844 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
847 s->app_wrk_index = app_wrk->wrk_index;
848 s->listener_index = listener_index;
849 s->session_state = SESSION_STATE_ACCEPTING;
851 /* Shoulder-tap the server */
854 application_t *app = application_get (app_wrk->app_index);
855 app->cb_fns.session_accept_callback (s);
862 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
864 transport_connection_t *tc;
865 transport_endpoint_t *tep;
866 segment_manager_t *sm;
867 app_worker_t *app_wrk;
872 tep = session_endpoint_to_transport (rmt);
873 rv = tp_vfts[rmt->transport_proto].open (tep);
876 SESSION_DBG ("Transport failed to open connection.");
877 return VNET_API_ERROR_SESSION_CONNECT;
880 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
882 /* For dgram type of service, allocate session and fifos now.
884 app_wrk = app_worker_get (app_wrk_index);
885 sm = app_worker_get_connect_segment_manager (app_wrk);
887 if (session_alloc_and_init (sm, tc, 1, &s))
889 s->app_wrk_index = app_wrk->wrk_index;
890 s->session_state = SESSION_STATE_OPENED;
892 /* Tell the app about the new event fifo for this session */
893 app = application_get (app_wrk->app_index);
894 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
900 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
902 transport_connection_t *tc;
903 transport_endpoint_t *tep;
907 tep = session_endpoint_to_transport (rmt);
908 rv = tp_vfts[rmt->transport_proto].open (tep);
911 SESSION_DBG ("Transport failed to open connection.");
912 return VNET_API_ERROR_SESSION_CONNECT;
915 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
917 /* If transport offers a stream service, only allocate session once the
918 * connection has been established.
919 * Add connection to half-open table and save app and tc index. The
920 * latter is needed to help establish the connection while the former
921 * is needed when the connect notify comes and we have to notify the
924 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
925 session_lookup_add_half_open (tc, handle);
927 /* Store api_context (opaque) for when the reply comes. Not the nicest
928 * thing but better than allocating a separate half-open pool.
930 tc->s_index = opaque;
935 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
937 session_endpoint_extended_t *sep = (session_endpoint_extended_t *) rmt;
938 sep->app_wrk_index = app_wrk_index;
939 sep->opaque = opaque;
941 return tp_vfts[rmt->transport_proto].open ((transport_endpoint_t *) sep);
944 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
947 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
955 * Ask transport to open connection to remote transport endpoint.
957 * Stores handle for matching request with reply since the call can be
958 * asynchronous. For instance, for TCP the 3-way handshake must complete
959 * before reply comes. Session is only created once connection is established.
961 * @param app_index Index of the application requesting the connect
962 * @param st Session type requested.
963 * @param tep Remote transport endpoint
964 * @param opaque Opaque data (typically, api_context) the application expects
965 * on open completion.
968 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
970 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
971 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
975 session_listen_vc (stream_session_t * s, session_endpoint_t * sep)
977 transport_connection_t *tc;
980 /* Transport bind/listen */
981 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
982 session_endpoint_to_transport
985 if (tci == (u32) ~ 0)
988 /* Attach transport to session */
989 s->connection_index = tci;
990 tc = tp_vfts[sep->transport_proto].get_listener (tci);
992 /* Weird but handle it ... */
996 /* Add to the main lookup table */
997 session_lookup_add_connection (tc, s->session_index);
1002 session_listen_cl (stream_session_t * s, session_endpoint_t * sep)
1004 transport_connection_t *tc;
1005 app_worker_t *server;
1006 segment_manager_t *sm;
1009 /* Transport bind/listen */
1010 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
1011 session_endpoint_to_transport
1014 if (tci == (u32) ~ 0)
1017 /* Attach transport to session */
1018 s->connection_index = tci;
1019 tc = tp_vfts[sep->transport_proto].get_listener (tci);
1021 /* Weird but handle it ... */
1025 server = app_worker_get (s->app_wrk_index);
1026 sm = app_worker_get_listen_segment_manager (server, s);
1027 if (session_alloc_fifos (sm, s))
1030 /* Add to the main lookup table */
1031 session_lookup_add_connection (tc, s->session_index);
1036 session_listen_app (stream_session_t * s, session_endpoint_t * sep)
1038 session_endpoint_extended_t esep;
1039 clib_memcpy (&esep, sep, sizeof (*sep));
1040 esep.app_wrk_index = s->app_wrk_index;
1042 return tp_vfts[sep->transport_proto].bind (s->session_index,
1043 (transport_endpoint_t *) & esep);
1046 typedef int (*session_listen_service_fn) (stream_session_t *,
1047 session_endpoint_t *);
1050 static session_listen_service_fn
1051 session_listen_srv_fns[TRANSPORT_N_SERVICES] = {
1059 * Ask transport to listen on local transport endpoint.
1061 * @param s Session for which listen will be called. Note that unlike
1062 * established sessions, listen sessions are not associated to a
1064 * @param tep Local endpoint to be listened on.
1067 stream_session_listen (stream_session_t * s, session_endpoint_t * sep)
1069 transport_service_type_t tst = tp_vfts[sep->transport_proto].service_type;
1070 return session_listen_srv_fns[tst] (s, sep);
1074 * Ask transport to stop listening on local transport endpoint.
1076 * @param s Session to stop listening on. It must be in state LISTENING.
1079 stream_session_stop_listen (stream_session_t * s)
1081 transport_proto_t tp = session_get_transport_proto (s);
1082 transport_connection_t *tc;
1083 if (s->session_state != SESSION_STATE_LISTENING)
1085 clib_warning ("not a listening session");
1089 tc = tp_vfts[tp].get_listener (s->connection_index);
1092 clib_warning ("no transport");
1093 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1096 session_lookup_del_connection (tc);
1097 tp_vfts[tp].unbind (s->connection_index);
1102 * Initialize session disconnect.
1104 * Request is always sent to session node to ensure that all outstanding
1105 * requests are served before transport is notified.
1108 stream_session_disconnect (stream_session_t * s)
1110 u32 thread_index = vlib_get_thread_index ();
1111 session_manager_main_t *smm = &session_manager_main;
1112 session_event_t *evt;
1117 if (s->session_state >= SESSION_STATE_CLOSING)
1119 /* Session already closed. Clear the tx fifo */
1120 if (s->session_state == SESSION_STATE_CLOSED)
1121 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1125 s->session_state = SESSION_STATE_CLOSING;
1127 /* If we are in the handler thread, or being called with the worker barrier
1128 * held (api/cli), just append a new event to pending disconnects vector. */
1129 if ((thread_index == 0 && !vlib_get_current_process (vlib_get_main ()))
1130 || thread_index == s->thread_index)
1132 ASSERT (s->thread_index == thread_index || thread_index == 0);
1133 vec_add2 (smm->pending_disconnects[s->thread_index], evt, 1);
1134 memset (evt, 0, sizeof (*evt));
1135 evt->session_handle = session_handle (s);
1136 evt->event_type = FIFO_EVENT_DISCONNECT;
1139 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
1143 * Notify transport the session can be disconnected. This should eventually
1144 * result in a delete notification that allows us to cleanup session state.
1145 * Called for both active/passive disconnects.
1147 * Must be called from the session's thread.
1150 stream_session_disconnect_transport (stream_session_t * s)
1152 s->session_state = SESSION_STATE_CLOSED;
1153 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1158 * Cleanup transport and session state.
1160 * Notify transport of the cleanup and free the session. This should
1161 * be called only if transport reported some error and is already
1165 stream_session_cleanup (stream_session_t * s)
1167 s->session_state = SESSION_STATE_CLOSED;
1169 /* Delete from main lookup table before we axe the the transport */
1170 session_lookup_del_session (s);
1171 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1173 /* Since we called cleanup, no delete notification will come. So, make
1174 * sure the session is properly freed. */
1175 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
1180 transport_service_type_t
1181 session_transport_service_type (stream_session_t * s)
1183 transport_proto_t tp;
1184 tp = session_get_transport_proto (s);
1185 return transport_protocol_service_type (tp);
1188 transport_tx_fn_type_t
1189 session_transport_tx_fn_type (stream_session_t * s)
1191 transport_proto_t tp;
1192 tp = session_get_transport_proto (s);
1193 return transport_protocol_tx_fn_type (tp);
1197 session_tx_is_dgram (stream_session_t * s)
1199 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1203 * Allocate event queues in the shared-memory segment
1205 * That can either be a newly created memfd segment, that will need to be
1206 * mapped by all stack users, or the binary api's svm region. The latter is
1207 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1208 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1209 * vpp uses api svm region for event queues.
1212 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1214 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1215 ssvm_private_t *eqs = &smm->evt_qs_segment;
1216 api_main_t *am = &api_main;
1217 u64 eqs_size = 64 << 20;
1218 pid_t vpp_pid = getpid ();
1222 if (smm->configured_event_queue_length)
1223 evt_q_length = smm->configured_event_queue_length;
1225 if (smm->evt_qs_use_memfd_seg)
1227 if (smm->evt_qs_segment_size)
1228 eqs_size = smm->evt_qs_segment_size;
1230 eqs->ssvm_size = eqs_size;
1231 eqs->i_am_master = 1;
1232 eqs->my_pid = vpp_pid;
1233 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1234 eqs->requested_va = smm->session_baseva;
1236 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1238 clib_warning ("failed to initialize queue segment");
1243 if (smm->evt_qs_use_memfd_seg)
1244 oldheap = ssvm_push_heap (eqs->sh);
1246 oldheap = svm_push_data_heap (am->vlib_rp);
1248 for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1250 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1251 u32 notif_q_size = clib_max (16, evt_q_length >> 4);
1252 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1253 {evt_q_length, evt_size, 0}
1255 {notif_q_size, 256, 0}
1257 cfg->consumer_pid = 0;
1259 cfg->q_nitems = evt_q_length;
1260 cfg->ring_cfgs = rc;
1261 smm->vpp_event_queues[i] = svm_msg_q_alloc (cfg);
1262 if (smm->evt_qs_use_memfd_seg)
1264 if (svm_msg_q_alloc_consumer_eventfd (smm->vpp_event_queues[i]))
1265 clib_warning ("eventfd returned");
1269 if (smm->evt_qs_use_memfd_seg)
1270 ssvm_pop_heap (oldheap);
1272 svm_pop_heap (oldheap);
1276 session_manager_get_evt_q_segment (void)
1278 session_manager_main_t *smm = &session_manager_main;
1279 if (smm->evt_qs_use_memfd_seg)
1280 return &smm->evt_qs_segment;
1285 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1286 session_tx_fifo_peek_and_snd,
1287 session_tx_fifo_dequeue_and_snd,
1288 session_tx_fifo_dequeue_internal,
1289 session_tx_fifo_dequeue_and_snd
1294 * Initialize session layer for given transport proto and ip version
1296 * Allocates per session type (transport proto + ip version) data structures
1297 * and adds arc from session queue node to session type output node.
1300 session_register_transport (transport_proto_t transport_proto,
1301 const transport_proto_vft_t * vft, u8 is_ip4,
1304 session_manager_main_t *smm = &session_manager_main;
1305 session_type_t session_type;
1306 u32 next_index = ~0;
1308 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1310 vec_validate (smm->session_type_to_next, session_type);
1311 vec_validate (smm->session_tx_fns, session_type);
1314 if (output_node != ~0)
1316 foreach_vlib_main (({
1317 next_index = vlib_node_add_next (this_vlib_main,
1318 session_queue_node.index,
1324 smm->session_type_to_next[session_type] = next_index;
1325 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1328 transport_connection_t *
1329 session_get_transport (stream_session_t * s)
1331 transport_proto_t tp;
1332 if (s->session_state != SESSION_STATE_LISTENING)
1334 tp = session_get_transport_proto (s);
1335 return tp_vfts[tp].get_connection (s->connection_index,
1341 transport_connection_t *
1342 listen_session_get_transport (stream_session_t * s)
1344 transport_proto_t tp = session_get_transport_proto (s);
1345 return tp_vfts[tp].get_listener (s->connection_index);
1349 listen_session_get_local_session_endpoint (stream_session_t * listener,
1350 session_endpoint_t * sep)
1352 transport_proto_t tp = session_get_transport_proto (listener);
1353 transport_connection_t *tc;
1354 tc = tp_vfts[tp].get_listener (listener->connection_index);
1357 clib_warning ("no transport");
1361 /* N.B. The ip should not be copied because this is the local endpoint */
1362 sep->port = tc->lcl_port;
1363 sep->transport_proto = tc->proto;
1364 sep->is_ip4 = tc->is_ip4;
1369 session_flush_frames_main_thread (vlib_main_t * vm)
1371 ASSERT (vlib_get_thread_index () == 0);
1372 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1373 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1376 static clib_error_t *
1377 session_manager_main_enable (vlib_main_t * vm)
1379 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1380 session_manager_main_t *smm = &session_manager_main;
1381 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1382 u32 num_threads, preallocated_sessions_per_worker;
1385 num_threads = 1 /* main thread */ + vtm->n_threads;
1387 if (num_threads < 1)
1388 return clib_error_return (0, "n_thread_stacks not set");
1390 /* configure per-thread ** vectors */
1391 vec_validate (smm->sessions, num_threads - 1);
1392 vec_validate (smm->tx_buffers, num_threads - 1);
1393 vec_validate (smm->pending_event_vector, num_threads - 1);
1394 vec_validate (smm->pending_disconnects, num_threads - 1);
1395 vec_validate (smm->free_event_vector, num_threads - 1);
1396 vec_validate (smm->vpp_event_queues, num_threads - 1);
1397 vec_validate (smm->peekers_rw_locks, num_threads - 1);
1398 vec_validate_aligned (smm->ctx, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1400 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1402 vec_validate (smm->current_enqueue_epoch[i], num_threads - 1);
1403 vec_validate (smm->session_to_enqueue[i], num_threads - 1);
1404 for (j = 0; j < num_threads; j++)
1405 smm->current_enqueue_epoch[i][j] = 1;
1408 for (i = 0; i < num_threads; i++)
1410 vec_validate (smm->free_event_vector[i], 0);
1411 _vec_len (smm->free_event_vector[i]) = 0;
1412 vec_validate (smm->pending_event_vector[i], 0);
1413 _vec_len (smm->pending_event_vector[i]) = 0;
1414 vec_validate (smm->pending_disconnects[i], 0);
1415 _vec_len (smm->pending_disconnects[i]) = 0;
1416 if (num_threads > 1)
1417 clib_rwlock_init (&smm->peekers_rw_locks[i]);
1421 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1424 /* Allocate vpp event queues segment and queue */
1425 session_vpp_event_queues_allocate (smm);
1427 /* Initialize fifo segment main baseva and timeout */
1428 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1429 sm_args->size = smm->session_va_space_size;
1430 segment_manager_main_init (sm_args);
1432 /* Preallocate sessions */
1433 if (smm->preallocated_sessions)
1435 if (num_threads == 1)
1437 pool_init_fixed (smm->sessions[0], smm->preallocated_sessions);
1442 preallocated_sessions_per_worker =
1443 (1.1 * (f64) smm->preallocated_sessions /
1444 (f64) (num_threads - 1));
1446 for (j = 1; j < num_threads; j++)
1448 pool_init_fixed (smm->sessions[j],
1449 preallocated_sessions_per_worker);
1454 session_lookup_init ();
1455 app_namespaces_init ();
1458 smm->is_enabled = 1;
1460 /* Enable transports */
1461 transport_enable_disable (vm, 1);
1467 session_node_enable_disable (u8 is_en)
1469 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1470 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1471 u8 have_workers = vtm->n_threads != 0;
1474 foreach_vlib_main (({
1475 if (have_workers && ii == 0)
1477 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1481 vlib_node_t *n = vlib_get_node (this_vlib_main,
1482 session_queue_process_node.index);
1483 vlib_start_process (this_vlib_main, n->runtime_index);
1487 vlib_process_signal_event_mt (this_vlib_main,
1488 session_queue_process_node.index,
1489 SESSION_Q_PROCESS_STOP, 0);
1494 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1501 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1503 clib_error_t *error = 0;
1506 if (session_manager_main.is_enabled)
1509 session_node_enable_disable (is_en);
1510 error = session_manager_main_enable (vm);
1514 session_manager_main.is_enabled = 0;
1515 session_node_enable_disable (is_en);
1522 session_manager_main_init (vlib_main_t * vm)
1524 session_manager_main_t *smm = &session_manager_main;
1525 smm->session_baseva = 0x200000000ULL;
1526 smm->session_va_space_size = (u64) 128 << 30;
1527 smm->evt_qs_segment_size = 64 << 20;
1528 smm->is_enabled = 0;
1532 VLIB_INIT_FUNCTION (session_manager_main_init);
1534 static clib_error_t *
1535 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1537 session_manager_main_t *smm = &session_manager_main;
1541 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1543 if (unformat (input, "event-queue-length %d", &nitems))
1546 smm->configured_event_queue_length = nitems;
1548 clib_warning ("event queue length %d too small, ignored", nitems);
1550 else if (unformat (input, "preallocated-sessions %d",
1551 &smm->preallocated_sessions))
1553 else if (unformat (input, "v4-session-table-buckets %d",
1554 &smm->configured_v4_session_table_buckets))
1556 else if (unformat (input, "v4-halfopen-table-buckets %d",
1557 &smm->configured_v4_halfopen_table_buckets))
1559 else if (unformat (input, "v6-session-table-buckets %d",
1560 &smm->configured_v6_session_table_buckets))
1562 else if (unformat (input, "v6-halfopen-table-buckets %d",
1563 &smm->configured_v6_halfopen_table_buckets))
1565 else if (unformat (input, "v4-session-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->configured_v4_session_table_memory = tmp;
1573 else if (unformat (input, "v4-halfopen-table-memory %U",
1574 unformat_memory_size, &tmp))
1576 if (tmp >= 0x100000000)
1577 return clib_error_return (0, "memory size %llx (%lld) too large",
1579 smm->configured_v4_halfopen_table_memory = tmp;
1581 else if (unformat (input, "v6-session-table-memory %U",
1582 unformat_memory_size, &tmp))
1584 if (tmp >= 0x100000000)
1585 return clib_error_return (0, "memory size %llx (%lld) too large",
1587 smm->configured_v6_session_table_memory = tmp;
1589 else if (unformat (input, "v6-halfopen-table-memory %U",
1590 unformat_memory_size, &tmp))
1592 if (tmp >= 0x100000000)
1593 return clib_error_return (0, "memory size %llx (%lld) too large",
1595 smm->configured_v6_halfopen_table_memory = tmp;
1597 else if (unformat (input, "local-endpoints-table-memory %U",
1598 unformat_memory_size, &tmp))
1600 if (tmp >= 0x100000000)
1601 return clib_error_return (0, "memory size %llx (%lld) too large",
1603 smm->local_endpoints_table_memory = tmp;
1605 else if (unformat (input, "local-endpoints-table-buckets %d",
1606 &smm->local_endpoints_table_buckets))
1608 else if (unformat (input, "evt_qs_memfd_seg"))
1609 smm->evt_qs_use_memfd_seg = 1;
1611 return clib_error_return (0, "unknown input `%U'",
1612 format_unformat_error, input);
1617 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1620 * fd.io coding-style-patch-verification: ON
1623 * eval: (c-set-style "gnu")