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 (u64 session_handle, fifo_event_type_t evt_type,
32 u32 thread_index, void *fp, void *rpc_args)
34 session_fifo_event_t evt = { {0}, };
36 u32 tries = 0, max_tries;
38 evt.event_type = evt_type;
39 if (evt_type == FIFO_EVENT_RPC)
42 evt.rpc_args.arg = rpc_args;
45 evt.session_handle = session_handle;
47 q = session_manager_get_vpp_event_queue (thread_index);
48 while (svm_queue_add (q, (u8 *) & evt, 1))
50 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
51 if (tries++ == max_tries)
53 SESSION_DBG ("failed to enqueue evt");
60 session_send_session_evt_to_thread (u64 session_handle,
61 fifo_event_type_t evt_type,
64 session_send_evt_to_thread (session_handle, evt_type, thread_index, 0, 0);
68 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
70 if (thread_index != vlib_get_thread_index ())
71 session_send_evt_to_thread (0, FIFO_EVENT_RPC, thread_index, fp,
75 void (*fnp) (void *) = fp;
81 session_alloc (u32 thread_index)
83 session_manager_main_t *smm = &session_manager_main;
86 pool_get_aligned_will_expand (smm->sessions[thread_index], will_expand,
87 CLIB_CACHE_LINE_BYTES);
88 /* If we have peekers, let them finish */
89 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
91 clib_rwlock_writer_lock (&smm->peekers_rw_locks[thread_index]);
92 pool_get_aligned (session_manager_main.sessions[thread_index], s,
93 CLIB_CACHE_LINE_BYTES);
94 clib_rwlock_writer_unlock (&smm->peekers_rw_locks[thread_index]);
98 pool_get_aligned (session_manager_main.sessions[thread_index], s,
99 CLIB_CACHE_LINE_BYTES);
101 memset (s, 0, sizeof (*s));
102 s->session_index = s - session_manager_main.sessions[thread_index];
103 s->thread_index = thread_index;
108 session_free (stream_session_t * s)
110 pool_put (session_manager_main.sessions[s->thread_index], s);
112 memset (s, 0xFA, sizeof (*s));
116 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
118 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
119 u32 fifo_segment_index;
122 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
124 &fifo_segment_index)))
126 /* Initialize backpointers */
127 server_rx_fifo->master_session_index = s->session_index;
128 server_rx_fifo->master_thread_index = s->thread_index;
130 server_tx_fifo->master_session_index = s->session_index;
131 server_tx_fifo->master_thread_index = s->thread_index;
133 s->server_rx_fifo = server_rx_fifo;
134 s->server_tx_fifo = server_tx_fifo;
135 s->svm_segment_index = fifo_segment_index;
139 static stream_session_t *
140 session_alloc_for_connection (transport_connection_t * tc)
143 u32 thread_index = tc->thread_index;
145 ASSERT (thread_index == vlib_get_thread_index ()
146 || transport_protocol_is_cl (tc->proto));
148 s = session_alloc (thread_index);
149 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
150 s->session_state = SESSION_STATE_CONNECTING;
151 s->enqueue_epoch = ~0;
153 /* Attach transport to session and vice versa */
154 s->connection_index = tc->c_index;
155 tc->s_index = s->session_index;
160 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
161 u8 alloc_fifos, stream_session_t ** ret_s)
166 s = session_alloc_for_connection (tc);
167 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
174 /* Add to the main lookup table */
175 session_lookup_add_connection (tc, session_handle (s));
182 * Discards bytes from buffer chain
184 * It discards n_bytes_to_drop starting at first buffer after chain_b
187 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
188 vlib_buffer_t ** chain_b,
191 vlib_buffer_t *next = *chain_b;
192 u32 to_drop = n_bytes_to_drop;
193 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
194 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
196 next = vlib_get_buffer (vm, next->next_buffer);
197 if (next->current_length > to_drop)
199 vlib_buffer_advance (next, to_drop);
204 to_drop -= next->current_length;
205 next->current_length = 0;
211 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
215 * Enqueue buffer chain tail
218 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
219 u32 offset, u8 is_in_order)
221 vlib_buffer_t *chain_b;
222 u32 chain_bi, len, diff;
223 vlib_main_t *vm = vlib_get_main ();
228 if (is_in_order && offset)
230 diff = offset - b->current_length;
231 if (diff > b->total_length_not_including_first_buffer)
234 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
235 chain_bi = vlib_get_buffer_index (vm, chain_b);
238 chain_bi = b->next_buffer;
242 chain_b = vlib_get_buffer (vm, chain_bi);
243 data = vlib_buffer_get_current (chain_b);
244 len = chain_b->current_length;
249 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
256 return (rv > 0) ? (written + rv) : written;
262 /* written more than what was left in chain */
263 if (written > b->total_length_not_including_first_buffer)
266 /* drop the bytes that have already been delivered */
267 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
272 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
276 clib_warning ("failed to enqueue multi-buffer seg");
282 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
283 ? chain_b->next_buffer : 0));
292 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
293 * event but on request can queue notification events for later delivery by
294 * calling stream_server_flush_enqueue_events().
296 * @param tc Transport connection which is to be enqueued data
297 * @param b Buffer to be enqueued
298 * @param offset Offset at which to start enqueueing if out-of-order
299 * @param queue_event Flag to indicate if peer is to be notified or if event
300 * is to be queued. The former is useful when more data is
301 * enqueued and only one event is to be generated.
302 * @param is_in_order Flag to indicate if data is in order
303 * @return Number of bytes enqueued or a negative value if enqueueing failed.
306 session_enqueue_stream_connection (transport_connection_t * tc,
307 vlib_buffer_t * b, u32 offset,
308 u8 queue_event, u8 is_in_order)
311 int enqueued = 0, rv, in_order_off;
313 s = session_get (tc->s_index, tc->thread_index);
317 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
319 vlib_buffer_get_current (b));
320 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
323 in_order_off = enqueued > b->current_length ? enqueued : 0;
324 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
331 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
333 vlib_buffer_get_current (b));
334 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
335 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
336 /* if something was enqueued, report even this as success for ooo
337 * segment handling */
343 /* Queue RX event on this fifo. Eventually these will need to be flushed
344 * by calling stream_server_flush_enqueue_events () */
345 session_manager_main_t *smm = vnet_get_session_manager_main ();
346 u32 thread_index = s->thread_index;
347 u32 enqueue_epoch = smm->current_enqueue_epoch[tc->proto][thread_index];
349 if (s->enqueue_epoch != enqueue_epoch)
351 s->enqueue_epoch = enqueue_epoch;
352 vec_add1 (smm->session_to_enqueue[tc->proto][thread_index],
353 s - smm->sessions[thread_index]);
362 session_enqueue_dgram_connection (stream_session_t * s,
363 session_dgram_hdr_t * hdr,
364 vlib_buffer_t * b, u8 proto, u8 queue_event)
366 int enqueued = 0, rv, in_order_off;
368 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
369 >= b->current_length + sizeof (*hdr));
371 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
373 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
374 vlib_buffer_get_current (b));
375 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
377 in_order_off = enqueued > b->current_length ? enqueued : 0;
378 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
384 /* Queue RX event on this fifo. Eventually these will need to be flushed
385 * by calling stream_server_flush_enqueue_events () */
386 session_manager_main_t *smm = vnet_get_session_manager_main ();
387 u32 thread_index = s->thread_index;
388 u32 enqueue_epoch = smm->current_enqueue_epoch[proto][thread_index];
390 if (s->enqueue_epoch != enqueue_epoch)
392 s->enqueue_epoch = enqueue_epoch;
393 vec_add1 (smm->session_to_enqueue[proto][thread_index],
394 s - smm->sessions[thread_index]);
400 /** Check if we have space in rx fifo to push more bytes */
402 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
405 stream_session_t *s = session_get (tc->s_index, thread_index);
407 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
410 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
417 session_tx_fifo_max_dequeue (transport_connection_t * tc)
419 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
420 if (!s->server_tx_fifo)
422 return svm_fifo_max_dequeue (s->server_tx_fifo);
426 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
427 u32 offset, u32 max_bytes)
429 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
430 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
434 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
436 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
437 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
441 * Notify session peer that new data has been enqueued.
443 * @param s Stream session for which the event is to be generated.
444 * @param block Flag to indicate if call should block if event queue is full.
446 * @return 0 on succes or negative number if failed to send notification.
449 session_enqueue_notify (stream_session_t * s, u8 block)
452 session_fifo_event_t evt;
455 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
457 /* Session is closed so app will never clean up. Flush rx fifo */
458 svm_fifo_dequeue_drop_all (s->server_rx_fifo);
462 /* Get session's server */
463 app = application_get_if_valid (s->app_index);
465 if (PREDICT_FALSE (app == 0))
467 clib_warning ("invalid s->app_index = %d", s->app_index);
471 /* Built-in app? Hand event to the callback... */
472 if (app->cb_fns.builtin_app_rx_callback)
473 return app->cb_fns.builtin_app_rx_callback (s);
475 /* If no event, send one */
476 if (svm_fifo_set_event (s->server_rx_fifo))
478 /* Fabricate event */
479 evt.fifo = s->server_rx_fifo;
480 evt.event_type = FIFO_EVENT_APP_RX;
482 /* Add event to server's event queue */
483 q = app->event_queue;
485 /* Based on request block (or not) for lack of space */
486 if (block || PREDICT_TRUE (q->cursize < q->maxsize))
487 svm_queue_add (app->event_queue, (u8 *) & evt,
488 0 /* do wait for mutex */ );
491 clib_warning ("fifo full");
497 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
498 ed->data[0] = evt.event_type;
499 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
507 session_dequeue_notify (stream_session_t * s)
512 app = application_get (s->app_index);
513 if (application_is_builtin (app))
516 q = app->event_queue;
517 if (PREDICT_TRUE (q->cursize < q->maxsize))
519 session_fifo_event_t evt = {
520 .event_type = FIFO_EVENT_APP_TX,
521 .fifo = s->server_tx_fifo
523 svm_queue_add (app->event_queue, (u8 *) & evt, SVM_Q_WAIT);
533 * Flushes queue of sessions that are to be notified of new data
536 * @param thread_index Thread index for which the flush is to be performed.
537 * @return 0 on success or a positive number indicating the number of
538 * failures due to API queue being full.
541 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
543 session_manager_main_t *smm = &session_manager_main;
548 indices = smm->session_to_enqueue[transport_proto][thread_index];
550 for (i = 0; i < vec_len (indices); i++)
552 s = session_get_if_valid (indices[i], thread_index);
553 if (s == 0 || session_enqueue_notify (s, 0 /* don't block */ ))
557 vec_reset_length (indices);
558 smm->session_to_enqueue[transport_proto][thread_index] = indices;
559 smm->current_enqueue_epoch[transport_proto][thread_index]++;
565 session_manager_flush_all_enqueue_events (u8 transport_proto)
567 vlib_thread_main_t *vtm = vlib_get_thread_main ();
569 for (i = 0; i < 1 + vtm->n_threads; i++)
570 errors += session_manager_flush_enqueue_events (transport_proto, i);
575 * Init fifo tail and head pointers
577 * Useful if transport uses absolute offsets for tracking ooo segments.
580 stream_session_init_fifos_pointers (transport_connection_t * tc,
581 u32 rx_pointer, u32 tx_pointer)
584 s = session_get (tc->s_index, tc->thread_index);
585 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
586 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
590 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
592 u32 opaque = 0, new_ti, new_si;
593 stream_session_t *new_s = 0;
594 segment_manager_t *sm;
601 * Find connection handle and cleanup half-open table
603 handle = session_lookup_half_open_handle (tc);
604 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
606 SESSION_DBG ("half-open was removed!");
609 session_lookup_del_half_open (tc);
611 /* Get the app's index from the handle we stored when opening connection
612 * and the opaque (api_context for external apps) from transport session
614 app = application_get_if_valid (handle >> 32);
617 opaque = tc->s_index;
620 * Allocate new session with fifos (svm segments are allocated if needed)
624 sm = application_get_connect_segment_manager (app);
625 alloc_fifos = !application_is_builtin_proxy (app);
626 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
633 new_s->app_index = app->index;
634 new_si = new_s->session_index;
635 new_ti = new_s->thread_index;
640 * Notify client application
642 if (app->cb_fns.session_connected_callback (app->index, opaque, new_s,
645 SESSION_DBG ("failed to notify app");
648 new_s = session_get (new_si, new_ti);
649 stream_session_disconnect_transport (new_s);
656 new_s = session_get (new_si, new_ti);
657 new_s->session_state = SESSION_STATE_READY;
664 typedef struct _session_switch_pool_args
668 u32 new_thread_index;
669 u32 new_session_index;
670 } session_switch_pool_args_t;
673 session_switch_pool (void *cb_args)
675 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
676 transport_proto_t tp;
678 ASSERT (args->thread_index == vlib_get_thread_index ());
679 s = session_get (args->session_index, args->thread_index);
680 s->server_tx_fifo->master_session_index = args->new_session_index;
681 s->server_tx_fifo->master_thread_index = args->new_thread_index;
682 tp = session_get_transport_proto (s);
683 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
685 clib_mem_free (cb_args);
689 * Move dgram session to the right thread
692 session_dgram_connect_notify (transport_connection_t * tc,
693 u32 old_thread_index,
694 stream_session_t ** new_session)
696 stream_session_t *new_s;
697 session_switch_pool_args_t *rpc_args;
700 * Clone half-open session to the right thread.
702 new_s = session_clone_safe (tc->s_index, old_thread_index);
703 new_s->connection_index = tc->c_index;
704 new_s->server_rx_fifo->master_session_index = new_s->session_index;
705 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
706 new_s->session_state = SESSION_STATE_READY;
707 session_lookup_add_connection (tc, session_handle (new_s));
710 * Ask thread owning the old session to clean it up and make us the tx
713 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
714 rpc_args->new_session_index = new_s->session_index;
715 rpc_args->new_thread_index = new_s->thread_index;
716 rpc_args->session_index = tc->s_index;
717 rpc_args->thread_index = old_thread_index;
718 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
721 tc->s_index = new_s->session_index;
722 new_s->connection_index = tc->c_index;
723 *new_session = new_s;
728 stream_session_accept_notify (transport_connection_t * tc)
730 application_t *server;
733 s = session_get (tc->s_index, tc->thread_index);
734 server = application_get (s->app_index);
735 server->cb_fns.session_accept_callback (s);
739 * Notification from transport that connection is being closed.
741 * A disconnect is sent to application but state is not removed. Once
742 * disconnect is acknowledged by application, session disconnect is called.
743 * Ultimately this leads to close being called on transport (passive close).
746 stream_session_disconnect_notify (transport_connection_t * tc)
748 application_t *server;
751 s = session_get (tc->s_index, tc->thread_index);
752 server = application_get (s->app_index);
753 server->cb_fns.session_disconnect_callback (s);
754 s->session_state = SESSION_STATE_CLOSING;
758 * Cleans up session and lookup table.
760 * Transport connection must still be valid.
763 stream_session_delete (stream_session_t * s)
767 /* Delete from the main lookup table. */
768 if ((rv = session_lookup_del_session (s)))
769 clib_warning ("hash delete error, rv %d", rv);
771 /* Cleanup fifo segments */
772 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
778 * Notification from transport that connection is being deleted
780 * This removes the session if it is still valid. It should be called only on
781 * previously fully established sessions. For instance failed connects should
782 * call stream_session_connect_notify and indicate that the connect has
786 stream_session_delete_notify (transport_connection_t * tc)
790 /* App might've been removed already */
791 s = session_get_if_valid (tc->s_index, tc->thread_index);
794 stream_session_delete (s);
798 * Notify application that connection has been reset.
801 stream_session_reset_notify (transport_connection_t * tc)
805 s = session_get (tc->s_index, tc->thread_index);
806 s->session_state = SESSION_STATE_CLOSED;
807 app = application_get (s->app_index);
808 app->cb_fns.session_reset_callback (s);
812 * Accept a stream session. Optionally ping the server by callback.
815 stream_session_accept (transport_connection_t * tc, u32 listener_index,
818 application_t *server;
819 stream_session_t *s, *listener;
820 segment_manager_t *sm;
823 /* Find the server */
824 listener = listen_session_get (listener_index);
825 server = application_get (listener->app_index);
827 sm = application_get_listen_segment_manager (server, listener);
828 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
831 s->app_index = server->index;
832 s->listener_index = listener_index;
833 s->session_state = SESSION_STATE_ACCEPTING;
835 /* Shoulder-tap the server */
838 server->cb_fns.session_accept_callback (s);
845 session_open_cl (u32 app_index, session_endpoint_t * rmt, u32 opaque)
847 transport_connection_t *tc;
848 transport_endpoint_t *tep;
849 segment_manager_t *sm;
854 tep = session_endpoint_to_transport (rmt);
855 rv = tp_vfts[rmt->transport_proto].open (tep);
858 SESSION_DBG ("Transport failed to open connection.");
859 return VNET_API_ERROR_SESSION_CONNECT;
862 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
864 /* For dgram type of service, allocate session and fifos now.
866 app = application_get (app_index);
867 sm = application_get_connect_segment_manager (app);
869 if (session_alloc_and_init (sm, tc, 1, &s))
871 s->app_index = app->index;
872 s->session_state = SESSION_STATE_OPENED;
874 /* Tell the app about the new event fifo for this session */
875 app->cb_fns.session_connected_callback (app->index, opaque, s, 0);
881 session_open_vc (u32 app_index, session_endpoint_t * rmt, u32 opaque)
883 transport_connection_t *tc;
884 transport_endpoint_t *tep;
888 tep = session_endpoint_to_transport (rmt);
889 rv = tp_vfts[rmt->transport_proto].open (tep);
892 SESSION_DBG ("Transport failed to open connection.");
893 return VNET_API_ERROR_SESSION_CONNECT;
896 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
898 /* If transport offers a stream service, only allocate session once the
899 * connection has been established.
900 * Add connection to half-open table and save app and tc index. The
901 * latter is needed to help establish the connection while the former
902 * is needed when the connect notify comes and we have to notify the
905 handle = (((u64) app_index) << 32) | (u64) tc->c_index;
906 session_lookup_add_half_open (tc, handle);
908 /* Store api_context (opaque) for when the reply comes. Not the nicest
909 * thing but better than allocating a separate half-open pool.
911 tc->s_index = opaque;
916 session_open_app (u32 app_index, session_endpoint_t * rmt, u32 opaque)
918 session_endpoint_extended_t *sep = (session_endpoint_extended_t *) rmt;
919 sep->app_index = app_index;
920 sep->opaque = opaque;
922 return tp_vfts[rmt->transport_proto].open ((transport_endpoint_t *) sep);
925 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
928 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
936 * Ask transport to open connection to remote transport endpoint.
938 * Stores handle for matching request with reply since the call can be
939 * asynchronous. For instance, for TCP the 3-way handshake must complete
940 * before reply comes. Session is only created once connection is established.
942 * @param app_index Index of the application requesting the connect
943 * @param st Session type requested.
944 * @param tep Remote transport endpoint
945 * @param opaque Opaque data (typically, api_context) the application expects
946 * on open completion.
949 session_open (u32 app_index, session_endpoint_t * rmt, u32 opaque)
951 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
952 return session_open_srv_fns[tst] (app_index, rmt, opaque);
956 session_listen_vc (stream_session_t * s, session_endpoint_t * sep)
958 transport_connection_t *tc;
961 /* Transport bind/listen */
962 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
963 session_endpoint_to_transport
966 if (tci == (u32) ~ 0)
969 /* Attach transport to session */
970 s->connection_index = tci;
971 tc = tp_vfts[sep->transport_proto].get_listener (tci);
973 /* Weird but handle it ... */
977 /* Add to the main lookup table */
978 session_lookup_add_connection (tc, s->session_index);
983 session_listen_cl (stream_session_t * s, session_endpoint_t * sep)
985 transport_connection_t *tc;
986 application_t *server;
987 segment_manager_t *sm;
990 /* Transport bind/listen */
991 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
992 session_endpoint_to_transport
995 if (tci == (u32) ~ 0)
998 /* Attach transport to session */
999 s->connection_index = tci;
1000 tc = tp_vfts[sep->transport_proto].get_listener (tci);
1002 /* Weird but handle it ... */
1006 server = application_get (s->app_index);
1007 sm = application_get_listen_segment_manager (server, s);
1008 if (session_alloc_fifos (sm, s))
1011 /* Add to the main lookup table */
1012 session_lookup_add_connection (tc, s->session_index);
1017 session_listen_app (stream_session_t * s, session_endpoint_t * sep)
1019 session_endpoint_extended_t esep;
1020 clib_memcpy (&esep, sep, sizeof (*sep));
1021 esep.app_index = s->app_index;
1023 return tp_vfts[sep->transport_proto].bind (s->session_index,
1024 (transport_endpoint_t *) & esep);
1027 typedef int (*session_listen_service_fn) (stream_session_t *,
1028 session_endpoint_t *);
1031 static session_listen_service_fn
1032 session_listen_srv_fns[TRANSPORT_N_SERVICES] = {
1040 * Ask transport to listen on local transport endpoint.
1042 * @param s Session for which listen will be called. Note that unlike
1043 * established sessions, listen sessions are not associated to a
1045 * @param tep Local endpoint to be listened on.
1048 stream_session_listen (stream_session_t * s, session_endpoint_t * sep)
1050 transport_service_type_t tst = tp_vfts[sep->transport_proto].service_type;
1051 return session_listen_srv_fns[tst] (s, sep);
1055 * Ask transport to stop listening on local transport endpoint.
1057 * @param s Session to stop listening on. It must be in state LISTENING.
1060 stream_session_stop_listen (stream_session_t * s)
1062 transport_proto_t tp = session_get_transport_proto (s);
1063 transport_connection_t *tc;
1064 if (s->session_state != SESSION_STATE_LISTENING)
1066 clib_warning ("not a listening session");
1070 tc = tp_vfts[tp].get_listener (s->connection_index);
1073 clib_warning ("no transport");
1074 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1077 session_lookup_del_connection (tc);
1078 tp_vfts[tp].unbind (s->connection_index);
1083 * Initialize session disconnect.
1085 * Request is always sent to session node to ensure that all outstanding
1086 * requests are served before transport is notified.
1089 stream_session_disconnect (stream_session_t * s)
1091 u32 thread_index = vlib_get_thread_index ();
1092 session_manager_main_t *smm = &session_manager_main;
1093 session_fifo_event_t *evt;
1098 if (s->session_state >= SESSION_STATE_CLOSING)
1100 /* Session already closed. Clear the tx fifo */
1101 if (s->session_state == SESSION_STATE_CLOSED)
1102 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1106 s->session_state = SESSION_STATE_CLOSING;
1108 /* If we are in the handler thread, or being called with the worker barrier
1109 * held (api/cli), just append a new event to pending disconnects vector. */
1110 if ((thread_index == 0 && !vlib_get_current_process (vlib_get_main ()))
1111 || thread_index == s->thread_index)
1113 ASSERT (s->thread_index == thread_index || thread_index == 0);
1114 vec_add2 (smm->pending_disconnects[s->thread_index], evt, 1);
1115 memset (evt, 0, sizeof (*evt));
1116 evt->session_handle = session_handle (s);
1117 evt->event_type = FIFO_EVENT_DISCONNECT;
1120 session_send_session_evt_to_thread (session_handle (s),
1121 FIFO_EVENT_DISCONNECT,
1126 * Notify transport the session can be disconnected. This should eventually
1127 * result in a delete notification that allows us to cleanup session state.
1128 * Called for both active/passive disconnects.
1130 * Must be called from the session's thread.
1133 stream_session_disconnect_transport (stream_session_t * s)
1135 s->session_state = SESSION_STATE_CLOSED;
1136 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1141 * Cleanup transport and session state.
1143 * Notify transport of the cleanup and free the session. This should
1144 * be called only if transport reported some error and is already
1148 stream_session_cleanup (stream_session_t * s)
1150 s->session_state = SESSION_STATE_CLOSED;
1152 /* Delete from main lookup table before we axe the the transport */
1153 session_lookup_del_session (s);
1154 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1156 /* Since we called cleanup, no delete notification will come. So, make
1157 * sure the session is properly freed. */
1158 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
1163 transport_service_type_t
1164 session_transport_service_type (stream_session_t * s)
1166 transport_proto_t tp;
1167 tp = session_get_transport_proto (s);
1168 return transport_protocol_service_type (tp);
1171 transport_tx_fn_type_t
1172 session_transport_tx_fn_type (stream_session_t * s)
1174 transport_proto_t tp;
1175 tp = session_get_transport_proto (s);
1176 return transport_protocol_tx_fn_type (tp);
1180 session_tx_is_dgram (stream_session_t * s)
1182 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1186 * Allocate event queues in the shared-memory segment
1188 * That can either be a newly created memfd segment, that will need to be
1189 * mapped by all stack users, or the binary api's svm region. The latter is
1190 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1191 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1192 * vpp uses api svm region for event queues.
1195 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1197 u32 evt_q_length = 2048, evt_size = sizeof (session_fifo_event_t);
1198 ssvm_private_t *eqs = &smm->evt_qs_segment;
1199 api_main_t *am = &api_main;
1200 u64 eqs_size = 64 << 20;
1201 pid_t vpp_pid = getpid ();
1205 if (smm->configured_event_queue_length)
1206 evt_q_length = smm->configured_event_queue_length;
1208 if (smm->evt_qs_use_memfd_seg)
1210 if (smm->evt_qs_segment_size)
1211 eqs_size = smm->evt_qs_segment_size;
1213 eqs->ssvm_size = eqs_size;
1214 eqs->i_am_master = 1;
1215 eqs->my_pid = vpp_pid;
1216 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1217 eqs->requested_va = smm->session_baseva;
1219 ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD);
1222 if (smm->evt_qs_use_memfd_seg)
1223 oldheap = ssvm_push_heap (eqs->sh);
1225 oldheap = svm_push_data_heap (am->vlib_rp);
1227 for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1229 smm->vpp_event_queues[i] = svm_queue_init (evt_q_length, evt_size,
1233 if (smm->evt_qs_use_memfd_seg)
1234 ssvm_pop_heap (oldheap);
1236 svm_pop_heap (oldheap);
1240 session_manager_get_evt_q_segment (void)
1242 session_manager_main_t *smm = &session_manager_main;
1243 if (smm->evt_qs_use_memfd_seg)
1244 return &smm->evt_qs_segment;
1249 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1250 session_tx_fifo_peek_and_snd,
1251 session_tx_fifo_dequeue_and_snd,
1252 session_tx_fifo_dequeue_internal,
1253 session_tx_fifo_dequeue_and_snd
1258 * Initialize session layer for given transport proto and ip version
1260 * Allocates per session type (transport proto + ip version) data structures
1261 * and adds arc from session queue node to session type output node.
1264 session_register_transport (transport_proto_t transport_proto,
1265 const transport_proto_vft_t * vft, u8 is_ip4,
1268 session_manager_main_t *smm = &session_manager_main;
1269 session_type_t session_type;
1270 u32 next_index = ~0;
1272 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1274 vec_validate (smm->session_type_to_next, session_type);
1275 vec_validate (smm->session_tx_fns, session_type);
1278 if (output_node != ~0)
1280 foreach_vlib_main (({
1281 next_index = vlib_node_add_next (this_vlib_main,
1282 session_queue_node.index,
1288 smm->session_type_to_next[session_type] = next_index;
1289 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1292 transport_connection_t *
1293 session_get_transport (stream_session_t * s)
1295 transport_proto_t tp;
1296 if (s->session_state != SESSION_STATE_LISTENING)
1298 tp = session_get_transport_proto (s);
1299 return tp_vfts[tp].get_connection (s->connection_index,
1305 transport_connection_t *
1306 listen_session_get_transport (stream_session_t * s)
1308 transport_proto_t tp = session_get_transport_proto (s);
1309 return tp_vfts[tp].get_listener (s->connection_index);
1313 listen_session_get_local_session_endpoint (stream_session_t * listener,
1314 session_endpoint_t * sep)
1316 transport_proto_t tp = session_get_transport_proto (listener);
1317 transport_connection_t *tc;
1318 tc = tp_vfts[tp].get_listener (listener->connection_index);
1321 clib_warning ("no transport");
1325 /* N.B. The ip should not be copied because this is the local endpoint */
1326 sep->port = tc->lcl_port;
1327 sep->transport_proto = tc->proto;
1328 sep->is_ip4 = tc->is_ip4;
1333 session_flush_frames_main_thread (vlib_main_t * vm)
1335 ASSERT (vlib_get_thread_index () == 0);
1336 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1337 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1340 static clib_error_t *
1341 session_manager_main_enable (vlib_main_t * vm)
1343 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1344 session_manager_main_t *smm = &session_manager_main;
1345 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1346 u32 num_threads, preallocated_sessions_per_worker;
1349 num_threads = 1 /* main thread */ + vtm->n_threads;
1351 if (num_threads < 1)
1352 return clib_error_return (0, "n_thread_stacks not set");
1354 /* configure per-thread ** vectors */
1355 vec_validate (smm->sessions, num_threads - 1);
1356 vec_validate (smm->tx_buffers, num_threads - 1);
1357 vec_validate (smm->pending_event_vector, num_threads - 1);
1358 vec_validate (smm->pending_disconnects, num_threads - 1);
1359 vec_validate (smm->free_event_vector, num_threads - 1);
1360 vec_validate (smm->vpp_event_queues, num_threads - 1);
1361 vec_validate (smm->peekers_rw_locks, num_threads - 1);
1362 vec_validate_aligned (smm->ctx, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1364 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1366 vec_validate (smm->current_enqueue_epoch[i], num_threads - 1);
1367 vec_validate (smm->session_to_enqueue[i], num_threads - 1);
1368 for (j = 0; j < num_threads; j++)
1369 smm->current_enqueue_epoch[i][j] = 1;
1372 for (i = 0; i < num_threads; i++)
1374 vec_validate (smm->free_event_vector[i], 0);
1375 _vec_len (smm->free_event_vector[i]) = 0;
1376 vec_validate (smm->pending_event_vector[i], 0);
1377 _vec_len (smm->pending_event_vector[i]) = 0;
1378 vec_validate (smm->pending_disconnects[i], 0);
1379 _vec_len (smm->pending_disconnects[i]) = 0;
1380 if (num_threads > 1)
1381 clib_rwlock_init (&smm->peekers_rw_locks[i]);
1385 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1388 /* Allocate vpp event queues segment and queue */
1389 session_vpp_event_queues_allocate (smm);
1391 /* Initialize fifo segment main baseva and timeout */
1392 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1393 sm_args->size = smm->session_va_space_size;
1394 segment_manager_main_init (sm_args);
1396 /* Preallocate sessions */
1397 if (smm->preallocated_sessions)
1399 if (num_threads == 1)
1401 pool_init_fixed (smm->sessions[0], smm->preallocated_sessions);
1406 preallocated_sessions_per_worker =
1407 (1.1 * (f64) smm->preallocated_sessions /
1408 (f64) (num_threads - 1));
1410 for (j = 1; j < num_threads; j++)
1412 pool_init_fixed (smm->sessions[j],
1413 preallocated_sessions_per_worker);
1418 session_lookup_init ();
1419 app_namespaces_init ();
1422 smm->is_enabled = 1;
1424 /* Enable transports */
1425 transport_enable_disable (vm, 1);
1431 session_node_enable_disable (u8 is_en)
1433 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1434 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1435 u8 have_workers = vtm->n_threads != 0;
1438 foreach_vlib_main (({
1439 if (have_workers && ii == 0)
1441 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1445 vlib_node_t *n = vlib_get_node (this_vlib_main,
1446 session_queue_process_node.index);
1447 vlib_start_process (this_vlib_main, n->runtime_index);
1451 vlib_process_signal_event_mt (this_vlib_main,
1452 session_queue_process_node.index,
1453 SESSION_Q_PROCESS_STOP, 0);
1458 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1465 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1467 clib_error_t *error = 0;
1470 if (session_manager_main.is_enabled)
1473 session_node_enable_disable (is_en);
1474 error = session_manager_main_enable (vm);
1478 session_manager_main.is_enabled = 0;
1479 session_node_enable_disable (is_en);
1486 session_manager_main_init (vlib_main_t * vm)
1488 session_manager_main_t *smm = &session_manager_main;
1489 smm->session_baseva = 0x200000000ULL;
1490 smm->session_va_space_size = (u64) 128 << 30;
1491 smm->evt_qs_segment_size = 64 << 20;
1492 smm->is_enabled = 0;
1496 VLIB_INIT_FUNCTION (session_manager_main_init);
1498 static clib_error_t *
1499 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1501 session_manager_main_t *smm = &session_manager_main;
1505 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1507 if (unformat (input, "event-queue-length %d", &nitems))
1510 smm->configured_event_queue_length = nitems;
1512 clib_warning ("event queue length %d too small, ignored", nitems);
1514 else if (unformat (input, "preallocated-sessions %d",
1515 &smm->preallocated_sessions))
1517 else if (unformat (input, "v4-session-table-buckets %d",
1518 &smm->configured_v4_session_table_buckets))
1520 else if (unformat (input, "v4-halfopen-table-buckets %d",
1521 &smm->configured_v4_halfopen_table_buckets))
1523 else if (unformat (input, "v6-session-table-buckets %d",
1524 &smm->configured_v6_session_table_buckets))
1526 else if (unformat (input, "v6-halfopen-table-buckets %d",
1527 &smm->configured_v6_halfopen_table_buckets))
1529 else if (unformat (input, "v4-session-table-memory %U",
1530 unformat_memory_size, &tmp))
1532 if (tmp >= 0x100000000)
1533 return clib_error_return (0, "memory size %llx (%lld) too large",
1535 smm->configured_v4_session_table_memory = tmp;
1537 else if (unformat (input, "v4-halfopen-table-memory %U",
1538 unformat_memory_size, &tmp))
1540 if (tmp >= 0x100000000)
1541 return clib_error_return (0, "memory size %llx (%lld) too large",
1543 smm->configured_v4_halfopen_table_memory = tmp;
1545 else if (unformat (input, "v6-session-table-memory %U",
1546 unformat_memory_size, &tmp))
1548 if (tmp >= 0x100000000)
1549 return clib_error_return (0, "memory size %llx (%lld) too large",
1551 smm->configured_v6_session_table_memory = tmp;
1553 else if (unformat (input, "v6-halfopen-table-memory %U",
1554 unformat_memory_size, &tmp))
1556 if (tmp >= 0x100000000)
1557 return clib_error_return (0, "memory size %llx (%lld) too large",
1559 smm->configured_v6_halfopen_table_memory = tmp;
1561 else if (unformat (input, "local-endpoints-table-memory %U",
1562 unformat_memory_size, &tmp))
1564 if (tmp >= 0x100000000)
1565 return clib_error_return (0, "memory size %llx (%lld) too large",
1567 smm->local_endpoints_table_memory = tmp;
1569 else if (unformat (input, "local-endpoints-table-buckets %d",
1570 &smm->local_endpoints_table_buckets))
1572 else if (unformat (input, "evt_qs_memfd_seg"))
1573 smm->evt_qs_use_memfd_seg = 1;
1575 return clib_error_return (0, "unknown input `%U'",
1576 format_unformat_error, input);
1581 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1584 * fd.io coding-style-patch-verification: ON
1587 * eval: (c-set-style "gnu")