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]);
359 session_enqueue_dgram_connection (stream_session_t * s, vlib_buffer_t * b,
360 u8 proto, u8 queue_event)
362 int enqueued = 0, rv, in_order_off;
364 if (svm_fifo_max_enqueue (s->server_rx_fifo) < b->current_length)
366 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
367 vlib_buffer_get_current (b));
368 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
370 in_order_off = enqueued > b->current_length ? enqueued : 0;
371 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
377 /* Queue RX event on this fifo. Eventually these will need to be flushed
378 * by calling stream_server_flush_enqueue_events () */
379 session_manager_main_t *smm = vnet_get_session_manager_main ();
380 u32 thread_index = s->thread_index;
381 u32 enqueue_epoch = smm->current_enqueue_epoch[proto][thread_index];
383 if (s->enqueue_epoch != enqueue_epoch)
385 s->enqueue_epoch = enqueue_epoch;
386 vec_add1 (smm->session_to_enqueue[proto][thread_index],
387 s - smm->sessions[thread_index]);
393 /** Check if we have space in rx fifo to push more bytes */
395 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
398 stream_session_t *s = session_get (tc->s_index, thread_index);
400 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
403 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
410 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc)
412 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
413 if (!s->server_tx_fifo)
415 return svm_fifo_max_dequeue (s->server_tx_fifo);
419 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
420 u32 offset, u32 max_bytes)
422 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
423 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
427 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
429 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
430 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
434 * Notify session peer that new data has been enqueued.
436 * @param s Stream session for which the event is to be generated.
437 * @param block Flag to indicate if call should block if event queue is full.
439 * @return 0 on succes or negative number if failed to send notification.
442 session_enqueue_notify (stream_session_t * s, u8 block)
445 session_fifo_event_t evt;
448 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
450 /* Session is closed so app will never clean up. Flush rx fifo */
451 u32 to_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
453 svm_fifo_dequeue_drop (s->server_rx_fifo, to_dequeue);
457 /* Get session's server */
458 app = application_get_if_valid (s->app_index);
460 if (PREDICT_FALSE (app == 0))
462 clib_warning ("invalid s->app_index = %d", s->app_index);
466 /* Built-in app? Hand event to the callback... */
467 if (app->cb_fns.builtin_app_rx_callback)
468 return app->cb_fns.builtin_app_rx_callback (s);
470 /* If no event, send one */
471 if (svm_fifo_set_event (s->server_rx_fifo))
473 /* Fabricate event */
474 evt.fifo = s->server_rx_fifo;
475 evt.event_type = FIFO_EVENT_APP_RX;
477 /* Add event to server's event queue */
478 q = app->event_queue;
480 /* Based on request block (or not) for lack of space */
481 if (block || PREDICT_TRUE (q->cursize < q->maxsize))
482 svm_queue_add (app->event_queue, (u8 *) & evt,
483 0 /* do wait for mutex */ );
486 clib_warning ("fifo full");
492 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
493 ed->data[0] = evt.event_type;
494 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
502 * Flushes queue of sessions that are to be notified of new data
505 * @param thread_index Thread index for which the flush is to be performed.
506 * @return 0 on success or a positive number indicating the number of
507 * failures due to API queue being full.
510 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
512 session_manager_main_t *smm = &session_manager_main;
517 indices = smm->session_to_enqueue[transport_proto][thread_index];
519 for (i = 0; i < vec_len (indices); i++)
521 s = session_get_if_valid (indices[i], thread_index);
522 if (s == 0 || session_enqueue_notify (s, 0 /* don't block */ ))
526 vec_reset_length (indices);
527 smm->session_to_enqueue[transport_proto][thread_index] = indices;
528 smm->current_enqueue_epoch[transport_proto][thread_index]++;
534 * Init fifo tail and head pointers
536 * Useful if transport uses absolute offsets for tracking ooo segments.
539 stream_session_init_fifos_pointers (transport_connection_t * tc,
540 u32 rx_pointer, u32 tx_pointer)
543 s = session_get (tc->s_index, tc->thread_index);
544 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
545 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
549 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
551 u32 opaque = 0, new_ti, new_si;
552 stream_session_t *new_s = 0;
553 segment_manager_t *sm;
560 * Find connection handle and cleanup half-open table
562 handle = session_lookup_half_open_handle (tc);
563 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
565 SESSION_DBG ("half-open was removed!");
568 session_lookup_del_half_open (tc);
570 /* Get the app's index from the handle we stored when opening connection
571 * and the opaque (api_context for external apps) from transport session
573 app = application_get_if_valid (handle >> 32);
576 opaque = tc->s_index;
579 * Allocate new session with fifos (svm segments are allocated if needed)
583 sm = application_get_connect_segment_manager (app);
584 alloc_fifos = !application_is_builtin_proxy (app);
585 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
592 new_s->app_index = app->index;
593 new_si = new_s->session_index;
594 new_ti = new_s->thread_index;
599 * Notify client application
601 if (app->cb_fns.session_connected_callback (app->index, opaque, new_s,
604 SESSION_DBG ("failed to notify app");
607 new_s = session_get (new_si, new_ti);
608 stream_session_disconnect_transport (new_s);
615 new_s = session_get (new_si, new_ti);
616 new_s->session_state = SESSION_STATE_READY;
623 typedef struct _session_switch_pool_args
627 u32 new_thread_index;
628 u32 new_session_index;
629 } session_switch_pool_args_t;
632 session_switch_pool (void *cb_args)
634 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
635 transport_proto_t tp;
637 ASSERT (args->thread_index == vlib_get_thread_index ());
638 s = session_get (args->session_index, args->thread_index);
639 s->server_tx_fifo->master_session_index = args->new_session_index;
640 s->server_tx_fifo->master_thread_index = args->new_thread_index;
641 tp = session_get_transport_proto (s);
642 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
644 clib_mem_free (cb_args);
648 * Move dgram session to the right thread
651 session_dgram_connect_notify (transport_connection_t * tc,
652 u32 old_thread_index,
653 stream_session_t ** new_session)
655 stream_session_t *new_s;
656 session_switch_pool_args_t *rpc_args;
659 * Clone half-open session to the right thread.
661 new_s = session_clone_safe (tc->s_index, old_thread_index);
662 new_s->connection_index = tc->c_index;
663 new_s->server_rx_fifo->master_session_index = new_s->session_index;
664 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
665 new_s->session_state = SESSION_STATE_READY;
666 session_lookup_add_connection (tc, session_handle (new_s));
669 * Ask thread owning the old session to clean it up and make us the tx
672 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
673 rpc_args->new_session_index = new_s->session_index;
674 rpc_args->new_thread_index = new_s->thread_index;
675 rpc_args->session_index = tc->s_index;
676 rpc_args->thread_index = old_thread_index;
677 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
680 tc->s_index = new_s->session_index;
681 new_s->connection_index = tc->c_index;
682 *new_session = new_s;
687 stream_session_accept_notify (transport_connection_t * tc)
689 application_t *server;
692 s = session_get (tc->s_index, tc->thread_index);
693 server = application_get (s->app_index);
694 server->cb_fns.session_accept_callback (s);
698 * Notification from transport that connection is being closed.
700 * A disconnect is sent to application but state is not removed. Once
701 * disconnect is acknowledged by application, session disconnect is called.
702 * Ultimately this leads to close being called on transport (passive close).
705 stream_session_disconnect_notify (transport_connection_t * tc)
707 application_t *server;
710 s = session_get (tc->s_index, tc->thread_index);
711 server = application_get (s->app_index);
712 server->cb_fns.session_disconnect_callback (s);
716 * Cleans up session and lookup table.
719 stream_session_delete (stream_session_t * s)
723 /* Delete from the main lookup table. */
724 if ((rv = session_lookup_del_session (s)))
725 clib_warning ("hash delete error, rv %d", rv);
727 /* Cleanup fifo segments */
728 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
734 * Notification from transport that connection is being deleted
736 * This removes the session if it is still valid. It should be called only on
737 * previously fully established sessions. For instance failed connects should
738 * call stream_session_connect_notify and indicate that the connect has
742 stream_session_delete_notify (transport_connection_t * tc)
746 /* App might've been removed already */
747 s = session_get_if_valid (tc->s_index, tc->thread_index);
750 stream_session_delete (s);
754 * Notify application that connection has been reset.
757 stream_session_reset_notify (transport_connection_t * tc)
761 s = session_get (tc->s_index, tc->thread_index);
763 app = application_get (s->app_index);
764 app->cb_fns.session_reset_callback (s);
768 * Accept a stream session. Optionally ping the server by callback.
771 stream_session_accept (transport_connection_t * tc, u32 listener_index,
774 application_t *server;
775 stream_session_t *s, *listener;
776 segment_manager_t *sm;
780 sst = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
782 /* Find the server */
783 listener = listen_session_get (sst, listener_index);
784 server = application_get (listener->app_index);
786 sm = application_get_listen_segment_manager (server, listener);
787 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
790 s->app_index = server->index;
791 s->listener_index = listener_index;
792 s->session_state = SESSION_STATE_ACCEPTING;
794 /* Shoulder-tap the server */
797 server->cb_fns.session_accept_callback (s);
804 session_open_cl (u32 app_index, session_endpoint_t * rmt, u32 opaque)
806 transport_connection_t *tc;
807 transport_endpoint_t *tep;
808 segment_manager_t *sm;
813 tep = session_endpoint_to_transport (rmt);
814 rv = tp_vfts[rmt->transport_proto].open (tep);
817 SESSION_DBG ("Transport failed to open connection.");
818 return VNET_API_ERROR_SESSION_CONNECT;
821 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
823 /* For dgram type of service, allocate session and fifos now.
825 app = application_get (app_index);
826 sm = application_get_connect_segment_manager (app);
828 if (session_alloc_and_init (sm, tc, 1, &s))
830 s->app_index = app->index;
831 s->session_state = SESSION_STATE_CONNECTING_READY;
833 /* Tell the app about the new event fifo for this session */
834 app->cb_fns.session_connected_callback (app->index, opaque, s, 0);
840 session_open_vc (u32 app_index, session_endpoint_t * rmt, u32 opaque)
842 transport_connection_t *tc;
843 transport_endpoint_t *tep;
847 /* TODO until udp is fixed */
848 if (rmt->transport_proto == TRANSPORT_PROTO_UDP)
849 return session_open_cl (app_index, rmt, opaque);
851 tep = session_endpoint_to_transport (rmt);
852 rv = tp_vfts[rmt->transport_proto].open (tep);
855 SESSION_DBG ("Transport failed to open connection.");
856 return VNET_API_ERROR_SESSION_CONNECT;
859 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
861 /* If transport offers a stream service, only allocate session once the
862 * connection has been established.
863 * Add connection to half-open table and save app and tc index. The
864 * latter is needed to help establish the connection while the former
865 * is needed when the connect notify comes and we have to notify the
868 handle = (((u64) app_index) << 32) | (u64) tc->c_index;
869 session_lookup_add_half_open (tc, handle);
871 /* Store api_context (opaque) for when the reply comes. Not the nicest
872 * thing but better than allocating a separate half-open pool.
874 tc->s_index = opaque;
879 session_open_app (u32 app_index, session_endpoint_t * rmt, u32 opaque)
881 session_endpoint_extended_t sep;
882 clib_memcpy (&sep, rmt, sizeof (*rmt));
883 sep.app_index = app_index;
886 return tp_vfts[rmt->transport_proto].open ((transport_endpoint_t *) & sep);
889 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
892 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
900 * Ask transport to open connection to remote transport endpoint.
902 * Stores handle for matching request with reply since the call can be
903 * asynchronous. For instance, for TCP the 3-way handshake must complete
904 * before reply comes. Session is only created once connection is established.
906 * @param app_index Index of the application requesting the connect
907 * @param st Session type requested.
908 * @param tep Remote transport endpoint
909 * @param opaque Opaque data (typically, api_context) the application expects
910 * on open completion.
913 session_open (u32 app_index, session_endpoint_t * rmt, u32 opaque)
915 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
916 return session_open_srv_fns[tst] (app_index, rmt, opaque);
920 * Ask transport to listen on local transport endpoint.
922 * @param s Session for which listen will be called. Note that unlike
923 * established sessions, listen sessions are not associated to a
925 * @param tep Local endpoint to be listened on.
928 session_listen_vc (stream_session_t * s, session_endpoint_t * sep)
930 transport_connection_t *tc;
933 /* Transport bind/listen */
934 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
935 session_endpoint_to_transport
938 if (tci == (u32) ~ 0)
941 /* Attach transport to session */
942 s->connection_index = tci;
943 tc = tp_vfts[sep->transport_proto].get_listener (tci);
945 /* Weird but handle it ... */
949 /* Add to the main lookup table */
950 session_lookup_add_connection (tc, s->session_index);
955 session_listen_app (stream_session_t * s, session_endpoint_t * sep)
957 session_endpoint_extended_t esep;
958 clib_memcpy (&esep, sep, sizeof (*sep));
959 esep.app_index = s->app_index;
961 return tp_vfts[sep->transport_proto].bind (s->session_index,
962 (transport_endpoint_t *) & esep);
965 typedef int (*session_listen_service_fn) (stream_session_t *,
966 session_endpoint_t *);
969 static session_listen_service_fn
970 session_listen_srv_fns[TRANSPORT_N_SERVICES] = {
978 stream_session_listen (stream_session_t * s, session_endpoint_t * sep)
980 transport_service_type_t tst = tp_vfts[sep->transport_proto].service_type;
981 return session_listen_srv_fns[tst] (s, sep);
985 * Ask transport to stop listening on local transport endpoint.
987 * @param s Session to stop listening on. It must be in state LISTENING.
990 stream_session_stop_listen (stream_session_t * s)
992 transport_proto_t tp = session_get_transport_proto (s);
993 transport_connection_t *tc;
994 if (s->session_state != SESSION_STATE_LISTENING)
996 clib_warning ("not a listening session");
1000 tc = tp_vfts[tp].get_listener (s->connection_index);
1003 clib_warning ("no transport");
1004 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1007 session_lookup_del_connection (tc);
1008 tp_vfts[tp].unbind (s->connection_index);
1013 * Initialize session disconnect.
1015 * Request is always sent to session node to ensure that all outstanding
1016 * requests are served before transport is notified.
1019 stream_session_disconnect (stream_session_t * s)
1021 if (!s || s->session_state == SESSION_STATE_CLOSED)
1023 s->session_state = SESSION_STATE_CLOSED;
1024 session_send_session_evt_to_thread (session_handle (s),
1025 FIFO_EVENT_DISCONNECT, s->thread_index);
1029 * Notify transport the session can be disconnected. This should eventually
1030 * result in a delete notification that allows us to cleanup session state.
1031 * Called for both active/passive disconnects.
1033 * Must be called from the session's thread.
1036 stream_session_disconnect_transport (stream_session_t * s)
1038 s->session_state = SESSION_STATE_CLOSED;
1039 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1044 * Cleanup transport and session state.
1046 * Notify transport of the cleanup, wait for a delete notify to actually
1047 * remove the session state.
1050 stream_session_cleanup (stream_session_t * s)
1054 s->session_state = SESSION_STATE_CLOSED;
1056 /* Delete from the main lookup table to avoid more enqueues */
1057 rv = session_lookup_del_session (s);
1059 clib_warning ("hash delete error, rv %d", rv);
1061 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1066 * Allocate event queues in the shared-memory segment
1068 * That can either be a newly created memfd segment, that will need to be
1069 * mapped by all stack users, or the binary api's svm region. The latter is
1070 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1071 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1072 * vpp uses api svm region for event queues.
1075 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1077 u32 evt_q_length = 2048, evt_size = sizeof (session_fifo_event_t);
1078 ssvm_private_t *eqs = &smm->evt_qs_segment;
1079 api_main_t *am = &api_main;
1080 u64 eqs_size = 64 << 20;
1081 pid_t vpp_pid = getpid ();
1085 if (smm->configured_event_queue_length)
1086 evt_q_length = smm->configured_event_queue_length;
1088 if (smm->evt_qs_use_memfd_seg)
1090 if (smm->evt_qs_segment_size)
1091 eqs_size = smm->evt_qs_segment_size;
1093 eqs->ssvm_size = eqs_size;
1094 eqs->i_am_master = 1;
1095 eqs->my_pid = vpp_pid;
1096 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1097 eqs->requested_va = smm->session_baseva;
1099 ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD);
1102 if (smm->evt_qs_use_memfd_seg)
1103 oldheap = ssvm_push_heap (eqs->sh);
1105 oldheap = svm_push_data_heap (am->vlib_rp);
1107 for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1109 smm->vpp_event_queues[i] = svm_queue_init (evt_q_length, evt_size,
1113 if (smm->evt_qs_use_memfd_seg)
1114 ssvm_pop_heap (oldheap);
1116 svm_pop_heap (oldheap);
1120 session_manager_get_evt_q_segment (void)
1122 session_manager_main_t *smm = &session_manager_main;
1123 if (smm->evt_qs_use_memfd_seg)
1124 return &smm->evt_qs_segment;
1129 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1130 session_tx_fifo_peek_and_snd,
1131 session_tx_fifo_dequeue_and_snd,
1132 session_tx_fifo_dequeue_internal
1137 * Initialize session layer for given transport proto and ip version
1139 * Allocates per session type (transport proto + ip version) data structures
1140 * and adds arc from session queue node to session type output node.
1143 session_register_transport (transport_proto_t transport_proto,
1144 const transport_proto_vft_t * vft, u8 is_ip4,
1147 session_manager_main_t *smm = &session_manager_main;
1148 session_type_t session_type;
1149 u32 next_index = ~0;
1151 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1153 vec_validate (smm->session_type_to_next, session_type);
1154 vec_validate (smm->listen_sessions, session_type);
1155 vec_validate (smm->session_tx_fns, session_type);
1158 if (output_node != ~0)
1160 foreach_vlib_main (({
1161 next_index = vlib_node_add_next (this_vlib_main,
1162 session_queue_node.index,
1168 smm->session_type_to_next[session_type] = next_index;
1169 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1172 transport_connection_t *
1173 session_get_transport (stream_session_t * s)
1175 transport_proto_t tp;
1176 if (s->session_state != SESSION_STATE_LISTENING)
1178 tp = session_get_transport_proto (s);
1179 return tp_vfts[tp].get_connection (s->connection_index,
1185 transport_connection_t *
1186 listen_session_get_transport (stream_session_t * s)
1188 transport_proto_t tp = session_get_transport_proto (s);
1189 return tp_vfts[tp].get_listener (s->connection_index);
1193 listen_session_get_local_session_endpoint (stream_session_t * listener,
1194 session_endpoint_t * sep)
1196 transport_proto_t tp = session_get_transport_proto (listener);
1197 transport_connection_t *tc;
1198 tc = tp_vfts[tp].get_listener (listener->connection_index);
1201 clib_warning ("no transport");
1205 /* N.B. The ip should not be copied because this is the local endpoint */
1206 sep->port = tc->lcl_port;
1207 sep->transport_proto = tc->proto;
1208 sep->is_ip4 = tc->is_ip4;
1212 static clib_error_t *
1213 session_manager_main_enable (vlib_main_t * vm)
1215 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1216 session_manager_main_t *smm = &session_manager_main;
1217 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1218 u32 num_threads, preallocated_sessions_per_worker;
1221 num_threads = 1 /* main thread */ + vtm->n_threads;
1223 if (num_threads < 1)
1224 return clib_error_return (0, "n_thread_stacks not set");
1226 /* configure per-thread ** vectors */
1227 vec_validate (smm->sessions, num_threads - 1);
1228 vec_validate (smm->tx_buffers, num_threads - 1);
1229 vec_validate (smm->pending_event_vector, num_threads - 1);
1230 vec_validate (smm->pending_disconnects, num_threads - 1);
1231 vec_validate (smm->free_event_vector, num_threads - 1);
1232 vec_validate (smm->vpp_event_queues, num_threads - 1);
1233 vec_validate (smm->peekers_rw_locks, num_threads - 1);
1235 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1236 for (j = 0; j < num_threads; j++)
1238 vec_validate (smm->session_to_enqueue[i], num_threads - 1);
1239 vec_validate (smm->current_enqueue_epoch[i], num_threads - 1);
1242 for (i = 0; i < num_threads; i++)
1244 vec_validate (smm->free_event_vector[i], 0);
1245 _vec_len (smm->free_event_vector[i]) = 0;
1246 vec_validate (smm->pending_event_vector[i], 0);
1247 _vec_len (smm->pending_event_vector[i]) = 0;
1248 vec_validate (smm->pending_disconnects[i], 0);
1249 _vec_len (smm->pending_disconnects[i]) = 0;
1250 if (num_threads > 1)
1251 clib_rwlock_init (&smm->peekers_rw_locks[i]);
1255 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1258 /* Allocate vpp event queues segment and queue */
1259 session_vpp_event_queues_allocate (smm);
1261 /* Initialize fifo segment main baseva and timeout */
1262 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1263 sm_args->size = smm->session_va_space_size;
1264 segment_manager_main_init (sm_args);
1266 /* Preallocate sessions */
1267 if (smm->preallocated_sessions)
1269 if (num_threads == 1)
1271 pool_init_fixed (smm->sessions[0], smm->preallocated_sessions);
1276 preallocated_sessions_per_worker =
1277 (1.1 * (f64) smm->preallocated_sessions /
1278 (f64) (num_threads - 1));
1280 for (j = 1; j < num_threads; j++)
1282 pool_init_fixed (smm->sessions[j],
1283 preallocated_sessions_per_worker);
1288 session_lookup_init ();
1289 app_namespaces_init ();
1292 smm->is_enabled = 1;
1294 /* Enable transports */
1295 transport_enable_disable (vm, 1);
1301 session_node_enable_disable (u8 is_en)
1303 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1305 foreach_vlib_main (({
1306 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1313 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1315 clib_error_t *error = 0;
1318 if (session_manager_main.is_enabled)
1321 session_node_enable_disable (is_en);
1322 error = session_manager_main_enable (vm);
1326 session_manager_main.is_enabled = 0;
1327 session_node_enable_disable (is_en);
1334 session_manager_main_init (vlib_main_t * vm)
1336 session_manager_main_t *smm = &session_manager_main;
1337 smm->session_baseva = 0x200000000ULL;
1338 smm->session_va_space_size = (u64) 128 << 30;
1339 smm->evt_qs_segment_size = 64 << 20;
1340 smm->is_enabled = 0;
1344 VLIB_INIT_FUNCTION (session_manager_main_init);
1346 static clib_error_t *
1347 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1349 session_manager_main_t *smm = &session_manager_main;
1353 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1355 if (unformat (input, "event-queue-length %d", &nitems))
1358 smm->configured_event_queue_length = nitems;
1360 clib_warning ("event queue length %d too small, ignored", nitems);
1362 else if (unformat (input, "preallocated-sessions %d",
1363 &smm->preallocated_sessions))
1365 else if (unformat (input, "v4-session-table-buckets %d",
1366 &smm->configured_v4_session_table_buckets))
1368 else if (unformat (input, "v4-halfopen-table-buckets %d",
1369 &smm->configured_v4_halfopen_table_buckets))
1371 else if (unformat (input, "v6-session-table-buckets %d",
1372 &smm->configured_v6_session_table_buckets))
1374 else if (unformat (input, "v6-halfopen-table-buckets %d",
1375 &smm->configured_v6_halfopen_table_buckets))
1377 else if (unformat (input, "v4-session-table-memory %U",
1378 unformat_memory_size, &tmp))
1380 if (tmp >= 0x100000000)
1381 return clib_error_return (0, "memory size %llx (%lld) too large",
1383 smm->configured_v4_session_table_memory = tmp;
1385 else if (unformat (input, "v4-halfopen-table-memory %U",
1386 unformat_memory_size, &tmp))
1388 if (tmp >= 0x100000000)
1389 return clib_error_return (0, "memory size %llx (%lld) too large",
1391 smm->configured_v4_halfopen_table_memory = tmp;
1393 else if (unformat (input, "v6-session-table-memory %U",
1394 unformat_memory_size, &tmp))
1396 if (tmp >= 0x100000000)
1397 return clib_error_return (0, "memory size %llx (%lld) too large",
1399 smm->configured_v6_session_table_memory = tmp;
1401 else if (unformat (input, "v6-halfopen-table-memory %U",
1402 unformat_memory_size, &tmp))
1404 if (tmp >= 0x100000000)
1405 return clib_error_return (0, "memory size %llx (%lld) too large",
1407 smm->configured_v6_halfopen_table_memory = tmp;
1409 else if (unformat (input, "local-endpoints-table-memory %U",
1410 unformat_memory_size, &tmp))
1412 if (tmp >= 0x100000000)
1413 return clib_error_return (0, "memory size %llx (%lld) too large",
1415 smm->local_endpoints_table_memory = tmp;
1417 else if (unformat (input, "local-endpoints-table-buckets %d",
1418 &smm->local_endpoints_table_buckets))
1420 else if (unformat (input, "evt_qs_memfd_seg"))
1421 smm->evt_qs_use_memfd_seg = 1;
1423 return clib_error_return (0, "unknown input `%U'",
1424 format_unformat_error, input);
1429 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1432 * fd.io coding-style-patch-verification: ON
1435 * eval: (c-set-style "gnu")