2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 * @brief Session and session manager
20 #include <vnet/session/session.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/application.h>
23 #include <vlibmemory/api.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/fib/ip4_fib.h>
27 session_manager_main_t session_manager_main;
28 extern transport_proto_vft_t *tp_vfts;
31 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
32 session_evt_type_t evt_type)
37 u32 tries = 0, max_tries;
39 mq = session_manager_get_vpp_event_queue (thread_index);
40 while (svm_msg_q_try_lock (mq))
42 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
43 if (tries++ == max_tries)
45 SESSION_DBG ("failed to enqueue evt");
49 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
51 svm_msg_q_unlock (mq);
54 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
55 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
57 svm_msg_q_unlock (mq);
60 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
61 evt->event_type = evt_type;
65 evt->rpc_args.fp = data;
66 evt->rpc_args.arg = args;
68 case FIFO_EVENT_APP_TX:
69 case SESSION_IO_EVT_TX_FLUSH:
70 case FIFO_EVENT_BUILTIN_RX:
73 case FIFO_EVENT_BUILTIN_TX:
74 case FIFO_EVENT_DISCONNECT:
75 evt->session_handle = session_handle ((stream_session_t *) data);
78 clib_warning ("evt unhandled!");
79 svm_msg_q_unlock (mq);
83 svm_msg_q_add_and_unlock (mq, &msg);
88 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
90 return session_send_evt_to_thread (f, 0, f->master_thread_index, evt_type);
94 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
95 session_evt_type_t evt_type)
97 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
101 session_send_ctrl_evt_to_thread (stream_session_t * s,
102 session_evt_type_t evt_type)
104 /* only event supported for now is disconnect */
105 ASSERT (evt_type == FIFO_EVENT_DISCONNECT);
106 return session_send_evt_to_thread (s, 0, s->thread_index,
107 FIFO_EVENT_DISCONNECT);
111 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
113 if (thread_index != vlib_get_thread_index ())
114 session_send_evt_to_thread (fp, rpc_args, thread_index, FIFO_EVENT_RPC);
117 void (*fnp) (void *) = fp;
123 session_program_transport_close (stream_session_t * s)
125 u32 thread_index = vlib_get_thread_index ();
126 session_manager_worker_t *wrk;
127 session_event_t *evt;
129 /* If we are in the handler thread, or being called with the worker barrier
130 * held, just append a new event to pending disconnects vector. */
131 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
133 wrk = session_manager_get_worker (s->thread_index);
134 vec_add2 (wrk->pending_disconnects, evt, 1);
135 clib_memset (evt, 0, sizeof (*evt));
136 evt->session_handle = session_handle (s);
137 evt->event_type = FIFO_EVENT_DISCONNECT;
140 session_send_ctrl_evt_to_thread (s, FIFO_EVENT_DISCONNECT);
144 session_alloc (u32 thread_index)
146 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
149 pool_get_aligned_will_expand (wrk->sessions, will_expand,
150 CLIB_CACHE_LINE_BYTES);
151 /* If we have peekers, let them finish */
152 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
154 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
155 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
156 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
160 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
162 clib_memset (s, 0, sizeof (*s));
163 s->session_index = s - wrk->sessions;
164 s->thread_index = thread_index;
169 session_free (stream_session_t * s)
171 pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
173 clib_memset (s, 0xFA, sizeof (*s));
177 session_free_w_fifos (stream_session_t * s)
179 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
185 * Cleans up session and lookup table.
187 * Transport connection must still be valid.
190 session_delete (stream_session_t * s)
194 /* Delete from the main lookup table. */
195 if ((rv = session_lookup_del_session (s)))
196 clib_warning ("hash delete error, rv %d", rv);
198 session_free_w_fifos (s);
202 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
204 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
205 u32 fifo_segment_index;
208 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
210 &fifo_segment_index)))
212 /* Initialize backpointers */
213 server_rx_fifo->master_session_index = s->session_index;
214 server_rx_fifo->master_thread_index = s->thread_index;
216 server_tx_fifo->master_session_index = s->session_index;
217 server_tx_fifo->master_thread_index = s->thread_index;
219 s->server_rx_fifo = server_rx_fifo;
220 s->server_tx_fifo = server_tx_fifo;
221 s->svm_segment_index = fifo_segment_index;
225 static stream_session_t *
226 session_alloc_for_connection (transport_connection_t * tc)
229 u32 thread_index = tc->thread_index;
231 ASSERT (thread_index == vlib_get_thread_index ()
232 || transport_protocol_is_cl (tc->proto));
234 s = session_alloc (thread_index);
235 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
236 s->enqueue_epoch = (u64) ~ 0;
237 s->session_state = SESSION_STATE_CLOSED;
239 /* Attach transport to session and vice versa */
240 s->connection_index = tc->c_index;
241 tc->s_index = s->session_index;
246 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
247 u8 alloc_fifos, stream_session_t ** ret_s)
252 s = session_alloc_for_connection (tc);
253 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
260 /* Add to the main lookup table */
261 session_lookup_add_connection (tc, session_handle (s));
268 * Discards bytes from buffer chain
270 * It discards n_bytes_to_drop starting at first buffer after chain_b
273 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
274 vlib_buffer_t ** chain_b,
277 vlib_buffer_t *next = *chain_b;
278 u32 to_drop = n_bytes_to_drop;
279 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
280 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
282 next = vlib_get_buffer (vm, next->next_buffer);
283 if (next->current_length > to_drop)
285 vlib_buffer_advance (next, to_drop);
290 to_drop -= next->current_length;
291 next->current_length = 0;
297 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
301 * Enqueue buffer chain tail
304 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
305 u32 offset, u8 is_in_order)
307 vlib_buffer_t *chain_b;
308 u32 chain_bi, len, diff;
309 vlib_main_t *vm = vlib_get_main ();
314 if (is_in_order && offset)
316 diff = offset - b->current_length;
317 if (diff > b->total_length_not_including_first_buffer)
320 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
321 chain_bi = vlib_get_buffer_index (vm, chain_b);
324 chain_bi = b->next_buffer;
328 chain_b = vlib_get_buffer (vm, chain_bi);
329 data = vlib_buffer_get_current (chain_b);
330 len = chain_b->current_length;
335 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
342 return (rv > 0) ? (written + rv) : written;
348 /* written more than what was left in chain */
349 if (written > b->total_length_not_including_first_buffer)
352 /* drop the bytes that have already been delivered */
353 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
358 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
362 clib_warning ("failed to enqueue multi-buffer seg");
368 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
369 ? chain_b->next_buffer : 0));
378 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
379 * event but on request can queue notification events for later delivery by
380 * calling stream_server_flush_enqueue_events().
382 * @param tc Transport connection which is to be enqueued data
383 * @param b Buffer to be enqueued
384 * @param offset Offset at which to start enqueueing if out-of-order
385 * @param queue_event Flag to indicate if peer is to be notified or if event
386 * is to be queued. The former is useful when more data is
387 * enqueued and only one event is to be generated.
388 * @param is_in_order Flag to indicate if data is in order
389 * @return Number of bytes enqueued or a negative value if enqueueing failed.
392 session_enqueue_stream_connection (transport_connection_t * tc,
393 vlib_buffer_t * b, u32 offset,
394 u8 queue_event, u8 is_in_order)
397 int enqueued = 0, rv, in_order_off;
399 s = session_get (tc->s_index, tc->thread_index);
403 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
405 vlib_buffer_get_current (b));
406 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
409 in_order_off = enqueued > b->current_length ? enqueued : 0;
410 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
417 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
419 vlib_buffer_get_current (b));
420 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
421 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
422 /* if something was enqueued, report even this as success for ooo
423 * segment handling */
429 /* Queue RX event on this fifo. Eventually these will need to be flushed
430 * by calling stream_server_flush_enqueue_events () */
431 session_manager_worker_t *wrk;
433 wrk = session_manager_get_worker (s->thread_index);
434 if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
436 s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
437 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
445 session_enqueue_dgram_connection (stream_session_t * s,
446 session_dgram_hdr_t * hdr,
447 vlib_buffer_t * b, u8 proto, u8 queue_event)
449 int enqueued = 0, rv, in_order_off;
451 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
452 >= b->current_length + sizeof (*hdr));
454 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
456 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
457 vlib_buffer_get_current (b));
458 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
460 in_order_off = enqueued > b->current_length ? enqueued : 0;
461 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
467 /* Queue RX event on this fifo. Eventually these will need to be flushed
468 * by calling stream_server_flush_enqueue_events () */
469 session_manager_worker_t *wrk;
471 wrk = session_manager_get_worker (s->thread_index);
472 if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
474 s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
475 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
481 /** Check if we have space in rx fifo to push more bytes */
483 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
486 stream_session_t *s = session_get (tc->s_index, thread_index);
488 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
491 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
498 session_tx_fifo_max_dequeue (transport_connection_t * tc)
500 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
501 if (!s->server_tx_fifo)
503 return svm_fifo_max_dequeue (s->server_tx_fifo);
507 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
508 u32 offset, u32 max_bytes)
510 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
511 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
515 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
517 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
518 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
522 * Notify session peer that new data has been enqueued.
524 * @param s Stream session for which the event is to be generated.
525 * @param lock Flag to indicate if call should lock message queue.
527 * @return 0 on success or negative number if failed to send notification.
530 session_enqueue_notify (stream_session_t * s)
534 app = app_worker_get_if_valid (s->app_wrk_index);
535 if (PREDICT_FALSE (!app))
537 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
542 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
543 ed->data[0] = FIFO_EVENT_APP_RX;
544 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
548 return app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_RX);
552 session_dequeue_notify (stream_session_t * s)
556 app = app_worker_get_if_valid (s->app_wrk_index);
557 if (PREDICT_FALSE (!app))
560 if (app_worker_lock_and_send_event (app, s, FIFO_EVENT_APP_TX))
563 svm_fifo_clear_tx_ntf (s->server_tx_fifo);
568 * Flushes queue of sessions that are to be notified of new data
571 * @param thread_index Thread index for which the flush is to be performed.
572 * @return 0 on success or a positive number indicating the number of
573 * failures due to API queue being full.
576 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
578 session_manager_worker_t *wrk = session_manager_get_worker (thread_index);
583 indices = wrk->session_to_enqueue[transport_proto];
585 for (i = 0; i < vec_len (indices); i++)
587 s = session_get_if_valid (indices[i], thread_index);
588 if (PREDICT_FALSE (!s))
593 if (PREDICT_FALSE (session_enqueue_notify (s)))
597 vec_reset_length (indices);
598 wrk->session_to_enqueue[transport_proto] = indices;
599 wrk->current_enqueue_epoch[transport_proto]++;
605 session_manager_flush_all_enqueue_events (u8 transport_proto)
607 vlib_thread_main_t *vtm = vlib_get_thread_main ();
609 for (i = 0; i < 1 + vtm->n_threads; i++)
610 errors += session_manager_flush_enqueue_events (transport_proto, i);
615 * Init fifo tail and head pointers
617 * Useful if transport uses absolute offsets for tracking ooo segments.
620 stream_session_init_fifos_pointers (transport_connection_t * tc,
621 u32 rx_pointer, u32 tx_pointer)
624 s = session_get (tc->s_index, tc->thread_index);
625 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
626 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
630 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
632 u32 opaque = 0, new_ti, new_si;
633 stream_session_t *new_s = 0;
634 segment_manager_t *sm;
635 app_worker_t *app_wrk;
642 * Find connection handle and cleanup half-open table
644 handle = session_lookup_half_open_handle (tc);
645 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
647 SESSION_DBG ("half-open was removed!");
650 session_lookup_del_half_open (tc);
652 /* Get the app's index from the handle we stored when opening connection
653 * and the opaque (api_context for external apps) from transport session
655 app_wrk = app_worker_get_if_valid (handle >> 32);
658 opaque = tc->s_index;
659 app = application_get (app_wrk->app_index);
662 * Allocate new session with fifos (svm segments are allocated if needed)
666 sm = app_worker_get_connect_segment_manager (app_wrk);
667 alloc_fifos = !application_is_builtin_proxy (app);
668 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
675 new_s->session_state = SESSION_STATE_CONNECTING;
676 new_s->app_wrk_index = app_wrk->wrk_index;
677 new_si = new_s->session_index;
678 new_ti = new_s->thread_index;
683 * Notify client application
685 if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
688 SESSION_DBG ("failed to notify app");
691 new_s = session_get (new_si, new_ti);
692 session_transport_close (new_s);
699 new_s = session_get (new_si, new_ti);
700 new_s->session_state = SESSION_STATE_READY;
707 typedef struct _session_switch_pool_args
711 u32 new_thread_index;
712 u32 new_session_index;
713 } session_switch_pool_args_t;
716 session_switch_pool (void *cb_args)
718 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
719 transport_proto_t tp;
721 ASSERT (args->thread_index == vlib_get_thread_index ());
722 s = session_get (args->session_index, args->thread_index);
723 s->server_tx_fifo->master_session_index = args->new_session_index;
724 s->server_tx_fifo->master_thread_index = args->new_thread_index;
725 tp = session_get_transport_proto (s);
726 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
728 clib_mem_free (cb_args);
732 * Move dgram session to the right thread
735 session_dgram_connect_notify (transport_connection_t * tc,
736 u32 old_thread_index,
737 stream_session_t ** new_session)
739 stream_session_t *new_s;
740 session_switch_pool_args_t *rpc_args;
743 * Clone half-open session to the right thread.
745 new_s = session_clone_safe (tc->s_index, old_thread_index);
746 new_s->connection_index = tc->c_index;
747 new_s->server_rx_fifo->master_session_index = new_s->session_index;
748 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
749 new_s->session_state = SESSION_STATE_READY;
750 session_lookup_add_connection (tc, session_handle (new_s));
753 * Ask thread owning the old session to clean it up and make us the tx
756 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
757 rpc_args->new_session_index = new_s->session_index;
758 rpc_args->new_thread_index = new_s->thread_index;
759 rpc_args->session_index = tc->s_index;
760 rpc_args->thread_index = old_thread_index;
761 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
764 tc->s_index = new_s->session_index;
765 new_s->connection_index = tc->c_index;
766 *new_session = new_s;
771 stream_session_accept_notify (transport_connection_t * tc)
773 app_worker_t *app_wrk;
777 s = session_get (tc->s_index, tc->thread_index);
778 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
781 s->session_state = SESSION_STATE_ACCEPTING;
782 app = application_get (app_wrk->app_index);
783 return app->cb_fns.session_accept_callback (s);
787 * Notification from transport that connection is being closed.
789 * A disconnect is sent to application but state is not removed. Once
790 * disconnect is acknowledged by application, session disconnect is called.
791 * Ultimately this leads to close being called on transport (passive close).
794 session_transport_closing_notify (transport_connection_t * tc)
796 app_worker_t *app_wrk;
800 s = session_get (tc->s_index, tc->thread_index);
801 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
803 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
804 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
807 app = application_get (app_wrk->app_index);
808 app->cb_fns.session_disconnect_callback (s);
812 * Notification from transport that connection is being deleted
814 * This removes the session if it is still valid. It should be called only on
815 * previously fully established sessions. For instance failed connects should
816 * call stream_session_connect_notify and indicate that the connect has
820 session_transport_delete_notify (transport_connection_t * tc)
824 /* App might've been removed already */
825 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
828 /* Make sure we don't try to send anything more */
829 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
831 switch (s->session_state)
833 case SESSION_STATE_ACCEPTING:
834 case SESSION_STATE_TRANSPORT_CLOSING:
835 /* If transport finishes or times out before we get a reply
836 * from the app, mark transport as closed and wait for reply
837 * before removing the session. Cleanup session table in advance
838 * because transport will soon be closed and closed sessions
839 * are assumed to have been removed from the lookup table */
840 session_lookup_del_session (s);
841 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
843 case SESSION_STATE_CLOSING:
844 case SESSION_STATE_CLOSED_WAITING:
845 /* Cleanup lookup table as transport needs to still be valid.
846 * Program transport close to ensure that all session events
847 * have been cleaned up. Once transport close is called, the
848 * session is just removed because both transport and app have
849 * confirmed the close*/
850 session_lookup_del_session (s);
851 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
852 session_program_transport_close (s);
854 case SESSION_STATE_TRANSPORT_CLOSED:
856 case SESSION_STATE_CLOSED:
860 clib_warning ("session state %u", s->session_state);
867 * Notification from transport that session can be closed
869 * Should be called by transport only if it was closed with non-empty
870 * tx fifo and once it decides to begin the closing procedure prior to
871 * issuing a delete notify. This gives the chance to the session layer
872 * to cleanup any outstanding events.
875 session_transport_closed_notify (transport_connection_t * tc)
879 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
882 /* If app close has not been received or has not yet resulted in
883 * a transport close, only mark the session transport as closed */
884 if (s->session_state <= SESSION_STATE_CLOSING)
886 session_lookup_del_session (s);
887 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
890 s->session_state = SESSION_STATE_CLOSED;
894 * Notify application that connection has been reset.
897 session_transport_reset_notify (transport_connection_t * tc)
900 app_worker_t *app_wrk;
902 s = session_get (tc->s_index, tc->thread_index);
903 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
904 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
906 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
907 app_wrk = app_worker_get (s->app_wrk_index);
908 app = application_get (app_wrk->app_index);
909 app->cb_fns.session_reset_callback (s);
913 * Accept a stream session. Optionally ping the server by callback.
916 stream_session_accept (transport_connection_t * tc, u32 listener_index,
919 stream_session_t *s, *listener;
920 app_worker_t *app_wrk;
921 segment_manager_t *sm;
924 /* Find the server */
925 listener = listen_session_get (listener_index);
926 app_wrk = application_listener_select_worker (listener, 0);
928 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
929 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
932 s->app_wrk_index = app_wrk->wrk_index;
933 s->listener_index = listener_index;
935 /* Shoulder-tap the server */
938 application_t *app = application_get (app_wrk->app_index);
939 return app->cb_fns.session_accept_callback (s);
946 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
948 transport_connection_t *tc;
949 transport_endpoint_cfg_t *tep;
950 segment_manager_t *sm;
951 app_worker_t *app_wrk;
956 tep = session_endpoint_to_transport_cfg (rmt);
957 rv = tp_vfts[rmt->transport_proto].open (tep);
960 SESSION_DBG ("Transport failed to open connection.");
961 return VNET_API_ERROR_SESSION_CONNECT;
964 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
966 /* For dgram type of service, allocate session and fifos now.
968 app_wrk = app_worker_get (app_wrk_index);
969 sm = app_worker_get_connect_segment_manager (app_wrk);
971 if (session_alloc_and_init (sm, tc, 1, &s))
973 s->app_wrk_index = app_wrk->wrk_index;
974 s->session_state = SESSION_STATE_OPENED;
976 /* Tell the app about the new event fifo for this session */
977 app = application_get (app_wrk->app_index);
978 app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
984 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
986 transport_connection_t *tc;
987 transport_endpoint_cfg_t *tep;
991 tep = session_endpoint_to_transport_cfg (rmt);
992 rv = tp_vfts[rmt->transport_proto].open (tep);
995 SESSION_DBG ("Transport failed to open connection.");
996 return VNET_API_ERROR_SESSION_CONNECT;
999 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
1001 /* If transport offers a stream service, only allocate session once the
1002 * connection has been established.
1003 * Add connection to half-open table and save app and tc index. The
1004 * latter is needed to help establish the connection while the former
1005 * is needed when the connect notify comes and we have to notify the
1008 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1009 session_lookup_add_half_open (tc, handle);
1011 /* Store api_context (opaque) for when the reply comes. Not the nicest
1012 * thing but better than allocating a separate half-open pool.
1014 tc->s_index = opaque;
1019 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1021 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1022 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1024 sep->app_wrk_index = app_wrk_index;
1025 sep->opaque = opaque;
1027 return tp_vfts[rmt->transport_proto].open (tep_cfg);
1030 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1033 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1041 * Ask transport to open connection to remote transport endpoint.
1043 * Stores handle for matching request with reply since the call can be
1044 * asynchronous. For instance, for TCP the 3-way handshake must complete
1045 * before reply comes. Session is only created once connection is established.
1047 * @param app_index Index of the application requesting the connect
1048 * @param st Session type requested.
1049 * @param tep Remote transport endpoint
1050 * @param opaque Opaque data (typically, api_context) the application expects
1051 * on open completion.
1054 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1056 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
1057 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1061 * Ask transport to listen on session endpoint.
1063 * @param s Session for which listen will be called. Note that unlike
1064 * established sessions, listen sessions are not associated to a
1066 * @param sep Local endpoint to be listened on.
1069 session_listen (stream_session_t * ls, session_endpoint_cfg_t * sep)
1071 transport_connection_t *tc;
1072 transport_endpoint_t *tep;
1073 u32 tc_index, s_index;
1075 /* Transport bind/listen */
1076 tep = session_endpoint_to_transport (sep);
1077 s_index = ls->session_index;
1078 tc_index = tp_vfts[sep->transport_proto].bind (s_index, tep);
1080 if (tc_index == (u32) ~ 0)
1083 /* Attach transport to session */
1084 ls = listen_session_get (s_index);
1085 ls->connection_index = tc_index;
1087 /* Add to the main lookup table after transport was initialized */
1088 tc = tp_vfts[sep->transport_proto].get_listener (tc_index);
1089 session_lookup_add_connection (tc, s_index);
1094 * Ask transport to stop listening on local transport endpoint.
1096 * @param s Session to stop listening on. It must be in state LISTENING.
1099 session_stop_listen (stream_session_t * s)
1101 transport_proto_t tp = session_get_transport_proto (s);
1102 transport_connection_t *tc;
1103 if (s->session_state != SESSION_STATE_LISTENING)
1105 clib_warning ("not a listening session");
1109 tc = tp_vfts[tp].get_listener (s->connection_index);
1112 clib_warning ("no transport");
1113 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1116 session_lookup_del_connection (tc);
1117 tp_vfts[tp].unbind (s->connection_index);
1122 * Initialize session closing procedure.
1124 * Request is always sent to session node to ensure that all outstanding
1125 * requests are served before transport is notified.
1128 session_close (stream_session_t * s)
1133 if (s->session_state >= SESSION_STATE_CLOSING)
1135 /* Session will only be removed once both app and transport
1136 * acknowledge the close */
1137 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1138 session_program_transport_close (s);
1140 /* Session already closed. Clear the tx fifo */
1141 if (s->session_state == SESSION_STATE_CLOSED)
1142 svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1146 s->session_state = SESSION_STATE_CLOSING;
1147 session_program_transport_close (s);
1151 * Notify transport the session can be disconnected. This should eventually
1152 * result in a delete notification that allows us to cleanup session state.
1153 * Called for both active/passive disconnects.
1155 * Must be called from the session's thread.
1158 session_transport_close (stream_session_t * s)
1160 /* If transport is already closed, just free the session */
1161 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1163 session_free_w_fifos (s);
1167 /* If tx queue wasn't drained, change state to closed waiting for transport.
1168 * This way, the transport, if it so wishes, can continue to try sending the
1169 * outstanding data (in closed state it cannot). It MUST however at one
1170 * point, either after sending everything or after a timeout, call delete
1171 * notify. This will finally lead to the complete cleanup of the session.
1173 if (svm_fifo_max_dequeue (s->server_tx_fifo))
1174 s->session_state = SESSION_STATE_CLOSED_WAITING;
1176 s->session_state = SESSION_STATE_CLOSED;
1178 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1183 * Cleanup transport and session state.
1185 * Notify transport of the cleanup and free the session. This should
1186 * be called only if transport reported some error and is already
1190 session_transport_cleanup (stream_session_t * s)
1192 s->session_state = SESSION_STATE_CLOSED;
1194 /* Delete from main lookup table before we axe the the transport */
1195 session_lookup_del_session (s);
1196 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1198 /* Since we called cleanup, no delete notification will come. So, make
1199 * sure the session is properly freed. */
1200 session_free_w_fifos (s);
1203 transport_service_type_t
1204 session_transport_service_type (stream_session_t * s)
1206 transport_proto_t tp;
1207 tp = session_get_transport_proto (s);
1208 return transport_protocol_service_type (tp);
1211 transport_tx_fn_type_t
1212 session_transport_tx_fn_type (stream_session_t * s)
1214 transport_proto_t tp;
1215 tp = session_get_transport_proto (s);
1216 return transport_protocol_tx_fn_type (tp);
1220 session_tx_is_dgram (stream_session_t * s)
1222 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1226 * Allocate event queues in the shared-memory segment
1228 * That can either be a newly created memfd segment, that will need to be
1229 * mapped by all stack users, or the binary api's svm region. The latter is
1230 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1231 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1232 * vpp uses api svm region for event queues.
1235 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1237 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1238 ssvm_private_t *eqs = &smm->evt_qs_segment;
1239 api_main_t *am = &api_main;
1240 u64 eqs_size = 64 << 20;
1241 pid_t vpp_pid = getpid ();
1245 if (smm->configured_event_queue_length)
1246 evt_q_length = smm->configured_event_queue_length;
1248 if (smm->evt_qs_use_memfd_seg)
1250 if (smm->evt_qs_segment_size)
1251 eqs_size = smm->evt_qs_segment_size;
1253 eqs->ssvm_size = eqs_size;
1254 eqs->i_am_master = 1;
1255 eqs->my_pid = vpp_pid;
1256 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1257 eqs->requested_va = smm->session_baseva;
1259 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1261 clib_warning ("failed to initialize queue segment");
1266 if (smm->evt_qs_use_memfd_seg)
1267 oldheap = ssvm_push_heap (eqs->sh);
1269 oldheap = svm_push_data_heap (am->vlib_rp);
1271 for (i = 0; i < vec_len (smm->wrk); i++)
1273 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1274 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1275 {evt_q_length, evt_size, 0}
1277 {evt_q_length << 1, 256, 0}
1279 cfg->consumer_pid = 0;
1281 cfg->q_nitems = evt_q_length;
1282 cfg->ring_cfgs = rc;
1283 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1284 if (smm->evt_qs_use_memfd_seg)
1286 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1287 clib_warning ("eventfd returned");
1291 if (smm->evt_qs_use_memfd_seg)
1292 ssvm_pop_heap (oldheap);
1294 svm_pop_heap (oldheap);
1298 session_manager_get_evt_q_segment (void)
1300 session_manager_main_t *smm = &session_manager_main;
1301 if (smm->evt_qs_use_memfd_seg)
1302 return &smm->evt_qs_segment;
1307 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1308 session_tx_fifo_peek_and_snd,
1309 session_tx_fifo_dequeue_and_snd,
1310 session_tx_fifo_dequeue_internal,
1311 session_tx_fifo_dequeue_and_snd
1316 * Initialize session layer for given transport proto and ip version
1318 * Allocates per session type (transport proto + ip version) data structures
1319 * and adds arc from session queue node to session type output node.
1322 session_register_transport (transport_proto_t transport_proto,
1323 const transport_proto_vft_t * vft, u8 is_ip4,
1326 session_manager_main_t *smm = &session_manager_main;
1327 session_type_t session_type;
1328 u32 next_index = ~0;
1330 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1332 vec_validate (smm->session_type_to_next, session_type);
1333 vec_validate (smm->session_tx_fns, session_type);
1336 if (output_node != ~0)
1338 foreach_vlib_main (({
1339 next_index = vlib_node_add_next (this_vlib_main,
1340 session_queue_node.index,
1346 smm->session_type_to_next[session_type] = next_index;
1347 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1350 transport_connection_t *
1351 session_get_transport (stream_session_t * s)
1353 transport_proto_t tp;
1354 if (s->session_state != SESSION_STATE_LISTENING)
1356 tp = session_get_transport_proto (s);
1357 return tp_vfts[tp].get_connection (s->connection_index,
1363 transport_connection_t *
1364 listen_session_get_transport (stream_session_t * s)
1366 transport_proto_t tp = session_get_transport_proto (s);
1367 return tp_vfts[tp].get_listener (s->connection_index);
1371 listen_session_get_local_session_endpoint (stream_session_t * listener,
1372 session_endpoint_t * sep)
1374 transport_proto_t tp = session_get_transport_proto (listener);
1375 transport_connection_t *tc;
1376 tc = tp_vfts[tp].get_listener (listener->connection_index);
1379 clib_warning ("no transport");
1383 /* N.B. The ip should not be copied because this is the local endpoint */
1384 sep->port = tc->lcl_port;
1385 sep->transport_proto = tc->proto;
1386 sep->is_ip4 = tc->is_ip4;
1391 session_flush_frames_main_thread (vlib_main_t * vm)
1393 ASSERT (vlib_get_thread_index () == 0);
1394 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1395 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1398 static clib_error_t *
1399 session_manager_main_enable (vlib_main_t * vm)
1401 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1402 session_manager_main_t *smm = &session_manager_main;
1403 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1404 u32 num_threads, preallocated_sessions_per_worker;
1405 session_manager_worker_t *wrk;
1408 num_threads = 1 /* main thread */ + vtm->n_threads;
1410 if (num_threads < 1)
1411 return clib_error_return (0, "n_thread_stacks not set");
1413 /* Allocate cache line aligned worker contexts */
1414 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1416 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1418 for (j = 0; j < num_threads; j++)
1419 smm->wrk[j].current_enqueue_epoch[i] = 1;
1422 for (i = 0; i < num_threads; i++)
1425 vec_validate (wrk->free_event_vector, 128);
1426 _vec_len (wrk->free_event_vector) = 0;
1427 vec_validate (wrk->pending_event_vector, 128);
1428 _vec_len (wrk->pending_event_vector) = 0;
1429 vec_validate (wrk->pending_disconnects, 128);
1430 _vec_len (wrk->pending_disconnects) = 0;
1431 vec_validate (wrk->postponed_event_vector, 128);
1432 _vec_len (wrk->postponed_event_vector) = 0;
1434 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1435 wrk->dispatch_period = 500e-6;
1437 if (num_threads > 1)
1438 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1442 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1445 /* Allocate vpp event queues segment and queue */
1446 session_vpp_event_queues_allocate (smm);
1448 /* Initialize fifo segment main baseva and timeout */
1449 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1450 sm_args->size = smm->session_va_space_size;
1451 segment_manager_main_init (sm_args);
1453 /* Preallocate sessions */
1454 if (smm->preallocated_sessions)
1456 if (num_threads == 1)
1458 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1463 preallocated_sessions_per_worker =
1464 (1.1 * (f64) smm->preallocated_sessions /
1465 (f64) (num_threads - 1));
1467 for (j = 1; j < num_threads; j++)
1469 pool_init_fixed (smm->wrk[j].sessions,
1470 preallocated_sessions_per_worker);
1475 session_lookup_init ();
1476 app_namespaces_init ();
1479 smm->is_enabled = 1;
1481 /* Enable transports */
1482 transport_enable_disable (vm, 1);
1483 transport_init_tx_pacers_period ();
1488 session_node_enable_disable (u8 is_en)
1490 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1491 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1492 u8 have_workers = vtm->n_threads != 0;
1495 foreach_vlib_main (({
1496 if (have_workers && ii == 0)
1498 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1502 vlib_node_t *n = vlib_get_node (this_vlib_main,
1503 session_queue_process_node.index);
1504 vlib_start_process (this_vlib_main, n->runtime_index);
1508 vlib_process_signal_event_mt (this_vlib_main,
1509 session_queue_process_node.index,
1510 SESSION_Q_PROCESS_STOP, 0);
1515 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1522 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1524 clib_error_t *error = 0;
1527 if (session_manager_main.is_enabled)
1530 session_node_enable_disable (is_en);
1531 error = session_manager_main_enable (vm);
1535 session_manager_main.is_enabled = 0;
1536 session_node_enable_disable (is_en);
1543 session_manager_main_init (vlib_main_t * vm)
1545 session_manager_main_t *smm = &session_manager_main;
1546 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1547 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1548 smm->session_va_space_size = 128ULL << 30;
1549 smm->evt_qs_segment_size = 64 << 20;
1551 smm->session_va_space_size = 128 << 20;
1552 smm->evt_qs_segment_size = 1 << 20;
1554 smm->is_enabled = 0;
1558 VLIB_INIT_FUNCTION (session_manager_main_init);
1560 static clib_error_t *
1561 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1563 session_manager_main_t *smm = &session_manager_main;
1567 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1569 if (unformat (input, "event-queue-length %d", &nitems))
1572 smm->configured_event_queue_length = nitems;
1574 clib_warning ("event queue length %d too small, ignored", nitems);
1576 else if (unformat (input, "preallocated-sessions %d",
1577 &smm->preallocated_sessions))
1579 else if (unformat (input, "v4-session-table-buckets %d",
1580 &smm->configured_v4_session_table_buckets))
1582 else if (unformat (input, "v4-halfopen-table-buckets %d",
1583 &smm->configured_v4_halfopen_table_buckets))
1585 else if (unformat (input, "v6-session-table-buckets %d",
1586 &smm->configured_v6_session_table_buckets))
1588 else if (unformat (input, "v6-halfopen-table-buckets %d",
1589 &smm->configured_v6_halfopen_table_buckets))
1591 else if (unformat (input, "v4-session-table-memory %U",
1592 unformat_memory_size, &tmp))
1594 if (tmp >= 0x100000000)
1595 return clib_error_return (0, "memory size %llx (%lld) too large",
1597 smm->configured_v4_session_table_memory = tmp;
1599 else if (unformat (input, "v4-halfopen-table-memory %U",
1600 unformat_memory_size, &tmp))
1602 if (tmp >= 0x100000000)
1603 return clib_error_return (0, "memory size %llx (%lld) too large",
1605 smm->configured_v4_halfopen_table_memory = tmp;
1607 else if (unformat (input, "v6-session-table-memory %U",
1608 unformat_memory_size, &tmp))
1610 if (tmp >= 0x100000000)
1611 return clib_error_return (0, "memory size %llx (%lld) too large",
1613 smm->configured_v6_session_table_memory = tmp;
1615 else if (unformat (input, "v6-halfopen-table-memory %U",
1616 unformat_memory_size, &tmp))
1618 if (tmp >= 0x100000000)
1619 return clib_error_return (0, "memory size %llx (%lld) too large",
1621 smm->configured_v6_halfopen_table_memory = tmp;
1623 else if (unformat (input, "local-endpoints-table-memory %U",
1624 unformat_memory_size, &tmp))
1626 if (tmp >= 0x100000000)
1627 return clib_error_return (0, "memory size %llx (%lld) too large",
1629 smm->local_endpoints_table_memory = tmp;
1631 else if (unformat (input, "local-endpoints-table-buckets %d",
1632 &smm->local_endpoints_table_buckets))
1634 else if (unformat (input, "evt_qs_memfd_seg"))
1635 smm->evt_qs_use_memfd_seg = 1;
1637 return clib_error_return (0, "unknown input `%U'",
1638 format_unformat_error, input);
1643 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1646 * fd.io coding-style-patch-verification: ON
1649 * eval: (c-set-style "gnu")