2 * Copyright (c) 2017-2019 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 <vnet/dpo/load_balance.h>
24 #include <vnet/fib/ip4_fib.h>
26 session_main_t session_main;
29 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
30 session_evt_type_t evt_type)
35 u32 tries = 0, max_tries;
37 mq = session_main_get_vpp_event_queue (thread_index);
38 while (svm_msg_q_try_lock (mq))
40 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
41 if (tries++ == max_tries)
43 SESSION_DBG ("failed to enqueue evt");
47 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
49 svm_msg_q_unlock (mq);
52 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
53 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
55 svm_msg_q_unlock (mq);
58 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
59 evt->event_type = evt_type;
62 case SESSION_CTRL_EVT_RPC:
63 evt->rpc_args.fp = data;
64 evt->rpc_args.arg = args;
66 case SESSION_IO_EVT_TX:
67 case SESSION_IO_EVT_TX_FLUSH:
68 case SESSION_IO_EVT_BUILTIN_RX:
69 evt->session_index = *(u32 *) data;
71 case SESSION_IO_EVT_BUILTIN_TX:
72 case SESSION_CTRL_EVT_CLOSE:
73 evt->session_handle = session_handle ((session_t *) data);
76 clib_warning ("evt unhandled!");
77 svm_msg_q_unlock (mq);
81 svm_msg_q_add_and_unlock (mq, &msg);
86 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
88 return session_send_evt_to_thread (&f->master_session_index, 0,
89 f->master_thread_index, evt_type);
93 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
94 session_evt_type_t evt_type)
96 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
100 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
102 /* only event supported for now is disconnect */
103 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE);
104 return session_send_evt_to_thread (s, 0, s->thread_index,
105 SESSION_CTRL_EVT_CLOSE);
109 session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
112 session_send_evt_to_thread (fp, rpc_args, thread_index,
113 SESSION_CTRL_EVT_RPC);
117 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
119 if (thread_index != vlib_get_thread_index ())
120 session_send_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
123 void (*fnp) (void *) = fp;
129 session_program_transport_close (session_t * s)
131 u32 thread_index = vlib_get_thread_index ();
132 session_worker_t *wrk;
133 session_event_t *evt;
135 /* If we are in the handler thread, or being called with the worker barrier
136 * held, just append a new event to pending disconnects vector. */
137 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
139 wrk = session_main_get_worker (s->thread_index);
140 vec_add2 (wrk->pending_disconnects, evt, 1);
141 clib_memset (evt, 0, sizeof (*evt));
142 evt->session_handle = session_handle (s);
143 evt->event_type = SESSION_CTRL_EVT_CLOSE;
146 session_send_ctrl_evt_to_thread (s, SESSION_CTRL_EVT_CLOSE);
150 session_alloc (u32 thread_index)
152 session_worker_t *wrk = &session_main.wrk[thread_index];
155 pool_get_aligned_will_expand (wrk->sessions, will_expand,
156 CLIB_CACHE_LINE_BYTES);
157 /* If we have peekers, let them finish */
158 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
160 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
161 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
162 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
166 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
168 clib_memset (s, 0, sizeof (*s));
169 s->session_index = s - wrk->sessions;
170 s->thread_index = thread_index;
175 session_free (session_t * s)
179 u8 thread_index = s->thread_index;
180 clib_memset (s, 0xFA, sizeof (*s));
181 pool_put (session_main.wrk[thread_index].sessions, s);
184 SESSION_EVT_DBG (SESSION_EVT_FREE, s);
185 pool_put (session_main.wrk[s->thread_index].sessions, s);
189 session_free_w_fifos (session_t * s)
191 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
196 * Cleans up session and lookup table.
198 * Transport connection must still be valid.
201 session_delete (session_t * s)
205 /* Delete from the main lookup table. */
206 if ((rv = session_lookup_del_session (s)))
207 clib_warning ("hash delete error, rv %d", rv);
209 session_free_w_fifos (s);
213 session_alloc_for_connection (transport_connection_t * tc)
216 u32 thread_index = tc->thread_index;
218 ASSERT (thread_index == vlib_get_thread_index ()
219 || transport_protocol_is_cl (tc->proto));
221 s = session_alloc (thread_index);
222 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
223 s->session_state = SESSION_STATE_CLOSED;
225 /* Attach transport to session and vice versa */
226 s->connection_index = tc->c_index;
227 tc->s_index = s->session_index;
232 * Discards bytes from buffer chain
234 * It discards n_bytes_to_drop starting at first buffer after chain_b
237 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
238 vlib_buffer_t ** chain_b,
241 vlib_buffer_t *next = *chain_b;
242 u32 to_drop = n_bytes_to_drop;
243 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
244 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
246 next = vlib_get_buffer (vm, next->next_buffer);
247 if (next->current_length > to_drop)
249 vlib_buffer_advance (next, to_drop);
254 to_drop -= next->current_length;
255 next->current_length = 0;
261 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
265 * Enqueue buffer chain tail
268 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
269 u32 offset, u8 is_in_order)
271 vlib_buffer_t *chain_b;
272 u32 chain_bi, len, diff;
273 vlib_main_t *vm = vlib_get_main ();
278 if (is_in_order && offset)
280 diff = offset - b->current_length;
281 if (diff > b->total_length_not_including_first_buffer)
284 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
285 chain_bi = vlib_get_buffer_index (vm, chain_b);
288 chain_bi = b->next_buffer;
292 chain_b = vlib_get_buffer (vm, chain_bi);
293 data = vlib_buffer_get_current (chain_b);
294 len = chain_b->current_length;
299 rv = svm_fifo_enqueue_nowait (s->rx_fifo, len, data);
306 return (rv > 0) ? (written + rv) : written;
312 /* written more than what was left in chain */
313 if (written > b->total_length_not_including_first_buffer)
316 /* drop the bytes that have already been delivered */
317 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
322 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
325 clib_warning ("failed to enqueue multi-buffer seg");
331 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
332 ? chain_b->next_buffer : 0));
341 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
342 * event but on request can queue notification events for later delivery by
343 * calling stream_server_flush_enqueue_events().
345 * @param tc Transport connection which is to be enqueued data
346 * @param b Buffer to be enqueued
347 * @param offset Offset at which to start enqueueing if out-of-order
348 * @param queue_event Flag to indicate if peer is to be notified or if event
349 * is to be queued. The former is useful when more data is
350 * enqueued and only one event is to be generated.
351 * @param is_in_order Flag to indicate if data is in order
352 * @return Number of bytes enqueued or a negative value if enqueueing failed.
355 session_enqueue_stream_connection (transport_connection_t * tc,
356 vlib_buffer_t * b, u32 offset,
357 u8 queue_event, u8 is_in_order)
360 int enqueued = 0, rv, in_order_off;
362 s = session_get (tc->s_index, tc->thread_index);
366 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo,
368 vlib_buffer_get_current (b));
369 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
372 in_order_off = enqueued > b->current_length ? enqueued : 0;
373 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
380 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
382 vlib_buffer_get_current (b));
383 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
384 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
385 /* if something was enqueued, report even this as success for ooo
386 * segment handling */
392 /* Queue RX event on this fifo. Eventually these will need to be flushed
393 * by calling stream_server_flush_enqueue_events () */
394 session_worker_t *wrk;
396 wrk = session_main_get_worker (s->thread_index);
397 if (!(s->flags & SESSION_F_RX_EVT))
399 s->flags |= SESSION_F_RX_EVT;
400 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
408 session_enqueue_dgram_connection (session_t * s,
409 session_dgram_hdr_t * hdr,
410 vlib_buffer_t * b, u8 proto, u8 queue_event)
412 int enqueued = 0, rv, in_order_off;
414 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
415 >= b->current_length + sizeof (*hdr));
417 svm_fifo_enqueue_nowait (s->rx_fifo, sizeof (session_dgram_hdr_t),
419 enqueued = svm_fifo_enqueue_nowait (s->rx_fifo, b->current_length,
420 vlib_buffer_get_current (b));
421 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
423 in_order_off = enqueued > b->current_length ? enqueued : 0;
424 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
430 /* Queue RX event on this fifo. Eventually these will need to be flushed
431 * by calling stream_server_flush_enqueue_events () */
432 session_worker_t *wrk;
434 wrk = session_main_get_worker (s->thread_index);
435 if (!(s->flags & SESSION_F_RX_EVT))
437 s->flags |= SESSION_F_RX_EVT;
438 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
445 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
446 u32 offset, u32 max_bytes)
448 session_t *s = session_get (tc->s_index, tc->thread_index);
449 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
453 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
455 session_t *s = session_get (tc->s_index, tc->thread_index);
456 return svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
460 session_notify_subscribers (u32 app_index, session_t * s,
461 svm_fifo_t * f, session_evt_type_t evt_type)
463 app_worker_t *app_wrk;
467 app = application_get (app_index);
471 for (i = 0; i < f->n_subscribers; i++)
473 app_wrk = application_get_worker (app, f->subscribers[i]);
476 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
484 * Notify session peer that new data has been enqueued.
486 * @param s Stream session for which the event is to be generated.
487 * @param lock Flag to indicate if call should lock message queue.
489 * @return 0 on success or negative number if failed to send notification.
492 session_enqueue_notify_inline (session_t * s)
494 app_worker_t *app_wrk;
498 session_index = s->session_index;
499 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
501 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
502 if (PREDICT_FALSE (!app_wrk))
504 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
509 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
510 ed->data[0] = SESSION_IO_EVT_RX;
511 ed->data[1] = svm_fifo_max_dequeue_prod (s->rx_fifo);
515 s->flags &= ~SESSION_F_RX_EVT;
516 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
520 if (PREDICT_FALSE (n_subscribers))
522 s = session_get (session_index, vlib_get_thread_index ());
523 return session_notify_subscribers (app_wrk->app_index, s,
524 s->rx_fifo, SESSION_IO_EVT_RX);
531 session_enqueue_notify (session_t * s)
533 return session_enqueue_notify_inline (s);
537 session_dequeue_notify (session_t * s)
539 app_worker_t *app_wrk;
541 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
542 if (PREDICT_FALSE (!app_wrk))
545 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
549 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
550 return session_notify_subscribers (app_wrk->app_index, s,
551 s->tx_fifo, SESSION_IO_EVT_TX);
553 svm_fifo_clear_tx_ntf (s->tx_fifo);
559 * Flushes queue of sessions that are to be notified of new data
562 * @param thread_index Thread index for which the flush is to be performed.
563 * @return 0 on success or a positive number indicating the number of
564 * failures due to API queue being full.
567 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
569 session_worker_t *wrk = session_main_get_worker (thread_index);
574 indices = wrk->session_to_enqueue[transport_proto];
576 for (i = 0; i < vec_len (indices); i++)
578 s = session_get_if_valid (indices[i], thread_index);
579 if (PREDICT_FALSE (!s))
585 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
589 vec_reset_length (indices);
590 wrk->session_to_enqueue[transport_proto] = indices;
596 session_main_flush_all_enqueue_events (u8 transport_proto)
598 vlib_thread_main_t *vtm = vlib_get_thread_main ();
600 for (i = 0; i < 1 + vtm->n_threads; i++)
601 errors += session_main_flush_enqueue_events (transport_proto, i);
606 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
608 u32 opaque = 0, new_ti, new_si;
609 app_worker_t *app_wrk;
614 * Find connection handle and cleanup half-open table
616 ho_handle = session_lookup_half_open_handle (tc);
617 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
619 SESSION_DBG ("half-open was removed!");
622 session_lookup_del_half_open (tc);
624 /* Get the app's index from the handle we stored when opening connection
625 * and the opaque (api_context for external apps) from transport session
627 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
631 opaque = tc->s_index;
634 return app_worker_connect_notify (app_wrk, s, opaque);
636 s = session_alloc_for_connection (tc);
637 s->session_state = SESSION_STATE_CONNECTING;
638 s->app_wrk_index = app_wrk->wrk_index;
639 new_si = s->session_index;
640 new_ti = s->thread_index;
642 if (app_worker_init_connected (app_wrk, s))
645 app_worker_connect_notify (app_wrk, 0, opaque);
649 if (app_worker_connect_notify (app_wrk, s, opaque))
651 s = session_get (new_si, new_ti);
652 session_free_w_fifos (s);
656 s = session_get (new_si, new_ti);
657 s->session_state = SESSION_STATE_READY;
658 session_lookup_add_connection (tc, session_handle (s));
663 typedef struct _session_switch_pool_args
667 u32 new_thread_index;
668 u32 new_session_index;
669 } session_switch_pool_args_t;
672 session_switch_pool (void *cb_args)
674 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
676 ASSERT (args->thread_index == vlib_get_thread_index ());
677 s = session_get (args->session_index, args->thread_index);
678 s->tx_fifo->master_session_index = args->new_session_index;
679 s->tx_fifo->master_thread_index = args->new_thread_index;
680 transport_cleanup (session_get_transport_proto (s), s->connection_index,
683 clib_mem_free (cb_args);
687 * Move dgram session to the right thread
690 session_dgram_connect_notify (transport_connection_t * tc,
691 u32 old_thread_index, session_t ** new_session)
694 session_switch_pool_args_t *rpc_args;
697 * Clone half-open session to the right thread.
699 new_s = session_clone_safe (tc->s_index, old_thread_index);
700 new_s->connection_index = tc->c_index;
701 new_s->rx_fifo->master_session_index = new_s->session_index;
702 new_s->rx_fifo->master_thread_index = new_s->thread_index;
703 new_s->session_state = SESSION_STATE_READY;
704 session_lookup_add_connection (tc, session_handle (new_s));
707 * Ask thread owning the old session to clean it up and make us the tx
710 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
711 rpc_args->new_session_index = new_s->session_index;
712 rpc_args->new_thread_index = new_s->thread_index;
713 rpc_args->session_index = tc->s_index;
714 rpc_args->thread_index = old_thread_index;
715 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
718 tc->s_index = new_s->session_index;
719 new_s->connection_index = tc->c_index;
720 *new_session = new_s;
725 * Notification from transport that connection is being closed.
727 * A disconnect is sent to application but state is not removed. Once
728 * disconnect is acknowledged by application, session disconnect is called.
729 * Ultimately this leads to close being called on transport (passive close).
732 session_transport_closing_notify (transport_connection_t * tc)
734 app_worker_t *app_wrk;
737 s = session_get (tc->s_index, tc->thread_index);
738 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
740 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
741 app_wrk = app_worker_get (s->app_wrk_index);
742 app_worker_close_notify (app_wrk, s);
746 * Notification from transport that connection is being deleted
748 * This removes the session if it is still valid. It should be called only on
749 * previously fully established sessions. For instance failed connects should
750 * call stream_session_connect_notify and indicate that the connect has
754 session_transport_delete_notify (transport_connection_t * tc)
758 /* App might've been removed already */
759 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
762 /* Make sure we don't try to send anything more */
763 svm_fifo_dequeue_drop_all (s->tx_fifo);
765 switch (s->session_state)
767 case SESSION_STATE_CREATED:
768 /* Session was created but accept notification was not yet sent to the
769 * app. Cleanup everything. */
770 session_lookup_del_session (s);
771 session_free_w_fifos (s);
773 case SESSION_STATE_ACCEPTING:
774 case SESSION_STATE_TRANSPORT_CLOSING:
775 /* If transport finishes or times out before we get a reply
776 * from the app, mark transport as closed and wait for reply
777 * before removing the session. Cleanup session table in advance
778 * because transport will soon be closed and closed sessions
779 * are assumed to have been removed from the lookup table */
780 session_lookup_del_session (s);
781 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
783 case SESSION_STATE_CLOSING:
784 case SESSION_STATE_CLOSED_WAITING:
785 /* Cleanup lookup table as transport needs to still be valid.
786 * Program transport close to ensure that all session events
787 * have been cleaned up. Once transport close is called, the
788 * session is just removed because both transport and app have
789 * confirmed the close*/
790 session_lookup_del_session (s);
791 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
792 session_program_transport_close (s);
794 case SESSION_STATE_TRANSPORT_CLOSED:
796 case SESSION_STATE_CLOSED:
800 clib_warning ("session state %u", s->session_state);
807 * Notification from transport that session can be closed
809 * Should be called by transport only if it was closed with non-empty
810 * tx fifo and once it decides to begin the closing procedure prior to
811 * issuing a delete notify. This gives the chance to the session layer
812 * to cleanup any outstanding events.
815 session_transport_closed_notify (transport_connection_t * tc)
819 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
822 /* If app close has not been received or has not yet resulted in
823 * a transport close, only mark the session transport as closed */
824 if (s->session_state <= SESSION_STATE_CLOSING)
826 session_lookup_del_session (s);
827 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
830 s->session_state = SESSION_STATE_CLOSED;
834 * Notify application that connection has been reset.
837 session_transport_reset_notify (transport_connection_t * tc)
839 app_worker_t *app_wrk;
842 s = session_get (tc->s_index, tc->thread_index);
843 svm_fifo_dequeue_drop_all (s->tx_fifo);
844 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
846 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
847 app_wrk = app_worker_get (s->app_wrk_index);
848 app_worker_reset_notify (app_wrk, s);
852 session_stream_accept_notify (transport_connection_t * tc)
854 app_worker_t *app_wrk;
857 s = session_get (tc->s_index, tc->thread_index);
858 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
861 s->session_state = SESSION_STATE_ACCEPTING;
862 return app_worker_accept_notify (app_wrk, s);
866 * Accept a stream session. Optionally ping the server by callback.
869 session_stream_accept (transport_connection_t * tc, u32 listener_index,
875 s = session_alloc_for_connection (tc);
876 s->listener_index = listener_index;
877 s->session_state = SESSION_STATE_CREATED;
879 if ((rv = app_worker_init_accepted (s)))
882 session_lookup_add_connection (tc, session_handle (s));
884 /* Shoulder-tap the server */
887 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
888 return app_worker_accept_notify (app_wrk, s);
895 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
897 transport_connection_t *tc;
898 transport_endpoint_cfg_t *tep;
899 app_worker_t *app_wrk;
904 tep = session_endpoint_to_transport_cfg (rmt);
905 rv = transport_connect (rmt->transport_proto, tep);
908 SESSION_DBG ("Transport failed to open connection.");
909 return VNET_API_ERROR_SESSION_CONNECT;
912 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
914 /* For dgram type of service, allocate session and fifos now */
915 app_wrk = app_worker_get (app_wrk_index);
916 s = session_alloc_for_connection (tc);
917 s->app_wrk_index = app_wrk->wrk_index;
918 s->session_state = SESSION_STATE_OPENED;
919 if (app_worker_init_connected (app_wrk, s))
925 sh = session_handle (s);
926 session_lookup_add_connection (tc, sh);
928 return app_worker_connect_notify (app_wrk, s, opaque);
932 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
934 transport_connection_t *tc;
935 transport_endpoint_cfg_t *tep;
939 tep = session_endpoint_to_transport_cfg (rmt);
940 rv = transport_connect (rmt->transport_proto, tep);
943 SESSION_DBG ("Transport failed to open connection.");
944 return VNET_API_ERROR_SESSION_CONNECT;
947 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
949 /* If transport offers a stream service, only allocate session once the
950 * connection has been established.
951 * Add connection to half-open table and save app and tc index. The
952 * latter is needed to help establish the connection while the former
953 * is needed when the connect notify comes and we have to notify the
956 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
957 session_lookup_add_half_open (tc, handle);
959 /* Store api_context (opaque) for when the reply comes. Not the nicest
960 * thing but better than allocating a separate half-open pool.
962 tc->s_index = opaque;
967 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
969 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
970 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
972 sep->app_wrk_index = app_wrk_index;
973 sep->opaque = opaque;
975 return transport_connect (rmt->transport_proto, tep_cfg);
978 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
981 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
989 * Ask transport to open connection to remote transport endpoint.
991 * Stores handle for matching request with reply since the call can be
992 * asynchronous. For instance, for TCP the 3-way handshake must complete
993 * before reply comes. Session is only created once connection is established.
995 * @param app_index Index of the application requesting the connect
996 * @param st Session type requested.
997 * @param tep Remote transport endpoint
998 * @param opaque Opaque data (typically, api_context) the application expects
999 * on open completion.
1002 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1004 transport_service_type_t tst;
1005 tst = transport_protocol_service_type (rmt->transport_proto);
1006 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1010 * Ask transport to listen on session endpoint.
1012 * @param s Session for which listen will be called. Note that unlike
1013 * established sessions, listen sessions are not associated to a
1015 * @param sep Local endpoint to be listened on.
1018 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1020 transport_endpoint_t *tep;
1021 u32 tc_index, s_index;
1023 /* Transport bind/listen */
1024 tep = session_endpoint_to_transport (sep);
1025 s_index = ls->session_index;
1026 tc_index = transport_start_listen (session_get_transport_proto (ls),
1029 if (tc_index == (u32) ~ 0)
1032 /* Attach transport to session. Lookup tables are populated by the app
1033 * worker because local tables (for ct sessions) are not backed by a fib */
1034 ls = listen_session_get (s_index);
1035 ls->connection_index = tc_index;
1041 * Ask transport to stop listening on local transport endpoint.
1043 * @param s Session to stop listening on. It must be in state LISTENING.
1046 session_stop_listen (session_t * s)
1048 transport_proto_t tp = session_get_transport_proto (s);
1049 transport_connection_t *tc;
1051 if (s->session_state != SESSION_STATE_LISTENING)
1054 tc = transport_get_listener (tp, s->connection_index);
1056 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1058 session_lookup_del_connection (tc);
1059 transport_stop_listen (tp, s->connection_index);
1064 * Initialize session closing procedure.
1066 * Request is always sent to session node to ensure that all outstanding
1067 * requests are served before transport is notified.
1070 session_close (session_t * s)
1075 if (s->session_state >= SESSION_STATE_CLOSING)
1077 /* Session will only be removed once both app and transport
1078 * acknowledge the close */
1079 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1080 session_program_transport_close (s);
1082 /* Session already closed. Clear the tx fifo */
1083 if (s->session_state == SESSION_STATE_CLOSED)
1084 svm_fifo_dequeue_drop_all (s->tx_fifo);
1088 s->session_state = SESSION_STATE_CLOSING;
1089 session_program_transport_close (s);
1093 * Notify transport the session can be disconnected. This should eventually
1094 * result in a delete notification that allows us to cleanup session state.
1095 * Called for both active/passive disconnects.
1097 * Must be called from the session's thread.
1100 session_transport_close (session_t * s)
1102 /* If transport is already closed, just free the session */
1103 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1105 session_free_w_fifos (s);
1109 /* If tx queue wasn't drained, change state to closed waiting for transport.
1110 * This way, the transport, if it so wishes, can continue to try sending the
1111 * outstanding data (in closed state it cannot). It MUST however at one
1112 * point, either after sending everything or after a timeout, call delete
1113 * notify. This will finally lead to the complete cleanup of the session.
1115 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1116 s->session_state = SESSION_STATE_CLOSED_WAITING;
1118 s->session_state = SESSION_STATE_CLOSED;
1120 transport_close (session_get_transport_proto (s), s->connection_index,
1125 * Cleanup transport and session state.
1127 * Notify transport of the cleanup and free the session. This should
1128 * be called only if transport reported some error and is already
1132 session_transport_cleanup (session_t * s)
1134 s->session_state = SESSION_STATE_CLOSED;
1136 /* Delete from main lookup table before we axe the the transport */
1137 session_lookup_del_session (s);
1138 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1140 /* Since we called cleanup, no delete notification will come. So, make
1141 * sure the session is properly freed. */
1142 session_free_w_fifos (s);
1146 * Allocate event queues in the shared-memory segment
1148 * That can either be a newly created memfd segment, that will need to be
1149 * mapped by all stack users, or the binary api's svm region. The latter is
1150 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1151 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1152 * vpp uses api svm region for event queues.
1155 session_vpp_event_queues_allocate (session_main_t * smm)
1157 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1158 ssvm_private_t *eqs = &smm->evt_qs_segment;
1159 api_main_t *am = &api_main;
1160 uword eqs_size = 64 << 20;
1161 pid_t vpp_pid = getpid ();
1165 if (smm->configured_event_queue_length)
1166 evt_q_length = smm->configured_event_queue_length;
1168 if (smm->evt_qs_use_memfd_seg)
1170 if (smm->evt_qs_segment_size)
1171 eqs_size = smm->evt_qs_segment_size;
1173 eqs->ssvm_size = eqs_size;
1174 eqs->i_am_master = 1;
1175 eqs->my_pid = vpp_pid;
1176 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1177 eqs->requested_va = smm->session_baseva;
1179 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1181 clib_warning ("failed to initialize queue segment");
1186 if (smm->evt_qs_use_memfd_seg)
1187 oldheap = ssvm_push_heap (eqs->sh);
1189 oldheap = svm_push_data_heap (am->vlib_rp);
1191 for (i = 0; i < vec_len (smm->wrk); i++)
1193 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1194 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1195 {evt_q_length, evt_size, 0}
1197 {evt_q_length >> 1, 256, 0}
1199 cfg->consumer_pid = 0;
1201 cfg->q_nitems = evt_q_length;
1202 cfg->ring_cfgs = rc;
1203 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1204 if (smm->evt_qs_use_memfd_seg)
1206 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1207 clib_warning ("eventfd returned");
1211 if (smm->evt_qs_use_memfd_seg)
1212 ssvm_pop_heap (oldheap);
1214 svm_pop_heap (oldheap);
1218 session_main_get_evt_q_segment (void)
1220 session_main_t *smm = &session_main;
1221 if (smm->evt_qs_use_memfd_seg)
1222 return &smm->evt_qs_segment;
1227 session_segment_handle (session_t * s)
1231 if (s->session_state == SESSION_STATE_LISTENING)
1232 return SESSION_INVALID_HANDLE;
1235 return segment_manager_make_segment_handle (f->segment_manager,
1240 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1241 session_tx_fifo_peek_and_snd,
1242 session_tx_fifo_dequeue_and_snd,
1243 session_tx_fifo_dequeue_internal,
1244 session_tx_fifo_dequeue_and_snd
1249 * Initialize session layer for given transport proto and ip version
1251 * Allocates per session type (transport proto + ip version) data structures
1252 * and adds arc from session queue node to session type output node.
1255 session_register_transport (transport_proto_t transport_proto,
1256 const transport_proto_vft_t * vft, u8 is_ip4,
1259 session_main_t *smm = &session_main;
1260 session_type_t session_type;
1261 u32 next_index = ~0;
1263 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1265 vec_validate (smm->session_type_to_next, session_type);
1266 vec_validate (smm->session_tx_fns, session_type);
1269 if (output_node != ~0)
1271 foreach_vlib_main (({
1272 next_index = vlib_node_add_next (this_vlib_main,
1273 session_queue_node.index,
1279 smm->session_type_to_next[session_type] = next_index;
1280 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1283 transport_connection_t *
1284 session_get_transport (session_t * s)
1286 if (s->session_state != SESSION_STATE_LISTENING)
1287 return transport_get_connection (session_get_transport_proto (s),
1288 s->connection_index, s->thread_index);
1290 return transport_get_listener (session_get_transport_proto (s),
1291 s->connection_index);
1294 transport_connection_t *
1295 listen_session_get_transport (session_t * s)
1297 return transport_get_listener (session_get_transport_proto (s),
1298 s->connection_index);
1302 session_flush_frames_main_thread (vlib_main_t * vm)
1304 ASSERT (vlib_get_thread_index () == 0);
1305 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1306 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1309 static clib_error_t *
1310 session_manager_main_enable (vlib_main_t * vm)
1312 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1313 session_main_t *smm = &session_main;
1314 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1315 u32 num_threads, preallocated_sessions_per_worker;
1316 session_worker_t *wrk;
1319 num_threads = 1 /* main thread */ + vtm->n_threads;
1321 if (num_threads < 1)
1322 return clib_error_return (0, "n_thread_stacks not set");
1324 /* Allocate cache line aligned worker contexts */
1325 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1327 for (i = 0; i < num_threads; i++)
1330 vec_validate (wrk->free_event_vector, 128);
1331 _vec_len (wrk->free_event_vector) = 0;
1332 vec_validate (wrk->pending_event_vector, 128);
1333 _vec_len (wrk->pending_event_vector) = 0;
1334 vec_validate (wrk->pending_disconnects, 128);
1335 _vec_len (wrk->pending_disconnects) = 0;
1336 vec_validate (wrk->postponed_event_vector, 128);
1337 _vec_len (wrk->postponed_event_vector) = 0;
1339 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1340 wrk->dispatch_period = 500e-6;
1342 if (num_threads > 1)
1343 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1347 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1350 /* Allocate vpp event queues segment and queue */
1351 session_vpp_event_queues_allocate (smm);
1353 /* Initialize fifo segment main baseva and timeout */
1354 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1355 sm_args->size = smm->session_va_space_size;
1356 segment_manager_main_init (sm_args);
1358 /* Preallocate sessions */
1359 if (smm->preallocated_sessions)
1361 if (num_threads == 1)
1363 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1368 preallocated_sessions_per_worker =
1369 (1.1 * (f64) smm->preallocated_sessions /
1370 (f64) (num_threads - 1));
1372 for (j = 1; j < num_threads; j++)
1374 pool_init_fixed (smm->wrk[j].sessions,
1375 preallocated_sessions_per_worker);
1380 session_lookup_init ();
1381 app_namespaces_init ();
1384 smm->is_enabled = 1;
1386 /* Enable transports */
1387 transport_enable_disable (vm, 1);
1388 transport_init_tx_pacers_period ();
1393 session_node_enable_disable (u8 is_en)
1395 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1396 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1397 u8 have_workers = vtm->n_threads != 0;
1400 foreach_vlib_main (({
1401 if (have_workers && ii == 0)
1403 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1407 vlib_node_t *n = vlib_get_node (this_vlib_main,
1408 session_queue_process_node.index);
1409 vlib_start_process (this_vlib_main, n->runtime_index);
1413 vlib_process_signal_event_mt (this_vlib_main,
1414 session_queue_process_node.index,
1415 SESSION_Q_PROCESS_STOP, 0);
1420 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1427 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1429 clib_error_t *error = 0;
1432 if (session_main.is_enabled)
1435 session_node_enable_disable (is_en);
1436 error = session_manager_main_enable (vm);
1440 session_main.is_enabled = 0;
1441 session_node_enable_disable (is_en);
1448 session_manager_main_init (vlib_main_t * vm)
1450 session_main_t *smm = &session_main;
1451 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1452 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1453 smm->session_va_space_size = 128ULL << 30;
1454 smm->evt_qs_segment_size = 64 << 20;
1456 smm->session_va_space_size = 128 << 20;
1457 smm->evt_qs_segment_size = 1 << 20;
1459 smm->is_enabled = 0;
1463 VLIB_INIT_FUNCTION (session_manager_main_init);
1465 static clib_error_t *
1466 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1468 session_main_t *smm = &session_main;
1472 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1474 if (unformat (input, "event-queue-length %d", &nitems))
1477 smm->configured_event_queue_length = nitems;
1479 clib_warning ("event queue length %d too small, ignored", nitems);
1481 else if (unformat (input, "preallocated-sessions %d",
1482 &smm->preallocated_sessions))
1484 else if (unformat (input, "v4-session-table-buckets %d",
1485 &smm->configured_v4_session_table_buckets))
1487 else if (unformat (input, "v4-halfopen-table-buckets %d",
1488 &smm->configured_v4_halfopen_table_buckets))
1490 else if (unformat (input, "v6-session-table-buckets %d",
1491 &smm->configured_v6_session_table_buckets))
1493 else if (unformat (input, "v6-halfopen-table-buckets %d",
1494 &smm->configured_v6_halfopen_table_buckets))
1496 else if (unformat (input, "v4-session-table-memory %U",
1497 unformat_memory_size, &tmp))
1499 if (tmp >= 0x100000000)
1500 return clib_error_return (0, "memory size %llx (%lld) too large",
1502 smm->configured_v4_session_table_memory = tmp;
1504 else if (unformat (input, "v4-halfopen-table-memory %U",
1505 unformat_memory_size, &tmp))
1507 if (tmp >= 0x100000000)
1508 return clib_error_return (0, "memory size %llx (%lld) too large",
1510 smm->configured_v4_halfopen_table_memory = tmp;
1512 else if (unformat (input, "v6-session-table-memory %U",
1513 unformat_memory_size, &tmp))
1515 if (tmp >= 0x100000000)
1516 return clib_error_return (0, "memory size %llx (%lld) too large",
1518 smm->configured_v6_session_table_memory = tmp;
1520 else if (unformat (input, "v6-halfopen-table-memory %U",
1521 unformat_memory_size, &tmp))
1523 if (tmp >= 0x100000000)
1524 return clib_error_return (0, "memory size %llx (%lld) too large",
1526 smm->configured_v6_halfopen_table_memory = tmp;
1528 else if (unformat (input, "local-endpoints-table-memory %U",
1529 unformat_memory_size, &tmp))
1531 if (tmp >= 0x100000000)
1532 return clib_error_return (0, "memory size %llx (%lld) too large",
1534 smm->local_endpoints_table_memory = tmp;
1536 else if (unformat (input, "local-endpoints-table-buckets %d",
1537 &smm->local_endpoints_table_buckets))
1539 else if (unformat (input, "evt_qs_memfd_seg"))
1540 smm->evt_qs_use_memfd_seg = 1;
1541 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1542 &smm->evt_qs_segment_size))
1545 return clib_error_return (0, "unknown input `%U'",
1546 format_unformat_error, input);
1551 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1554 * fd.io coding-style-patch-verification: ON
1557 * eval: (c-set-style "gnu")