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>
25 session_main_t session_main;
28 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
29 session_evt_type_t evt_type)
31 session_worker_t *wrk = session_main_get_worker (thread_index);
36 mq = wrk->vpp_event_queue;
37 if (PREDICT_FALSE (svm_msg_q_lock (mq)))
39 if (PREDICT_FALSE (svm_msg_q_is_full (mq)
40 || svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
42 svm_msg_q_unlock (mq);
47 case SESSION_CTRL_EVT_RPC:
48 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
49 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
50 evt->rpc_args.fp = data;
51 evt->rpc_args.arg = args;
53 case SESSION_IO_EVT_RX:
54 case SESSION_IO_EVT_TX:
55 case SESSION_IO_EVT_TX_FLUSH:
56 case SESSION_IO_EVT_BUILTIN_RX:
57 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
58 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
59 evt->session_index = *(u32 *) data;
61 case SESSION_IO_EVT_BUILTIN_TX:
62 case SESSION_CTRL_EVT_CLOSE:
63 case SESSION_CTRL_EVT_RESET:
64 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
65 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
66 evt->session_handle = session_handle ((session_t *) data);
69 clib_warning ("evt unhandled!");
70 svm_msg_q_unlock (mq);
73 evt->event_type = evt_type;
75 svm_msg_q_add_and_unlock (mq, &msg);
77 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
78 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
84 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
86 return session_send_evt_to_thread (&f->shr->master_session_index, 0,
87 f->master_thread_index, evt_type);
91 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
92 session_evt_type_t evt_type)
94 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
98 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
100 /* only events supported are disconnect, shutdown and reset */
101 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE ||
102 evt_type == SESSION_CTRL_EVT_HALF_CLOSE ||
103 evt_type == SESSION_CTRL_EVT_RESET);
104 return session_send_evt_to_thread (s, 0, s->thread_index, evt_type);
108 session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
111 session_send_evt_to_thread (fp, rpc_args, thread_index,
112 SESSION_CTRL_EVT_RPC);
116 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
118 if (thread_index != vlib_get_thread_index ())
119 session_send_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
122 void (*fnp) (void *) = fp;
128 session_add_self_custom_tx_evt (transport_connection_t * tc, u8 has_prio)
130 session_t *s = session_get (tc->s_index, tc->thread_index);
132 ASSERT (s->thread_index == vlib_get_thread_index ());
133 ASSERT (s->session_state != SESSION_STATE_TRANSPORT_DELETED);
135 if (!(s->flags & SESSION_F_CUSTOM_TX))
137 s->flags |= SESSION_F_CUSTOM_TX;
138 if (svm_fifo_set_event (s->tx_fifo)
139 || transport_connection_is_descheduled (tc))
141 session_evt_elt_t *elt;
142 session_worker_t *wrk;
144 wrk = session_main_get_worker (tc->thread_index);
146 elt = session_evt_alloc_new (wrk);
148 elt = session_evt_alloc_old (wrk);
149 elt->evt.session_index = tc->s_index;
150 elt->evt.event_type = SESSION_IO_EVT_TX;
151 tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
153 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
154 vlib_node_set_interrupt_pending (wrk->vm,
155 session_queue_node.index);
161 sesssion_reschedule_tx (transport_connection_t * tc)
163 session_worker_t *wrk = session_main_get_worker (tc->thread_index);
164 session_evt_elt_t *elt;
166 ASSERT (tc->thread_index == vlib_get_thread_index ());
168 elt = session_evt_alloc_new (wrk);
169 elt->evt.session_index = tc->s_index;
170 elt->evt.event_type = SESSION_IO_EVT_TX;
172 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
173 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
177 session_program_transport_ctrl_evt (session_t * s, session_evt_type_t evt)
179 u32 thread_index = vlib_get_thread_index ();
180 session_evt_elt_t *elt;
181 session_worker_t *wrk;
183 /* If we are in the handler thread, or being called with the worker barrier
184 * held, just append a new event to pending disconnects vector. */
185 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
187 wrk = session_main_get_worker (s->thread_index);
188 elt = session_evt_alloc_ctrl (wrk);
189 clib_memset (&elt->evt, 0, sizeof (session_event_t));
190 elt->evt.session_handle = session_handle (s);
191 elt->evt.event_type = evt;
193 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
194 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
197 session_send_ctrl_evt_to_thread (s, evt);
201 session_alloc (u32 thread_index)
203 session_worker_t *wrk = &session_main.wrk[thread_index];
206 pool_get_aligned_safe (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
207 clib_memset (s, 0, sizeof (*s));
208 s->session_index = s - wrk->sessions;
209 s->thread_index = thread_index;
210 s->app_index = APP_INVALID_INDEX;
216 session_free (session_t * s)
220 u8 thread_index = s->thread_index;
221 clib_memset (s, 0xFA, sizeof (*s));
222 pool_put (session_main.wrk[thread_index].sessions, s);
225 SESSION_EVT (SESSION_EVT_FREE, s);
226 pool_put (session_main.wrk[s->thread_index].sessions, s);
230 session_is_valid (u32 si, u8 thread_index)
233 transport_connection_t *tc;
235 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
237 if (s->thread_index != thread_index || s->session_index != si)
240 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED
241 || s->session_state <= SESSION_STATE_LISTENING)
244 if (s->session_state == SESSION_STATE_CONNECTING &&
245 (s->flags & SESSION_F_HALF_OPEN))
248 tc = session_get_transport (s);
249 if (s->connection_index != tc->c_index
250 || s->thread_index != tc->thread_index || tc->s_index != si)
257 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
259 app_worker_t *app_wrk;
261 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
264 app_worker_cleanup_notify (app_wrk, s, ntf);
268 session_free_w_fifos (session_t * s)
270 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
271 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
276 * Cleans up session and lookup table.
278 * Transport connection must still be valid.
281 session_delete (session_t * s)
285 /* Delete from the main lookup table. */
286 if ((rv = session_lookup_del_session (s)))
287 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
289 session_free_w_fifos (s);
293 session_cleanup_half_open (session_handle_t ho_handle)
295 session_t *ho = session_get_from_handle (ho_handle);
297 /* App transports can migrate their half-opens */
298 if (ho->flags & SESSION_F_IS_MIGRATING)
300 /* Session still migrating, move to closed state to signal that the
301 * session should be removed. */
302 if (ho->connection_index == ~0)
304 ho->session_state = SESSION_STATE_CLOSED;
307 /* Migrated transports are no longer half-opens */
308 transport_cleanup (session_get_transport_proto (ho),
309 ho->connection_index, ho->app_index /* overloaded */);
312 transport_cleanup_half_open (session_get_transport_proto (ho),
313 ho->connection_index);
318 session_half_open_free (session_t *ho)
320 app_worker_t *app_wrk;
322 ASSERT (vlib_get_thread_index () <= 1);
323 app_wrk = app_worker_get (ho->app_wrk_index);
324 app_worker_del_half_open (app_wrk, ho);
329 session_half_open_free_rpc (void *args)
331 session_t *ho = ho_session_get (pointer_to_uword (args));
332 session_half_open_free (ho);
336 session_half_open_delete_notify (transport_connection_t *tc)
338 /* Notification from ctrl thread accepted without rpc */
339 if (!tc->thread_index)
341 session_half_open_free (ho_session_get (tc->s_index));
345 void *args = uword_to_pointer ((uword) tc->s_index, void *);
346 session_send_rpc_evt_to_thread_force (0, session_half_open_free_rpc,
352 session_half_open_migrate_notify (transport_connection_t *tc)
356 ho = ho_session_get (tc->s_index);
357 ho->flags |= SESSION_F_IS_MIGRATING;
358 ho->connection_index = ~0;
362 session_half_open_migrated_notify (transport_connection_t *tc)
366 ho = ho_session_get (tc->s_index);
368 /* App probably detached so the half-open must be cleaned up */
369 if (ho->session_state == SESSION_STATE_CLOSED)
371 session_half_open_delete_notify (tc);
374 ho->connection_index = tc->c_index;
375 /* Overload app index for half-open with new thread */
376 ho->app_index = tc->thread_index;
381 session_alloc_for_connection (transport_connection_t * tc)
384 u32 thread_index = tc->thread_index;
386 ASSERT (thread_index == vlib_get_thread_index ()
387 || transport_protocol_is_cl (tc->proto));
389 s = session_alloc (thread_index);
390 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
391 s->session_state = SESSION_STATE_CLOSED;
393 /* Attach transport to session and vice versa */
394 s->connection_index = tc->c_index;
395 tc->s_index = s->session_index;
400 session_alloc_for_half_open (transport_connection_t *tc)
404 s = ho_session_alloc ();
405 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
406 s->connection_index = tc->c_index;
407 tc->s_index = s->session_index;
412 * Discards bytes from buffer chain
414 * It discards n_bytes_to_drop starting at first buffer after chain_b
417 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
418 vlib_buffer_t ** chain_b,
421 vlib_buffer_t *next = *chain_b;
422 u32 to_drop = n_bytes_to_drop;
423 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
424 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
426 next = vlib_get_buffer (vm, next->next_buffer);
427 if (next->current_length > to_drop)
429 vlib_buffer_advance (next, to_drop);
434 to_drop -= next->current_length;
435 next->current_length = 0;
441 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
445 * Enqueue buffer chain tail
448 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
449 u32 offset, u8 is_in_order)
451 vlib_buffer_t *chain_b;
452 u32 chain_bi, len, diff;
453 vlib_main_t *vm = vlib_get_main ();
458 if (is_in_order && offset)
460 diff = offset - b->current_length;
461 if (diff > b->total_length_not_including_first_buffer)
464 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
465 chain_bi = vlib_get_buffer_index (vm, chain_b);
468 chain_bi = b->next_buffer;
472 chain_b = vlib_get_buffer (vm, chain_bi);
473 data = vlib_buffer_get_current (chain_b);
474 len = chain_b->current_length;
479 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
486 return (rv > 0) ? (written + rv) : written;
492 /* written more than what was left in chain */
493 if (written > b->total_length_not_including_first_buffer)
496 /* drop the bytes that have already been delivered */
497 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
502 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
505 clib_warning ("failed to enqueue multi-buffer seg");
511 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
512 ? chain_b->next_buffer : 0));
521 session_fifo_tuning (session_t * s, svm_fifo_t * f,
522 session_ft_action_t act, u32 len)
524 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
526 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
527 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
528 if (CLIB_ASSERT_ENABLE)
530 segment_manager_t *sm;
531 sm = segment_manager_get (f->segment_manager);
532 ASSERT (f->shr->size >= 4096);
533 ASSERT (f->shr->size <= sm->max_fifo_size);
539 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
540 * event but on request can queue notification events for later delivery by
541 * calling stream_server_flush_enqueue_events().
543 * @param tc Transport connection which is to be enqueued data
544 * @param b Buffer to be enqueued
545 * @param offset Offset at which to start enqueueing if out-of-order
546 * @param queue_event Flag to indicate if peer is to be notified or if event
547 * is to be queued. The former is useful when more data is
548 * enqueued and only one event is to be generated.
549 * @param is_in_order Flag to indicate if data is in order
550 * @return Number of bytes enqueued or a negative value if enqueueing failed.
553 session_enqueue_stream_connection (transport_connection_t * tc,
554 vlib_buffer_t * b, u32 offset,
555 u8 queue_event, u8 is_in_order)
558 int enqueued = 0, rv, in_order_off;
560 s = session_get (tc->s_index, tc->thread_index);
564 enqueued = svm_fifo_enqueue (s->rx_fifo,
566 vlib_buffer_get_current (b));
567 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
570 in_order_off = enqueued > b->current_length ? enqueued : 0;
571 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
578 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
580 vlib_buffer_get_current (b));
581 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
582 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
583 /* if something was enqueued, report even this as success for ooo
584 * segment handling */
590 /* Queue RX event on this fifo. Eventually these will need to be flushed
591 * by calling stream_server_flush_enqueue_events () */
592 session_worker_t *wrk;
594 wrk = session_main_get_worker (s->thread_index);
595 if (!(s->flags & SESSION_F_RX_EVT))
597 s->flags |= SESSION_F_RX_EVT;
598 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
601 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
608 session_enqueue_dgram_connection (session_t * s,
609 session_dgram_hdr_t * hdr,
610 vlib_buffer_t * b, u8 proto, u8 queue_event)
614 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
615 >= b->current_length + sizeof (*hdr));
617 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
620 svm_fifo_seg_t segs[2] = {
621 { (u8 *) hdr, sizeof (*hdr) },
622 { vlib_buffer_get_current (b), b->current_length }
626 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
627 0 /* allow_partial */ );
631 vlib_main_t *vm = vlib_get_main ();
632 svm_fifo_seg_t *segs = 0, *seg;
633 vlib_buffer_t *it = b;
636 vec_add2 (segs, seg, 1);
637 seg->data = (u8 *) hdr;
638 seg->len = sizeof (*hdr);
641 vec_add2 (segs, seg, 1);
642 seg->data = vlib_buffer_get_current (it);
643 seg->len = it->current_length;
645 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
647 it = vlib_get_buffer (vm, it->next_buffer);
649 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
650 0 /* allow partial */ );
654 if (queue_event && rv > 0)
656 /* Queue RX event on this fifo. Eventually these will need to be flushed
657 * by calling stream_server_flush_enqueue_events () */
658 session_worker_t *wrk;
660 wrk = session_main_get_worker (s->thread_index);
661 if (!(s->flags & SESSION_F_RX_EVT))
663 s->flags |= SESSION_F_RX_EVT;
664 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
667 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
669 return rv > 0 ? rv : 0;
673 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
674 u32 offset, u32 max_bytes)
676 session_t *s = session_get (tc->s_index, tc->thread_index);
677 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
681 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
683 session_t *s = session_get (tc->s_index, tc->thread_index);
686 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
687 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
689 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
690 session_dequeue_notify (s);
696 session_notify_subscribers (u32 app_index, session_t * s,
697 svm_fifo_t * f, session_evt_type_t evt_type)
699 app_worker_t *app_wrk;
703 app = application_get (app_index);
707 for (i = 0; i < f->shr->n_subscribers; i++)
709 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
712 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
720 * Notify session peer that new data has been enqueued.
722 * @param s Stream session for which the event is to be generated.
723 * @param lock Flag to indicate if call should lock message queue.
725 * @return 0 on success or negative number if failed to send notification.
728 session_enqueue_notify_inline (session_t * s)
730 app_worker_t *app_wrk;
734 session_index = s->session_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, vlib_get_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 s->session_state = 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 s->session_state = 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 new_s->session_state = 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 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1100 s->session_state = 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 s->session_state = 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 s->session_state = 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 s->session_state = 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)
1202 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1204 /* If app also closed, switch to closed */
1205 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1206 s->session_state = SESSION_STATE_CLOSED;
1208 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1210 app_worker_transport_closed_notify (app_wrk, s);
1214 * Notify application that connection has been reset.
1217 session_transport_reset_notify (transport_connection_t * tc)
1219 app_worker_t *app_wrk;
1222 s = session_get (tc->s_index, tc->thread_index);
1223 svm_fifo_dequeue_drop_all (s->tx_fifo);
1224 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1226 if (s->session_state == SESSION_STATE_ACCEPTING)
1228 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1231 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1232 app_wrk = app_worker_get (s->app_wrk_index);
1233 app_worker_reset_notify (app_wrk, s);
1237 session_stream_accept_notify (transport_connection_t * tc)
1239 app_worker_t *app_wrk;
1242 s = session_get (tc->s_index, tc->thread_index);
1243 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1246 if (s->session_state != SESSION_STATE_CREATED)
1248 s->session_state = SESSION_STATE_ACCEPTING;
1249 if (app_worker_accept_notify (app_wrk, s))
1251 /* On transport delete, no notifications should be sent. Unless, the
1252 * accept is retried and successful. */
1253 s->session_state = SESSION_STATE_CREATED;
1260 * Accept a stream session. Optionally ping the server by callback.
1263 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1264 u32 thread_index, u8 notify)
1269 s = session_alloc_for_connection (tc);
1270 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1271 s->session_state = SESSION_STATE_CREATED;
1273 if ((rv = app_worker_init_accepted (s)))
1279 session_lookup_add_connection (tc, session_handle (s));
1281 /* Shoulder-tap the server */
1284 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1285 if ((rv = app_worker_accept_notify (app_wrk, s)))
1287 session_lookup_del_session (s);
1288 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1298 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1301 app_worker_t *app_wrk;
1305 s = session_alloc_for_connection (tc);
1306 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1308 if ((rv = app_worker_init_accepted (s)))
1314 session_lookup_add_connection (tc, session_handle (s));
1316 app_wrk = app_worker_get (s->app_wrk_index);
1317 if ((rv = app_worker_accept_notify (app_wrk, s)))
1319 session_lookup_del_session (s);
1320 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1329 session_open_cl (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1331 transport_connection_t *tc;
1332 transport_endpoint_cfg_t *tep;
1333 app_worker_t *app_wrk;
1334 session_handle_t sh;
1338 tep = session_endpoint_to_transport_cfg (rmt);
1339 rv = transport_connect (rmt->transport_proto, tep);
1342 SESSION_DBG ("Transport failed to open connection.");
1346 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1348 /* For dgram type of service, allocate session and fifos now */
1349 app_wrk = app_worker_get (rmt->app_wrk_index);
1350 s = session_alloc_for_connection (tc);
1351 s->app_wrk_index = app_wrk->wrk_index;
1352 s->session_state = SESSION_STATE_OPENED;
1353 if (app_worker_init_connected (app_wrk, s))
1359 sh = session_handle (s);
1362 session_lookup_add_connection (tc, sh);
1363 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, rmt->opaque);
1367 session_open_vc (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1369 transport_connection_t *tc;
1370 transport_endpoint_cfg_t *tep;
1371 app_worker_t *app_wrk;
1375 tep = session_endpoint_to_transport_cfg (rmt);
1376 rv = transport_connect (rmt->transport_proto, tep);
1379 SESSION_DBG ("Transport failed to open connection.");
1383 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1385 app_wrk = app_worker_get (rmt->app_wrk_index);
1387 /* If transport offers a vc service, only allocate established
1388 * session once the connection has been established.
1389 * In the meantime allocate half-open session for tracking purposes
1390 * associate half-open connection to it and add session to app-worker
1391 * half-open table. These are needed to allocate the established
1392 * session on transport notification, and to cleanup the half-open
1393 * session if the app detaches before connection establishment.
1395 ho = session_alloc_for_half_open (tc);
1396 ho->app_wrk_index = app_wrk->wrk_index;
1397 ho->ho_index = app_worker_add_half_open (app_wrk, session_handle (ho));
1398 ho->opaque = rmt->opaque;
1399 *rsh = session_handle (ho);
1401 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1402 session_lookup_add_half_open (tc, tc->c_index);
1408 session_open_app (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1410 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (rmt);
1412 /* Not supported for now */
1413 *rsh = SESSION_INVALID_HANDLE;
1414 return transport_connect (rmt->transport_proto, tep_cfg);
1417 typedef int (*session_open_service_fn) (session_endpoint_cfg_t *,
1418 session_handle_t *);
1421 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1429 * Ask transport to open connection to remote transport endpoint.
1431 * Stores handle for matching request with reply since the call can be
1432 * asynchronous. For instance, for TCP the 3-way handshake must complete
1433 * before reply comes. Session is only created once connection is established.
1435 * @param app_index Index of the application requesting the connect
1436 * @param st Session type requested.
1437 * @param tep Remote transport endpoint
1438 * @param opaque Opaque data (typically, api_context) the application expects
1439 * on open completion.
1442 session_open (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1444 transport_service_type_t tst;
1445 tst = transport_protocol_service_type (rmt->transport_proto);
1446 return session_open_srv_fns[tst](rmt, rsh);
1450 * Ask transport to listen on session endpoint.
1452 * @param s Session for which listen will be called. Note that unlike
1453 * established sessions, listen sessions are not associated to a
1455 * @param sep Local endpoint to be listened on.
1458 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1460 transport_endpoint_cfg_t *tep;
1464 /* Transport bind/listen */
1465 tep = session_endpoint_to_transport_cfg (sep);
1466 s_index = ls->session_index;
1467 tc_index = transport_start_listen (session_get_transport_proto (ls),
1473 /* Attach transport to session. Lookup tables are populated by the app
1474 * worker because local tables (for ct sessions) are not backed by a fib */
1475 ls = listen_session_get (s_index);
1476 ls->connection_index = tc_index;
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)
1534 if (s->session_state >= SESSION_STATE_CLOSING)
1536 /* Session will only be removed once both app and transport
1537 * acknowledge the close */
1538 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1539 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1540 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1544 /* App closed so stop propagating dequeue notifications */
1545 svm_fifo_clear_deq_ntf (s->tx_fifo);
1546 s->session_state = SESSION_STATE_CLOSING;
1547 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1551 * Force a close without waiting for data to be flushed
1554 session_reset (session_t * s)
1556 if (s->session_state >= SESSION_STATE_CLOSING)
1558 /* Drop all outstanding tx data */
1559 svm_fifo_dequeue_drop_all (s->tx_fifo);
1560 s->session_state = SESSION_STATE_CLOSING;
1561 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1565 * Notify transport the session can be half-disconnected.
1567 * Must be called from the session's thread.
1570 session_transport_half_close (session_t *s)
1572 /* Only READY session can be half-closed */
1573 if (s->session_state != SESSION_STATE_READY)
1578 transport_half_close (session_get_transport_proto (s), s->connection_index,
1583 * Notify transport the session can be disconnected. This should eventually
1584 * result in a delete notification that allows us to cleanup session state.
1585 * Called for both active/passive disconnects.
1587 * Must be called from the session's thread.
1590 session_transport_close (session_t * s)
1592 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1594 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1595 s->session_state = SESSION_STATE_CLOSED;
1596 /* If transport is already deleted, just free the session */
1597 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1598 session_free_w_fifos (s);
1602 /* If the tx queue wasn't drained, the transport can continue to try
1603 * sending the outstanding data (in closed state it cannot). It MUST however
1604 * at one point, either after sending everything or after a timeout, call
1605 * delete notify. This will finally lead to the complete cleanup of the
1608 s->session_state = SESSION_STATE_APP_CLOSED;
1610 transport_close (session_get_transport_proto (s), s->connection_index,
1615 * Force transport close
1618 session_transport_reset (session_t * s)
1620 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1622 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1623 s->session_state = SESSION_STATE_CLOSED;
1624 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1625 session_free_w_fifos (s);
1629 s->session_state = SESSION_STATE_APP_CLOSED;
1630 transport_reset (session_get_transport_proto (s), s->connection_index,
1635 * Cleanup transport and session state.
1637 * Notify transport of the cleanup and free the session. This should
1638 * be called only if transport reported some error and is already
1642 session_transport_cleanup (session_t * s)
1644 /* Delete from main lookup table before we axe the the transport */
1645 session_lookup_del_session (s);
1646 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1647 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1649 /* Since we called cleanup, no delete notification will come. So, make
1650 * sure the session is properly freed. */
1651 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1656 * Allocate worker mqs in share-able segment
1658 * That can only be a newly created memfd segment, that must be mapped
1659 * by all apps/stack users unless private rx mqs are enabled.
1662 session_vpp_wrk_mqs_alloc (session_main_t *smm)
1664 u32 mq_q_length = 2048, evt_size = sizeof (session_event_t);
1665 fifo_segment_t *mqs_seg = &smm->wrk_mqs_segment;
1666 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1670 mq_q_length = clib_max (mq_q_length, smm->configured_wrk_mq_length);
1672 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1673 { mq_q_length, evt_size, 0 }, { mq_q_length >> 1, 256, 0 }
1675 cfg->consumer_pid = 0;
1677 cfg->q_nitems = mq_q_length;
1678 cfg->ring_cfgs = rc;
1681 * Compute mqs segment size based on rings config and leave space
1682 * for passing extended configuration messages, i.e., data allocated
1683 * outside of the rings. If provided with a config value, accept it
1684 * if larger than minimum size.
1686 mqs_seg_size = svm_msg_q_size_to_alloc (cfg) * vec_len (smm->wrk);
1687 mqs_seg_size = mqs_seg_size + (32 << 10);
1688 mqs_seg_size = clib_max (mqs_seg_size, smm->wrk_mqs_segment_size);
1690 mqs_seg->ssvm.ssvm_size = mqs_seg_size;
1691 mqs_seg->ssvm.my_pid = getpid ();
1692 mqs_seg->ssvm.name = format (0, "%s%c", "session: wrk-mqs-segment", 0);
1694 if (ssvm_server_init (&mqs_seg->ssvm, SSVM_SEGMENT_MEMFD))
1696 clib_warning ("failed to initialize queue segment");
1700 fifo_segment_init (mqs_seg);
1702 /* Special fifo segment that's filled only with mqs */
1703 mqs_seg->h->n_mqs = vec_len (smm->wrk);
1705 for (i = 0; i < vec_len (smm->wrk); i++)
1706 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (mqs_seg, i, cfg);
1710 session_main_get_wrk_mqs_segment (void)
1712 return &session_main.wrk_mqs_segment;
1716 session_segment_handle (session_t * s)
1721 return SESSION_INVALID_HANDLE;
1724 return segment_manager_make_segment_handle (f->segment_manager,
1729 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1730 session_tx_fifo_peek_and_snd,
1731 session_tx_fifo_dequeue_and_snd,
1732 session_tx_fifo_dequeue_internal,
1733 session_tx_fifo_dequeue_and_snd
1738 session_register_transport (transport_proto_t transport_proto,
1739 const transport_proto_vft_t * vft, u8 is_ip4,
1742 session_main_t *smm = &session_main;
1743 session_type_t session_type;
1744 u32 next_index = ~0;
1746 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1748 vec_validate (smm->session_type_to_next, session_type);
1749 vec_validate (smm->session_tx_fns, session_type);
1751 if (output_node != ~0)
1752 next_index = vlib_node_add_next (vlib_get_main (),
1753 session_queue_node.index, output_node);
1755 smm->session_type_to_next[session_type] = next_index;
1756 smm->session_tx_fns[session_type] =
1757 session_tx_fns[vft->transport_options.tx_type];
1761 session_register_update_time_fn (session_update_time_fn fn, u8 is_add)
1763 session_main_t *smm = &session_main;
1764 session_update_time_fn *fi;
1768 vec_foreach (fi, smm->update_time_fns)
1772 fi_pos = fi - smm->update_time_fns;
1782 clib_warning ("update time fn %p already registered", fn);
1785 vec_add1 (smm->update_time_fns, fn);
1789 vec_del1 (smm->update_time_fns, fi_pos);
1794 session_add_transport_proto (void)
1796 session_main_t *smm = &session_main;
1797 session_worker_t *wrk;
1800 smm->last_transport_proto_type += 1;
1802 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1804 wrk = session_main_get_worker (thread);
1805 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1808 return smm->last_transport_proto_type;
1811 transport_connection_t *
1812 session_get_transport (session_t * s)
1814 if (s->session_state != SESSION_STATE_LISTENING)
1815 return transport_get_connection (session_get_transport_proto (s),
1816 s->connection_index, s->thread_index);
1818 return transport_get_listener (session_get_transport_proto (s),
1819 s->connection_index);
1823 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1825 if (s->session_state != SESSION_STATE_LISTENING)
1826 return transport_get_endpoint (session_get_transport_proto (s),
1827 s->connection_index, s->thread_index, tep,
1830 return transport_get_listener_endpoint (session_get_transport_proto (s),
1831 s->connection_index, tep, is_lcl);
1835 session_transport_attribute (session_t *s, u8 is_get,
1836 transport_endpt_attr_t *attr)
1838 if (s->session_state < SESSION_STATE_READY)
1841 return transport_connection_attribute (session_get_transport_proto (s),
1842 s->connection_index, s->thread_index,
1846 transport_connection_t *
1847 listen_session_get_transport (session_t * s)
1849 return transport_get_listener (session_get_transport_proto (s),
1850 s->connection_index);
1854 session_queue_run_on_main_thread (vlib_main_t * vm)
1856 ASSERT (vlib_get_thread_index () == 0);
1857 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1860 static clib_error_t *
1861 session_manager_main_enable (vlib_main_t * vm)
1863 session_main_t *smm = &session_main;
1864 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1865 u32 num_threads, preallocated_sessions_per_worker;
1866 session_worker_t *wrk;
1869 /* We only initialize once and do not de-initialized on disable */
1870 if (smm->is_initialized)
1873 num_threads = 1 /* main thread */ + vtm->n_threads;
1875 if (num_threads < 1)
1876 return clib_error_return (0, "n_thread_stacks not set");
1878 /* Allocate cache line aligned worker contexts */
1879 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1880 clib_spinlock_init (&session_main.pool_realloc_lock);
1882 for (i = 0; i < num_threads; i++)
1885 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1886 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1887 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1888 wrk->pending_connects = clib_llist_make_head (wrk->event_elts, evt_list);
1889 wrk->evts_pending_main =
1890 clib_llist_make_head (wrk->event_elts, evt_list);
1891 wrk->vm = vlib_get_main_by_index (i);
1892 wrk->last_vlib_time = vlib_time_now (vm);
1893 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1895 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1897 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1898 session_wrk_enable_adaptive_mode (wrk);
1901 /* Allocate vpp event queues segment and queue */
1902 session_vpp_wrk_mqs_alloc (smm);
1904 /* Initialize segment manager properties */
1905 segment_manager_main_init ();
1907 /* Preallocate sessions */
1908 if (smm->preallocated_sessions)
1910 if (num_threads == 1)
1912 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1917 preallocated_sessions_per_worker =
1918 (1.1 * (f64) smm->preallocated_sessions /
1919 (f64) (num_threads - 1));
1921 for (j = 1; j < num_threads; j++)
1923 pool_init_fixed (smm->wrk[j].sessions,
1924 preallocated_sessions_per_worker);
1929 session_lookup_init ();
1930 app_namespaces_init ();
1932 smm->is_initialized = 1;
1936 smm->is_enabled = 1;
1938 /* Enable transports */
1939 transport_enable_disable (vm, 1);
1940 session_debug_init ();
1946 session_manager_main_disable (vlib_main_t * vm)
1948 transport_enable_disable (vm, 0 /* is_en */ );
1952 session_node_enable_disable (u8 is_en)
1954 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
1955 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1956 session_main_t *sm = &session_main;
1961 n_vlibs = vlib_get_n_threads ();
1962 for (i = 0; i < n_vlibs; i++)
1964 vm = vlib_get_main_by_index (i);
1965 /* main thread with workers and not polling */
1966 if (i == 0 && n_vlibs > 1)
1968 vlib_node_set_state (vm, session_queue_node.index, mstate);
1971 session_main_get_worker (0)->state = SESSION_WRK_INTERRUPT;
1972 vlib_node_set_state (vm, session_queue_process_node.index,
1974 n = vlib_get_node (vm, session_queue_process_node.index);
1975 vlib_start_process (vm, n->runtime_index);
1979 vlib_process_signal_event_mt (vm,
1980 session_queue_process_node.index,
1981 SESSION_Q_PROCESS_STOP, 0);
1986 vlib_node_set_state (vm, session_queue_node.index, state);
1989 if (sm->use_private_rx_mqs)
1990 application_enable_rx_mqs_nodes (is_en);
1994 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1996 clib_error_t *error = 0;
1999 if (session_main.is_enabled)
2002 error = session_manager_main_enable (vm);
2003 session_node_enable_disable (is_en);
2007 session_main.is_enabled = 0;
2008 session_manager_main_disable (vm);
2009 session_node_enable_disable (is_en);
2016 session_main_init (vlib_main_t * vm)
2018 session_main_t *smm = &session_main;
2020 smm->is_enabled = 0;
2021 smm->session_enable_asap = 0;
2023 smm->use_private_rx_mqs = 0;
2024 smm->no_adaptive = 0;
2025 smm->last_transport_proto_type = TRANSPORT_PROTO_HTTP;
2030 static clib_error_t *
2031 session_main_loop_init (vlib_main_t * vm)
2033 session_main_t *smm = &session_main;
2034 if (smm->session_enable_asap)
2036 vlib_worker_thread_barrier_sync (vm);
2037 vnet_session_enable_disable (vm, 1 /* is_en */ );
2038 vlib_worker_thread_barrier_release (vm);
2043 VLIB_INIT_FUNCTION (session_main_init);
2044 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
2046 static clib_error_t *
2047 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
2049 session_main_t *smm = &session_main;
2053 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2055 if (unformat (input, "wrk-mq-length %d", &nitems))
2058 smm->configured_wrk_mq_length = nitems;
2060 clib_warning ("event queue length %d too small, ignored", nitems);
2062 else if (unformat (input, "preallocated-sessions %d",
2063 &smm->preallocated_sessions))
2065 else if (unformat (input, "v4-session-table-buckets %d",
2066 &smm->configured_v4_session_table_buckets))
2068 else if (unformat (input, "v4-halfopen-table-buckets %d",
2069 &smm->configured_v4_halfopen_table_buckets))
2071 else if (unformat (input, "v6-session-table-buckets %d",
2072 &smm->configured_v6_session_table_buckets))
2074 else if (unformat (input, "v6-halfopen-table-buckets %d",
2075 &smm->configured_v6_halfopen_table_buckets))
2077 else if (unformat (input, "v4-session-table-memory %U",
2078 unformat_memory_size, &tmp))
2080 if (tmp >= 0x100000000)
2081 return clib_error_return (0, "memory size %llx (%lld) too large",
2083 smm->configured_v4_session_table_memory = tmp;
2085 else if (unformat (input, "v4-halfopen-table-memory %U",
2086 unformat_memory_size, &tmp))
2088 if (tmp >= 0x100000000)
2089 return clib_error_return (0, "memory size %llx (%lld) too large",
2091 smm->configured_v4_halfopen_table_memory = tmp;
2093 else if (unformat (input, "v6-session-table-memory %U",
2094 unformat_memory_size, &tmp))
2096 if (tmp >= 0x100000000)
2097 return clib_error_return (0, "memory size %llx (%lld) too large",
2099 smm->configured_v6_session_table_memory = tmp;
2101 else if (unformat (input, "v6-halfopen-table-memory %U",
2102 unformat_memory_size, &tmp))
2104 if (tmp >= 0x100000000)
2105 return clib_error_return (0, "memory size %llx (%lld) too large",
2107 smm->configured_v6_halfopen_table_memory = tmp;
2109 else if (unformat (input, "local-endpoints-table-memory %U",
2110 unformat_memory_size, &tmp))
2112 if (tmp >= 0x100000000)
2113 return clib_error_return (0, "memory size %llx (%lld) too large",
2115 smm->local_endpoints_table_memory = tmp;
2117 else if (unformat (input, "local-endpoints-table-buckets %d",
2118 &smm->local_endpoints_table_buckets))
2120 else if (unformat (input, "enable"))
2121 smm->session_enable_asap = 1;
2122 else if (unformat (input, "use-app-socket-api"))
2123 (void) appns_sapi_enable_disable (1 /* is_enable */);
2124 else if (unformat (input, "poll-main"))
2126 else if (unformat (input, "use-private-rx-mqs"))
2127 smm->use_private_rx_mqs = 1;
2128 else if (unformat (input, "no-adaptive"))
2129 smm->no_adaptive = 1;
2131 * Deprecated but maintained for compatibility
2133 else if (unformat (input, "evt_qs_memfd_seg"))
2135 else if (unformat (input, "segment-baseva 0x%lx", &tmp))
2137 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
2140 else if (unformat (input, "event-queue-length %d", &nitems))
2143 smm->configured_wrk_mq_length = nitems;
2145 clib_warning ("event queue length %d too small, ignored", nitems);
2148 return clib_error_return (0, "unknown input `%U'",
2149 format_unformat_error, input);
2154 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2157 * fd.io coding-style-patch-verification: ON
2160 * eval: (c-set-style "gnu")