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)
36 mq = session_main_get_vpp_event_queue (thread_index);
37 if (PREDICT_FALSE (svm_msg_q_lock (mq)))
39 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
41 svm_msg_q_unlock (mq);
44 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
45 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
47 svm_msg_q_unlock (mq);
50 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
51 evt->event_type = evt_type;
54 case SESSION_CTRL_EVT_RPC:
55 evt->rpc_args.fp = data;
56 evt->rpc_args.arg = args;
58 case SESSION_IO_EVT_RX:
59 case SESSION_IO_EVT_TX:
60 case SESSION_IO_EVT_TX_FLUSH:
61 case SESSION_IO_EVT_BUILTIN_RX:
62 evt->session_index = *(u32 *) data;
64 case SESSION_IO_EVT_BUILTIN_TX:
65 case SESSION_CTRL_EVT_CLOSE:
66 evt->session_handle = session_handle ((session_t *) data);
69 clib_warning ("evt unhandled!");
70 svm_msg_q_unlock (mq);
74 svm_msg_q_add_and_unlock (mq, &msg);
79 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
81 return session_send_evt_to_thread (&f->master_session_index, 0,
82 f->master_thread_index, evt_type);
86 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
87 session_evt_type_t evt_type)
89 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
93 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
95 /* only event supported for now is disconnect */
96 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE);
97 return session_send_evt_to_thread (s, 0, s->thread_index,
98 SESSION_CTRL_EVT_CLOSE);
102 session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
105 session_send_evt_to_thread (fp, rpc_args, thread_index,
106 SESSION_CTRL_EVT_RPC);
110 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
112 if (thread_index != vlib_get_thread_index ())
113 session_send_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
116 void (*fnp) (void *) = fp;
122 session_add_self_custom_tx_evt (transport_connection_t * tc, u8 has_prio)
126 s = session_get (tc->s_index, tc->thread_index);
127 ASSERT (s->thread_index == vlib_get_thread_index ());
128 if (!(s->flags & SESSION_F_CUSTOM_TX))
130 s->flags |= SESSION_F_CUSTOM_TX;
131 if (svm_fifo_set_event (s->tx_fifo))
133 session_worker_t *wrk;
134 session_evt_elt_t *elt;
135 wrk = session_main_get_worker (tc->thread_index);
137 elt = session_evt_alloc_new (wrk);
139 elt = session_evt_alloc_old (wrk);
140 elt->evt.session_index = tc->s_index;
141 elt->evt.event_type = SESSION_IO_EVT_TX;
147 session_program_transport_close (session_t * s)
149 u32 thread_index = vlib_get_thread_index ();
150 session_evt_elt_t *elt;
151 session_worker_t *wrk;
153 /* If we are in the handler thread, or being called with the worker barrier
154 * held, just append a new event to pending disconnects vector. */
155 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
157 wrk = session_main_get_worker (s->thread_index);
158 elt = session_evt_alloc_ctrl (wrk);
159 clib_memset (&elt->evt, 0, sizeof (session_event_t));
160 elt->evt.session_handle = session_handle (s);
161 elt->evt.event_type = SESSION_CTRL_EVT_CLOSE;
164 session_send_ctrl_evt_to_thread (s, SESSION_CTRL_EVT_CLOSE);
168 session_alloc (u32 thread_index)
170 session_worker_t *wrk = &session_main.wrk[thread_index];
173 pool_get_aligned_will_expand (wrk->sessions, will_expand,
174 CLIB_CACHE_LINE_BYTES);
175 /* If we have peekers, let them finish */
176 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
178 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
179 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
180 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
184 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
186 clib_memset (s, 0, sizeof (*s));
187 s->session_index = s - wrk->sessions;
188 s->thread_index = thread_index;
189 s->app_index = APP_INVALID_INDEX;
194 session_free (session_t * s)
198 u8 thread_index = s->thread_index;
199 clib_memset (s, 0xFA, sizeof (*s));
200 pool_put (session_main.wrk[thread_index].sessions, s);
203 SESSION_EVT (SESSION_EVT_FREE, s);
204 pool_put (session_main.wrk[s->thread_index].sessions, s);
208 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
210 app_worker_t *app_wrk;
212 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
215 app_worker_cleanup_notify (app_wrk, s, ntf);
219 session_free_w_fifos (session_t * s)
221 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
222 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
227 * Cleans up session and lookup table.
229 * Transport connection must still be valid.
232 session_delete (session_t * s)
236 /* Delete from the main lookup table. */
237 if ((rv = session_lookup_del_session (s)))
238 clib_warning ("hash delete error, rv %d", rv);
240 session_free_w_fifos (s);
244 session_alloc_for_connection (transport_connection_t * tc)
247 u32 thread_index = tc->thread_index;
249 ASSERT (thread_index == vlib_get_thread_index ()
250 || transport_protocol_is_cl (tc->proto));
252 s = session_alloc (thread_index);
253 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
254 s->session_state = SESSION_STATE_CLOSED;
256 /* Attach transport to session and vice versa */
257 s->connection_index = tc->c_index;
258 tc->s_index = s->session_index;
263 * Discards bytes from buffer chain
265 * It discards n_bytes_to_drop starting at first buffer after chain_b
268 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
269 vlib_buffer_t ** chain_b,
272 vlib_buffer_t *next = *chain_b;
273 u32 to_drop = n_bytes_to_drop;
274 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
275 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
277 next = vlib_get_buffer (vm, next->next_buffer);
278 if (next->current_length > to_drop)
280 vlib_buffer_advance (next, to_drop);
285 to_drop -= next->current_length;
286 next->current_length = 0;
292 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
296 * Enqueue buffer chain tail
299 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
300 u32 offset, u8 is_in_order)
302 vlib_buffer_t *chain_b;
303 u32 chain_bi, len, diff;
304 vlib_main_t *vm = vlib_get_main ();
309 if (is_in_order && offset)
311 diff = offset - b->current_length;
312 if (diff > b->total_length_not_including_first_buffer)
315 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
316 chain_bi = vlib_get_buffer_index (vm, chain_b);
319 chain_bi = b->next_buffer;
323 chain_b = vlib_get_buffer (vm, chain_bi);
324 data = vlib_buffer_get_current (chain_b);
325 len = chain_b->current_length;
330 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
337 return (rv > 0) ? (written + rv) : written;
343 /* written more than what was left in chain */
344 if (written > b->total_length_not_including_first_buffer)
347 /* drop the bytes that have already been delivered */
348 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
353 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
356 clib_warning ("failed to enqueue multi-buffer seg");
362 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
363 ? chain_b->next_buffer : 0));
372 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
373 * event but on request can queue notification events for later delivery by
374 * calling stream_server_flush_enqueue_events().
376 * @param tc Transport connection which is to be enqueued data
377 * @param b Buffer to be enqueued
378 * @param offset Offset at which to start enqueueing if out-of-order
379 * @param queue_event Flag to indicate if peer is to be notified or if event
380 * is to be queued. The former is useful when more data is
381 * enqueued and only one event is to be generated.
382 * @param is_in_order Flag to indicate if data is in order
383 * @return Number of bytes enqueued or a negative value if enqueueing failed.
386 session_enqueue_stream_connection (transport_connection_t * tc,
387 vlib_buffer_t * b, u32 offset,
388 u8 queue_event, u8 is_in_order)
391 int enqueued = 0, rv, in_order_off;
393 s = session_get (tc->s_index, tc->thread_index);
397 enqueued = svm_fifo_enqueue (s->rx_fifo,
399 vlib_buffer_get_current (b));
400 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
403 in_order_off = enqueued > b->current_length ? enqueued : 0;
404 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
411 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
413 vlib_buffer_get_current (b));
414 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
415 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
416 /* if something was enqueued, report even this as success for ooo
417 * segment handling */
423 /* Queue RX event on this fifo. Eventually these will need to be flushed
424 * by calling stream_server_flush_enqueue_events () */
425 session_worker_t *wrk;
427 wrk = session_main_get_worker (s->thread_index);
428 if (!(s->flags & SESSION_F_RX_EVT))
430 s->flags |= SESSION_F_RX_EVT;
431 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
439 session_enqueue_dgram_connection (session_t * s,
440 session_dgram_hdr_t * hdr,
441 vlib_buffer_t * b, u8 proto, u8 queue_event)
443 int enqueued = 0, rv, in_order_off;
445 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
446 >= b->current_length + sizeof (*hdr));
448 svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
449 enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
450 vlib_buffer_get_current (b));
451 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
453 in_order_off = enqueued > b->current_length ? enqueued : 0;
454 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
460 /* Queue RX event on this fifo. Eventually these will need to be flushed
461 * by calling stream_server_flush_enqueue_events () */
462 session_worker_t *wrk;
464 wrk = session_main_get_worker (s->thread_index);
465 if (!(s->flags & SESSION_F_RX_EVT))
467 s->flags |= SESSION_F_RX_EVT;
468 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
475 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
476 u32 offset, u32 max_bytes)
478 session_t *s = session_get (tc->s_index, tc->thread_index);
479 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
483 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
485 session_t *s = session_get (tc->s_index, tc->thread_index);
488 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
490 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
491 session_dequeue_notify (s);
497 session_notify_subscribers (u32 app_index, session_t * s,
498 svm_fifo_t * f, session_evt_type_t evt_type)
500 app_worker_t *app_wrk;
504 app = application_get (app_index);
508 for (i = 0; i < f->n_subscribers; i++)
510 app_wrk = application_get_worker (app, f->subscribers[i]);
513 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
521 * Notify session peer that new data has been enqueued.
523 * @param s Stream session for which the event is to be generated.
524 * @param lock Flag to indicate if call should lock message queue.
526 * @return 0 on success or negative number if failed to send notification.
529 session_enqueue_notify_inline (session_t * s)
531 app_worker_t *app_wrk;
535 session_index = s->session_index;
536 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
538 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
539 if (PREDICT_FALSE (!app_wrk))
541 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
545 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
547 s->flags &= ~SESSION_F_RX_EVT;
548 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
552 if (PREDICT_FALSE (n_subscribers))
554 s = session_get (session_index, vlib_get_thread_index ());
555 return session_notify_subscribers (app_wrk->app_index, s,
556 s->rx_fifo, SESSION_IO_EVT_RX);
563 session_enqueue_notify (session_t * s)
565 return session_enqueue_notify_inline (s);
569 session_dequeue_notify (session_t * s)
571 app_worker_t *app_wrk;
573 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
574 if (PREDICT_FALSE (!app_wrk))
577 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
581 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
582 return session_notify_subscribers (app_wrk->app_index, s,
583 s->tx_fifo, SESSION_IO_EVT_TX);
585 svm_fifo_clear_deq_ntf (s->tx_fifo);
591 * Flushes queue of sessions that are to be notified of new data
594 * @param thread_index Thread index for which the flush is to be performed.
595 * @return 0 on success or a positive number indicating the number of
596 * failures due to API queue being full.
599 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
601 session_worker_t *wrk = session_main_get_worker (thread_index);
606 indices = wrk->session_to_enqueue[transport_proto];
608 for (i = 0; i < vec_len (indices); i++)
610 s = session_get_if_valid (indices[i], thread_index);
611 if (PREDICT_FALSE (!s))
617 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
621 vec_reset_length (indices);
622 wrk->session_to_enqueue[transport_proto] = indices;
628 session_main_flush_all_enqueue_events (u8 transport_proto)
630 vlib_thread_main_t *vtm = vlib_get_thread_main ();
632 for (i = 0; i < 1 + vtm->n_threads; i++)
633 errors += session_main_flush_enqueue_events (transport_proto, i);
638 session_stream_connect_notify_inline (transport_connection_t * tc, u8 is_fail,
639 session_state_t opened_state)
641 u32 opaque = 0, new_ti, new_si;
642 app_worker_t *app_wrk;
647 * Find connection handle and cleanup half-open table
649 ho_handle = session_lookup_half_open_handle (tc);
650 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
652 SESSION_DBG ("half-open was removed!");
655 session_lookup_del_half_open (tc);
657 /* Get the app's index from the handle we stored when opening connection
658 * and the opaque (api_context for external apps) from transport session
660 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
664 opaque = tc->s_index;
667 return app_worker_connect_notify (app_wrk, s, opaque);
669 s = session_alloc_for_connection (tc);
670 s->session_state = SESSION_STATE_CONNECTING;
671 s->app_wrk_index = app_wrk->wrk_index;
672 new_si = s->session_index;
673 new_ti = s->thread_index;
675 if (app_worker_init_connected (app_wrk, s))
678 app_worker_connect_notify (app_wrk, 0, opaque);
682 s = session_get (new_si, new_ti);
683 s->session_state = opened_state;
684 session_lookup_add_connection (tc, session_handle (s));
686 if (app_worker_connect_notify (app_wrk, s, opaque))
688 s = session_get (new_si, new_ti);
689 session_free_w_fifos (s);
697 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
699 return session_stream_connect_notify_inline (tc, is_fail,
700 SESSION_STATE_READY);
704 session_ho_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
706 return session_stream_connect_notify_inline (tc, is_fail,
707 SESSION_STATE_OPENED);
710 typedef struct _session_switch_pool_args
714 u32 new_thread_index;
715 u32 new_session_index;
716 } session_switch_pool_args_t;
719 session_switch_pool (void *cb_args)
721 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
723 ASSERT (args->thread_index == vlib_get_thread_index ());
724 s = session_get (args->session_index, args->thread_index);
725 s->tx_fifo->master_session_index = args->new_session_index;
726 s->tx_fifo->master_thread_index = args->new_thread_index;
727 transport_cleanup (session_get_transport_proto (s), s->connection_index,
730 clib_mem_free (cb_args);
734 * Move dgram session to the right thread
737 session_dgram_connect_notify (transport_connection_t * tc,
738 u32 old_thread_index, session_t ** new_session)
741 session_switch_pool_args_t *rpc_args;
744 * Clone half-open session to the right thread.
746 new_s = session_clone_safe (tc->s_index, old_thread_index);
747 new_s->connection_index = tc->c_index;
748 new_s->rx_fifo->master_session_index = new_s->session_index;
749 new_s->rx_fifo->master_thread_index = new_s->thread_index;
750 new_s->session_state = SESSION_STATE_READY;
751 session_lookup_add_connection (tc, session_handle (new_s));
754 * Ask thread owning the old session to clean it up and make us the tx
757 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
758 rpc_args->new_session_index = new_s->session_index;
759 rpc_args->new_thread_index = new_s->thread_index;
760 rpc_args->session_index = tc->s_index;
761 rpc_args->thread_index = old_thread_index;
762 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
765 tc->s_index = new_s->session_index;
766 new_s->connection_index = tc->c_index;
767 *new_session = new_s;
772 * Notification from transport that connection is being closed.
774 * A disconnect is sent to application but state is not removed. Once
775 * disconnect is acknowledged by application, session disconnect is called.
776 * Ultimately this leads to close being called on transport (passive close).
779 session_transport_closing_notify (transport_connection_t * tc)
781 app_worker_t *app_wrk;
784 s = session_get (tc->s_index, tc->thread_index);
785 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
787 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
788 app_wrk = app_worker_get (s->app_wrk_index);
789 app_worker_close_notify (app_wrk, s);
793 * Notification from transport that connection is being deleted
795 * This removes the session if it is still valid. It should be called only on
796 * previously fully established sessions. For instance failed connects should
797 * call stream_session_connect_notify and indicate that the connect has
801 session_transport_delete_notify (transport_connection_t * tc)
805 /* App might've been removed already */
806 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
809 switch (s->session_state)
811 case SESSION_STATE_CREATED:
812 /* Session was created but accept notification was not yet sent to the
813 * app. Cleanup everything. */
814 session_lookup_del_session (s);
815 session_free_w_fifos (s);
817 case SESSION_STATE_ACCEPTING:
818 case SESSION_STATE_TRANSPORT_CLOSING:
819 case SESSION_STATE_CLOSING:
820 case SESSION_STATE_TRANSPORT_CLOSED:
821 /* If transport finishes or times out before we get a reply
822 * from the app, mark transport as closed and wait for reply
823 * before removing the session. Cleanup session table in advance
824 * because transport will soon be closed and closed sessions
825 * are assumed to have been removed from the lookup table */
826 session_lookup_del_session (s);
827 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
828 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
829 svm_fifo_dequeue_drop_all (s->tx_fifo);
831 case SESSION_STATE_APP_CLOSED:
832 /* Cleanup lookup table as transport needs to still be valid.
833 * Program transport close to ensure that all session events
834 * have been cleaned up. Once transport close is called, the
835 * session is just removed because both transport and app have
836 * confirmed the close*/
837 session_lookup_del_session (s);
838 s->session_state = SESSION_STATE_CLOSED;
839 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
840 svm_fifo_dequeue_drop_all (s->tx_fifo);
841 session_program_transport_close (s);
843 case SESSION_STATE_TRANSPORT_DELETED:
845 case SESSION_STATE_CLOSED:
846 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
850 clib_warning ("session state %u", s->session_state);
851 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
858 * Notification from transport that it is closed
860 * Should be called by transport, prior to calling delete notify, once it
861 * knows that no more data will be exchanged. This could serve as an
862 * early acknowledgment of an active close especially if transport delete
863 * can be delayed a long time, e.g., tcp time-wait.
866 session_transport_closed_notify (transport_connection_t * tc)
868 app_worker_t *app_wrk;
871 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
874 /* Transport thinks that app requested close but it actually didn't.
875 * Can happen for tcp if fin and rst are received in close succession. */
876 if (s->session_state == SESSION_STATE_READY)
878 session_transport_closing_notify (tc);
879 svm_fifo_dequeue_drop_all (s->tx_fifo);
880 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
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 else if (s->session_state <= SESSION_STATE_CLOSING)
886 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
888 /* If app also closed, switch to closed */
889 else if (s->session_state == SESSION_STATE_APP_CLOSED)
890 s->session_state = SESSION_STATE_CLOSED;
892 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
894 app_worker_transport_closed_notify (app_wrk, s);
898 * Notify application that connection has been reset.
901 session_transport_reset_notify (transport_connection_t * tc)
903 app_worker_t *app_wrk;
906 s = session_get (tc->s_index, tc->thread_index);
907 svm_fifo_dequeue_drop_all (s->tx_fifo);
908 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
910 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
911 app_wrk = app_worker_get (s->app_wrk_index);
912 app_worker_reset_notify (app_wrk, s);
916 session_stream_accept_notify (transport_connection_t * tc)
918 app_worker_t *app_wrk;
921 s = session_get (tc->s_index, tc->thread_index);
922 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
925 s->session_state = SESSION_STATE_ACCEPTING;
926 return app_worker_accept_notify (app_wrk, s);
930 * Accept a stream session. Optionally ping the server by callback.
933 session_stream_accept (transport_connection_t * tc, u32 listener_index,
934 u32 thread_index, u8 notify)
939 s = session_alloc_for_connection (tc);
940 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
941 s->session_state = SESSION_STATE_CREATED;
943 if ((rv = app_worker_init_accepted (s)))
946 session_lookup_add_connection (tc, session_handle (s));
948 /* Shoulder-tap the server */
951 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
952 return app_worker_accept_notify (app_wrk, s);
959 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
961 transport_connection_t *tc;
962 transport_endpoint_cfg_t *tep;
963 app_worker_t *app_wrk;
968 tep = session_endpoint_to_transport_cfg (rmt);
969 rv = transport_connect (rmt->transport_proto, tep);
972 SESSION_DBG ("Transport failed to open connection.");
973 return VNET_API_ERROR_SESSION_CONNECT;
976 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
978 /* For dgram type of service, allocate session and fifos now */
979 app_wrk = app_worker_get (app_wrk_index);
980 s = session_alloc_for_connection (tc);
981 s->app_wrk_index = app_wrk->wrk_index;
982 s->session_state = SESSION_STATE_OPENED;
983 if (app_worker_init_connected (app_wrk, s))
989 sh = session_handle (s);
990 session_lookup_add_connection (tc, sh);
991 return app_worker_connect_notify (app_wrk, s, opaque);
995 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
997 transport_connection_t *tc;
998 transport_endpoint_cfg_t *tep;
1002 tep = session_endpoint_to_transport_cfg (rmt);
1003 rv = transport_connect (rmt->transport_proto, tep);
1006 SESSION_DBG ("Transport failed to open connection.");
1007 return VNET_API_ERROR_SESSION_CONNECT;
1010 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1012 /* If transport offers a stream service, only allocate session once the
1013 * connection has been established.
1014 * Add connection to half-open table and save app and tc index. The
1015 * latter is needed to help establish the connection while the former
1016 * is needed when the connect notify comes and we have to notify the
1019 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1020 session_lookup_add_half_open (tc, handle);
1022 /* Store api_context (opaque) for when the reply comes. Not the nicest
1023 * thing but better than allocating a separate half-open pool.
1025 tc->s_index = opaque;
1026 if (transport_half_open_has_fifos (rmt->transport_proto))
1027 return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1032 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1034 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1035 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1037 sep->app_wrk_index = app_wrk_index;
1038 sep->opaque = opaque;
1040 return transport_connect (rmt->transport_proto, tep_cfg);
1043 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1046 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1054 * Ask transport to open connection to remote transport endpoint.
1056 * Stores handle for matching request with reply since the call can be
1057 * asynchronous. For instance, for TCP the 3-way handshake must complete
1058 * before reply comes. Session is only created once connection is established.
1060 * @param app_index Index of the application requesting the connect
1061 * @param st Session type requested.
1062 * @param tep Remote transport endpoint
1063 * @param opaque Opaque data (typically, api_context) the application expects
1064 * on open completion.
1067 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1069 transport_service_type_t tst;
1070 tst = transport_protocol_service_type (rmt->transport_proto);
1071 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1075 * Ask transport to listen on session endpoint.
1077 * @param s Session for which listen will be called. Note that unlike
1078 * established sessions, listen sessions are not associated to a
1080 * @param sep Local endpoint to be listened on.
1083 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1085 transport_endpoint_t *tep;
1086 u32 tc_index, s_index;
1088 /* Transport bind/listen */
1089 tep = session_endpoint_to_transport (sep);
1090 s_index = ls->session_index;
1091 tc_index = transport_start_listen (session_get_transport_proto (ls),
1094 if (tc_index == (u32) ~ 0)
1097 /* Attach transport to session. Lookup tables are populated by the app
1098 * worker because local tables (for ct sessions) are not backed by a fib */
1099 ls = listen_session_get (s_index);
1100 ls->connection_index = tc_index;
1106 * Ask transport to stop listening on local transport endpoint.
1108 * @param s Session to stop listening on. It must be in state LISTENING.
1111 session_stop_listen (session_t * s)
1113 transport_proto_t tp = session_get_transport_proto (s);
1114 transport_connection_t *tc;
1116 if (s->session_state != SESSION_STATE_LISTENING)
1119 tc = transport_get_listener (tp, s->connection_index);
1121 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1123 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1124 session_lookup_del_connection (tc);
1125 transport_stop_listen (tp, s->connection_index);
1130 * Initialize session closing procedure.
1132 * Request is always sent to session node to ensure that all outstanding
1133 * requests are served before transport is notified.
1136 session_close (session_t * s)
1141 if (s->session_state >= SESSION_STATE_CLOSING)
1143 /* Session will only be removed once both app and transport
1144 * acknowledge the close */
1145 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1146 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1147 session_program_transport_close (s);
1151 s->session_state = SESSION_STATE_CLOSING;
1152 session_program_transport_close (s);
1156 * Notify transport the session can be disconnected. This should eventually
1157 * result in a delete notification that allows us to cleanup session state.
1158 * Called for both active/passive disconnects.
1160 * Must be called from the session's thread.
1163 session_transport_close (session_t * s)
1165 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1167 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1168 s->session_state = SESSION_STATE_CLOSED;
1169 /* If transport is already deleted, just free the session */
1170 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1171 session_free_w_fifos (s);
1175 /* If the tx queue wasn't drained, the transport can continue to try
1176 * sending the outstanding data (in closed state it cannot). It MUST however
1177 * at one point, either after sending everything or after a timeout, call
1178 * delete notify. This will finally lead to the complete cleanup of the
1181 s->session_state = SESSION_STATE_APP_CLOSED;
1183 transport_close (session_get_transport_proto (s), s->connection_index,
1188 * Cleanup transport and session state.
1190 * Notify transport of the cleanup and free the session. This should
1191 * be called only if transport reported some error and is already
1195 session_transport_cleanup (session_t * s)
1197 s->session_state = SESSION_STATE_CLOSED;
1199 /* Delete from main lookup table before we axe the the transport */
1200 session_lookup_del_session (s);
1201 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1203 /* Since we called cleanup, no delete notification will come. So, make
1204 * sure the session is properly freed. */
1205 session_free_w_fifos (s);
1209 * Allocate event queues in the shared-memory segment
1211 * That can either be a newly created memfd segment, that will need to be
1212 * mapped by all stack users, or the binary api's svm region. The latter is
1213 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1214 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1215 * vpp uses api svm region for event queues.
1218 session_vpp_event_queues_allocate (session_main_t * smm)
1220 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1221 ssvm_private_t *eqs = &smm->evt_qs_segment;
1222 api_main_t *am = &api_main;
1223 uword eqs_size = 64 << 20;
1224 pid_t vpp_pid = getpid ();
1228 if (smm->configured_event_queue_length)
1229 evt_q_length = smm->configured_event_queue_length;
1231 if (smm->evt_qs_use_memfd_seg)
1233 if (smm->evt_qs_segment_size)
1234 eqs_size = smm->evt_qs_segment_size;
1236 eqs->ssvm_size = eqs_size;
1237 eqs->i_am_master = 1;
1238 eqs->my_pid = vpp_pid;
1239 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1240 eqs->requested_va = smm->session_baseva;
1242 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1244 clib_warning ("failed to initialize queue segment");
1249 if (smm->evt_qs_use_memfd_seg)
1250 oldheap = ssvm_push_heap (eqs->sh);
1252 oldheap = svm_push_data_heap (am->vlib_rp);
1254 for (i = 0; i < vec_len (smm->wrk); i++)
1256 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1257 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1258 {evt_q_length, evt_size, 0}
1260 {evt_q_length >> 1, 256, 0}
1262 cfg->consumer_pid = 0;
1264 cfg->q_nitems = evt_q_length;
1265 cfg->ring_cfgs = rc;
1266 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1267 if (smm->evt_qs_use_memfd_seg)
1269 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1270 clib_warning ("eventfd returned");
1274 if (smm->evt_qs_use_memfd_seg)
1275 ssvm_pop_heap (oldheap);
1277 svm_pop_heap (oldheap);
1281 session_main_get_evt_q_segment (void)
1283 session_main_t *smm = &session_main;
1284 if (smm->evt_qs_use_memfd_seg)
1285 return &smm->evt_qs_segment;
1290 session_segment_handle (session_t * s)
1295 return SESSION_INVALID_HANDLE;
1298 return segment_manager_make_segment_handle (f->segment_manager,
1303 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1304 session_tx_fifo_peek_and_snd,
1305 session_tx_fifo_dequeue_and_snd,
1306 session_tx_fifo_dequeue_internal,
1307 session_tx_fifo_dequeue_and_snd
1312 * Initialize session layer for given transport proto and ip version
1314 * Allocates per session type (transport proto + ip version) data structures
1315 * and adds arc from session queue node to session type output node.
1318 session_register_transport (transport_proto_t transport_proto,
1319 const transport_proto_vft_t * vft, u8 is_ip4,
1322 session_main_t *smm = &session_main;
1323 session_type_t session_type;
1324 u32 next_index = ~0;
1326 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1328 vec_validate (smm->session_type_to_next, session_type);
1329 vec_validate (smm->session_tx_fns, session_type);
1332 if (output_node != ~0)
1334 foreach_vlib_main (({
1335 next_index = vlib_node_add_next (this_vlib_main,
1336 session_queue_node.index,
1342 smm->session_type_to_next[session_type] = next_index;
1343 smm->session_tx_fns[session_type] =
1344 session_tx_fns[vft->transport_options.tx_type];
1347 transport_connection_t *
1348 session_get_transport (session_t * s)
1350 if (s->session_state != SESSION_STATE_LISTENING)
1351 return transport_get_connection (session_get_transport_proto (s),
1352 s->connection_index, s->thread_index);
1354 return transport_get_listener (session_get_transport_proto (s),
1355 s->connection_index);
1359 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1361 if (s->session_state != SESSION_STATE_LISTENING)
1362 return transport_get_endpoint (session_get_transport_proto (s),
1363 s->connection_index, s->thread_index, tep,
1366 return transport_get_listener_endpoint (session_get_transport_proto (s),
1367 s->connection_index, tep, is_lcl);
1370 transport_connection_t *
1371 listen_session_get_transport (session_t * s)
1373 return transport_get_listener (session_get_transport_proto (s),
1374 s->connection_index);
1378 session_flush_frames_main_thread (vlib_main_t * vm)
1380 ASSERT (vlib_get_thread_index () == 0);
1381 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1382 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1385 static clib_error_t *
1386 session_manager_main_enable (vlib_main_t * vm)
1388 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1389 session_main_t *smm = &session_main;
1390 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1391 u32 num_threads, preallocated_sessions_per_worker;
1392 session_worker_t *wrk;
1395 num_threads = 1 /* main thread */ + vtm->n_threads;
1397 if (num_threads < 1)
1398 return clib_error_return (0, "n_thread_stacks not set");
1400 /* Allocate cache line aligned worker contexts */
1401 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1403 for (i = 0; i < num_threads; i++)
1406 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1407 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1408 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1409 wrk->vm = vlib_mains[i];
1410 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1412 if (num_threads > 1)
1413 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1416 /* Allocate vpp event queues segment and queue */
1417 session_vpp_event_queues_allocate (smm);
1419 /* Initialize fifo segment main baseva and timeout */
1420 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1421 sm_args->size = smm->session_va_space_size;
1422 segment_manager_main_init (sm_args);
1424 /* Preallocate sessions */
1425 if (smm->preallocated_sessions)
1427 if (num_threads == 1)
1429 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1434 preallocated_sessions_per_worker =
1435 (1.1 * (f64) smm->preallocated_sessions /
1436 (f64) (num_threads - 1));
1438 for (j = 1; j < num_threads; j++)
1440 pool_init_fixed (smm->wrk[j].sessions,
1441 preallocated_sessions_per_worker);
1446 session_lookup_init ();
1447 app_namespaces_init ();
1450 smm->is_enabled = 1;
1452 /* Enable transports */
1453 transport_enable_disable (vm, 1);
1454 transport_init_tx_pacers_period ();
1459 session_node_enable_disable (u8 is_en)
1461 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1462 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1463 u8 have_workers = vtm->n_threads != 0;
1466 foreach_vlib_main (({
1467 if (have_workers && ii == 0)
1469 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1473 vlib_node_t *n = vlib_get_node (this_vlib_main,
1474 session_queue_process_node.index);
1475 vlib_start_process (this_vlib_main, n->runtime_index);
1479 vlib_process_signal_event_mt (this_vlib_main,
1480 session_queue_process_node.index,
1481 SESSION_Q_PROCESS_STOP, 0);
1486 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1493 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1495 clib_error_t *error = 0;
1498 if (session_main.is_enabled)
1501 error = session_manager_main_enable (vm);
1502 session_node_enable_disable (is_en);
1506 session_main.is_enabled = 0;
1507 session_node_enable_disable (is_en);
1514 session_manager_main_init (vlib_main_t * vm)
1516 session_main_t *smm = &session_main;
1517 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1518 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1519 smm->session_va_space_size = 128ULL << 30;
1520 smm->evt_qs_segment_size = 64 << 20;
1522 smm->session_va_space_size = 128 << 20;
1523 smm->evt_qs_segment_size = 1 << 20;
1525 smm->is_enabled = 0;
1529 VLIB_INIT_FUNCTION (session_manager_main_init);
1531 static clib_error_t *
1532 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1534 session_main_t *smm = &session_main;
1538 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1540 if (unformat (input, "event-queue-length %d", &nitems))
1543 smm->configured_event_queue_length = nitems;
1545 clib_warning ("event queue length %d too small, ignored", nitems);
1547 else if (unformat (input, "preallocated-sessions %d",
1548 &smm->preallocated_sessions))
1550 else if (unformat (input, "v4-session-table-buckets %d",
1551 &smm->configured_v4_session_table_buckets))
1553 else if (unformat (input, "v4-halfopen-table-buckets %d",
1554 &smm->configured_v4_halfopen_table_buckets))
1556 else if (unformat (input, "v6-session-table-buckets %d",
1557 &smm->configured_v6_session_table_buckets))
1559 else if (unformat (input, "v6-halfopen-table-buckets %d",
1560 &smm->configured_v6_halfopen_table_buckets))
1562 else if (unformat (input, "v4-session-table-memory %U",
1563 unformat_memory_size, &tmp))
1565 if (tmp >= 0x100000000)
1566 return clib_error_return (0, "memory size %llx (%lld) too large",
1568 smm->configured_v4_session_table_memory = tmp;
1570 else if (unformat (input, "v4-halfopen-table-memory %U",
1571 unformat_memory_size, &tmp))
1573 if (tmp >= 0x100000000)
1574 return clib_error_return (0, "memory size %llx (%lld) too large",
1576 smm->configured_v4_halfopen_table_memory = tmp;
1578 else if (unformat (input, "v6-session-table-memory %U",
1579 unformat_memory_size, &tmp))
1581 if (tmp >= 0x100000000)
1582 return clib_error_return (0, "memory size %llx (%lld) too large",
1584 smm->configured_v6_session_table_memory = tmp;
1586 else if (unformat (input, "v6-halfopen-table-memory %U",
1587 unformat_memory_size, &tmp))
1589 if (tmp >= 0x100000000)
1590 return clib_error_return (0, "memory size %llx (%lld) too large",
1592 smm->configured_v6_halfopen_table_memory = tmp;
1594 else if (unformat (input, "local-endpoints-table-memory %U",
1595 unformat_memory_size, &tmp))
1597 if (tmp >= 0x100000000)
1598 return clib_error_return (0, "memory size %llx (%lld) too large",
1600 smm->local_endpoints_table_memory = tmp;
1602 else if (unformat (input, "local-endpoints-table-buckets %d",
1603 &smm->local_endpoints_table_buckets))
1605 else if (unformat (input, "evt_qs_memfd_seg"))
1606 smm->evt_qs_use_memfd_seg = 1;
1607 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1608 &smm->evt_qs_segment_size))
1611 return clib_error_return (0, "unknown input `%U'",
1612 format_unformat_error, input);
1617 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1620 * fd.io coding-style-patch-verification: ON
1623 * eval: (c-set-style "gnu")