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_elt_alloc (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;
162 session_evt_add_pending_disconnects (wrk, elt);
165 session_send_ctrl_evt_to_thread (s, SESSION_CTRL_EVT_CLOSE);
169 session_alloc (u32 thread_index)
171 session_worker_t *wrk = &session_main.wrk[thread_index];
174 pool_get_aligned_will_expand (wrk->sessions, will_expand,
175 CLIB_CACHE_LINE_BYTES);
176 /* If we have peekers, let them finish */
177 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
179 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
180 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
181 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
185 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
187 clib_memset (s, 0, sizeof (*s));
188 s->session_index = s - wrk->sessions;
189 s->thread_index = thread_index;
190 s->app_index = APP_INVALID_INDEX;
195 session_free (session_t * s)
199 u8 thread_index = s->thread_index;
200 clib_memset (s, 0xFA, sizeof (*s));
201 pool_put (session_main.wrk[thread_index].sessions, s);
204 SESSION_EVT (SESSION_EVT_FREE, s);
205 pool_put (session_main.wrk[s->thread_index].sessions, s);
209 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
211 app_worker_t *app_wrk;
213 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
216 app_worker_cleanup_notify (app_wrk, s, ntf);
220 session_free_w_fifos (session_t * s)
222 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
223 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
228 * Cleans up session and lookup table.
230 * Transport connection must still be valid.
233 session_delete (session_t * s)
237 /* Delete from the main lookup table. */
238 if ((rv = session_lookup_del_session (s)))
239 clib_warning ("hash delete error, rv %d", rv);
241 session_free_w_fifos (s);
245 session_alloc_for_connection (transport_connection_t * tc)
248 u32 thread_index = tc->thread_index;
250 ASSERT (thread_index == vlib_get_thread_index ()
251 || transport_protocol_is_cl (tc->proto));
253 s = session_alloc (thread_index);
254 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
255 s->session_state = SESSION_STATE_CLOSED;
257 /* Attach transport to session and vice versa */
258 s->connection_index = tc->c_index;
259 tc->s_index = s->session_index;
264 * Discards bytes from buffer chain
266 * It discards n_bytes_to_drop starting at first buffer after chain_b
269 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
270 vlib_buffer_t ** chain_b,
273 vlib_buffer_t *next = *chain_b;
274 u32 to_drop = n_bytes_to_drop;
275 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
276 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
278 next = vlib_get_buffer (vm, next->next_buffer);
279 if (next->current_length > to_drop)
281 vlib_buffer_advance (next, to_drop);
286 to_drop -= next->current_length;
287 next->current_length = 0;
293 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
297 * Enqueue buffer chain tail
300 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
301 u32 offset, u8 is_in_order)
303 vlib_buffer_t *chain_b;
304 u32 chain_bi, len, diff;
305 vlib_main_t *vm = vlib_get_main ();
310 if (is_in_order && offset)
312 diff = offset - b->current_length;
313 if (diff > b->total_length_not_including_first_buffer)
316 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
317 chain_bi = vlib_get_buffer_index (vm, chain_b);
320 chain_bi = b->next_buffer;
324 chain_b = vlib_get_buffer (vm, chain_bi);
325 data = vlib_buffer_get_current (chain_b);
326 len = chain_b->current_length;
331 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
338 return (rv > 0) ? (written + rv) : written;
344 /* written more than what was left in chain */
345 if (written > b->total_length_not_including_first_buffer)
348 /* drop the bytes that have already been delivered */
349 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
354 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
357 clib_warning ("failed to enqueue multi-buffer seg");
363 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
364 ? chain_b->next_buffer : 0));
373 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
374 * event but on request can queue notification events for later delivery by
375 * calling stream_server_flush_enqueue_events().
377 * @param tc Transport connection which is to be enqueued data
378 * @param b Buffer to be enqueued
379 * @param offset Offset at which to start enqueueing if out-of-order
380 * @param queue_event Flag to indicate if peer is to be notified or if event
381 * is to be queued. The former is useful when more data is
382 * enqueued and only one event is to be generated.
383 * @param is_in_order Flag to indicate if data is in order
384 * @return Number of bytes enqueued or a negative value if enqueueing failed.
387 session_enqueue_stream_connection (transport_connection_t * tc,
388 vlib_buffer_t * b, u32 offset,
389 u8 queue_event, u8 is_in_order)
392 int enqueued = 0, rv, in_order_off;
394 s = session_get (tc->s_index, tc->thread_index);
398 enqueued = svm_fifo_enqueue (s->rx_fifo,
400 vlib_buffer_get_current (b));
401 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
404 in_order_off = enqueued > b->current_length ? enqueued : 0;
405 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
412 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
414 vlib_buffer_get_current (b));
415 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
416 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
417 /* if something was enqueued, report even this as success for ooo
418 * segment handling */
424 /* Queue RX event on this fifo. Eventually these will need to be flushed
425 * by calling stream_server_flush_enqueue_events () */
426 session_worker_t *wrk;
428 wrk = session_main_get_worker (s->thread_index);
429 if (!(s->flags & SESSION_F_RX_EVT))
431 s->flags |= SESSION_F_RX_EVT;
432 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
440 session_enqueue_dgram_connection (session_t * s,
441 session_dgram_hdr_t * hdr,
442 vlib_buffer_t * b, u8 proto, u8 queue_event)
444 int enqueued = 0, rv, in_order_off;
446 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
447 >= b->current_length + sizeof (*hdr));
449 svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
450 enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
451 vlib_buffer_get_current (b));
452 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
454 in_order_off = enqueued > b->current_length ? enqueued : 0;
455 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
461 /* Queue RX event on this fifo. Eventually these will need to be flushed
462 * by calling stream_server_flush_enqueue_events () */
463 session_worker_t *wrk;
465 wrk = session_main_get_worker (s->thread_index);
466 if (!(s->flags & SESSION_F_RX_EVT))
468 s->flags |= SESSION_F_RX_EVT;
469 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
476 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
477 u32 offset, u32 max_bytes)
479 session_t *s = session_get (tc->s_index, tc->thread_index);
480 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
484 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
486 session_t *s = session_get (tc->s_index, tc->thread_index);
489 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
491 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
492 session_dequeue_notify (s);
498 session_notify_subscribers (u32 app_index, session_t * s,
499 svm_fifo_t * f, session_evt_type_t evt_type)
501 app_worker_t *app_wrk;
505 app = application_get (app_index);
509 for (i = 0; i < f->n_subscribers; i++)
511 app_wrk = application_get_worker (app, f->subscribers[i]);
514 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
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_inline (session_t * s)
532 app_worker_t *app_wrk;
536 session_index = s->session_index;
537 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
539 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
540 if (PREDICT_FALSE (!app_wrk))
542 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
546 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
548 s->flags &= ~SESSION_F_RX_EVT;
549 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
553 if (PREDICT_FALSE (n_subscribers))
555 s = session_get (session_index, vlib_get_thread_index ());
556 return session_notify_subscribers (app_wrk->app_index, s,
557 s->rx_fifo, SESSION_IO_EVT_RX);
564 session_enqueue_notify (session_t * s)
566 return session_enqueue_notify_inline (s);
570 session_dequeue_notify (session_t * s)
572 app_worker_t *app_wrk;
574 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
575 if (PREDICT_FALSE (!app_wrk))
578 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
582 if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
583 return session_notify_subscribers (app_wrk->app_index, s,
584 s->tx_fifo, SESSION_IO_EVT_TX);
586 svm_fifo_clear_deq_ntf (s->tx_fifo);
592 * Flushes queue of sessions that are to be notified of new data
595 * @param thread_index Thread index for which the flush is to be performed.
596 * @return 0 on success or a positive number indicating the number of
597 * failures due to API queue being full.
600 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
602 session_worker_t *wrk = session_main_get_worker (thread_index);
607 indices = wrk->session_to_enqueue[transport_proto];
609 for (i = 0; i < vec_len (indices); i++)
611 s = session_get_if_valid (indices[i], thread_index);
612 if (PREDICT_FALSE (!s))
618 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
622 vec_reset_length (indices);
623 wrk->session_to_enqueue[transport_proto] = indices;
629 session_main_flush_all_enqueue_events (u8 transport_proto)
631 vlib_thread_main_t *vtm = vlib_get_thread_main ();
633 for (i = 0; i < 1 + vtm->n_threads; i++)
634 errors += session_main_flush_enqueue_events (transport_proto, i);
639 session_stream_connect_notify_inline (transport_connection_t * tc, u8 is_fail,
640 session_state_t opened_state)
642 u32 opaque = 0, new_ti, new_si;
643 app_worker_t *app_wrk;
648 * Find connection handle and cleanup half-open table
650 ho_handle = session_lookup_half_open_handle (tc);
651 if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
653 SESSION_DBG ("half-open was removed!");
656 session_lookup_del_half_open (tc);
658 /* Get the app's index from the handle we stored when opening connection
659 * and the opaque (api_context for external apps) from transport session
661 app_wrk = app_worker_get_if_valid (ho_handle >> 32);
665 opaque = tc->s_index;
668 return app_worker_connect_notify (app_wrk, s, opaque);
670 s = session_alloc_for_connection (tc);
671 s->session_state = SESSION_STATE_CONNECTING;
672 s->app_wrk_index = app_wrk->wrk_index;
673 new_si = s->session_index;
674 new_ti = s->thread_index;
676 if (app_worker_init_connected (app_wrk, s))
679 app_worker_connect_notify (app_wrk, 0, opaque);
683 s = session_get (new_si, new_ti);
684 s->session_state = opened_state;
685 session_lookup_add_connection (tc, session_handle (s));
687 if (app_worker_connect_notify (app_wrk, s, opaque))
689 s = session_get (new_si, new_ti);
690 session_free_w_fifos (s);
698 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
700 return session_stream_connect_notify_inline (tc, is_fail,
701 SESSION_STATE_READY);
705 session_ho_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
707 return session_stream_connect_notify_inline (tc, is_fail,
708 SESSION_STATE_OPENED);
711 typedef struct _session_switch_pool_args
715 u32 new_thread_index;
716 u32 new_session_index;
717 } session_switch_pool_args_t;
720 session_switch_pool (void *cb_args)
722 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
724 ASSERT (args->thread_index == vlib_get_thread_index ());
725 s = session_get (args->session_index, args->thread_index);
726 s->tx_fifo->master_session_index = args->new_session_index;
727 s->tx_fifo->master_thread_index = args->new_thread_index;
728 transport_cleanup (session_get_transport_proto (s), s->connection_index,
731 clib_mem_free (cb_args);
735 * Move dgram session to the right thread
738 session_dgram_connect_notify (transport_connection_t * tc,
739 u32 old_thread_index, session_t ** new_session)
742 session_switch_pool_args_t *rpc_args;
745 * Clone half-open session to the right thread.
747 new_s = session_clone_safe (tc->s_index, old_thread_index);
748 new_s->connection_index = tc->c_index;
749 new_s->rx_fifo->master_session_index = new_s->session_index;
750 new_s->rx_fifo->master_thread_index = new_s->thread_index;
751 new_s->session_state = SESSION_STATE_READY;
752 session_lookup_add_connection (tc, session_handle (new_s));
755 * Ask thread owning the old session to clean it up and make us the tx
758 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
759 rpc_args->new_session_index = new_s->session_index;
760 rpc_args->new_thread_index = new_s->thread_index;
761 rpc_args->session_index = tc->s_index;
762 rpc_args->thread_index = old_thread_index;
763 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
766 tc->s_index = new_s->session_index;
767 new_s->connection_index = tc->c_index;
768 *new_session = new_s;
773 * Notification from transport that connection is being closed.
775 * A disconnect is sent to application but state is not removed. Once
776 * disconnect is acknowledged by application, session disconnect is called.
777 * Ultimately this leads to close being called on transport (passive close).
780 session_transport_closing_notify (transport_connection_t * tc)
782 app_worker_t *app_wrk;
785 s = session_get (tc->s_index, tc->thread_index);
786 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
788 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
789 app_wrk = app_worker_get (s->app_wrk_index);
790 app_worker_close_notify (app_wrk, s);
794 * Notification from transport that connection is being deleted
796 * This removes the session if it is still valid. It should be called only on
797 * previously fully established sessions. For instance failed connects should
798 * call stream_session_connect_notify and indicate that the connect has
802 session_transport_delete_notify (transport_connection_t * tc)
806 /* App might've been removed already */
807 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
810 switch (s->session_state)
812 case SESSION_STATE_CREATED:
813 /* Session was created but accept notification was not yet sent to the
814 * app. Cleanup everything. */
815 session_lookup_del_session (s);
816 session_free_w_fifos (s);
818 case SESSION_STATE_ACCEPTING:
819 case SESSION_STATE_TRANSPORT_CLOSING:
820 case SESSION_STATE_CLOSING:
821 case SESSION_STATE_TRANSPORT_CLOSED:
822 /* If transport finishes or times out before we get a reply
823 * from the app, mark transport as closed and wait for reply
824 * before removing the session. Cleanup session table in advance
825 * because transport will soon be closed and closed sessions
826 * are assumed to have been removed from the lookup table */
827 session_lookup_del_session (s);
828 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
829 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
830 svm_fifo_dequeue_drop_all (s->tx_fifo);
832 case SESSION_STATE_APP_CLOSED:
833 /* Cleanup lookup table as transport needs to still be valid.
834 * Program transport close to ensure that all session events
835 * have been cleaned up. Once transport close is called, the
836 * session is just removed because both transport and app have
837 * confirmed the close*/
838 session_lookup_del_session (s);
839 s->session_state = SESSION_STATE_CLOSED;
840 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
841 svm_fifo_dequeue_drop_all (s->tx_fifo);
842 session_program_transport_close (s);
844 case SESSION_STATE_TRANSPORT_DELETED:
846 case SESSION_STATE_CLOSED:
847 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
851 clib_warning ("session state %u", s->session_state);
852 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
859 * Notification from transport that it is closed
861 * Should be called by transport, prior to calling delete notify, once it
862 * knows that no more data will be exchanged. This could serve as an
863 * early acknowledgment of an active close especially if transport delete
864 * can be delayed a long time, e.g., tcp time-wait.
867 session_transport_closed_notify (transport_connection_t * tc)
869 app_worker_t *app_wrk;
872 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
875 /* Transport thinks that app requested close but it actually didn't.
876 * Can happen for tcp if fin and rst are received in close succession. */
877 if (s->session_state == SESSION_STATE_READY)
879 session_transport_closing_notify (tc);
880 svm_fifo_dequeue_drop_all (s->tx_fifo);
881 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
883 /* If app close has not been received or has not yet resulted in
884 * a transport close, only mark the session transport as closed */
885 else if (s->session_state <= SESSION_STATE_CLOSING)
887 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
889 /* If app also closed, switch to closed */
890 else if (s->session_state == SESSION_STATE_APP_CLOSED)
891 s->session_state = SESSION_STATE_CLOSED;
893 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
895 app_worker_transport_closed_notify (app_wrk, s);
899 * Notify application that connection has been reset.
902 session_transport_reset_notify (transport_connection_t * tc)
904 app_worker_t *app_wrk;
907 s = session_get (tc->s_index, tc->thread_index);
908 svm_fifo_dequeue_drop_all (s->tx_fifo);
909 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
911 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
912 app_wrk = app_worker_get (s->app_wrk_index);
913 app_worker_reset_notify (app_wrk, s);
917 session_stream_accept_notify (transport_connection_t * tc)
919 app_worker_t *app_wrk;
922 s = session_get (tc->s_index, tc->thread_index);
923 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
926 s->session_state = SESSION_STATE_ACCEPTING;
927 return app_worker_accept_notify (app_wrk, s);
931 * Accept a stream session. Optionally ping the server by callback.
934 session_stream_accept (transport_connection_t * tc, u32 listener_index,
935 u32 thread_index, u8 notify)
940 s = session_alloc_for_connection (tc);
941 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
942 s->session_state = SESSION_STATE_CREATED;
944 if ((rv = app_worker_init_accepted (s)))
947 session_lookup_add_connection (tc, session_handle (s));
949 /* Shoulder-tap the server */
952 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
953 return app_worker_accept_notify (app_wrk, s);
960 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
962 transport_connection_t *tc;
963 transport_endpoint_cfg_t *tep;
964 app_worker_t *app_wrk;
969 tep = session_endpoint_to_transport_cfg (rmt);
970 rv = transport_connect (rmt->transport_proto, tep);
973 SESSION_DBG ("Transport failed to open connection.");
974 return VNET_API_ERROR_SESSION_CONNECT;
977 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
979 /* For dgram type of service, allocate session and fifos now */
980 app_wrk = app_worker_get (app_wrk_index);
981 s = session_alloc_for_connection (tc);
982 s->app_wrk_index = app_wrk->wrk_index;
983 s->session_state = SESSION_STATE_OPENED;
984 if (app_worker_init_connected (app_wrk, s))
990 sh = session_handle (s);
991 session_lookup_add_connection (tc, sh);
992 return app_worker_connect_notify (app_wrk, s, opaque);
996 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
998 transport_connection_t *tc;
999 transport_endpoint_cfg_t *tep;
1003 tep = session_endpoint_to_transport_cfg (rmt);
1004 rv = transport_connect (rmt->transport_proto, tep);
1007 SESSION_DBG ("Transport failed to open connection.");
1008 return VNET_API_ERROR_SESSION_CONNECT;
1011 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1013 /* If transport offers a stream service, only allocate session once the
1014 * connection has been established.
1015 * Add connection to half-open table and save app and tc index. The
1016 * latter is needed to help establish the connection while the former
1017 * is needed when the connect notify comes and we have to notify the
1020 handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1021 session_lookup_add_half_open (tc, handle);
1023 /* Store api_context (opaque) for when the reply comes. Not the nicest
1024 * thing but better than allocating a separate half-open pool.
1026 tc->s_index = opaque;
1027 if (transport_half_open_has_fifos (rmt->transport_proto))
1028 return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1033 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1035 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1036 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1038 sep->app_wrk_index = app_wrk_index;
1039 sep->opaque = opaque;
1041 return transport_connect (rmt->transport_proto, tep_cfg);
1044 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1047 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1055 * Ask transport to open connection to remote transport endpoint.
1057 * Stores handle for matching request with reply since the call can be
1058 * asynchronous. For instance, for TCP the 3-way handshake must complete
1059 * before reply comes. Session is only created once connection is established.
1061 * @param app_index Index of the application requesting the connect
1062 * @param st Session type requested.
1063 * @param tep Remote transport endpoint
1064 * @param opaque Opaque data (typically, api_context) the application expects
1065 * on open completion.
1068 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1070 transport_service_type_t tst;
1071 tst = transport_protocol_service_type (rmt->transport_proto);
1072 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1076 * Ask transport to listen on session endpoint.
1078 * @param s Session for which listen will be called. Note that unlike
1079 * established sessions, listen sessions are not associated to a
1081 * @param sep Local endpoint to be listened on.
1084 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1086 transport_endpoint_t *tep;
1087 u32 tc_index, s_index;
1089 /* Transport bind/listen */
1090 tep = session_endpoint_to_transport (sep);
1091 s_index = ls->session_index;
1092 tc_index = transport_start_listen (session_get_transport_proto (ls),
1095 if (tc_index == (u32) ~ 0)
1098 /* Attach transport to session. Lookup tables are populated by the app
1099 * worker because local tables (for ct sessions) are not backed by a fib */
1100 ls = listen_session_get (s_index);
1101 ls->connection_index = tc_index;
1107 * Ask transport to stop listening on local transport endpoint.
1109 * @param s Session to stop listening on. It must be in state LISTENING.
1112 session_stop_listen (session_t * s)
1114 transport_proto_t tp = session_get_transport_proto (s);
1115 transport_connection_t *tc;
1117 if (s->session_state != SESSION_STATE_LISTENING)
1120 tc = transport_get_listener (tp, s->connection_index);
1122 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1124 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1125 session_lookup_del_connection (tc);
1126 transport_stop_listen (tp, s->connection_index);
1131 * Initialize session closing procedure.
1133 * Request is always sent to session node to ensure that all outstanding
1134 * requests are served before transport is notified.
1137 session_close (session_t * s)
1142 if (s->session_state >= SESSION_STATE_CLOSING)
1144 /* Session will only be removed once both app and transport
1145 * acknowledge the close */
1146 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1147 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1148 session_program_transport_close (s);
1152 s->session_state = SESSION_STATE_CLOSING;
1153 session_program_transport_close (s);
1157 * Notify transport the session can be disconnected. This should eventually
1158 * result in a delete notification that allows us to cleanup session state.
1159 * Called for both active/passive disconnects.
1161 * Must be called from the session's thread.
1164 session_transport_close (session_t * s)
1166 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1168 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1169 s->session_state = SESSION_STATE_CLOSED;
1170 /* If transport is already deleted, just free the session */
1171 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1172 session_free_w_fifos (s);
1176 /* If the tx queue wasn't drained, the transport can continue to try
1177 * sending the outstanding data (in closed state it cannot). It MUST however
1178 * at one point, either after sending everything or after a timeout, call
1179 * delete notify. This will finally lead to the complete cleanup of the
1182 s->session_state = SESSION_STATE_APP_CLOSED;
1184 transport_close (session_get_transport_proto (s), s->connection_index,
1189 * Cleanup transport and session state.
1191 * Notify transport of the cleanup and free the session. This should
1192 * be called only if transport reported some error and is already
1196 session_transport_cleanup (session_t * s)
1198 s->session_state = SESSION_STATE_CLOSED;
1200 /* Delete from main lookup table before we axe the the transport */
1201 session_lookup_del_session (s);
1202 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1204 /* Since we called cleanup, no delete notification will come. So, make
1205 * sure the session is properly freed. */
1206 session_free_w_fifos (s);
1210 * Allocate event queues in the shared-memory segment
1212 * That can either be a newly created memfd segment, that will need to be
1213 * mapped by all stack users, or the binary api's svm region. The latter is
1214 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1215 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1216 * vpp uses api svm region for event queues.
1219 session_vpp_event_queues_allocate (session_main_t * smm)
1221 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1222 ssvm_private_t *eqs = &smm->evt_qs_segment;
1223 api_main_t *am = &api_main;
1224 uword eqs_size = 64 << 20;
1225 pid_t vpp_pid = getpid ();
1229 if (smm->configured_event_queue_length)
1230 evt_q_length = smm->configured_event_queue_length;
1232 if (smm->evt_qs_use_memfd_seg)
1234 if (smm->evt_qs_segment_size)
1235 eqs_size = smm->evt_qs_segment_size;
1237 eqs->ssvm_size = eqs_size;
1238 eqs->i_am_master = 1;
1239 eqs->my_pid = vpp_pid;
1240 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1241 eqs->requested_va = smm->session_baseva;
1243 if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1245 clib_warning ("failed to initialize queue segment");
1250 if (smm->evt_qs_use_memfd_seg)
1251 oldheap = ssvm_push_heap (eqs->sh);
1253 oldheap = svm_push_data_heap (am->vlib_rp);
1255 for (i = 0; i < vec_len (smm->wrk); i++)
1257 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1258 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1259 {evt_q_length, evt_size, 0}
1261 {evt_q_length >> 1, 256, 0}
1263 cfg->consumer_pid = 0;
1265 cfg->q_nitems = evt_q_length;
1266 cfg->ring_cfgs = rc;
1267 smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1268 if (smm->evt_qs_use_memfd_seg)
1270 if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1271 clib_warning ("eventfd returned");
1275 if (smm->evt_qs_use_memfd_seg)
1276 ssvm_pop_heap (oldheap);
1278 svm_pop_heap (oldheap);
1282 session_main_get_evt_q_segment (void)
1284 session_main_t *smm = &session_main;
1285 if (smm->evt_qs_use_memfd_seg)
1286 return &smm->evt_qs_segment;
1291 session_segment_handle (session_t * s)
1296 return SESSION_INVALID_HANDLE;
1299 return segment_manager_make_segment_handle (f->segment_manager,
1304 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1305 session_tx_fifo_peek_and_snd,
1306 session_tx_fifo_dequeue_and_snd,
1307 session_tx_fifo_dequeue_internal,
1308 session_tx_fifo_dequeue_and_snd
1313 * Initialize session layer for given transport proto and ip version
1315 * Allocates per session type (transport proto + ip version) data structures
1316 * and adds arc from session queue node to session type output node.
1319 session_register_transport (transport_proto_t transport_proto,
1320 const transport_proto_vft_t * vft, u8 is_ip4,
1323 session_main_t *smm = &session_main;
1324 session_type_t session_type;
1325 u32 next_index = ~0;
1327 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1329 vec_validate (smm->session_type_to_next, session_type);
1330 vec_validate (smm->session_tx_fns, session_type);
1333 if (output_node != ~0)
1335 foreach_vlib_main (({
1336 next_index = vlib_node_add_next (this_vlib_main,
1337 session_queue_node.index,
1343 smm->session_type_to_next[session_type] = next_index;
1344 smm->session_tx_fns[session_type] =
1345 session_tx_fns[vft->transport_options.tx_type];
1348 transport_connection_t *
1349 session_get_transport (session_t * s)
1351 if (s->session_state != SESSION_STATE_LISTENING)
1352 return transport_get_connection (session_get_transport_proto (s),
1353 s->connection_index, s->thread_index);
1355 return transport_get_listener (session_get_transport_proto (s),
1356 s->connection_index);
1360 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1362 if (s->session_state != SESSION_STATE_LISTENING)
1363 return transport_get_endpoint (session_get_transport_proto (s),
1364 s->connection_index, s->thread_index, tep,
1367 return transport_get_listener_endpoint (session_get_transport_proto (s),
1368 s->connection_index, tep, is_lcl);
1371 transport_connection_t *
1372 listen_session_get_transport (session_t * s)
1374 return transport_get_listener (session_get_transport_proto (s),
1375 s->connection_index);
1379 session_flush_frames_main_thread (vlib_main_t * vm)
1381 ASSERT (vlib_get_thread_index () == 0);
1382 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1383 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1386 static clib_error_t *
1387 session_manager_main_enable (vlib_main_t * vm)
1389 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1390 session_main_t *smm = &session_main;
1391 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1392 u32 num_threads, preallocated_sessions_per_worker;
1393 session_worker_t *wrk;
1396 num_threads = 1 /* main thread */ + vtm->n_threads;
1398 if (num_threads < 1)
1399 return clib_error_return (0, "n_thread_stacks not set");
1401 /* Allocate cache line aligned worker contexts */
1402 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1404 for (i = 0; i < num_threads; i++)
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->postponed_head = clib_llist_make_head (wrk->event_elts, evt_list);
1410 wrk->disconnects_head = clib_llist_make_head (wrk->event_elts,
1412 wrk->vm = vlib_mains[i];
1413 wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1415 if (num_threads > 1)
1416 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1419 /* Allocate vpp event queues segment and queue */
1420 session_vpp_event_queues_allocate (smm);
1422 /* Initialize fifo segment main baseva and timeout */
1423 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1424 sm_args->size = smm->session_va_space_size;
1425 segment_manager_main_init (sm_args);
1427 /* Preallocate sessions */
1428 if (smm->preallocated_sessions)
1430 if (num_threads == 1)
1432 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1437 preallocated_sessions_per_worker =
1438 (1.1 * (f64) smm->preallocated_sessions /
1439 (f64) (num_threads - 1));
1441 for (j = 1; j < num_threads; j++)
1443 pool_init_fixed (smm->wrk[j].sessions,
1444 preallocated_sessions_per_worker);
1449 session_lookup_init ();
1450 app_namespaces_init ();
1453 smm->is_enabled = 1;
1455 /* Enable transports */
1456 transport_enable_disable (vm, 1);
1457 transport_init_tx_pacers_period ();
1462 session_node_enable_disable (u8 is_en)
1464 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1465 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1466 u8 have_workers = vtm->n_threads != 0;
1469 foreach_vlib_main (({
1470 if (have_workers && ii == 0)
1472 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1476 vlib_node_t *n = vlib_get_node (this_vlib_main,
1477 session_queue_process_node.index);
1478 vlib_start_process (this_vlib_main, n->runtime_index);
1482 vlib_process_signal_event_mt (this_vlib_main,
1483 session_queue_process_node.index,
1484 SESSION_Q_PROCESS_STOP, 0);
1489 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1496 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1498 clib_error_t *error = 0;
1501 if (session_main.is_enabled)
1504 error = session_manager_main_enable (vm);
1505 session_node_enable_disable (is_en);
1509 session_main.is_enabled = 0;
1510 session_node_enable_disable (is_en);
1517 session_manager_main_init (vlib_main_t * vm)
1519 session_main_t *smm = &session_main;
1520 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1521 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1522 smm->session_va_space_size = 128ULL << 30;
1523 smm->evt_qs_segment_size = 64 << 20;
1525 smm->session_va_space_size = 128 << 20;
1526 smm->evt_qs_segment_size = 1 << 20;
1528 smm->is_enabled = 0;
1532 VLIB_INIT_FUNCTION (session_manager_main_init);
1534 static clib_error_t *
1535 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1537 session_main_t *smm = &session_main;
1541 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1543 if (unformat (input, "event-queue-length %d", &nitems))
1546 smm->configured_event_queue_length = nitems;
1548 clib_warning ("event queue length %d too small, ignored", nitems);
1550 else if (unformat (input, "preallocated-sessions %d",
1551 &smm->preallocated_sessions))
1553 else if (unformat (input, "v4-session-table-buckets %d",
1554 &smm->configured_v4_session_table_buckets))
1556 else if (unformat (input, "v4-halfopen-table-buckets %d",
1557 &smm->configured_v4_halfopen_table_buckets))
1559 else if (unformat (input, "v6-session-table-buckets %d",
1560 &smm->configured_v6_session_table_buckets))
1562 else if (unformat (input, "v6-halfopen-table-buckets %d",
1563 &smm->configured_v6_halfopen_table_buckets))
1565 else if (unformat (input, "v4-session-table-memory %U",
1566 unformat_memory_size, &tmp))
1568 if (tmp >= 0x100000000)
1569 return clib_error_return (0, "memory size %llx (%lld) too large",
1571 smm->configured_v4_session_table_memory = tmp;
1573 else if (unformat (input, "v4-halfopen-table-memory %U",
1574 unformat_memory_size, &tmp))
1576 if (tmp >= 0x100000000)
1577 return clib_error_return (0, "memory size %llx (%lld) too large",
1579 smm->configured_v4_halfopen_table_memory = tmp;
1581 else if (unformat (input, "v6-session-table-memory %U",
1582 unformat_memory_size, &tmp))
1584 if (tmp >= 0x100000000)
1585 return clib_error_return (0, "memory size %llx (%lld) too large",
1587 smm->configured_v6_session_table_memory = tmp;
1589 else if (unformat (input, "v6-halfopen-table-memory %U",
1590 unformat_memory_size, &tmp))
1592 if (tmp >= 0x100000000)
1593 return clib_error_return (0, "memory size %llx (%lld) too large",
1595 smm->configured_v6_halfopen_table_memory = tmp;
1597 else if (unformat (input, "local-endpoints-table-memory %U",
1598 unformat_memory_size, &tmp))
1600 if (tmp >= 0x100000000)
1601 return clib_error_return (0, "memory size %llx (%lld) too large",
1603 smm->local_endpoints_table_memory = tmp;
1605 else if (unformat (input, "local-endpoints-table-buckets %d",
1606 &smm->local_endpoints_table_buckets))
1608 else if (unformat (input, "evt_qs_memfd_seg"))
1609 smm->evt_qs_use_memfd_seg = 1;
1610 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1611 &smm->evt_qs_segment_size))
1614 return clib_error_return (0, "unknown input `%U'",
1615 format_unformat_error, input);
1620 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1623 * fd.io coding-style-patch-verification: ON
1626 * eval: (c-set-style "gnu")