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 * 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);
728 s->session_state = SESSION_STATE_CLOSING;
732 * Cleans up session and lookup table.
734 * Transport connection must still be valid.
737 stream_session_delete (stream_session_t * s)
741 /* Delete from the main lookup table. */
742 if ((rv = session_lookup_del_session (s)))
743 clib_warning ("hash delete error, rv %d", rv);
745 /* Cleanup fifo segments */
746 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
752 * Notification from transport that connection is being deleted
754 * This removes the session if it is still valid. It should be called only on
755 * previously fully established sessions. For instance failed connects should
756 * call stream_session_connect_notify and indicate that the connect has
760 stream_session_delete_notify (transport_connection_t * tc)
764 /* App might've been removed already */
765 s = session_get_if_valid (tc->s_index, tc->thread_index);
768 stream_session_delete (s);
772 * Notify application that connection has been reset.
775 stream_session_reset_notify (transport_connection_t * tc)
779 s = session_get (tc->s_index, tc->thread_index);
780 s->session_state = SESSION_STATE_CLOSED;
781 app = application_get (s->app_index);
782 app->cb_fns.session_reset_callback (s);
786 * Accept a stream session. Optionally ping the server by callback.
789 stream_session_accept (transport_connection_t * tc, u32 listener_index,
792 application_t *server;
793 stream_session_t *s, *listener;
794 segment_manager_t *sm;
797 /* Find the server */
798 listener = listen_session_get (listener_index);
799 server = application_get (listener->app_index);
801 sm = application_get_listen_segment_manager (server, listener);
802 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
805 s->app_index = server->index;
806 s->listener_index = listener_index;
807 s->session_state = SESSION_STATE_ACCEPTING;
809 /* Shoulder-tap the server */
812 server->cb_fns.session_accept_callback (s);
819 session_open_cl (u32 app_index, session_endpoint_t * rmt, u32 opaque)
821 transport_connection_t *tc;
822 transport_endpoint_t *tep;
823 segment_manager_t *sm;
828 tep = session_endpoint_to_transport (rmt);
829 rv = tp_vfts[rmt->transport_proto].open (tep);
832 SESSION_DBG ("Transport failed to open connection.");
833 return VNET_API_ERROR_SESSION_CONNECT;
836 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
838 /* For dgram type of service, allocate session and fifos now.
840 app = application_get (app_index);
841 sm = application_get_connect_segment_manager (app);
843 if (session_alloc_and_init (sm, tc, 1, &s))
845 s->app_index = app->index;
846 s->session_state = SESSION_STATE_OPENED;
848 /* Tell the app about the new event fifo for this session */
849 app->cb_fns.session_connected_callback (app->index, opaque, s, 0);
855 session_open_vc (u32 app_index, session_endpoint_t * rmt, u32 opaque)
857 transport_connection_t *tc;
858 transport_endpoint_t *tep;
862 tep = session_endpoint_to_transport (rmt);
863 rv = tp_vfts[rmt->transport_proto].open (tep);
866 SESSION_DBG ("Transport failed to open connection.");
867 return VNET_API_ERROR_SESSION_CONNECT;
870 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
872 /* If transport offers a stream service, only allocate session once the
873 * connection has been established.
874 * Add connection to half-open table and save app and tc index. The
875 * latter is needed to help establish the connection while the former
876 * is needed when the connect notify comes and we have to notify the
879 handle = (((u64) app_index) << 32) | (u64) tc->c_index;
880 session_lookup_add_half_open (tc, handle);
882 /* Store api_context (opaque) for when the reply comes. Not the nicest
883 * thing but better than allocating a separate half-open pool.
885 tc->s_index = opaque;
890 session_open_app (u32 app_index, session_endpoint_t * rmt, u32 opaque)
892 session_endpoint_extended_t *sep = (session_endpoint_extended_t *) rmt;
893 sep->app_index = app_index;
894 sep->opaque = opaque;
896 return tp_vfts[rmt->transport_proto].open ((transport_endpoint_t *) sep);
899 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
902 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
910 * Ask transport to open connection to remote transport endpoint.
912 * Stores handle for matching request with reply since the call can be
913 * asynchronous. For instance, for TCP the 3-way handshake must complete
914 * before reply comes. Session is only created once connection is established.
916 * @param app_index Index of the application requesting the connect
917 * @param st Session type requested.
918 * @param tep Remote transport endpoint
919 * @param opaque Opaque data (typically, api_context) the application expects
920 * on open completion.
923 session_open (u32 app_index, session_endpoint_t * rmt, u32 opaque)
925 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
926 return session_open_srv_fns[tst] (app_index, rmt, opaque);
930 session_listen_vc (stream_session_t * s, session_endpoint_t * sep)
932 transport_connection_t *tc;
935 /* Transport bind/listen */
936 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
937 session_endpoint_to_transport
940 if (tci == (u32) ~ 0)
943 /* Attach transport to session */
944 s->connection_index = tci;
945 tc = tp_vfts[sep->transport_proto].get_listener (tci);
947 /* Weird but handle it ... */
951 /* Add to the main lookup table */
952 session_lookup_add_connection (tc, s->session_index);
957 session_listen_cl (stream_session_t * s, session_endpoint_t * sep)
959 transport_connection_t *tc;
960 application_t *server;
961 segment_manager_t *sm;
964 /* Transport bind/listen */
965 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
966 session_endpoint_to_transport
969 if (tci == (u32) ~ 0)
972 /* Attach transport to session */
973 s->connection_index = tci;
974 tc = tp_vfts[sep->transport_proto].get_listener (tci);
976 /* Weird but handle it ... */
980 server = application_get (s->app_index);
981 sm = application_get_listen_segment_manager (server, s);
982 if (session_alloc_fifos (sm, s))
985 /* Add to the main lookup table */
986 session_lookup_add_connection (tc, s->session_index);
991 session_listen_app (stream_session_t * s, session_endpoint_t * sep)
993 session_endpoint_extended_t esep;
994 clib_memcpy (&esep, sep, sizeof (*sep));
995 esep.app_index = s->app_index;
997 return tp_vfts[sep->transport_proto].bind (s->session_index,
998 (transport_endpoint_t *) & esep);
1001 typedef int (*session_listen_service_fn) (stream_session_t *,
1002 session_endpoint_t *);
1005 static session_listen_service_fn
1006 session_listen_srv_fns[TRANSPORT_N_SERVICES] = {
1014 * Ask transport to listen on local transport endpoint.
1016 * @param s Session for which listen will be called. Note that unlike
1017 * established sessions, listen sessions are not associated to a
1019 * @param tep Local endpoint to be listened on.
1022 stream_session_listen (stream_session_t * s, session_endpoint_t * sep)
1024 transport_service_type_t tst = tp_vfts[sep->transport_proto].service_type;
1025 return session_listen_srv_fns[tst] (s, sep);
1029 * Ask transport to stop listening on local transport endpoint.
1031 * @param s Session to stop listening on. It must be in state LISTENING.
1034 stream_session_stop_listen (stream_session_t * s)
1036 transport_proto_t tp = session_get_transport_proto (s);
1037 transport_connection_t *tc;
1038 if (s->session_state != SESSION_STATE_LISTENING)
1040 clib_warning ("not a listening session");
1044 tc = tp_vfts[tp].get_listener (s->connection_index);
1047 clib_warning ("no transport");
1048 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1051 session_lookup_del_connection (tc);
1052 tp_vfts[tp].unbind (s->connection_index);
1057 * Initialize session disconnect.
1059 * Request is always sent to session node to ensure that all outstanding
1060 * requests are served before transport is notified.
1063 stream_session_disconnect (stream_session_t * s)
1065 u32 thread_index = vlib_get_thread_index ();
1066 session_manager_main_t *smm = &session_manager_main;
1067 session_fifo_event_t *evt;
1072 if (s->session_state >= SESSION_STATE_CLOSING)
1074 /* Session already closed. Clear the tx fifo */
1075 if (s->session_state == SESSION_STATE_CLOSED)
1076 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1080 s->session_state = SESSION_STATE_CLOSING;
1082 /* If we are in the handler thread, or being called with the worker barrier
1083 * held (api/cli), just append a new event to pending disconnects vector. */
1084 if ((thread_index == 0 && !vlib_get_current_process (vlib_get_main ()))
1085 || thread_index == s->thread_index)
1087 ASSERT (s->thread_index == thread_index || thread_index == 0);
1088 vec_add2 (smm->pending_disconnects[s->thread_index], evt, 1);
1089 memset (evt, 0, sizeof (*evt));
1090 evt->session_handle = session_handle (s);
1091 evt->event_type = FIFO_EVENT_DISCONNECT;
1094 session_send_session_evt_to_thread (session_handle (s),
1095 FIFO_EVENT_DISCONNECT,
1100 * Notify transport the session can be disconnected. This should eventually
1101 * result in a delete notification that allows us to cleanup session state.
1102 * Called for both active/passive disconnects.
1104 * Must be called from the session's thread.
1107 stream_session_disconnect_transport (stream_session_t * s)
1109 s->session_state = SESSION_STATE_CLOSED;
1110 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1115 * Cleanup transport and session state.
1117 * Notify transport of the cleanup and free the session. This should
1118 * be called only if transport reported some error and is already
1122 stream_session_cleanup (stream_session_t * s)
1124 s->session_state = SESSION_STATE_CLOSED;
1126 /* Delete from main lookup table before we axe the the transport */
1127 session_lookup_del_session (s);
1128 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1130 /* Since we called cleanup, no delete notification will come. So, make
1131 * sure the session is properly freed. */
1132 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
1137 transport_service_type_t
1138 session_transport_service_type (stream_session_t * s)
1140 transport_proto_t tp;
1141 tp = session_get_transport_proto (s);
1142 return transport_protocol_service_type (tp);
1145 transport_tx_fn_type_t
1146 session_transport_tx_fn_type (stream_session_t * s)
1148 transport_proto_t tp;
1149 tp = session_get_transport_proto (s);
1150 return transport_protocol_tx_fn_type (tp);
1154 session_tx_is_dgram (stream_session_t * s)
1156 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1160 * Allocate event queues in the shared-memory segment
1162 * That can either be a newly created memfd segment, that will need to be
1163 * mapped by all stack users, or the binary api's svm region. The latter is
1164 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1165 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1166 * vpp uses api svm region for event queues.
1169 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1171 u32 evt_q_length = 2048, evt_size = sizeof (session_fifo_event_t);
1172 ssvm_private_t *eqs = &smm->evt_qs_segment;
1173 api_main_t *am = &api_main;
1174 u64 eqs_size = 64 << 20;
1175 pid_t vpp_pid = getpid ();
1179 if (smm->configured_event_queue_length)
1180 evt_q_length = smm->configured_event_queue_length;
1182 if (smm->evt_qs_use_memfd_seg)
1184 if (smm->evt_qs_segment_size)
1185 eqs_size = smm->evt_qs_segment_size;
1187 eqs->ssvm_size = eqs_size;
1188 eqs->i_am_master = 1;
1189 eqs->my_pid = vpp_pid;
1190 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1191 eqs->requested_va = smm->session_baseva;
1193 ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD);
1196 if (smm->evt_qs_use_memfd_seg)
1197 oldheap = ssvm_push_heap (eqs->sh);
1199 oldheap = svm_push_data_heap (am->vlib_rp);
1201 for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1203 smm->vpp_event_queues[i] = svm_queue_init (evt_q_length, evt_size,
1207 if (smm->evt_qs_use_memfd_seg)
1208 ssvm_pop_heap (oldheap);
1210 svm_pop_heap (oldheap);
1214 session_manager_get_evt_q_segment (void)
1216 session_manager_main_t *smm = &session_manager_main;
1217 if (smm->evt_qs_use_memfd_seg)
1218 return &smm->evt_qs_segment;
1223 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1224 session_tx_fifo_peek_and_snd,
1225 session_tx_fifo_dequeue_and_snd,
1226 session_tx_fifo_dequeue_internal,
1227 session_tx_fifo_dequeue_and_snd
1232 * Initialize session layer for given transport proto and ip version
1234 * Allocates per session type (transport proto + ip version) data structures
1235 * and adds arc from session queue node to session type output node.
1238 session_register_transport (transport_proto_t transport_proto,
1239 const transport_proto_vft_t * vft, u8 is_ip4,
1242 session_manager_main_t *smm = &session_manager_main;
1243 session_type_t session_type;
1244 u32 next_index = ~0;
1246 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1248 vec_validate (smm->session_type_to_next, session_type);
1249 vec_validate (smm->session_tx_fns, session_type);
1252 if (output_node != ~0)
1254 foreach_vlib_main (({
1255 next_index = vlib_node_add_next (this_vlib_main,
1256 session_queue_node.index,
1262 smm->session_type_to_next[session_type] = next_index;
1263 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1266 transport_connection_t *
1267 session_get_transport (stream_session_t * s)
1269 transport_proto_t tp;
1270 if (s->session_state != SESSION_STATE_LISTENING)
1272 tp = session_get_transport_proto (s);
1273 return tp_vfts[tp].get_connection (s->connection_index,
1279 transport_connection_t *
1280 listen_session_get_transport (stream_session_t * s)
1282 transport_proto_t tp = session_get_transport_proto (s);
1283 return tp_vfts[tp].get_listener (s->connection_index);
1287 listen_session_get_local_session_endpoint (stream_session_t * listener,
1288 session_endpoint_t * sep)
1290 transport_proto_t tp = session_get_transport_proto (listener);
1291 transport_connection_t *tc;
1292 tc = tp_vfts[tp].get_listener (listener->connection_index);
1295 clib_warning ("no transport");
1299 /* N.B. The ip should not be copied because this is the local endpoint */
1300 sep->port = tc->lcl_port;
1301 sep->transport_proto = tc->proto;
1302 sep->is_ip4 = tc->is_ip4;
1307 session_flush_frames_main_thread (vlib_main_t * vm)
1309 ASSERT (vlib_get_thread_index () == 0);
1310 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1311 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1314 static clib_error_t *
1315 session_manager_main_enable (vlib_main_t * vm)
1317 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1318 session_manager_main_t *smm = &session_manager_main;
1319 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1320 u32 num_threads, preallocated_sessions_per_worker;
1323 num_threads = 1 /* main thread */ + vtm->n_threads;
1325 if (num_threads < 1)
1326 return clib_error_return (0, "n_thread_stacks not set");
1328 /* configure per-thread ** vectors */
1329 vec_validate (smm->sessions, num_threads - 1);
1330 vec_validate (smm->tx_buffers, num_threads - 1);
1331 vec_validate (smm->pending_event_vector, num_threads - 1);
1332 vec_validate (smm->pending_disconnects, num_threads - 1);
1333 vec_validate (smm->free_event_vector, num_threads - 1);
1334 vec_validate (smm->vpp_event_queues, num_threads - 1);
1335 vec_validate (smm->peekers_rw_locks, num_threads - 1);
1336 vec_validate_aligned (smm->ctx, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1338 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1340 vec_validate (smm->current_enqueue_epoch[i], num_threads - 1);
1341 vec_validate (smm->session_to_enqueue[i], num_threads - 1);
1342 for (j = 0; j < num_threads; j++)
1343 smm->current_enqueue_epoch[i][j] = 1;
1346 for (i = 0; i < num_threads; i++)
1348 vec_validate (smm->free_event_vector[i], 0);
1349 _vec_len (smm->free_event_vector[i]) = 0;
1350 vec_validate (smm->pending_event_vector[i], 0);
1351 _vec_len (smm->pending_event_vector[i]) = 0;
1352 vec_validate (smm->pending_disconnects[i], 0);
1353 _vec_len (smm->pending_disconnects[i]) = 0;
1354 if (num_threads > 1)
1355 clib_rwlock_init (&smm->peekers_rw_locks[i]);
1359 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1362 /* Allocate vpp event queues segment and queue */
1363 session_vpp_event_queues_allocate (smm);
1365 /* Initialize fifo segment main baseva and timeout */
1366 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1367 sm_args->size = smm->session_va_space_size;
1368 segment_manager_main_init (sm_args);
1370 /* Preallocate sessions */
1371 if (smm->preallocated_sessions)
1373 if (num_threads == 1)
1375 pool_init_fixed (smm->sessions[0], smm->preallocated_sessions);
1380 preallocated_sessions_per_worker =
1381 (1.1 * (f64) smm->preallocated_sessions /
1382 (f64) (num_threads - 1));
1384 for (j = 1; j < num_threads; j++)
1386 pool_init_fixed (smm->sessions[j],
1387 preallocated_sessions_per_worker);
1392 session_lookup_init ();
1393 app_namespaces_init ();
1396 smm->is_enabled = 1;
1398 /* Enable transports */
1399 transport_enable_disable (vm, 1);
1405 session_node_enable_disable (u8 is_en)
1407 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1408 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1409 u8 have_workers = vtm->n_threads != 0;
1412 foreach_vlib_main (({
1413 if (have_workers && ii == 0)
1415 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1419 vlib_node_t *n = vlib_get_node (this_vlib_main,
1420 session_queue_process_node.index);
1421 vlib_start_process (this_vlib_main, n->runtime_index);
1425 vlib_process_signal_event_mt (this_vlib_main,
1426 session_queue_process_node.index,
1427 SESSION_Q_PROCESS_STOP, 0);
1432 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1439 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1441 clib_error_t *error = 0;
1444 if (session_manager_main.is_enabled)
1447 session_node_enable_disable (is_en);
1448 error = session_manager_main_enable (vm);
1452 session_manager_main.is_enabled = 0;
1453 session_node_enable_disable (is_en);
1460 session_manager_main_init (vlib_main_t * vm)
1462 session_manager_main_t *smm = &session_manager_main;
1463 smm->session_baseva = 0x200000000ULL;
1464 smm->session_va_space_size = (u64) 128 << 30;
1465 smm->evt_qs_segment_size = 64 << 20;
1466 smm->is_enabled = 0;
1470 VLIB_INIT_FUNCTION (session_manager_main_init);
1472 static clib_error_t *
1473 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1475 session_manager_main_t *smm = &session_manager_main;
1479 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1481 if (unformat (input, "event-queue-length %d", &nitems))
1484 smm->configured_event_queue_length = nitems;
1486 clib_warning ("event queue length %d too small, ignored", nitems);
1488 else if (unformat (input, "preallocated-sessions %d",
1489 &smm->preallocated_sessions))
1491 else if (unformat (input, "v4-session-table-buckets %d",
1492 &smm->configured_v4_session_table_buckets))
1494 else if (unformat (input, "v4-halfopen-table-buckets %d",
1495 &smm->configured_v4_halfopen_table_buckets))
1497 else if (unformat (input, "v6-session-table-buckets %d",
1498 &smm->configured_v6_session_table_buckets))
1500 else if (unformat (input, "v6-halfopen-table-buckets %d",
1501 &smm->configured_v6_halfopen_table_buckets))
1503 else if (unformat (input, "v4-session-table-memory %U",
1504 unformat_memory_size, &tmp))
1506 if (tmp >= 0x100000000)
1507 return clib_error_return (0, "memory size %llx (%lld) too large",
1509 smm->configured_v4_session_table_memory = tmp;
1511 else if (unformat (input, "v4-halfopen-table-memory %U",
1512 unformat_memory_size, &tmp))
1514 if (tmp >= 0x100000000)
1515 return clib_error_return (0, "memory size %llx (%lld) too large",
1517 smm->configured_v4_halfopen_table_memory = tmp;
1519 else if (unformat (input, "v6-session-table-memory %U",
1520 unformat_memory_size, &tmp))
1522 if (tmp >= 0x100000000)
1523 return clib_error_return (0, "memory size %llx (%lld) too large",
1525 smm->configured_v6_session_table_memory = tmp;
1527 else if (unformat (input, "v6-halfopen-table-memory %U",
1528 unformat_memory_size, &tmp))
1530 if (tmp >= 0x100000000)
1531 return clib_error_return (0, "memory size %llx (%lld) too large",
1533 smm->configured_v6_halfopen_table_memory = tmp;
1535 else if (unformat (input, "local-endpoints-table-memory %U",
1536 unformat_memory_size, &tmp))
1538 if (tmp >= 0x100000000)
1539 return clib_error_return (0, "memory size %llx (%lld) too large",
1541 smm->local_endpoints_table_memory = tmp;
1543 else if (unformat (input, "local-endpoints-table-buckets %d",
1544 &smm->local_endpoints_table_buckets))
1546 else if (unformat (input, "evt_qs_memfd_seg"))
1547 smm->evt_qs_use_memfd_seg = 1;
1549 return clib_error_return (0, "unknown input `%U'",
1550 format_unformat_error, input);
1555 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1558 * fd.io coding-style-patch-verification: ON
1561 * eval: (c-set-style "gnu")