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/application.h>
22 #include <vnet/dpo/load_balance.h>
23 #include <vnet/fib/ip4_fib.h>
24 #include <vlib/stats/stats.h>
25 #include <vlib/dma/dma.h>
27 session_main_t session_main;
30 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
31 session_evt_type_t evt_type)
33 session_worker_t *wrk = session_main_get_worker (thread_index);
38 mq = wrk->vpp_event_queue;
39 if (PREDICT_FALSE (svm_msg_q_lock (mq)))
41 if (PREDICT_FALSE (svm_msg_q_or_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
43 svm_msg_q_unlock (mq);
48 case SESSION_CTRL_EVT_RPC:
49 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
50 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
51 evt->rpc_args.fp = data;
52 evt->rpc_args.arg = args;
54 case SESSION_IO_EVT_RX:
55 case SESSION_IO_EVT_TX:
56 case SESSION_IO_EVT_TX_FLUSH:
57 case SESSION_IO_EVT_BUILTIN_RX:
58 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
59 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
60 evt->session_index = *(u32 *) data;
62 case SESSION_IO_EVT_BUILTIN_TX:
63 case SESSION_CTRL_EVT_CLOSE:
64 case SESSION_CTRL_EVT_RESET:
65 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
66 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
67 evt->session_handle = session_handle ((session_t *) data);
70 clib_warning ("evt unhandled!");
71 svm_msg_q_unlock (mq);
74 evt->event_type = evt_type;
76 svm_msg_q_add_and_unlock (mq, &msg);
78 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
79 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
85 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
87 return session_send_evt_to_thread (&f->shr->master_session_index, 0,
88 f->master_thread_index, evt_type);
92 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
93 session_evt_type_t evt_type)
95 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
99 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
101 /* only events supported are disconnect, shutdown and reset */
102 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE ||
103 evt_type == SESSION_CTRL_EVT_HALF_CLOSE ||
104 evt_type == SESSION_CTRL_EVT_RESET);
105 return session_send_evt_to_thread (s, 0, s->thread_index, evt_type);
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_add_self_custom_tx_evt (transport_connection_t * tc, u8 has_prio)
131 session_t *s = session_get (tc->s_index, tc->thread_index);
133 ASSERT (s->thread_index == vlib_get_thread_index ());
134 ASSERT (s->session_state != SESSION_STATE_TRANSPORT_DELETED);
136 if (!(s->flags & SESSION_F_CUSTOM_TX))
138 s->flags |= SESSION_F_CUSTOM_TX;
139 if (svm_fifo_set_event (s->tx_fifo)
140 || transport_connection_is_descheduled (tc))
142 session_evt_elt_t *elt;
143 session_worker_t *wrk;
145 wrk = session_main_get_worker (tc->thread_index);
147 elt = session_evt_alloc_new (wrk);
149 elt = session_evt_alloc_old (wrk);
150 elt->evt.session_index = tc->s_index;
151 elt->evt.event_type = SESSION_IO_EVT_TX;
152 tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
154 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
155 vlib_node_set_interrupt_pending (wrk->vm,
156 session_queue_node.index);
162 sesssion_reschedule_tx (transport_connection_t * tc)
164 session_worker_t *wrk = session_main_get_worker (tc->thread_index);
165 session_evt_elt_t *elt;
167 ASSERT (tc->thread_index == vlib_get_thread_index ());
169 elt = session_evt_alloc_new (wrk);
170 elt->evt.session_index = tc->s_index;
171 elt->evt.event_type = SESSION_IO_EVT_TX;
173 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
174 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
178 session_program_transport_ctrl_evt (session_t * s, session_evt_type_t evt)
180 u32 thread_index = vlib_get_thread_index ();
181 session_evt_elt_t *elt;
182 session_worker_t *wrk;
184 /* If we are in the handler thread, or being called with the worker barrier
185 * held, just append a new event to pending disconnects vector. */
186 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
188 wrk = session_main_get_worker (s->thread_index);
189 elt = session_evt_alloc_ctrl (wrk);
190 clib_memset (&elt->evt, 0, sizeof (session_event_t));
191 elt->evt.session_handle = session_handle (s);
192 elt->evt.event_type = evt;
194 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
195 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
198 session_send_ctrl_evt_to_thread (s, evt);
202 session_alloc (u32 thread_index)
204 session_worker_t *wrk = &session_main.wrk[thread_index];
207 pool_get_aligned_safe (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
208 clib_memset (s, 0, sizeof (*s));
209 s->session_index = s - wrk->sessions;
210 s->thread_index = thread_index;
211 s->app_index = APP_INVALID_INDEX;
217 session_free (session_t * s)
219 session_worker_t *wrk = &session_main.wrk[s->thread_index];
221 SESSION_EVT (SESSION_EVT_FREE, s);
223 clib_memset (s, 0xFA, sizeof (*s));
224 pool_put (wrk->sessions, s);
228 session_is_valid (u32 si, u8 thread_index)
231 transport_connection_t *tc;
233 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
235 if (s->thread_index != thread_index || s->session_index != si)
238 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED
239 || s->session_state <= SESSION_STATE_LISTENING)
242 if (s->session_state == SESSION_STATE_CONNECTING &&
243 (s->flags & SESSION_F_HALF_OPEN))
246 tc = session_get_transport (s);
247 if (s->connection_index != tc->c_index
248 || s->thread_index != tc->thread_index || tc->s_index != si)
255 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
257 app_worker_t *app_wrk;
259 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
262 app_worker_cleanup_notify (app_wrk, s, ntf);
266 session_free_w_fifos (session_t * s)
268 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
269 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
274 * Cleans up session and lookup table.
276 * Transport connection must still be valid.
279 session_delete (session_t * s)
283 /* Delete from the main lookup table. */
284 if ((rv = session_lookup_del_session (s)))
285 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
287 session_free_w_fifos (s);
291 session_cleanup_half_open (session_handle_t ho_handle)
293 session_t *ho = session_get_from_handle (ho_handle);
295 /* App transports can migrate their half-opens */
296 if (ho->flags & SESSION_F_IS_MIGRATING)
298 /* Session still migrating, move to closed state to signal that the
299 * session should be removed. */
300 if (ho->connection_index == ~0)
302 session_set_state (ho, SESSION_STATE_CLOSED);
305 /* Migrated transports are no longer half-opens */
306 transport_cleanup (session_get_transport_proto (ho),
307 ho->connection_index, ho->app_index /* overloaded */);
310 transport_cleanup_half_open (session_get_transport_proto (ho),
311 ho->connection_index);
316 session_half_open_free (session_t *ho)
318 app_worker_t *app_wrk;
320 ASSERT (vlib_get_thread_index () <= 1);
321 app_wrk = app_worker_get (ho->app_wrk_index);
322 app_worker_del_half_open (app_wrk, ho);
327 session_half_open_free_rpc (void *args)
329 session_t *ho = ho_session_get (pointer_to_uword (args));
330 session_half_open_free (ho);
334 session_half_open_delete_notify (transport_connection_t *tc)
336 /* Notification from ctrl thread accepted without rpc */
337 if (tc->thread_index == transport_cl_thread ())
339 session_half_open_free (ho_session_get (tc->s_index));
343 void *args = uword_to_pointer ((uword) tc->s_index, void *);
344 session_send_rpc_evt_to_thread_force (transport_cl_thread (),
345 session_half_open_free_rpc, args);
350 session_half_open_migrate_notify (transport_connection_t *tc)
354 ho = ho_session_get (tc->s_index);
355 ho->flags |= SESSION_F_IS_MIGRATING;
356 ho->connection_index = ~0;
360 session_half_open_migrated_notify (transport_connection_t *tc)
364 ho = ho_session_get (tc->s_index);
366 /* App probably detached so the half-open must be cleaned up */
367 if (ho->session_state == SESSION_STATE_CLOSED)
369 session_half_open_delete_notify (tc);
372 ho->connection_index = tc->c_index;
373 /* Overload app index for half-open with new thread */
374 ho->app_index = tc->thread_index;
379 session_alloc_for_connection (transport_connection_t * tc)
382 u32 thread_index = tc->thread_index;
384 ASSERT (thread_index == vlib_get_thread_index ()
385 || transport_protocol_is_cl (tc->proto));
387 s = session_alloc (thread_index);
388 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
389 session_set_state (s, SESSION_STATE_CLOSED);
391 /* Attach transport to session and vice versa */
392 s->connection_index = tc->c_index;
393 tc->s_index = s->session_index;
398 session_alloc_for_half_open (transport_connection_t *tc)
402 s = ho_session_alloc ();
403 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
404 s->connection_index = tc->c_index;
405 tc->s_index = s->session_index;
410 * Discards bytes from buffer chain
412 * It discards n_bytes_to_drop starting at first buffer after chain_b
415 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
416 vlib_buffer_t ** chain_b,
419 vlib_buffer_t *next = *chain_b;
420 u32 to_drop = n_bytes_to_drop;
421 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
422 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
424 next = vlib_get_buffer (vm, next->next_buffer);
425 if (next->current_length > to_drop)
427 vlib_buffer_advance (next, to_drop);
432 to_drop -= next->current_length;
433 next->current_length = 0;
439 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
443 * Enqueue buffer chain tail
446 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
447 u32 offset, u8 is_in_order)
449 vlib_buffer_t *chain_b;
450 u32 chain_bi, len, diff;
451 vlib_main_t *vm = vlib_get_main ();
456 if (is_in_order && offset)
458 diff = offset - b->current_length;
459 if (diff > b->total_length_not_including_first_buffer)
462 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
463 chain_bi = vlib_get_buffer_index (vm, chain_b);
466 chain_bi = b->next_buffer;
470 chain_b = vlib_get_buffer (vm, chain_bi);
471 data = vlib_buffer_get_current (chain_b);
472 len = chain_b->current_length;
477 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
484 return (rv > 0) ? (written + rv) : written;
490 /* written more than what was left in chain */
491 if (written > b->total_length_not_including_first_buffer)
494 /* drop the bytes that have already been delivered */
495 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
500 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
503 clib_warning ("failed to enqueue multi-buffer seg");
509 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
510 ? chain_b->next_buffer : 0));
519 session_fifo_tuning (session_t * s, svm_fifo_t * f,
520 session_ft_action_t act, u32 len)
522 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
524 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
525 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
526 if (CLIB_ASSERT_ENABLE)
528 segment_manager_t *sm;
529 sm = segment_manager_get (f->segment_manager);
530 ASSERT (f->shr->size >= 4096);
531 ASSERT (f->shr->size <= sm->max_fifo_size);
537 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
538 * event but on request can queue notification events for later delivery by
539 * calling stream_server_flush_enqueue_events().
541 * @param tc Transport connection which is to be enqueued data
542 * @param b Buffer to be enqueued
543 * @param offset Offset at which to start enqueueing if out-of-order
544 * @param queue_event Flag to indicate if peer is to be notified or if event
545 * is to be queued. The former is useful when more data is
546 * enqueued and only one event is to be generated.
547 * @param is_in_order Flag to indicate if data is in order
548 * @return Number of bytes enqueued or a negative value if enqueueing failed.
551 session_enqueue_stream_connection (transport_connection_t * tc,
552 vlib_buffer_t * b, u32 offset,
553 u8 queue_event, u8 is_in_order)
556 int enqueued = 0, rv, in_order_off;
558 s = session_get (tc->s_index, tc->thread_index);
562 enqueued = svm_fifo_enqueue (s->rx_fifo,
564 vlib_buffer_get_current (b));
565 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
568 in_order_off = enqueued > b->current_length ? enqueued : 0;
569 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
576 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
578 vlib_buffer_get_current (b));
579 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
580 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
581 /* if something was enqueued, report even this as success for ooo
582 * segment handling */
588 /* Queue RX event on this fifo. Eventually these will need to be flushed
589 * by calling stream_server_flush_enqueue_events () */
590 session_worker_t *wrk;
592 wrk = session_main_get_worker (s->thread_index);
593 if (!(s->flags & SESSION_F_RX_EVT))
595 s->flags |= SESSION_F_RX_EVT;
596 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
599 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
606 session_enqueue_dgram_connection (session_t * s,
607 session_dgram_hdr_t * hdr,
608 vlib_buffer_t * b, u8 proto, u8 queue_event)
612 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
613 >= b->current_length + sizeof (*hdr));
615 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
618 svm_fifo_seg_t segs[2] = {
619 { (u8 *) hdr, sizeof (*hdr) },
620 { vlib_buffer_get_current (b), b->current_length }
624 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
625 0 /* allow_partial */ );
629 vlib_main_t *vm = vlib_get_main ();
630 svm_fifo_seg_t *segs = 0, *seg;
631 vlib_buffer_t *it = b;
634 vec_add2 (segs, seg, 1);
635 seg->data = (u8 *) hdr;
636 seg->len = sizeof (*hdr);
639 vec_add2 (segs, seg, 1);
640 seg->data = vlib_buffer_get_current (it);
641 seg->len = it->current_length;
643 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
645 it = vlib_get_buffer (vm, it->next_buffer);
647 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
648 0 /* allow partial */ );
652 if (queue_event && rv > 0)
654 /* Queue RX event on this fifo. Eventually these will need to be flushed
655 * by calling stream_server_flush_enqueue_events () */
656 session_worker_t *wrk;
658 wrk = session_main_get_worker (s->thread_index);
659 if (!(s->flags & SESSION_F_RX_EVT))
661 s->flags |= SESSION_F_RX_EVT;
662 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
665 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
667 return rv > 0 ? rv : 0;
671 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
672 u32 offset, u32 max_bytes)
674 session_t *s = session_get (tc->s_index, tc->thread_index);
675 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
679 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
681 session_t *s = session_get (tc->s_index, tc->thread_index);
684 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
685 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
687 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
688 session_dequeue_notify (s);
694 session_notify_subscribers (u32 app_index, session_t * s,
695 svm_fifo_t * f, session_evt_type_t evt_type)
697 app_worker_t *app_wrk;
701 app = application_get (app_index);
705 for (i = 0; i < f->shr->n_subscribers; i++)
707 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
710 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
718 * Notify session peer that new data has been enqueued.
720 * @param s Stream session for which the event is to be generated.
721 * @param lock Flag to indicate if call should lock message queue.
723 * @return 0 on success or negative number if failed to send notification.
726 session_enqueue_notify_inline (session_t * s)
728 app_worker_t *app_wrk;
733 session_index = s->session_index;
734 thread_index = s->thread_index;
735 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
737 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
738 if (PREDICT_FALSE (!app_wrk))
740 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
744 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
746 s->flags &= ~SESSION_F_RX_EVT;
748 /* Application didn't confirm accept yet */
749 if (PREDICT_FALSE (s->session_state == SESSION_STATE_ACCEPTING))
752 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
756 if (PREDICT_FALSE (n_subscribers))
758 s = session_get (session_index, thread_index);
759 return session_notify_subscribers (app_wrk->app_index, s,
760 s->rx_fifo, SESSION_IO_EVT_RX);
767 session_enqueue_notify (session_t * s)
769 return session_enqueue_notify_inline (s);
773 session_enqueue_notify_rpc (void *arg)
775 u32 session_index = pointer_to_uword (arg);
778 s = session_get_if_valid (session_index, vlib_get_thread_index ());
782 session_enqueue_notify (s);
786 * Like session_enqueue_notify, but can be called from a thread that does not
790 session_enqueue_notify_thread (session_handle_t sh)
792 u32 thread_index = session_thread_from_handle (sh);
793 u32 session_index = session_index_from_handle (sh);
796 * Pass session index (u32) as opposed to handle (u64) in case pointers
799 session_send_rpc_evt_to_thread (thread_index,
800 session_enqueue_notify_rpc,
801 uword_to_pointer (session_index, void *));
805 session_dequeue_notify (session_t * s)
807 app_worker_t *app_wrk;
809 svm_fifo_clear_deq_ntf (s->tx_fifo);
811 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
812 if (PREDICT_FALSE (!app_wrk))
815 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
819 if (PREDICT_FALSE (s->tx_fifo->shr->n_subscribers))
820 return session_notify_subscribers (app_wrk->app_index, s,
821 s->tx_fifo, SESSION_IO_EVT_TX);
827 * Flushes queue of sessions that are to be notified of new data
830 * @param thread_index Thread index for which the flush is to be performed.
831 * @return 0 on success or a positive number indicating the number of
832 * failures due to API queue being full.
835 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
837 session_worker_t *wrk = session_main_get_worker (thread_index);
842 indices = wrk->session_to_enqueue[transport_proto];
844 for (i = 0; i < vec_len (indices); i++)
846 s = session_get_if_valid (indices[i], thread_index);
847 if (PREDICT_FALSE (!s))
853 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
854 0 /* TODO/not needed */ );
856 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
860 vec_reset_length (indices);
861 wrk->session_to_enqueue[transport_proto] = indices;
867 session_main_flush_all_enqueue_events (u8 transport_proto)
869 vlib_thread_main_t *vtm = vlib_get_thread_main ();
871 for (i = 0; i < 1 + vtm->n_threads; i++)
872 errors += session_main_flush_enqueue_events (transport_proto, i);
877 session_stream_connect_notify (transport_connection_t * tc,
880 u32 opaque = 0, new_ti, new_si;
881 app_worker_t *app_wrk;
882 session_t *s = 0, *ho;
885 * Cleanup half-open table
887 session_lookup_del_half_open (tc);
889 ho = ho_session_get (tc->s_index);
891 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
896 return app_worker_connect_notify (app_wrk, s, err, opaque);
898 s = session_alloc_for_connection (tc);
899 session_set_state (s, SESSION_STATE_CONNECTING);
900 s->app_wrk_index = app_wrk->wrk_index;
901 new_si = s->session_index;
902 new_ti = s->thread_index;
904 if ((err = app_worker_init_connected (app_wrk, s)))
907 app_worker_connect_notify (app_wrk, 0, err, opaque);
911 s = session_get (new_si, new_ti);
912 session_set_state (s, SESSION_STATE_READY);
913 session_lookup_add_connection (tc, session_handle (s));
915 if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
917 session_lookup_del_connection (tc);
918 /* Avoid notifying app about rejected session cleanup */
919 s = session_get (new_si, new_ti);
920 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
928 typedef union session_switch_pool_reply_args_
937 } session_switch_pool_reply_args_t;
939 STATIC_ASSERT (sizeof (session_switch_pool_reply_args_t) <= sizeof (uword),
940 "switch pool reply args size");
943 session_switch_pool_reply (void *arg)
945 session_switch_pool_reply_args_t rargs;
948 rargs.as_u64 = pointer_to_uword (arg);
949 s = session_get_if_valid (rargs.session_index, rargs.thread_index);
953 /* Session closed during migration. Clean everything up */
956 transport_cleanup (session_get_transport_proto (s), s->connection_index,
958 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
963 /* Notify app that it has data on the new session */
964 session_enqueue_notify (s);
967 typedef struct _session_switch_pool_args
971 u32 new_thread_index;
972 u32 new_session_index;
973 } session_switch_pool_args_t;
976 * Notify old thread of the session pool switch
979 session_switch_pool (void *cb_args)
981 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
982 session_switch_pool_reply_args_t rargs;
983 session_handle_t new_sh;
984 segment_manager_t *sm;
985 app_worker_t *app_wrk;
988 ASSERT (args->thread_index == vlib_get_thread_index ());
989 s = session_get (args->session_index, args->thread_index);
991 /* Check if session closed during migration */
992 rargs.is_closed = s->session_state >= SESSION_STATE_TRANSPORT_CLOSING;
994 transport_cleanup (session_get_transport_proto (s), s->connection_index,
997 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1000 /* Cleanup fifo segment slice state for fifos */
1001 sm = app_worker_get_connect_segment_manager (app_wrk);
1002 segment_manager_detach_fifo (sm, &s->rx_fifo);
1003 segment_manager_detach_fifo (sm, &s->tx_fifo);
1005 /* Notify app, using old session, about the migration event */
1006 if (!rargs.is_closed)
1008 new_sh = session_make_handle (args->new_session_index,
1009 args->new_thread_index);
1010 app_worker_migrate_notify (app_wrk, s, new_sh);
1014 /* Trigger app read and fifo updates on the new thread */
1015 rargs.session_index = args->new_session_index;
1016 rargs.thread_index = args->new_thread_index;
1017 session_send_rpc_evt_to_thread (args->new_thread_index,
1018 session_switch_pool_reply,
1019 uword_to_pointer (rargs.as_u64, void *));
1022 clib_mem_free (cb_args);
1026 * Move dgram session to the right thread
1029 session_dgram_connect_notify (transport_connection_t * tc,
1030 u32 old_thread_index, session_t ** new_session)
1033 session_switch_pool_args_t *rpc_args;
1034 segment_manager_t *sm;
1035 app_worker_t *app_wrk;
1038 * Clone half-open session to the right thread.
1040 new_s = session_clone_safe (tc->s_index, old_thread_index);
1041 new_s->connection_index = tc->c_index;
1042 session_set_state (new_s, SESSION_STATE_READY);
1043 new_s->flags |= SESSION_F_IS_MIGRATING;
1045 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1046 session_lookup_add_connection (tc, session_handle (new_s));
1048 app_wrk = app_worker_get_if_valid (new_s->app_wrk_index);
1051 /* New set of fifos attached to the same shared memory */
1052 sm = app_worker_get_connect_segment_manager (app_wrk);
1053 segment_manager_attach_fifo (sm, &new_s->rx_fifo, new_s);
1054 segment_manager_attach_fifo (sm, &new_s->tx_fifo, new_s);
1058 * Ask thread owning the old session to clean it up and make us the tx
1061 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
1062 rpc_args->new_session_index = new_s->session_index;
1063 rpc_args->new_thread_index = new_s->thread_index;
1064 rpc_args->session_index = tc->s_index;
1065 rpc_args->thread_index = old_thread_index;
1066 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
1069 tc->s_index = new_s->session_index;
1070 new_s->connection_index = tc->c_index;
1071 *new_session = new_s;
1076 * Notification from transport that connection is being closed.
1078 * A disconnect is sent to application but state is not removed. Once
1079 * disconnect is acknowledged by application, session disconnect is called.
1080 * Ultimately this leads to close being called on transport (passive close).
1083 session_transport_closing_notify (transport_connection_t * tc)
1085 app_worker_t *app_wrk;
1088 s = session_get (tc->s_index, tc->thread_index);
1089 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1092 /* Wait for reply from app before sending notification as the
1093 * accept might be rejected */
1094 if (s->session_state == SESSION_STATE_ACCEPTING)
1096 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1100 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1101 app_wrk = app_worker_get (s->app_wrk_index);
1102 app_worker_close_notify (app_wrk, s);
1106 * Notification from transport that connection is being deleted
1108 * This removes the session if it is still valid. It should be called only on
1109 * previously fully established sessions. For instance failed connects should
1110 * call stream_session_connect_notify and indicate that the connect has
1114 session_transport_delete_notify (transport_connection_t * tc)
1118 /* App might've been removed already */
1119 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1122 switch (s->session_state)
1124 case SESSION_STATE_CREATED:
1125 /* Session was created but accept notification was not yet sent to the
1126 * app. Cleanup everything. */
1127 session_lookup_del_session (s);
1128 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1131 case SESSION_STATE_ACCEPTING:
1132 case SESSION_STATE_TRANSPORT_CLOSING:
1133 case SESSION_STATE_CLOSING:
1134 case SESSION_STATE_TRANSPORT_CLOSED:
1135 /* If transport finishes or times out before we get a reply
1136 * from the app, mark transport as closed and wait for reply
1137 * before removing the session. Cleanup session table in advance
1138 * because transport will soon be closed and closed sessions
1139 * are assumed to have been removed from the lookup table */
1140 session_lookup_del_session (s);
1141 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1142 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1143 svm_fifo_dequeue_drop_all (s->tx_fifo);
1145 case SESSION_STATE_APP_CLOSED:
1146 /* Cleanup lookup table as transport needs to still be valid.
1147 * Program transport close to ensure that all session events
1148 * have been cleaned up. Once transport close is called, the
1149 * session is just removed because both transport and app have
1150 * confirmed the close*/
1151 session_lookup_del_session (s);
1152 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1153 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1154 svm_fifo_dequeue_drop_all (s->tx_fifo);
1155 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1157 case SESSION_STATE_TRANSPORT_DELETED:
1159 case SESSION_STATE_CLOSED:
1160 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1164 clib_warning ("session state %u", s->session_state);
1165 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1172 * Notification from transport that it is closed
1174 * Should be called by transport, prior to calling delete notify, once it
1175 * knows that no more data will be exchanged. This could serve as an
1176 * early acknowledgment of an active close especially if transport delete
1177 * can be delayed a long time, e.g., tcp time-wait.
1180 session_transport_closed_notify (transport_connection_t * tc)
1182 app_worker_t *app_wrk;
1185 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1188 /* Transport thinks that app requested close but it actually didn't.
1189 * Can happen for tcp:
1190 * 1)if fin and rst are received in close succession.
1191 * 2)if app shutdown the connection. */
1192 if (s->session_state == SESSION_STATE_READY)
1194 session_transport_closing_notify (tc);
1195 svm_fifo_dequeue_drop_all (s->tx_fifo);
1196 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSED);
1198 /* If app close has not been received or has not yet resulted in
1199 * a transport close, only mark the session transport as closed */
1200 else if (s->session_state <= SESSION_STATE_CLOSING)
1201 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSED);
1202 /* If app also closed, switch to closed */
1203 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1204 session_set_state (s, SESSION_STATE_CLOSED);
1206 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1208 app_worker_transport_closed_notify (app_wrk, s);
1212 * Notify application that connection has been reset.
1215 session_transport_reset_notify (transport_connection_t * tc)
1217 app_worker_t *app_wrk;
1220 s = session_get (tc->s_index, tc->thread_index);
1221 svm_fifo_dequeue_drop_all (s->tx_fifo);
1222 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1224 if (s->session_state == SESSION_STATE_ACCEPTING)
1226 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1229 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1230 app_wrk = app_worker_get (s->app_wrk_index);
1231 app_worker_reset_notify (app_wrk, s);
1235 session_stream_accept_notify (transport_connection_t * tc)
1237 app_worker_t *app_wrk;
1240 s = session_get (tc->s_index, tc->thread_index);
1241 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1244 if (s->session_state != SESSION_STATE_CREATED)
1246 session_set_state (s, SESSION_STATE_ACCEPTING);
1247 if (app_worker_accept_notify (app_wrk, s))
1249 /* On transport delete, no notifications should be sent. Unless, the
1250 * accept is retried and successful. */
1251 session_set_state (s, SESSION_STATE_CREATED);
1258 * Accept a stream session. Optionally ping the server by callback.
1261 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1262 u32 thread_index, u8 notify)
1267 s = session_alloc_for_connection (tc);
1268 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1269 session_set_state (s, SESSION_STATE_CREATED);
1271 if ((rv = app_worker_init_accepted (s)))
1277 session_lookup_add_connection (tc, session_handle (s));
1279 /* Shoulder-tap the server */
1282 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1283 if ((rv = app_worker_accept_notify (app_wrk, s)))
1285 session_lookup_del_session (s);
1286 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1296 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1299 app_worker_t *app_wrk;
1303 s = session_alloc_for_connection (tc);
1304 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1306 if ((rv = app_worker_init_accepted (s)))
1312 session_lookup_add_connection (tc, session_handle (s));
1313 session_set_state (s, SESSION_STATE_ACCEPTING);
1315 app_wrk = app_worker_get (s->app_wrk_index);
1316 if ((rv = app_worker_accept_notify (app_wrk, s)))
1318 session_lookup_del_session (s);
1319 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1328 session_open_cl (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1330 transport_connection_t *tc;
1331 transport_endpoint_cfg_t *tep;
1332 app_worker_t *app_wrk;
1333 session_handle_t sh;
1337 tep = session_endpoint_to_transport_cfg (rmt);
1338 rv = transport_connect (rmt->transport_proto, tep);
1341 SESSION_DBG ("Transport failed to open connection.");
1345 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1347 /* For dgram type of service, allocate session and fifos now */
1348 app_wrk = app_worker_get (rmt->app_wrk_index);
1349 s = session_alloc_for_connection (tc);
1350 s->app_wrk_index = app_wrk->wrk_index;
1351 session_set_state (s, SESSION_STATE_OPENED);
1352 if (app_worker_init_connected (app_wrk, s))
1358 sh = session_handle (s);
1361 session_lookup_add_connection (tc, sh);
1362 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, rmt->opaque);
1366 session_open_vc (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1368 transport_connection_t *tc;
1369 transport_endpoint_cfg_t *tep;
1370 app_worker_t *app_wrk;
1374 tep = session_endpoint_to_transport_cfg (rmt);
1375 rv = transport_connect (rmt->transport_proto, tep);
1378 SESSION_DBG ("Transport failed to open connection.");
1382 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1384 app_wrk = app_worker_get (rmt->app_wrk_index);
1386 /* If transport offers a vc service, only allocate established
1387 * session once the connection has been established.
1388 * In the meantime allocate half-open session for tracking purposes
1389 * associate half-open connection to it and add session to app-worker
1390 * half-open table. These are needed to allocate the established
1391 * session on transport notification, and to cleanup the half-open
1392 * session if the app detaches before connection establishment.
1394 ho = session_alloc_for_half_open (tc);
1395 ho->app_wrk_index = app_wrk->wrk_index;
1396 ho->ho_index = app_worker_add_half_open (app_wrk, session_handle (ho));
1397 ho->opaque = rmt->opaque;
1398 *rsh = session_handle (ho);
1400 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1401 session_lookup_add_half_open (tc, tc->c_index);
1407 session_open_app (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1409 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (rmt);
1411 /* Not supported for now */
1412 *rsh = SESSION_INVALID_HANDLE;
1413 return transport_connect (rmt->transport_proto, tep_cfg);
1416 typedef int (*session_open_service_fn) (session_endpoint_cfg_t *,
1417 session_handle_t *);
1420 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1428 * Ask transport to open connection to remote transport endpoint.
1430 * Stores handle for matching request with reply since the call can be
1431 * asynchronous. For instance, for TCP the 3-way handshake must complete
1432 * before reply comes. Session is only created once connection is established.
1434 * @param app_index Index of the application requesting the connect
1435 * @param st Session type requested.
1436 * @param tep Remote transport endpoint
1437 * @param opaque Opaque data (typically, api_context) the application expects
1438 * on open completion.
1441 session_open (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1443 transport_service_type_t tst;
1444 tst = transport_protocol_service_type (rmt->transport_proto);
1445 return session_open_srv_fns[tst](rmt, rsh);
1449 * Ask transport to listen on session endpoint.
1451 * @param s Session for which listen will be called. Note that unlike
1452 * established sessions, listen sessions are not associated to a
1454 * @param sep Local endpoint to be listened on.
1457 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1459 transport_endpoint_cfg_t *tep;
1463 /* Transport bind/listen */
1464 tep = session_endpoint_to_transport_cfg (sep);
1465 s_index = ls->session_index;
1466 tc_index = transport_start_listen (session_get_transport_proto (ls),
1472 /* Attach transport to session. Lookup tables are populated by the app
1473 * worker because local tables (for ct sessions) are not backed by a fib */
1474 ls = listen_session_get (s_index);
1475 ls->connection_index = tc_index;
1476 ls->opaque = sep->opaque;
1482 * Ask transport to stop listening on local transport endpoint.
1484 * @param s Session to stop listening on. It must be in state LISTENING.
1487 session_stop_listen (session_t * s)
1489 transport_proto_t tp = session_get_transport_proto (s);
1490 transport_connection_t *tc;
1492 if (s->session_state != SESSION_STATE_LISTENING)
1493 return SESSION_E_NOLISTEN;
1495 tc = transport_get_listener (tp, s->connection_index);
1497 /* If no transport, assume everything was cleaned up already */
1499 return SESSION_E_NONE;
1501 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1502 session_lookup_del_connection (tc);
1504 transport_stop_listen (tp, s->connection_index);
1509 * Initialize session half-closing procedure.
1511 * Note that half-closing will not change the state of the session.
1514 session_half_close (session_t *s)
1519 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_HALF_CLOSE);
1523 * Initialize session closing procedure.
1525 * Request is always sent to session node to ensure that all outstanding
1526 * requests are served before transport is notified.
1529 session_close (session_t * s)
1531 if (!s || (s->flags & SESSION_F_APP_CLOSED))
1534 /* Transports can close and delete their state independent of app closes
1535 * and transport initiated state transitions can hide app closes. Instead
1536 * of extending the state machine to support separate tracking of app and
1537 * transport initiated closes, use a flag. */
1538 s->flags |= SESSION_F_APP_CLOSED;
1540 if (s->session_state >= SESSION_STATE_CLOSING)
1542 /* Session will only be removed once both app and transport
1543 * acknowledge the close */
1544 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1545 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1546 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1550 /* App closed so stop propagating dequeue notifications.
1551 * App might disconnect session before connected, in this case,
1552 * tx_fifo may not be setup yet, so clear only it's inited. */
1554 svm_fifo_clear_deq_ntf (s->tx_fifo);
1555 session_set_state (s, SESSION_STATE_CLOSING);
1556 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1560 * Force a close without waiting for data to be flushed
1563 session_reset (session_t * s)
1565 if (s->session_state >= SESSION_STATE_CLOSING)
1567 /* Drop all outstanding tx data
1568 * App might disconnect session before connected, in this case,
1569 * tx_fifo may not be setup yet, so clear only it's inited. */
1571 svm_fifo_dequeue_drop_all (s->tx_fifo);
1572 session_set_state (s, SESSION_STATE_CLOSING);
1573 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1577 * Notify transport the session can be half-disconnected.
1579 * Must be called from the session's thread.
1582 session_transport_half_close (session_t *s)
1584 /* Only READY session can be half-closed */
1585 if (s->session_state != SESSION_STATE_READY)
1590 transport_half_close (session_get_transport_proto (s), s->connection_index,
1595 * Notify transport the session can be disconnected. This should eventually
1596 * result in a delete notification that allows us to cleanup session state.
1597 * Called for both active/passive disconnects.
1599 * Must be called from the session's thread.
1602 session_transport_close (session_t * s)
1604 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1606 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1607 session_set_state (s, SESSION_STATE_CLOSED);
1608 /* If transport is already deleted, just free the session */
1609 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1610 session_free_w_fifos (s);
1614 /* If the tx queue wasn't drained, the transport can continue to try
1615 * sending the outstanding data (in closed state it cannot). It MUST however
1616 * at one point, either after sending everything or after a timeout, call
1617 * delete notify. This will finally lead to the complete cleanup of the
1620 session_set_state (s, SESSION_STATE_APP_CLOSED);
1622 transport_close (session_get_transport_proto (s), s->connection_index,
1627 * Force transport close
1630 session_transport_reset (session_t * s)
1632 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1634 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1635 session_set_state (s, SESSION_STATE_CLOSED);
1636 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1637 session_free_w_fifos (s);
1641 session_set_state (s, SESSION_STATE_APP_CLOSED);
1642 transport_reset (session_get_transport_proto (s), s->connection_index,
1647 * Cleanup transport and session state.
1649 * Notify transport of the cleanup and free the session. This should
1650 * be called only if transport reported some error and is already
1654 session_transport_cleanup (session_t * s)
1656 /* Delete from main lookup table before we axe the the transport */
1657 session_lookup_del_session (s);
1658 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1659 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1661 /* Since we called cleanup, no delete notification will come. So, make
1662 * sure the session is properly freed. */
1663 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1668 * Allocate worker mqs in share-able segment
1670 * That can only be a newly created memfd segment, that must be mapped
1671 * by all apps/stack users unless private rx mqs are enabled.
1674 session_vpp_wrk_mqs_alloc (session_main_t *smm)
1676 u32 mq_q_length = 2048, evt_size = sizeof (session_event_t);
1677 fifo_segment_t *mqs_seg = &smm->wrk_mqs_segment;
1678 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1682 mq_q_length = clib_max (mq_q_length, smm->configured_wrk_mq_length);
1684 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1685 { mq_q_length, evt_size, 0 }, { mq_q_length >> 1, 256, 0 }
1687 cfg->consumer_pid = 0;
1689 cfg->q_nitems = mq_q_length;
1690 cfg->ring_cfgs = rc;
1693 * Compute mqs segment size based on rings config and leave space
1694 * for passing extended configuration messages, i.e., data allocated
1695 * outside of the rings. If provided with a config value, accept it
1696 * if larger than minimum size.
1698 mqs_seg_size = svm_msg_q_size_to_alloc (cfg) * vec_len (smm->wrk);
1699 mqs_seg_size = mqs_seg_size + (1 << 20);
1700 mqs_seg_size = clib_max (mqs_seg_size, smm->wrk_mqs_segment_size);
1702 mqs_seg->ssvm.ssvm_size = mqs_seg_size;
1703 mqs_seg->ssvm.my_pid = getpid ();
1704 mqs_seg->ssvm.name = format (0, "%s%c", "session: wrk-mqs-segment", 0);
1706 if (ssvm_server_init (&mqs_seg->ssvm, SSVM_SEGMENT_MEMFD))
1708 clib_warning ("failed to initialize queue segment");
1712 fifo_segment_init (mqs_seg);
1714 /* Special fifo segment that's filled only with mqs */
1715 mqs_seg->h->n_mqs = vec_len (smm->wrk);
1717 for (i = 0; i < vec_len (smm->wrk); i++)
1718 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (mqs_seg, i, cfg);
1722 session_main_get_wrk_mqs_segment (void)
1724 return &session_main.wrk_mqs_segment;
1728 session_segment_handle (session_t * s)
1733 return SESSION_INVALID_HANDLE;
1736 return segment_manager_make_segment_handle (f->segment_manager,
1741 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1742 session_tx_fifo_peek_and_snd,
1743 session_tx_fifo_dequeue_and_snd,
1744 session_tx_fifo_dequeue_internal,
1745 session_tx_fifo_dequeue_and_snd
1750 session_register_transport (transport_proto_t transport_proto,
1751 const transport_proto_vft_t * vft, u8 is_ip4,
1754 session_main_t *smm = &session_main;
1755 session_type_t session_type;
1756 u32 next_index = ~0;
1758 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1760 vec_validate (smm->session_type_to_next, session_type);
1761 vec_validate (smm->session_tx_fns, session_type);
1763 if (output_node != ~0)
1764 next_index = vlib_node_add_next (vlib_get_main (),
1765 session_queue_node.index, output_node);
1767 smm->session_type_to_next[session_type] = next_index;
1768 smm->session_tx_fns[session_type] =
1769 session_tx_fns[vft->transport_options.tx_type];
1773 session_register_update_time_fn (session_update_time_fn fn, u8 is_add)
1775 session_main_t *smm = &session_main;
1776 session_update_time_fn *fi;
1780 vec_foreach (fi, smm->update_time_fns)
1784 fi_pos = fi - smm->update_time_fns;
1794 clib_warning ("update time fn %p already registered", fn);
1797 vec_add1 (smm->update_time_fns, fn);
1801 vec_del1 (smm->update_time_fns, fi_pos);
1806 session_add_transport_proto (void)
1808 session_main_t *smm = &session_main;
1809 session_worker_t *wrk;
1812 smm->last_transport_proto_type += 1;
1814 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1816 wrk = session_main_get_worker (thread);
1817 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1820 return smm->last_transport_proto_type;
1823 transport_connection_t *
1824 session_get_transport (session_t * s)
1826 if (s->session_state != SESSION_STATE_LISTENING)
1827 return transport_get_connection (session_get_transport_proto (s),
1828 s->connection_index, s->thread_index);
1830 return transport_get_listener (session_get_transport_proto (s),
1831 s->connection_index);
1835 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1837 if (s->session_state != SESSION_STATE_LISTENING)
1838 return transport_get_endpoint (session_get_transport_proto (s),
1839 s->connection_index, s->thread_index, tep,
1842 return transport_get_listener_endpoint (session_get_transport_proto (s),
1843 s->connection_index, tep, is_lcl);
1847 session_transport_attribute (session_t *s, u8 is_get,
1848 transport_endpt_attr_t *attr)
1850 if (s->session_state < SESSION_STATE_READY)
1853 return transport_connection_attribute (session_get_transport_proto (s),
1854 s->connection_index, s->thread_index,
1858 transport_connection_t *
1859 listen_session_get_transport (session_t * s)
1861 return transport_get_listener (session_get_transport_proto (s),
1862 s->connection_index);
1866 session_queue_run_on_main_thread (vlib_main_t * vm)
1868 ASSERT (vlib_get_thread_index () == 0);
1869 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1873 session_stats_collector_fn (vlib_stats_collector_data_t *d)
1875 u32 i, n_workers, n_wrk_sessions, n_sessions = 0;
1876 session_main_t *smm = &session_main;
1877 session_worker_t *wrk;
1878 counter_t **counters;
1881 n_workers = vec_len (smm->wrk);
1882 vlib_stats_validate (d->entry_index, 0, n_workers - 1);
1883 counters = d->entry->data;
1886 for (i = 0; i < vec_len (smm->wrk); i++)
1888 wrk = session_main_get_worker (i);
1889 n_wrk_sessions = pool_elts (wrk->sessions);
1890 cb[i] = n_wrk_sessions;
1891 n_sessions += n_wrk_sessions;
1894 vlib_stats_set_gauge (d->private_data, n_sessions);
1898 session_stats_collector_init (void)
1900 vlib_stats_collector_reg_t reg = {};
1903 vlib_stats_add_counter_vector ("/sys/session/sessions_per_worker");
1904 reg.private_data = vlib_stats_add_gauge ("/sys/session/sessions_total");
1905 reg.collect_fn = session_stats_collector_fn;
1906 vlib_stats_register_collector_fn (®);
1907 vlib_stats_validate (reg.entry_index, 0, vlib_get_n_threads ());
1910 static clib_error_t *
1911 session_manager_main_enable (vlib_main_t * vm)
1913 session_main_t *smm = &session_main;
1914 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1915 u32 num_threads, preallocated_sessions_per_worker;
1916 session_worker_t *wrk;
1919 /* We only initialize once and do not de-initialized on disable */
1920 if (smm->is_initialized)
1923 num_threads = 1 /* main thread */ + vtm->n_threads;
1925 if (num_threads < 1)
1926 return clib_error_return (0, "n_thread_stacks not set");
1928 /* Allocate cache line aligned worker contexts */
1929 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1930 clib_spinlock_init (&session_main.pool_realloc_lock);
1932 for (i = 0; i < num_threads; i++)
1935 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1936 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1937 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1938 wrk->pending_connects = clib_llist_make_head (wrk->event_elts, evt_list);
1939 wrk->evts_pending_main =
1940 clib_llist_make_head (wrk->event_elts, evt_list);
1941 wrk->vm = vlib_get_main_by_index (i);
1942 wrk->last_vlib_time = vlib_time_now (vm);
1943 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1945 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1947 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1948 session_wrk_enable_adaptive_mode (wrk);
1951 /* Allocate vpp event queues segment and queue */
1952 session_vpp_wrk_mqs_alloc (smm);
1954 /* Initialize segment manager properties */
1955 segment_manager_main_init ();
1957 /* Preallocate sessions */
1958 if (smm->preallocated_sessions)
1960 if (num_threads == 1)
1962 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1967 preallocated_sessions_per_worker =
1968 (1.1 * (f64) smm->preallocated_sessions /
1969 (f64) (num_threads - 1));
1971 for (j = 1; j < num_threads; j++)
1973 pool_init_fixed (smm->wrk[j].sessions,
1974 preallocated_sessions_per_worker);
1979 session_lookup_init ();
1980 app_namespaces_init ();
1982 session_stats_collector_init ();
1983 smm->is_initialized = 1;
1987 smm->is_enabled = 1;
1989 /* Enable transports */
1990 transport_enable_disable (vm, 1);
1991 session_debug_init ();
1997 session_manager_main_disable (vlib_main_t * vm)
1999 transport_enable_disable (vm, 0 /* is_en */ );
2002 /* in this new callback, cookie hint the index */
2004 session_dma_completion_cb (vlib_main_t *vm, struct vlib_dma_batch *batch)
2006 session_worker_t *wrk;
2007 wrk = session_main_get_worker (vm->thread_index);
2008 session_dma_transfer *dma_transfer;
2010 dma_transfer = &wrk->dma_trans[wrk->trans_head];
2011 vec_add (wrk->pending_tx_buffers, dma_transfer->pending_tx_buffers,
2012 vec_len (dma_transfer->pending_tx_buffers));
2013 vec_add (wrk->pending_tx_nexts, dma_transfer->pending_tx_nexts,
2014 vec_len (dma_transfer->pending_tx_nexts));
2015 vec_reset_length (dma_transfer->pending_tx_buffers);
2016 vec_reset_length (dma_transfer->pending_tx_nexts);
2018 if (wrk->trans_head == wrk->trans_size)
2019 wrk->trans_head = 0;
2024 session_prepare_dma_args (vlib_dma_config_t *args)
2026 args->max_transfers = DMA_TRANS_SIZE;
2027 args->max_transfer_size = 65536;
2029 args->sw_fallback = 1;
2030 args->barrier_before_last = 1;
2031 args->callback_fn = session_dma_completion_cb;
2035 session_node_enable_dma (u8 is_en, int n_vlibs)
2037 vlib_dma_config_t args;
2038 session_prepare_dma_args (&args);
2039 session_worker_t *wrk;
2042 int config_index = -1;
2046 vm = vlib_get_main_by_index (0);
2047 config_index = vlib_dma_config_add (vm, &args);
2051 vm = vlib_get_main_by_index (0);
2052 wrk = session_main_get_worker (0);
2053 if (wrk->config_index >= 0)
2054 vlib_dma_config_del (vm, wrk->config_index);
2057 for (i = 0; i < n_vlibs; i++)
2059 vm = vlib_get_main_by_index (i);
2060 wrk = session_main_get_worker (vm->thread_index);
2061 wrk->config_index = config_index;
2064 if (config_index >= 0)
2065 wrk->dma_enabled = true;
2066 wrk->dma_trans = (session_dma_transfer *) clib_mem_alloc (
2067 sizeof (session_dma_transfer) * DMA_TRANS_SIZE);
2068 bzero (wrk->dma_trans,
2069 sizeof (session_dma_transfer) * DMA_TRANS_SIZE);
2074 clib_mem_free (wrk->dma_trans);
2076 wrk->trans_head = 0;
2077 wrk->trans_tail = 0;
2078 wrk->trans_size = DMA_TRANS_SIZE;
2083 session_node_enable_disable (u8 is_en)
2085 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
2086 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
2087 session_main_t *sm = &session_main;
2092 n_vlibs = vlib_get_n_threads ();
2093 for (i = 0; i < n_vlibs; i++)
2095 vm = vlib_get_main_by_index (i);
2096 /* main thread with workers and not polling */
2097 if (i == 0 && n_vlibs > 1)
2099 vlib_node_set_state (vm, session_queue_node.index, mstate);
2102 session_main_get_worker (0)->state = SESSION_WRK_INTERRUPT;
2103 vlib_node_set_state (vm, session_queue_process_node.index,
2105 n = vlib_get_node (vm, session_queue_process_node.index);
2106 vlib_start_process (vm, n->runtime_index);
2110 vlib_process_signal_event_mt (vm,
2111 session_queue_process_node.index,
2112 SESSION_Q_PROCESS_STOP, 0);
2117 vlib_node_set_state (vm, session_queue_node.index, state);
2120 if (sm->use_private_rx_mqs)
2121 application_enable_rx_mqs_nodes (is_en);
2123 if (sm->dma_enabled)
2124 session_node_enable_dma (is_en, n_vlibs);
2128 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
2130 clib_error_t *error = 0;
2133 if (session_main.is_enabled)
2136 error = session_manager_main_enable (vm);
2137 session_node_enable_disable (is_en);
2141 session_main.is_enabled = 0;
2142 session_manager_main_disable (vm);
2143 session_node_enable_disable (is_en);
2150 session_main_init (vlib_main_t * vm)
2152 session_main_t *smm = &session_main;
2154 smm->is_enabled = 0;
2155 smm->session_enable_asap = 0;
2157 smm->use_private_rx_mqs = 0;
2158 smm->no_adaptive = 0;
2159 smm->last_transport_proto_type = TRANSPORT_PROTO_HTTP;
2164 static clib_error_t *
2165 session_main_loop_init (vlib_main_t * vm)
2167 session_main_t *smm = &session_main;
2168 if (smm->session_enable_asap)
2170 vlib_worker_thread_barrier_sync (vm);
2171 vnet_session_enable_disable (vm, 1 /* is_en */ );
2172 vlib_worker_thread_barrier_release (vm);
2177 VLIB_INIT_FUNCTION (session_main_init);
2178 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
2180 static clib_error_t *
2181 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
2183 session_main_t *smm = &session_main;
2187 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2189 if (unformat (input, "wrk-mq-length %d", &nitems))
2192 smm->configured_wrk_mq_length = nitems;
2194 clib_warning ("event queue length %d too small, ignored", nitems);
2196 else if (unformat (input, "wrk-mqs-segment-size %U",
2197 unformat_memory_size, &smm->wrk_mqs_segment_size))
2199 else if (unformat (input, "preallocated-sessions %d",
2200 &smm->preallocated_sessions))
2202 else if (unformat (input, "v4-session-table-buckets %d",
2203 &smm->configured_v4_session_table_buckets))
2205 else if (unformat (input, "v4-halfopen-table-buckets %d",
2206 &smm->configured_v4_halfopen_table_buckets))
2208 else if (unformat (input, "v6-session-table-buckets %d",
2209 &smm->configured_v6_session_table_buckets))
2211 else if (unformat (input, "v6-halfopen-table-buckets %d",
2212 &smm->configured_v6_halfopen_table_buckets))
2214 else if (unformat (input, "v4-session-table-memory %U",
2215 unformat_memory_size, &tmp))
2217 if (tmp >= 0x100000000)
2218 return clib_error_return (0, "memory size %llx (%lld) too large",
2220 smm->configured_v4_session_table_memory = tmp;
2222 else if (unformat (input, "v4-halfopen-table-memory %U",
2223 unformat_memory_size, &tmp))
2225 if (tmp >= 0x100000000)
2226 return clib_error_return (0, "memory size %llx (%lld) too large",
2228 smm->configured_v4_halfopen_table_memory = tmp;
2230 else if (unformat (input, "v6-session-table-memory %U",
2231 unformat_memory_size, &tmp))
2233 if (tmp >= 0x100000000)
2234 return clib_error_return (0, "memory size %llx (%lld) too large",
2236 smm->configured_v6_session_table_memory = tmp;
2238 else if (unformat (input, "v6-halfopen-table-memory %U",
2239 unformat_memory_size, &tmp))
2241 if (tmp >= 0x100000000)
2242 return clib_error_return (0, "memory size %llx (%lld) too large",
2244 smm->configured_v6_halfopen_table_memory = tmp;
2246 else if (unformat (input, "local-endpoints-table-memory %U",
2247 unformat_memory_size, &tmp))
2249 if (tmp >= 0x100000000)
2250 return clib_error_return (0, "memory size %llx (%lld) too large",
2252 smm->local_endpoints_table_memory = tmp;
2254 else if (unformat (input, "local-endpoints-table-buckets %d",
2255 &smm->local_endpoints_table_buckets))
2257 else if (unformat (input, "enable"))
2258 smm->session_enable_asap = 1;
2259 else if (unformat (input, "use-app-socket-api"))
2260 (void) appns_sapi_enable_disable (1 /* is_enable */);
2261 else if (unformat (input, "poll-main"))
2263 else if (unformat (input, "use-private-rx-mqs"))
2264 smm->use_private_rx_mqs = 1;
2265 else if (unformat (input, "no-adaptive"))
2266 smm->no_adaptive = 1;
2267 else if (unformat (input, "use-dma"))
2268 smm->dma_enabled = 1;
2270 * Deprecated but maintained for compatibility
2272 else if (unformat (input, "evt_qs_memfd_seg"))
2274 else if (unformat (input, "segment-baseva 0x%lx", &tmp))
2276 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
2277 &smm->wrk_mqs_segment_size))
2279 else if (unformat (input, "event-queue-length %d", &nitems))
2282 smm->configured_wrk_mq_length = nitems;
2284 clib_warning ("event queue length %d too small, ignored", nitems);
2287 return clib_error_return (0, "unknown input `%U'",
2288 format_unformat_error, input);
2293 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2296 * fd.io coding-style-patch-verification: ON
2299 * eval: (c-set-style "gnu")