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)
35 session_fifo_event_t evt = { {0}, };
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))
52 SESSION_DBG ("failed to enqueue evt");
59 session_send_session_evt_to_thread (u64 session_handle,
60 fifo_event_type_t evt_type,
63 session_send_evt_to_thread (session_handle, evt_type, thread_index, 0, 0);
67 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
69 if (thread_index != vlib_get_thread_index ())
70 session_send_evt_to_thread (0, FIFO_EVENT_RPC, thread_index, fp,
74 void (*fnp) (void *) = fp;
80 session_alloc (u32 thread_index)
82 session_manager_main_t *smm = &session_manager_main;
85 pool_get_aligned_will_expand (smm->sessions[thread_index], will_expand,
86 CLIB_CACHE_LINE_BYTES);
87 /* If we have peekers, let them finish */
88 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
90 clib_rwlock_writer_lock (&smm->peekers_rw_locks[thread_index]);
91 pool_get_aligned (session_manager_main.sessions[thread_index], s,
92 CLIB_CACHE_LINE_BYTES);
93 clib_rwlock_writer_unlock (&smm->peekers_rw_locks[thread_index]);
97 pool_get_aligned (session_manager_main.sessions[thread_index], s,
98 CLIB_CACHE_LINE_BYTES);
100 memset (s, 0, sizeof (*s));
101 s->session_index = s - session_manager_main.sessions[thread_index];
102 s->thread_index = thread_index;
107 session_free (stream_session_t * s)
109 pool_put (session_manager_main.sessions[s->thread_index], s);
111 memset (s, 0xFA, sizeof (*s));
115 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
117 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
118 u32 fifo_segment_index;
121 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
123 &fifo_segment_index)))
125 /* Initialize backpointers */
126 server_rx_fifo->master_session_index = s->session_index;
127 server_rx_fifo->master_thread_index = s->thread_index;
129 server_tx_fifo->master_session_index = s->session_index;
130 server_tx_fifo->master_thread_index = s->thread_index;
132 s->server_rx_fifo = server_rx_fifo;
133 s->server_tx_fifo = server_tx_fifo;
134 s->svm_segment_index = fifo_segment_index;
138 static stream_session_t *
139 session_alloc_for_connection (transport_connection_t * tc)
142 u32 thread_index = tc->thread_index;
144 ASSERT (thread_index == vlib_get_thread_index ());
146 s = session_alloc (thread_index);
147 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
148 s->session_state = SESSION_STATE_CONNECTING;
149 s->enqueue_epoch = ~0;
151 /* Attach transport to session and vice versa */
152 s->connection_index = tc->c_index;
153 tc->s_index = s->session_index;
158 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
159 u8 alloc_fifos, stream_session_t ** ret_s)
164 s = session_alloc_for_connection (tc);
165 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
172 /* Add to the main lookup table */
173 session_lookup_add_connection (tc, session_handle (s));
180 * Discards bytes from buffer chain
182 * It discards n_bytes_to_drop starting at first buffer after chain_b
185 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
186 vlib_buffer_t ** chain_b,
189 vlib_buffer_t *next = *chain_b;
190 u32 to_drop = n_bytes_to_drop;
191 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
192 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
194 next = vlib_get_buffer (vm, next->next_buffer);
195 if (next->current_length > to_drop)
197 vlib_buffer_advance (next, to_drop);
202 to_drop -= next->current_length;
203 next->current_length = 0;
209 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
213 * Enqueue buffer chain tail
216 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
217 u32 offset, u8 is_in_order)
219 vlib_buffer_t *chain_b;
220 u32 chain_bi, len, diff;
221 vlib_main_t *vm = vlib_get_main ();
226 if (is_in_order && offset)
228 diff = offset - b->current_length;
229 if (diff > b->total_length_not_including_first_buffer)
232 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
233 chain_bi = vlib_get_buffer_index (vm, chain_b);
236 chain_bi = b->next_buffer;
240 chain_b = vlib_get_buffer (vm, chain_bi);
241 data = vlib_buffer_get_current (chain_b);
242 len = chain_b->current_length;
247 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
254 return (rv > 0) ? (written + rv) : written;
260 /* written more than what was left in chain */
261 if (written > b->total_length_not_including_first_buffer)
264 /* drop the bytes that have already been delivered */
265 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
270 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
274 clib_warning ("failed to enqueue multi-buffer seg");
280 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
281 ? chain_b->next_buffer : 0));
290 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
291 * event but on request can queue notification events for later delivery by
292 * calling stream_server_flush_enqueue_events().
294 * @param tc Transport connection which is to be enqueued data
295 * @param b Buffer to be enqueued
296 * @param offset Offset at which to start enqueueing if out-of-order
297 * @param queue_event Flag to indicate if peer is to be notified or if event
298 * is to be queued. The former is useful when more data is
299 * enqueued and only one event is to be generated.
300 * @param is_in_order Flag to indicate if data is in order
301 * @return Number of bytes enqueued or a negative value if enqueueing failed.
304 session_enqueue_stream_connection (transport_connection_t * tc,
305 vlib_buffer_t * b, u32 offset,
306 u8 queue_event, u8 is_in_order)
309 int enqueued = 0, rv, in_order_off;
311 s = session_get (tc->s_index, tc->thread_index);
315 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
317 vlib_buffer_get_current (b));
318 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
321 in_order_off = enqueued > b->current_length ? enqueued : 0;
322 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
329 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
331 vlib_buffer_get_current (b));
332 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
333 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
334 /* if something was enqueued, report even this as success for ooo
335 * segment handling */
341 /* Queue RX event on this fifo. Eventually these will need to be flushed
342 * by calling stream_server_flush_enqueue_events () */
343 session_manager_main_t *smm = vnet_get_session_manager_main ();
344 u32 thread_index = s->thread_index;
345 u32 enqueue_epoch = smm->current_enqueue_epoch[tc->proto][thread_index];
347 if (s->enqueue_epoch != enqueue_epoch)
349 s->enqueue_epoch = enqueue_epoch;
350 vec_add1 (smm->session_to_enqueue[tc->proto][thread_index],
351 s - smm->sessions[thread_index]);
360 session_enqueue_dgram_connection (stream_session_t * s,
361 session_dgram_hdr_t * hdr,
362 vlib_buffer_t * b, u8 proto, u8 queue_event)
364 int enqueued = 0, rv, in_order_off;
366 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
367 >= b->current_length + sizeof (*hdr));
369 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
371 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
372 vlib_buffer_get_current (b));
373 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
375 in_order_off = enqueued > b->current_length ? enqueued : 0;
376 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
382 /* Queue RX event on this fifo. Eventually these will need to be flushed
383 * by calling stream_server_flush_enqueue_events () */
384 session_manager_main_t *smm = vnet_get_session_manager_main ();
385 u32 thread_index = s->thread_index;
386 u32 enqueue_epoch = smm->current_enqueue_epoch[proto][thread_index];
388 if (s->enqueue_epoch != enqueue_epoch)
390 s->enqueue_epoch = enqueue_epoch;
391 vec_add1 (smm->session_to_enqueue[proto][thread_index],
392 s - smm->sessions[thread_index]);
398 /** Check if we have space in rx fifo to push more bytes */
400 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
403 stream_session_t *s = session_get (tc->s_index, thread_index);
405 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
408 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
415 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc)
417 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
418 if (!s->server_tx_fifo)
420 return svm_fifo_max_dequeue (s->server_tx_fifo);
424 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
425 u32 offset, u32 max_bytes)
427 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
428 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
432 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
434 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
435 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
439 * Notify session peer that new data has been enqueued.
441 * @param s Stream session for which the event is to be generated.
442 * @param block Flag to indicate if call should block if event queue is full.
444 * @return 0 on succes or negative number if failed to send notification.
447 session_enqueue_notify (stream_session_t * s, u8 block)
450 session_fifo_event_t evt;
453 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
455 /* Session is closed so app will never clean up. Flush rx fifo */
456 u32 to_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
458 svm_fifo_dequeue_drop (s->server_rx_fifo, to_dequeue);
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 * Flushes queue of sessions that are to be notified of new data
510 * @param thread_index Thread index for which the flush is to be performed.
511 * @return 0 on success or a positive number indicating the number of
512 * failures due to API queue being full.
515 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
517 session_manager_main_t *smm = &session_manager_main;
522 indices = smm->session_to_enqueue[transport_proto][thread_index];
524 for (i = 0; i < vec_len (indices); i++)
526 s = session_get_if_valid (indices[i], thread_index);
527 if (s == 0 || session_enqueue_notify (s, 0 /* don't block */ ))
531 vec_reset_length (indices);
532 smm->session_to_enqueue[transport_proto][thread_index] = indices;
533 smm->current_enqueue_epoch[transport_proto][thread_index]++;
539 session_manager_flush_all_enqueue_events (u8 transport_proto)
541 vlib_thread_main_t *vtm = vlib_get_thread_main ();
543 for (i = 0; i < 1 + vtm->n_threads; i++)
544 errors += session_manager_flush_enqueue_events (transport_proto, i);
549 * Init fifo tail and head pointers
551 * Useful if transport uses absolute offsets for tracking ooo segments.
554 stream_session_init_fifos_pointers (transport_connection_t * tc,
555 u32 rx_pointer, u32 tx_pointer)
558 s = session_get (tc->s_index, tc->thread_index);
559 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
560 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
564 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
566 u32 opaque = 0, new_ti, new_si;
567 stream_session_t *new_s = 0;
568 segment_manager_t *sm;
575 * Find connection handle and cleanup half-open table
577 handle = session_lookup_half_open_handle (tc);
578 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
580 SESSION_DBG ("half-open was removed!");
583 session_lookup_del_half_open (tc);
585 /* Get the app's index from the handle we stored when opening connection
586 * and the opaque (api_context for external apps) from transport session
588 app = application_get_if_valid (handle >> 32);
591 opaque = tc->s_index;
594 * Allocate new session with fifos (svm segments are allocated if needed)
598 sm = application_get_connect_segment_manager (app);
599 alloc_fifos = !application_is_builtin_proxy (app);
600 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
607 new_s->app_index = app->index;
608 new_si = new_s->session_index;
609 new_ti = new_s->thread_index;
614 * Notify client application
616 if (app->cb_fns.session_connected_callback (app->index, opaque, new_s,
619 SESSION_DBG ("failed to notify app");
622 new_s = session_get (new_si, new_ti);
623 stream_session_disconnect_transport (new_s);
630 new_s = session_get (new_si, new_ti);
631 new_s->session_state = SESSION_STATE_READY;
638 typedef struct _session_switch_pool_args
642 u32 new_thread_index;
643 u32 new_session_index;
644 } session_switch_pool_args_t;
647 session_switch_pool (void *cb_args)
649 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
650 transport_proto_t tp;
652 ASSERT (args->thread_index == vlib_get_thread_index ());
653 s = session_get (args->session_index, args->thread_index);
654 s->server_tx_fifo->master_session_index = args->new_session_index;
655 s->server_tx_fifo->master_thread_index = args->new_thread_index;
656 tp = session_get_transport_proto (s);
657 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
659 clib_mem_free (cb_args);
663 * Move dgram session to the right thread
666 session_dgram_connect_notify (transport_connection_t * tc,
667 u32 old_thread_index,
668 stream_session_t ** new_session)
670 stream_session_t *new_s;
671 session_switch_pool_args_t *rpc_args;
674 * Clone half-open session to the right thread.
676 new_s = session_clone_safe (tc->s_index, old_thread_index);
677 new_s->connection_index = tc->c_index;
678 new_s->server_rx_fifo->master_session_index = new_s->session_index;
679 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
680 new_s->session_state = SESSION_STATE_READY;
681 session_lookup_add_connection (tc, session_handle (new_s));
684 * Ask thread owning the old session to clean it up and make us the tx
687 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
688 rpc_args->new_session_index = new_s->session_index;
689 rpc_args->new_thread_index = new_s->thread_index;
690 rpc_args->session_index = tc->s_index;
691 rpc_args->thread_index = old_thread_index;
692 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
695 tc->s_index = new_s->session_index;
696 new_s->connection_index = tc->c_index;
697 *new_session = new_s;
702 stream_session_accept_notify (transport_connection_t * tc)
704 application_t *server;
707 s = session_get (tc->s_index, tc->thread_index);
708 server = application_get (s->app_index);
709 server->cb_fns.session_accept_callback (s);
713 * Notification from transport that connection is being closed.
715 * A disconnect is sent to application but state is not removed. Once
716 * disconnect is acknowledged by application, session disconnect is called.
717 * Ultimately this leads to close being called on transport (passive close).
720 stream_session_disconnect_notify (transport_connection_t * tc)
722 application_t *server;
725 s = session_get (tc->s_index, tc->thread_index);
726 server = application_get (s->app_index);
727 server->cb_fns.session_disconnect_callback (s);
731 * Cleans up session and lookup table.
734 stream_session_delete (stream_session_t * s)
738 /* Delete from the main lookup table. */
739 if ((rv = session_lookup_del_session (s)))
740 clib_warning ("hash delete error, rv %d", rv);
742 /* Cleanup fifo segments */
743 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
749 * Notification from transport that connection is being deleted
751 * This removes the session if it is still valid. It should be called only on
752 * previously fully established sessions. For instance failed connects should
753 * call stream_session_connect_notify and indicate that the connect has
757 stream_session_delete_notify (transport_connection_t * tc)
761 /* App might've been removed already */
762 s = session_get_if_valid (tc->s_index, tc->thread_index);
765 stream_session_delete (s);
769 * Notify application that connection has been reset.
772 stream_session_reset_notify (transport_connection_t * tc)
776 s = session_get (tc->s_index, tc->thread_index);
778 app = application_get (s->app_index);
779 app->cb_fns.session_reset_callback (s);
783 * Accept a stream session. Optionally ping the server by callback.
786 stream_session_accept (transport_connection_t * tc, u32 listener_index,
789 application_t *server;
790 stream_session_t *s, *listener;
791 segment_manager_t *sm;
794 /* Find the server */
795 listener = listen_session_get (listener_index);
796 server = application_get (listener->app_index);
798 sm = application_get_listen_segment_manager (server, listener);
799 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
802 s->app_index = server->index;
803 s->listener_index = listener_index;
804 s->session_state = SESSION_STATE_ACCEPTING;
806 /* Shoulder-tap the server */
809 server->cb_fns.session_accept_callback (s);
816 session_open_cl (u32 app_index, session_endpoint_t * rmt, u32 opaque)
818 transport_connection_t *tc;
819 transport_endpoint_t *tep;
820 segment_manager_t *sm;
825 tep = session_endpoint_to_transport (rmt);
826 rv = tp_vfts[rmt->transport_proto].open (tep);
829 SESSION_DBG ("Transport failed to open connection.");
830 return VNET_API_ERROR_SESSION_CONNECT;
833 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
835 /* For dgram type of service, allocate session and fifos now.
837 app = application_get (app_index);
838 sm = application_get_connect_segment_manager (app);
840 if (session_alloc_and_init (sm, tc, 1, &s))
842 s->app_index = app->index;
843 s->session_state = SESSION_STATE_OPENED;
845 /* Tell the app about the new event fifo for this session */
846 app->cb_fns.session_connected_callback (app->index, opaque, s, 0);
852 session_open_vc (u32 app_index, session_endpoint_t * rmt, u32 opaque)
854 transport_connection_t *tc;
855 transport_endpoint_t *tep;
859 tep = session_endpoint_to_transport (rmt);
860 rv = tp_vfts[rmt->transport_proto].open (tep);
863 SESSION_DBG ("Transport failed to open connection.");
864 return VNET_API_ERROR_SESSION_CONNECT;
867 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
869 /* If transport offers a stream service, only allocate session once the
870 * connection has been established.
871 * Add connection to half-open table and save app and tc index. The
872 * latter is needed to help establish the connection while the former
873 * is needed when the connect notify comes and we have to notify the
876 handle = (((u64) app_index) << 32) | (u64) tc->c_index;
877 session_lookup_add_half_open (tc, handle);
879 /* Store api_context (opaque) for when the reply comes. Not the nicest
880 * thing but better than allocating a separate half-open pool.
882 tc->s_index = opaque;
887 session_open_app (u32 app_index, session_endpoint_t * rmt, u32 opaque)
889 session_endpoint_extended_t *sep = (session_endpoint_extended_t *) rmt;
890 sep->app_index = app_index;
891 sep->opaque = opaque;
893 return tp_vfts[rmt->transport_proto].open ((transport_endpoint_t *) sep);
896 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
899 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
907 * Ask transport to open connection to remote transport endpoint.
909 * Stores handle for matching request with reply since the call can be
910 * asynchronous. For instance, for TCP the 3-way handshake must complete
911 * before reply comes. Session is only created once connection is established.
913 * @param app_index Index of the application requesting the connect
914 * @param st Session type requested.
915 * @param tep Remote transport endpoint
916 * @param opaque Opaque data (typically, api_context) the application expects
917 * on open completion.
920 session_open (u32 app_index, session_endpoint_t * rmt, u32 opaque)
922 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
923 return session_open_srv_fns[tst] (app_index, rmt, opaque);
927 session_listen_vc (stream_session_t * s, session_endpoint_t * sep)
929 transport_connection_t *tc;
932 /* Transport bind/listen */
933 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
934 session_endpoint_to_transport
937 if (tci == (u32) ~ 0)
940 /* Attach transport to session */
941 s->connection_index = tci;
942 tc = tp_vfts[sep->transport_proto].get_listener (tci);
944 /* Weird but handle it ... */
948 /* Add to the main lookup table */
949 session_lookup_add_connection (tc, s->session_index);
954 session_listen_cl (stream_session_t * s, session_endpoint_t * sep)
956 transport_connection_t *tc;
957 application_t *server;
958 segment_manager_t *sm;
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 server = application_get (s->app_index);
978 sm = application_get_listen_segment_manager (server, s);
979 if (session_alloc_fifos (sm, s))
982 /* Add to the main lookup table */
983 session_lookup_add_connection (tc, s->session_index);
988 session_listen_app (stream_session_t * s, session_endpoint_t * sep)
990 session_endpoint_extended_t esep;
991 clib_memcpy (&esep, sep, sizeof (*sep));
992 esep.app_index = s->app_index;
994 return tp_vfts[sep->transport_proto].bind (s->session_index,
995 (transport_endpoint_t *) & esep);
998 typedef int (*session_listen_service_fn) (stream_session_t *,
999 session_endpoint_t *);
1002 static session_listen_service_fn
1003 session_listen_srv_fns[TRANSPORT_N_SERVICES] = {
1011 * Ask transport to listen on local transport endpoint.
1013 * @param s Session for which listen will be called. Note that unlike
1014 * established sessions, listen sessions are not associated to a
1016 * @param tep Local endpoint to be listened on.
1019 stream_session_listen (stream_session_t * s, session_endpoint_t * sep)
1021 transport_service_type_t tst = tp_vfts[sep->transport_proto].service_type;
1022 return session_listen_srv_fns[tst] (s, sep);
1026 * Ask transport to stop listening on local transport endpoint.
1028 * @param s Session to stop listening on. It must be in state LISTENING.
1031 stream_session_stop_listen (stream_session_t * s)
1033 transport_proto_t tp = session_get_transport_proto (s);
1034 transport_connection_t *tc;
1035 if (s->session_state != SESSION_STATE_LISTENING)
1037 clib_warning ("not a listening session");
1041 tc = tp_vfts[tp].get_listener (s->connection_index);
1044 clib_warning ("no transport");
1045 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1048 session_lookup_del_connection (tc);
1049 tp_vfts[tp].unbind (s->connection_index);
1054 * Initialize session disconnect.
1056 * Request is always sent to session node to ensure that all outstanding
1057 * requests are served before transport is notified.
1060 stream_session_disconnect (stream_session_t * s)
1062 if (!s || s->session_state == SESSION_STATE_CLOSED)
1064 s->session_state = SESSION_STATE_CLOSED;
1065 session_send_session_evt_to_thread (session_handle (s),
1066 FIFO_EVENT_DISCONNECT, s->thread_index);
1070 * Notify transport the session can be disconnected. This should eventually
1071 * result in a delete notification that allows us to cleanup session state.
1072 * Called for both active/passive disconnects.
1074 * Must be called from the session's thread.
1077 stream_session_disconnect_transport (stream_session_t * s)
1079 s->session_state = SESSION_STATE_CLOSED;
1080 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1085 * Cleanup transport and session state.
1087 * Notify transport of the cleanup, wait for a delete notify to actually
1088 * remove the session state.
1091 stream_session_cleanup (stream_session_t * s)
1095 s->session_state = SESSION_STATE_CLOSED;
1097 /* Delete from the main lookup table to avoid more enqueues */
1098 rv = session_lookup_del_session (s);
1100 clib_warning ("hash delete error, rv %d", rv);
1102 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1107 * Allocate event queues in the shared-memory segment
1109 * That can either be a newly created memfd segment, that will need to be
1110 * mapped by all stack users, or the binary api's svm region. The latter is
1111 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1112 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1113 * vpp uses api svm region for event queues.
1116 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1118 u32 evt_q_length = 2048, evt_size = sizeof (session_fifo_event_t);
1119 ssvm_private_t *eqs = &smm->evt_qs_segment;
1120 api_main_t *am = &api_main;
1121 u64 eqs_size = 64 << 20;
1122 pid_t vpp_pid = getpid ();
1126 if (smm->configured_event_queue_length)
1127 evt_q_length = smm->configured_event_queue_length;
1129 if (smm->evt_qs_use_memfd_seg)
1131 if (smm->evt_qs_segment_size)
1132 eqs_size = smm->evt_qs_segment_size;
1134 eqs->ssvm_size = eqs_size;
1135 eqs->i_am_master = 1;
1136 eqs->my_pid = vpp_pid;
1137 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1138 eqs->requested_va = smm->session_baseva;
1140 ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD);
1143 if (smm->evt_qs_use_memfd_seg)
1144 oldheap = ssvm_push_heap (eqs->sh);
1146 oldheap = svm_push_data_heap (am->vlib_rp);
1148 for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1150 smm->vpp_event_queues[i] = svm_queue_init (evt_q_length, evt_size,
1154 if (smm->evt_qs_use_memfd_seg)
1155 ssvm_pop_heap (oldheap);
1157 svm_pop_heap (oldheap);
1161 session_manager_get_evt_q_segment (void)
1163 session_manager_main_t *smm = &session_manager_main;
1164 if (smm->evt_qs_use_memfd_seg)
1165 return &smm->evt_qs_segment;
1170 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1171 session_tx_fifo_peek_and_snd,
1172 session_tx_fifo_dequeue_and_snd,
1173 session_tx_fifo_dequeue_internal,
1174 session_tx_fifo_dequeue_and_snd
1179 * Initialize session layer for given transport proto and ip version
1181 * Allocates per session type (transport proto + ip version) data structures
1182 * and adds arc from session queue node to session type output node.
1185 session_register_transport (transport_proto_t transport_proto,
1186 const transport_proto_vft_t * vft, u8 is_ip4,
1189 session_manager_main_t *smm = &session_manager_main;
1190 session_type_t session_type;
1191 u32 next_index = ~0;
1193 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1195 vec_validate (smm->session_type_to_next, session_type);
1196 vec_validate (smm->session_tx_fns, session_type);
1199 if (output_node != ~0)
1201 foreach_vlib_main (({
1202 next_index = vlib_node_add_next (this_vlib_main,
1203 session_queue_node.index,
1209 smm->session_type_to_next[session_type] = next_index;
1210 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1213 transport_connection_t *
1214 session_get_transport (stream_session_t * s)
1216 transport_proto_t tp;
1217 if (s->session_state != SESSION_STATE_LISTENING)
1219 tp = session_get_transport_proto (s);
1220 return tp_vfts[tp].get_connection (s->connection_index,
1226 transport_connection_t *
1227 listen_session_get_transport (stream_session_t * s)
1229 transport_proto_t tp = session_get_transport_proto (s);
1230 return tp_vfts[tp].get_listener (s->connection_index);
1234 listen_session_get_local_session_endpoint (stream_session_t * listener,
1235 session_endpoint_t * sep)
1237 transport_proto_t tp = session_get_transport_proto (listener);
1238 transport_connection_t *tc;
1239 tc = tp_vfts[tp].get_listener (listener->connection_index);
1242 clib_warning ("no transport");
1246 /* N.B. The ip should not be copied because this is the local endpoint */
1247 sep->port = tc->lcl_port;
1248 sep->transport_proto = tc->proto;
1249 sep->is_ip4 = tc->is_ip4;
1253 static clib_error_t *
1254 session_manager_main_enable (vlib_main_t * vm)
1256 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1257 session_manager_main_t *smm = &session_manager_main;
1258 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1259 u32 num_threads, preallocated_sessions_per_worker;
1262 num_threads = 1 /* main thread */ + vtm->n_threads;
1264 if (num_threads < 1)
1265 return clib_error_return (0, "n_thread_stacks not set");
1267 /* configure per-thread ** vectors */
1268 vec_validate (smm->sessions, num_threads - 1);
1269 vec_validate (smm->tx_buffers, num_threads - 1);
1270 vec_validate (smm->pending_event_vector, num_threads - 1);
1271 vec_validate (smm->pending_disconnects, num_threads - 1);
1272 vec_validate (smm->free_event_vector, num_threads - 1);
1273 vec_validate (smm->vpp_event_queues, num_threads - 1);
1274 vec_validate (smm->peekers_rw_locks, num_threads - 1);
1275 vec_validate_aligned (smm->ctx, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1277 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1279 vec_validate (smm->current_enqueue_epoch[i], num_threads - 1);
1280 vec_validate (smm->session_to_enqueue[i], num_threads - 1);
1281 for (j = 0; j < num_threads; j++)
1282 smm->current_enqueue_epoch[i][j] = 1;
1285 for (i = 0; i < num_threads; i++)
1287 vec_validate (smm->free_event_vector[i], 0);
1288 _vec_len (smm->free_event_vector[i]) = 0;
1289 vec_validate (smm->pending_event_vector[i], 0);
1290 _vec_len (smm->pending_event_vector[i]) = 0;
1291 vec_validate (smm->pending_disconnects[i], 0);
1292 _vec_len (smm->pending_disconnects[i]) = 0;
1293 if (num_threads > 1)
1294 clib_rwlock_init (&smm->peekers_rw_locks[i]);
1298 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1301 /* Allocate vpp event queues segment and queue */
1302 session_vpp_event_queues_allocate (smm);
1304 /* Initialize fifo segment main baseva and timeout */
1305 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1306 sm_args->size = smm->session_va_space_size;
1307 segment_manager_main_init (sm_args);
1309 /* Preallocate sessions */
1310 if (smm->preallocated_sessions)
1312 if (num_threads == 1)
1314 pool_init_fixed (smm->sessions[0], smm->preallocated_sessions);
1319 preallocated_sessions_per_worker =
1320 (1.1 * (f64) smm->preallocated_sessions /
1321 (f64) (num_threads - 1));
1323 for (j = 1; j < num_threads; j++)
1325 pool_init_fixed (smm->sessions[j],
1326 preallocated_sessions_per_worker);
1331 session_lookup_init ();
1332 app_namespaces_init ();
1335 smm->is_enabled = 1;
1337 /* Enable transports */
1338 transport_enable_disable (vm, 1);
1344 session_node_enable_disable (u8 is_en)
1346 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1348 foreach_vlib_main (({
1349 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1356 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1358 clib_error_t *error = 0;
1361 if (session_manager_main.is_enabled)
1364 session_node_enable_disable (is_en);
1365 error = session_manager_main_enable (vm);
1369 session_manager_main.is_enabled = 0;
1370 session_node_enable_disable (is_en);
1377 session_manager_main_init (vlib_main_t * vm)
1379 session_manager_main_t *smm = &session_manager_main;
1380 smm->session_baseva = 0x200000000ULL;
1381 smm->session_va_space_size = (u64) 128 << 30;
1382 smm->evt_qs_segment_size = 64 << 20;
1383 smm->is_enabled = 0;
1387 VLIB_INIT_FUNCTION (session_manager_main_init);
1389 static clib_error_t *
1390 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1392 session_manager_main_t *smm = &session_manager_main;
1396 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1398 if (unformat (input, "event-queue-length %d", &nitems))
1401 smm->configured_event_queue_length = nitems;
1403 clib_warning ("event queue length %d too small, ignored", nitems);
1405 else if (unformat (input, "preallocated-sessions %d",
1406 &smm->preallocated_sessions))
1408 else if (unformat (input, "v4-session-table-buckets %d",
1409 &smm->configured_v4_session_table_buckets))
1411 else if (unformat (input, "v4-halfopen-table-buckets %d",
1412 &smm->configured_v4_halfopen_table_buckets))
1414 else if (unformat (input, "v6-session-table-buckets %d",
1415 &smm->configured_v6_session_table_buckets))
1417 else if (unformat (input, "v6-halfopen-table-buckets %d",
1418 &smm->configured_v6_halfopen_table_buckets))
1420 else if (unformat (input, "v4-session-table-memory %U",
1421 unformat_memory_size, &tmp))
1423 if (tmp >= 0x100000000)
1424 return clib_error_return (0, "memory size %llx (%lld) too large",
1426 smm->configured_v4_session_table_memory = tmp;
1428 else if (unformat (input, "v4-halfopen-table-memory %U",
1429 unformat_memory_size, &tmp))
1431 if (tmp >= 0x100000000)
1432 return clib_error_return (0, "memory size %llx (%lld) too large",
1434 smm->configured_v4_halfopen_table_memory = tmp;
1436 else if (unformat (input, "v6-session-table-memory %U",
1437 unformat_memory_size, &tmp))
1439 if (tmp >= 0x100000000)
1440 return clib_error_return (0, "memory size %llx (%lld) too large",
1442 smm->configured_v6_session_table_memory = tmp;
1444 else if (unformat (input, "v6-halfopen-table-memory %U",
1445 unformat_memory_size, &tmp))
1447 if (tmp >= 0x100000000)
1448 return clib_error_return (0, "memory size %llx (%lld) too large",
1450 smm->configured_v6_halfopen_table_memory = tmp;
1452 else if (unformat (input, "local-endpoints-table-memory %U",
1453 unformat_memory_size, &tmp))
1455 if (tmp >= 0x100000000)
1456 return clib_error_return (0, "memory size %llx (%lld) too large",
1458 smm->local_endpoints_table_memory = tmp;
1460 else if (unformat (input, "local-endpoints-table-buckets %d",
1461 &smm->local_endpoints_table_buckets))
1463 else if (unformat (input, "evt_qs_memfd_seg"))
1464 smm->evt_qs_use_memfd_seg = 1;
1466 return clib_error_return (0, "unknown input `%U'",
1467 format_unformat_error, input);
1472 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1475 * fd.io coding-style-patch-verification: ON
1478 * eval: (c-set-style "gnu")