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_will_expand (wrk->sessions, will_expand,
207 CLIB_CACHE_LINE_BYTES);
208 /* If we have peekers, let them finish */
209 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
211 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
212 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
213 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
217 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
219 clib_memset (s, 0, sizeof (*s));
220 s->session_index = s - wrk->sessions;
221 s->thread_index = thread_index;
222 s->app_index = APP_INVALID_INDEX;
227 session_free (session_t * s)
231 u8 thread_index = s->thread_index;
232 clib_memset (s, 0xFA, sizeof (*s));
233 pool_put (session_main.wrk[thread_index].sessions, s);
236 SESSION_EVT (SESSION_EVT_FREE, s);
237 pool_put (session_main.wrk[s->thread_index].sessions, s);
241 session_is_valid (u32 si, u8 thread_index)
244 transport_connection_t *tc;
246 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
248 if (s->thread_index != thread_index || s->session_index != si)
251 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED
252 || s->session_state <= SESSION_STATE_LISTENING)
255 if (s->session_state == SESSION_STATE_CONNECTING &&
256 (s->flags & SESSION_F_HALF_OPEN))
259 tc = session_get_transport (s);
260 if (s->connection_index != tc->c_index
261 || s->thread_index != tc->thread_index || tc->s_index != si)
268 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
270 app_worker_t *app_wrk;
272 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
275 app_worker_cleanup_notify (app_wrk, s, ntf);
279 session_free_w_fifos (session_t * s)
281 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
282 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
287 * Cleans up session and lookup table.
289 * Transport connection must still be valid.
292 session_delete (session_t * s)
296 /* Delete from the main lookup table. */
297 if ((rv = session_lookup_del_session (s)))
298 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
300 session_free_w_fifos (s);
304 session_cleanup_half_open (session_handle_t ho_handle)
306 session_t *s = session_get_from_handle (ho_handle);
307 transport_cleanup_half_open (session_get_transport_proto (s),
308 s->connection_index);
312 session_half_open_delete_notify (transport_connection_t *tc)
314 app_worker_t *app_wrk;
317 s = session_get (tc->s_index, tc->thread_index);
318 app_wrk = app_worker_get (s->app_wrk_index);
319 app_worker_del_half_open (app_wrk, s->ho_index);
324 session_alloc_for_connection (transport_connection_t * tc)
327 u32 thread_index = tc->thread_index;
329 ASSERT (thread_index == vlib_get_thread_index ()
330 || transport_protocol_is_cl (tc->proto));
332 s = session_alloc (thread_index);
333 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
334 s->session_state = SESSION_STATE_CLOSED;
336 /* Attach transport to session and vice versa */
337 s->connection_index = tc->c_index;
338 tc->s_index = s->session_index;
343 session_alloc_for_half_open (transport_connection_t *tc)
347 s = ho_session_alloc ();
348 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
349 s->connection_index = tc->c_index;
350 tc->s_index = s->session_index;
355 * Discards bytes from buffer chain
357 * It discards n_bytes_to_drop starting at first buffer after chain_b
360 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
361 vlib_buffer_t ** chain_b,
364 vlib_buffer_t *next = *chain_b;
365 u32 to_drop = n_bytes_to_drop;
366 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
367 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
369 next = vlib_get_buffer (vm, next->next_buffer);
370 if (next->current_length > to_drop)
372 vlib_buffer_advance (next, to_drop);
377 to_drop -= next->current_length;
378 next->current_length = 0;
384 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
388 * Enqueue buffer chain tail
391 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
392 u32 offset, u8 is_in_order)
394 vlib_buffer_t *chain_b;
395 u32 chain_bi, len, diff;
396 vlib_main_t *vm = vlib_get_main ();
401 if (is_in_order && offset)
403 diff = offset - b->current_length;
404 if (diff > b->total_length_not_including_first_buffer)
407 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
408 chain_bi = vlib_get_buffer_index (vm, chain_b);
411 chain_bi = b->next_buffer;
415 chain_b = vlib_get_buffer (vm, chain_bi);
416 data = vlib_buffer_get_current (chain_b);
417 len = chain_b->current_length;
422 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
429 return (rv > 0) ? (written + rv) : written;
435 /* written more than what was left in chain */
436 if (written > b->total_length_not_including_first_buffer)
439 /* drop the bytes that have already been delivered */
440 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
445 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
448 clib_warning ("failed to enqueue multi-buffer seg");
454 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
455 ? chain_b->next_buffer : 0));
464 session_fifo_tuning (session_t * s, svm_fifo_t * f,
465 session_ft_action_t act, u32 len)
467 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
469 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
470 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
471 if (CLIB_ASSERT_ENABLE)
473 segment_manager_t *sm;
474 sm = segment_manager_get (f->segment_manager);
475 ASSERT (f->shr->size >= 4096);
476 ASSERT (f->shr->size <= sm->max_fifo_size);
482 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
483 * event but on request can queue notification events for later delivery by
484 * calling stream_server_flush_enqueue_events().
486 * @param tc Transport connection which is to be enqueued data
487 * @param b Buffer to be enqueued
488 * @param offset Offset at which to start enqueueing if out-of-order
489 * @param queue_event Flag to indicate if peer is to be notified or if event
490 * is to be queued. The former is useful when more data is
491 * enqueued and only one event is to be generated.
492 * @param is_in_order Flag to indicate if data is in order
493 * @return Number of bytes enqueued or a negative value if enqueueing failed.
496 session_enqueue_stream_connection (transport_connection_t * tc,
497 vlib_buffer_t * b, u32 offset,
498 u8 queue_event, u8 is_in_order)
501 int enqueued = 0, rv, in_order_off;
503 s = session_get (tc->s_index, tc->thread_index);
507 enqueued = svm_fifo_enqueue (s->rx_fifo,
509 vlib_buffer_get_current (b));
510 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
513 in_order_off = enqueued > b->current_length ? enqueued : 0;
514 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
521 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
523 vlib_buffer_get_current (b));
524 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
525 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
526 /* if something was enqueued, report even this as success for ooo
527 * segment handling */
533 /* Queue RX event on this fifo. Eventually these will need to be flushed
534 * by calling stream_server_flush_enqueue_events () */
535 session_worker_t *wrk;
537 wrk = session_main_get_worker (s->thread_index);
538 if (!(s->flags & SESSION_F_RX_EVT))
540 s->flags |= SESSION_F_RX_EVT;
541 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
544 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
551 session_enqueue_dgram_connection (session_t * s,
552 session_dgram_hdr_t * hdr,
553 vlib_buffer_t * b, u8 proto, u8 queue_event)
557 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
558 >= b->current_length + sizeof (*hdr));
560 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
563 svm_fifo_seg_t segs[2] = {
564 { (u8 *) hdr, sizeof (*hdr) },
565 { vlib_buffer_get_current (b), b->current_length }
569 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
570 0 /* allow_partial */ );
574 vlib_main_t *vm = vlib_get_main ();
575 svm_fifo_seg_t *segs = 0, *seg;
576 vlib_buffer_t *it = b;
579 vec_add2 (segs, seg, 1);
580 seg->data = (u8 *) hdr;
581 seg->len = sizeof (*hdr);
584 vec_add2 (segs, seg, 1);
585 seg->data = vlib_buffer_get_current (it);
586 seg->len = it->current_length;
588 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
590 it = vlib_get_buffer (vm, it->next_buffer);
592 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
593 0 /* allow partial */ );
597 if (queue_event && rv > 0)
599 /* Queue RX event on this fifo. Eventually these will need to be flushed
600 * by calling stream_server_flush_enqueue_events () */
601 session_worker_t *wrk;
603 wrk = session_main_get_worker (s->thread_index);
604 if (!(s->flags & SESSION_F_RX_EVT))
606 s->flags |= SESSION_F_RX_EVT;
607 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
610 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
612 return rv > 0 ? rv : 0;
616 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
617 u32 offset, u32 max_bytes)
619 session_t *s = session_get (tc->s_index, tc->thread_index);
620 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
624 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
626 session_t *s = session_get (tc->s_index, tc->thread_index);
629 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
630 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
632 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
633 session_dequeue_notify (s);
639 session_notify_subscribers (u32 app_index, session_t * s,
640 svm_fifo_t * f, session_evt_type_t evt_type)
642 app_worker_t *app_wrk;
646 app = application_get (app_index);
650 for (i = 0; i < f->shr->n_subscribers; i++)
652 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
655 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
663 * Notify session peer that new data has been enqueued.
665 * @param s Stream session for which the event is to be generated.
666 * @param lock Flag to indicate if call should lock message queue.
668 * @return 0 on success or negative number if failed to send notification.
671 session_enqueue_notify_inline (session_t * s)
673 app_worker_t *app_wrk;
677 session_index = s->session_index;
678 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
680 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
681 if (PREDICT_FALSE (!app_wrk))
683 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
687 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
689 s->flags &= ~SESSION_F_RX_EVT;
691 /* Application didn't confirm accept yet */
692 if (PREDICT_FALSE (s->session_state == SESSION_STATE_ACCEPTING))
695 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
699 if (PREDICT_FALSE (n_subscribers))
701 s = session_get (session_index, vlib_get_thread_index ());
702 return session_notify_subscribers (app_wrk->app_index, s,
703 s->rx_fifo, SESSION_IO_EVT_RX);
710 session_enqueue_notify (session_t * s)
712 return session_enqueue_notify_inline (s);
716 session_enqueue_notify_rpc (void *arg)
718 u32 session_index = pointer_to_uword (arg);
721 s = session_get_if_valid (session_index, vlib_get_thread_index ());
725 session_enqueue_notify (s);
729 * Like session_enqueue_notify, but can be called from a thread that does not
733 session_enqueue_notify_thread (session_handle_t sh)
735 u32 thread_index = session_thread_from_handle (sh);
736 u32 session_index = session_index_from_handle (sh);
739 * Pass session index (u32) as opposed to handle (u64) in case pointers
742 session_send_rpc_evt_to_thread (thread_index,
743 session_enqueue_notify_rpc,
744 uword_to_pointer (session_index, void *));
748 session_dequeue_notify (session_t * s)
750 app_worker_t *app_wrk;
752 svm_fifo_clear_deq_ntf (s->tx_fifo);
754 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
755 if (PREDICT_FALSE (!app_wrk))
758 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
762 if (PREDICT_FALSE (s->tx_fifo->shr->n_subscribers))
763 return session_notify_subscribers (app_wrk->app_index, s,
764 s->tx_fifo, SESSION_IO_EVT_TX);
770 * Flushes queue of sessions that are to be notified of new data
773 * @param thread_index Thread index for which the flush is to be performed.
774 * @return 0 on success or a positive number indicating the number of
775 * failures due to API queue being full.
778 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
780 session_worker_t *wrk = session_main_get_worker (thread_index);
785 indices = wrk->session_to_enqueue[transport_proto];
787 for (i = 0; i < vec_len (indices); i++)
789 s = session_get_if_valid (indices[i], thread_index);
790 if (PREDICT_FALSE (!s))
796 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
797 0 /* TODO/not needed */ );
799 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
803 vec_reset_length (indices);
804 wrk->session_to_enqueue[transport_proto] = indices;
810 session_main_flush_all_enqueue_events (u8 transport_proto)
812 vlib_thread_main_t *vtm = vlib_get_thread_main ();
814 for (i = 0; i < 1 + vtm->n_threads; i++)
815 errors += session_main_flush_enqueue_events (transport_proto, i);
820 session_stream_connect_notify (transport_connection_t * tc,
823 u32 opaque = 0, new_ti, new_si;
824 app_worker_t *app_wrk;
825 session_t *s = 0, *ho;
828 * Cleanup half-open table
830 session_lookup_del_half_open (tc);
832 ho = ho_session_get (tc->s_index);
834 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
839 return app_worker_connect_notify (app_wrk, s, err, opaque);
841 s = session_alloc_for_connection (tc);
842 s->session_state = SESSION_STATE_CONNECTING;
843 s->app_wrk_index = app_wrk->wrk_index;
844 new_si = s->session_index;
845 new_ti = s->thread_index;
847 if ((err = app_worker_init_connected (app_wrk, s)))
850 app_worker_connect_notify (app_wrk, 0, err, opaque);
854 s = session_get (new_si, new_ti);
855 s->session_state = SESSION_STATE_READY;
856 session_lookup_add_connection (tc, session_handle (s));
858 if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
860 session_lookup_del_connection (tc);
861 /* Avoid notifying app about rejected session cleanup */
862 s = session_get (new_si, new_ti);
863 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
872 session_switch_pool_reply (void *arg)
874 u32 session_index = pointer_to_uword (arg);
877 s = session_get_if_valid (session_index, vlib_get_thread_index ());
881 /* Notify app that it has data on the new session */
882 session_enqueue_notify (s);
885 typedef struct _session_switch_pool_args
889 u32 new_thread_index;
890 u32 new_session_index;
891 } session_switch_pool_args_t;
894 * Notify old thread of the session pool switch
897 session_switch_pool (void *cb_args)
899 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
900 session_handle_t new_sh;
901 segment_manager_t *sm;
902 app_worker_t *app_wrk;
906 ASSERT (args->thread_index == vlib_get_thread_index ());
907 s = session_get (args->session_index, args->thread_index);
909 transport_cleanup (session_get_transport_proto (s), s->connection_index,
912 new_sh = session_make_handle (args->new_session_index,
913 args->new_thread_index);
915 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
918 /* Cleanup fifo segment slice state for fifos */
919 sm = app_worker_get_connect_segment_manager (app_wrk);
920 segment_manager_detach_fifo (sm, &s->rx_fifo);
921 segment_manager_detach_fifo (sm, &s->tx_fifo);
923 /* Notify app, using old session, about the migration event */
924 app_worker_migrate_notify (app_wrk, s, new_sh);
927 /* Trigger app read and fifo updates on the new thread */
928 rargs = uword_to_pointer (args->new_session_index, void *);
929 session_send_rpc_evt_to_thread (args->new_thread_index,
930 session_switch_pool_reply, rargs);
933 clib_mem_free (cb_args);
937 * Move dgram session to the right thread
940 session_dgram_connect_notify (transport_connection_t * tc,
941 u32 old_thread_index, session_t ** new_session)
944 session_switch_pool_args_t *rpc_args;
945 segment_manager_t *sm;
946 app_worker_t *app_wrk;
949 * Clone half-open session to the right thread.
951 new_s = session_clone_safe (tc->s_index, old_thread_index);
952 new_s->connection_index = tc->c_index;
953 new_s->session_state = SESSION_STATE_READY;
954 new_s->flags |= SESSION_F_IS_MIGRATING;
956 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
957 session_lookup_add_connection (tc, session_handle (new_s));
959 app_wrk = app_worker_get_if_valid (new_s->app_wrk_index);
962 /* New set of fifos attached to the same shared memory */
963 sm = app_worker_get_connect_segment_manager (app_wrk);
964 segment_manager_attach_fifo (sm, &new_s->rx_fifo, new_s);
965 segment_manager_attach_fifo (sm, &new_s->tx_fifo, new_s);
969 * Ask thread owning the old session to clean it up and make us the tx
972 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
973 rpc_args->new_session_index = new_s->session_index;
974 rpc_args->new_thread_index = new_s->thread_index;
975 rpc_args->session_index = tc->s_index;
976 rpc_args->thread_index = old_thread_index;
977 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
980 tc->s_index = new_s->session_index;
981 new_s->connection_index = tc->c_index;
982 *new_session = new_s;
987 * Notification from transport that connection is being closed.
989 * A disconnect is sent to application but state is not removed. Once
990 * disconnect is acknowledged by application, session disconnect is called.
991 * Ultimately this leads to close being called on transport (passive close).
994 session_transport_closing_notify (transport_connection_t * tc)
996 app_worker_t *app_wrk;
999 s = session_get (tc->s_index, tc->thread_index);
1000 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1002 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1003 app_wrk = app_worker_get (s->app_wrk_index);
1004 app_worker_close_notify (app_wrk, s);
1008 * Notification from transport that connection is being deleted
1010 * This removes the session if it is still valid. It should be called only on
1011 * previously fully established sessions. For instance failed connects should
1012 * call stream_session_connect_notify and indicate that the connect has
1016 session_transport_delete_notify (transport_connection_t * tc)
1020 /* App might've been removed already */
1021 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1024 switch (s->session_state)
1026 case SESSION_STATE_CREATED:
1027 /* Session was created but accept notification was not yet sent to the
1028 * app. Cleanup everything. */
1029 session_lookup_del_session (s);
1030 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1033 case SESSION_STATE_ACCEPTING:
1034 case SESSION_STATE_TRANSPORT_CLOSING:
1035 case SESSION_STATE_CLOSING:
1036 case SESSION_STATE_TRANSPORT_CLOSED:
1037 /* If transport finishes or times out before we get a reply
1038 * from the app, mark transport as closed and wait for reply
1039 * before removing the session. Cleanup session table in advance
1040 * because transport will soon be closed and closed sessions
1041 * are assumed to have been removed from the lookup table */
1042 session_lookup_del_session (s);
1043 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
1044 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1045 svm_fifo_dequeue_drop_all (s->tx_fifo);
1047 case SESSION_STATE_APP_CLOSED:
1048 /* Cleanup lookup table as transport needs to still be valid.
1049 * Program transport close to ensure that all session events
1050 * have been cleaned up. Once transport close is called, the
1051 * session is just removed because both transport and app have
1052 * confirmed the close*/
1053 session_lookup_del_session (s);
1054 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
1055 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1056 svm_fifo_dequeue_drop_all (s->tx_fifo);
1057 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1059 case SESSION_STATE_TRANSPORT_DELETED:
1061 case SESSION_STATE_CLOSED:
1062 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1066 clib_warning ("session state %u", s->session_state);
1067 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1074 * Notification from transport that it is closed
1076 * Should be called by transport, prior to calling delete notify, once it
1077 * knows that no more data will be exchanged. This could serve as an
1078 * early acknowledgment of an active close especially if transport delete
1079 * can be delayed a long time, e.g., tcp time-wait.
1082 session_transport_closed_notify (transport_connection_t * tc)
1084 app_worker_t *app_wrk;
1087 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1090 /* Transport thinks that app requested close but it actually didn't.
1091 * Can happen for tcp:
1092 * 1)if fin and rst are received in close succession.
1093 * 2)if app shutdown the connection. */
1094 if (s->session_state == SESSION_STATE_READY)
1096 session_transport_closing_notify (tc);
1097 svm_fifo_dequeue_drop_all (s->tx_fifo);
1098 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1100 /* If app close has not been received or has not yet resulted in
1101 * a transport close, only mark the session transport as closed */
1102 else if (s->session_state <= SESSION_STATE_CLOSING)
1104 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1106 /* If app also closed, switch to closed */
1107 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1108 s->session_state = SESSION_STATE_CLOSED;
1110 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1112 app_worker_transport_closed_notify (app_wrk, s);
1116 * Notify application that connection has been reset.
1119 session_transport_reset_notify (transport_connection_t * tc)
1121 app_worker_t *app_wrk;
1124 s = session_get (tc->s_index, tc->thread_index);
1125 svm_fifo_dequeue_drop_all (s->tx_fifo);
1126 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1128 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1129 app_wrk = app_worker_get (s->app_wrk_index);
1130 app_worker_reset_notify (app_wrk, s);
1134 session_stream_accept_notify (transport_connection_t * tc)
1136 app_worker_t *app_wrk;
1139 s = session_get (tc->s_index, tc->thread_index);
1140 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1143 if (s->session_state != SESSION_STATE_CREATED)
1145 s->session_state = SESSION_STATE_ACCEPTING;
1146 if (app_worker_accept_notify (app_wrk, s))
1148 /* On transport delete, no notifications should be sent. Unless, the
1149 * accept is retried and successful. */
1150 s->session_state = SESSION_STATE_CREATED;
1157 * Accept a stream session. Optionally ping the server by callback.
1160 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1161 u32 thread_index, u8 notify)
1166 s = session_alloc_for_connection (tc);
1167 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1168 s->session_state = SESSION_STATE_CREATED;
1170 if ((rv = app_worker_init_accepted (s)))
1176 session_lookup_add_connection (tc, session_handle (s));
1178 /* Shoulder-tap the server */
1181 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1182 if ((rv = app_worker_accept_notify (app_wrk, s)))
1184 session_lookup_del_session (s);
1185 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1195 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1198 app_worker_t *app_wrk;
1202 s = session_alloc_for_connection (tc);
1203 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1205 if ((rv = app_worker_init_accepted (s)))
1211 session_lookup_add_connection (tc, session_handle (s));
1213 app_wrk = app_worker_get (s->app_wrk_index);
1214 if ((rv = app_worker_accept_notify (app_wrk, s)))
1216 session_lookup_del_session (s);
1217 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1222 s->session_state = SESSION_STATE_READY;
1228 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1230 transport_connection_t *tc;
1231 transport_endpoint_cfg_t *tep;
1232 app_worker_t *app_wrk;
1233 session_handle_t sh;
1237 tep = session_endpoint_to_transport_cfg (rmt);
1238 rv = transport_connect (rmt->transport_proto, tep);
1241 SESSION_DBG ("Transport failed to open connection.");
1245 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1247 /* For dgram type of service, allocate session and fifos now */
1248 app_wrk = app_worker_get (app_wrk_index);
1249 s = session_alloc_for_connection (tc);
1250 s->app_wrk_index = app_wrk->wrk_index;
1251 s->session_state = SESSION_STATE_OPENED;
1252 if (app_worker_init_connected (app_wrk, s))
1258 sh = session_handle (s);
1259 session_lookup_add_connection (tc, sh);
1260 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque);
1264 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1266 transport_connection_t *tc;
1267 transport_endpoint_cfg_t *tep;
1268 app_worker_t *app_wrk;
1272 tep = session_endpoint_to_transport_cfg (rmt);
1273 rv = transport_connect (rmt->transport_proto, tep);
1276 SESSION_DBG ("Transport failed to open connection.");
1280 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1282 app_wrk = app_worker_get (app_wrk_index);
1284 /* If transport offers a vc service, only allocate established
1285 * session once the connection has been established.
1286 * In the meantime allocate half-open session for tracking purposes
1287 * associate half-open connection to it and add session to app-worker
1288 * half-open table. These are needed to allocate the established
1289 * session on transport notification, and to cleanup the half-open
1290 * session if the app detaches before connection establishment.
1292 s = session_alloc_for_half_open (tc);
1293 s->app_wrk_index = app_wrk->wrk_index;
1294 s->ho_index = app_worker_add_half_open (app_wrk, session_handle (s));
1297 session_lookup_add_half_open (tc, tc->c_index);
1303 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1305 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1306 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1308 sep->app_wrk_index = app_wrk_index;
1309 sep->opaque = opaque;
1311 return transport_connect (rmt->transport_proto, tep_cfg);
1314 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1317 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1325 * Ask transport to open connection to remote transport endpoint.
1327 * Stores handle for matching request with reply since the call can be
1328 * asynchronous. For instance, for TCP the 3-way handshake must complete
1329 * before reply comes. Session is only created once connection is established.
1331 * @param app_index Index of the application requesting the connect
1332 * @param st Session type requested.
1333 * @param tep Remote transport endpoint
1334 * @param opaque Opaque data (typically, api_context) the application expects
1335 * on open completion.
1338 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1340 transport_service_type_t tst;
1341 tst = transport_protocol_service_type (rmt->transport_proto);
1342 return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1346 * Ask transport to listen on session endpoint.
1348 * @param s Session for which listen will be called. Note that unlike
1349 * established sessions, listen sessions are not associated to a
1351 * @param sep Local endpoint to be listened on.
1354 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1356 transport_endpoint_t *tep;
1360 /* Transport bind/listen */
1361 tep = session_endpoint_to_transport (sep);
1362 s_index = ls->session_index;
1363 tc_index = transport_start_listen (session_get_transport_proto (ls),
1369 /* Attach transport to session. Lookup tables are populated by the app
1370 * worker because local tables (for ct sessions) are not backed by a fib */
1371 ls = listen_session_get (s_index);
1372 ls->connection_index = tc_index;
1378 * Ask transport to stop listening on local transport endpoint.
1380 * @param s Session to stop listening on. It must be in state LISTENING.
1383 session_stop_listen (session_t * s)
1385 transport_proto_t tp = session_get_transport_proto (s);
1386 transport_connection_t *tc;
1388 if (s->session_state != SESSION_STATE_LISTENING)
1389 return SESSION_E_NOLISTEN;
1391 tc = transport_get_listener (tp, s->connection_index);
1393 /* If no transport, assume everything was cleaned up already */
1395 return SESSION_E_NONE;
1397 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1398 session_lookup_del_connection (tc);
1400 transport_stop_listen (tp, s->connection_index);
1405 * Initialize session half-closing procedure.
1407 * Note that half-closing will not change the state of the session.
1410 session_half_close (session_t *s)
1415 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_HALF_CLOSE);
1419 * Initialize session closing procedure.
1421 * Request is always sent to session node to ensure that all outstanding
1422 * requests are served before transport is notified.
1425 session_close (session_t * s)
1430 if (s->session_state >= SESSION_STATE_CLOSING)
1432 /* Session will only be removed once both app and transport
1433 * acknowledge the close */
1434 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1435 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1436 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1440 s->session_state = SESSION_STATE_CLOSING;
1441 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1445 * Force a close without waiting for data to be flushed
1448 session_reset (session_t * s)
1450 if (s->session_state >= SESSION_STATE_CLOSING)
1452 /* Drop all outstanding tx data */
1453 svm_fifo_dequeue_drop_all (s->tx_fifo);
1454 s->session_state = SESSION_STATE_CLOSING;
1455 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1459 * Notify transport the session can be half-disconnected.
1461 * Must be called from the session's thread.
1464 session_transport_half_close (session_t *s)
1466 /* Only READY session can be half-closed */
1467 if (s->session_state != SESSION_STATE_READY)
1472 transport_half_close (session_get_transport_proto (s), s->connection_index,
1477 * Notify transport the session can be disconnected. This should eventually
1478 * result in a delete notification that allows us to cleanup session state.
1479 * Called for both active/passive disconnects.
1481 * Must be called from the session's thread.
1484 session_transport_close (session_t * s)
1486 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1488 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1489 s->session_state = SESSION_STATE_CLOSED;
1490 /* If transport is already deleted, just free the session */
1491 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1492 session_free_w_fifos (s);
1496 /* If the tx queue wasn't drained, the transport can continue to try
1497 * sending the outstanding data (in closed state it cannot). It MUST however
1498 * at one point, either after sending everything or after a timeout, call
1499 * delete notify. This will finally lead to the complete cleanup of the
1502 s->session_state = SESSION_STATE_APP_CLOSED;
1504 transport_close (session_get_transport_proto (s), s->connection_index,
1509 * Force transport close
1512 session_transport_reset (session_t * s)
1514 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1516 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1517 s->session_state = SESSION_STATE_CLOSED;
1518 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1519 session_free_w_fifos (s);
1523 s->session_state = SESSION_STATE_APP_CLOSED;
1524 transport_reset (session_get_transport_proto (s), s->connection_index,
1529 * Cleanup transport and session state.
1531 * Notify transport of the cleanup and free the session. This should
1532 * be called only if transport reported some error and is already
1536 session_transport_cleanup (session_t * s)
1538 /* Delete from main lookup table before we axe the the transport */
1539 session_lookup_del_session (s);
1540 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1541 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1543 /* Since we called cleanup, no delete notification will come. So, make
1544 * sure the session is properly freed. */
1545 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1550 * Allocate event queues in the shared-memory segment
1552 * That can only be a newly created memfd segment, that must be
1553 * mapped by all apps/stack users.
1556 session_vpp_event_queues_allocate (session_main_t * smm)
1558 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1559 fifo_segment_t *eqs = &smm->evt_qs_segment;
1560 uword eqs_size = 64 << 20;
1561 pid_t vpp_pid = getpid ();
1564 if (smm->configured_event_queue_length)
1565 evt_q_length = smm->configured_event_queue_length;
1567 if (smm->evt_qs_segment_size)
1568 eqs_size = smm->evt_qs_segment_size;
1570 eqs->ssvm.ssvm_size = eqs_size;
1571 eqs->ssvm.my_pid = vpp_pid;
1572 eqs->ssvm.name = format (0, "%s%c", "session: evt-qs-segment", 0);
1573 /* clib_mem_vm_map_shared consumes first page before requested_va */
1574 eqs->ssvm.requested_va = smm->session_baseva + clib_mem_get_page_size ();
1576 if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
1578 clib_warning ("failed to initialize queue segment");
1582 fifo_segment_init (eqs);
1584 /* Special fifo segment that's filled only with mqs */
1585 eqs->h->n_mqs = vec_len (smm->wrk);
1587 for (i = 0; i < vec_len (smm->wrk); i++)
1589 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1590 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1591 {evt_q_length, evt_size, 0}
1593 {evt_q_length >> 1, 256, 0}
1595 cfg->consumer_pid = 0;
1597 cfg->q_nitems = evt_q_length;
1598 cfg->ring_cfgs = rc;
1600 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (eqs, i, cfg);
1605 session_main_get_evt_q_segment (void)
1607 return &session_main.evt_qs_segment;
1611 session_segment_handle (session_t * s)
1616 return SESSION_INVALID_HANDLE;
1619 return segment_manager_make_segment_handle (f->segment_manager,
1624 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1625 session_tx_fifo_peek_and_snd,
1626 session_tx_fifo_dequeue_and_snd,
1627 session_tx_fifo_dequeue_internal,
1628 session_tx_fifo_dequeue_and_snd
1633 session_register_transport (transport_proto_t transport_proto,
1634 const transport_proto_vft_t * vft, u8 is_ip4,
1637 session_main_t *smm = &session_main;
1638 session_type_t session_type;
1639 u32 next_index = ~0;
1641 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1643 vec_validate (smm->session_type_to_next, session_type);
1644 vec_validate (smm->session_tx_fns, session_type);
1646 if (output_node != ~0)
1647 next_index = vlib_node_add_next (vlib_get_main (),
1648 session_queue_node.index, output_node);
1650 smm->session_type_to_next[session_type] = next_index;
1651 smm->session_tx_fns[session_type] =
1652 session_tx_fns[vft->transport_options.tx_type];
1656 session_add_transport_proto (void)
1658 session_main_t *smm = &session_main;
1659 session_worker_t *wrk;
1662 smm->last_transport_proto_type += 1;
1664 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1666 wrk = session_main_get_worker (thread);
1667 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1670 return smm->last_transport_proto_type;
1673 transport_connection_t *
1674 session_get_transport (session_t * s)
1676 if (s->session_state != SESSION_STATE_LISTENING)
1677 return transport_get_connection (session_get_transport_proto (s),
1678 s->connection_index, s->thread_index);
1680 return transport_get_listener (session_get_transport_proto (s),
1681 s->connection_index);
1685 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1687 if (s->session_state != SESSION_STATE_LISTENING)
1688 return transport_get_endpoint (session_get_transport_proto (s),
1689 s->connection_index, s->thread_index, tep,
1692 return transport_get_listener_endpoint (session_get_transport_proto (s),
1693 s->connection_index, tep, is_lcl);
1697 session_transport_attribute (session_t *s, u8 is_get,
1698 transport_endpt_attr_t *attr)
1700 if (s->session_state < SESSION_STATE_READY)
1703 return transport_connection_attribute (session_get_transport_proto (s),
1704 s->connection_index, s->thread_index,
1708 transport_connection_t *
1709 listen_session_get_transport (session_t * s)
1711 return transport_get_listener (session_get_transport_proto (s),
1712 s->connection_index);
1716 session_queue_run_on_main_thread (vlib_main_t * vm)
1718 ASSERT (vlib_get_thread_index () == 0);
1719 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1722 static clib_error_t *
1723 session_manager_main_enable (vlib_main_t * vm)
1725 session_main_t *smm = &session_main;
1726 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1727 u32 num_threads, preallocated_sessions_per_worker;
1728 session_worker_t *wrk;
1731 /* We only initialize once and do not de-initialized on disable */
1732 if (smm->is_initialized)
1735 num_threads = 1 /* main thread */ + vtm->n_threads;
1737 if (num_threads < 1)
1738 return clib_error_return (0, "n_thread_stacks not set");
1740 /* Allocate cache line aligned worker contexts */
1741 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1743 for (i = 0; i < num_threads; i++)
1746 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1747 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1748 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1749 wrk->vm = vlib_get_main_by_index (i);
1750 wrk->last_vlib_time = vlib_time_now (vm);
1751 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1752 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1754 if (num_threads > 1)
1755 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1757 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1758 session_wrk_enable_adaptive_mode (wrk);
1761 /* Allocate vpp event queues segment and queue */
1762 session_vpp_event_queues_allocate (smm);
1764 /* Initialize segment manager properties */
1765 segment_manager_main_init ();
1767 /* Preallocate sessions */
1768 if (smm->preallocated_sessions)
1770 if (num_threads == 1)
1772 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1777 preallocated_sessions_per_worker =
1778 (1.1 * (f64) smm->preallocated_sessions /
1779 (f64) (num_threads - 1));
1781 for (j = 1; j < num_threads; j++)
1783 pool_init_fixed (smm->wrk[j].sessions,
1784 preallocated_sessions_per_worker);
1789 session_lookup_init ();
1790 app_namespaces_init ();
1792 smm->is_initialized = 1;
1796 smm->is_enabled = 1;
1798 /* Enable transports */
1799 transport_enable_disable (vm, 1);
1800 session_debug_init ();
1806 session_manager_main_disable (vlib_main_t * vm)
1808 transport_enable_disable (vm, 0 /* is_en */ );
1812 session_node_enable_disable (u8 is_en)
1814 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
1815 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1816 session_main_t *sm = &session_main;
1821 n_vlibs = vlib_get_n_threads ();
1822 for (i = 0; i < n_vlibs; i++)
1824 vm = vlib_get_main_by_index (i);
1825 /* main thread with workers and not polling */
1826 if (i == 0 && n_vlibs > 1)
1828 vlib_node_set_state (vm, session_queue_node.index, mstate);
1831 vlib_node_set_state (vm, session_queue_process_node.index,
1833 n = vlib_get_node (vm, session_queue_process_node.index);
1834 vlib_start_process (vm, n->runtime_index);
1838 vlib_process_signal_event_mt (vm,
1839 session_queue_process_node.index,
1840 SESSION_Q_PROCESS_STOP, 0);
1845 vlib_node_set_state (vm, session_queue_node.index, state);
1848 if (sm->use_private_rx_mqs)
1849 application_enable_rx_mqs_nodes (is_en);
1853 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1855 clib_error_t *error = 0;
1858 if (session_main.is_enabled)
1861 error = session_manager_main_enable (vm);
1862 session_node_enable_disable (is_en);
1866 session_main.is_enabled = 0;
1867 session_manager_main_disable (vm);
1868 session_node_enable_disable (is_en);
1875 session_main_init (vlib_main_t * vm)
1877 session_main_t *smm = &session_main;
1879 smm->is_enabled = 0;
1880 smm->session_enable_asap = 0;
1882 smm->use_private_rx_mqs = 0;
1883 smm->no_adaptive = 0;
1884 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1886 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1887 smm->session_va_space_size = 128ULL << 30;
1888 smm->evt_qs_segment_size = 64 << 20;
1890 smm->session_va_space_size = 128 << 20;
1891 smm->evt_qs_segment_size = 1 << 20;
1894 smm->last_transport_proto_type = TRANSPORT_PROTO_DTLS;
1899 static clib_error_t *
1900 session_main_loop_init (vlib_main_t * vm)
1902 session_main_t *smm = &session_main;
1903 if (smm->session_enable_asap)
1905 vlib_worker_thread_barrier_sync (vm);
1906 vnet_session_enable_disable (vm, 1 /* is_en */ );
1907 vlib_worker_thread_barrier_release (vm);
1912 VLIB_INIT_FUNCTION (session_main_init);
1913 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
1915 static clib_error_t *
1916 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1918 session_main_t *smm = &session_main;
1922 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1924 if (unformat (input, "event-queue-length %d", &nitems))
1927 smm->configured_event_queue_length = nitems;
1929 clib_warning ("event queue length %d too small, ignored", nitems);
1931 else if (unformat (input, "preallocated-sessions %d",
1932 &smm->preallocated_sessions))
1934 else if (unformat (input, "v4-session-table-buckets %d",
1935 &smm->configured_v4_session_table_buckets))
1937 else if (unformat (input, "v4-halfopen-table-buckets %d",
1938 &smm->configured_v4_halfopen_table_buckets))
1940 else if (unformat (input, "v6-session-table-buckets %d",
1941 &smm->configured_v6_session_table_buckets))
1943 else if (unformat (input, "v6-halfopen-table-buckets %d",
1944 &smm->configured_v6_halfopen_table_buckets))
1946 else if (unformat (input, "v4-session-table-memory %U",
1947 unformat_memory_size, &tmp))
1949 if (tmp >= 0x100000000)
1950 return clib_error_return (0, "memory size %llx (%lld) too large",
1952 smm->configured_v4_session_table_memory = tmp;
1954 else if (unformat (input, "v4-halfopen-table-memory %U",
1955 unformat_memory_size, &tmp))
1957 if (tmp >= 0x100000000)
1958 return clib_error_return (0, "memory size %llx (%lld) too large",
1960 smm->configured_v4_halfopen_table_memory = tmp;
1962 else if (unformat (input, "v6-session-table-memory %U",
1963 unformat_memory_size, &tmp))
1965 if (tmp >= 0x100000000)
1966 return clib_error_return (0, "memory size %llx (%lld) too large",
1968 smm->configured_v6_session_table_memory = tmp;
1970 else if (unformat (input, "v6-halfopen-table-memory %U",
1971 unformat_memory_size, &tmp))
1973 if (tmp >= 0x100000000)
1974 return clib_error_return (0, "memory size %llx (%lld) too large",
1976 smm->configured_v6_halfopen_table_memory = tmp;
1978 else if (unformat (input, "local-endpoints-table-memory %U",
1979 unformat_memory_size, &tmp))
1981 if (tmp >= 0x100000000)
1982 return clib_error_return (0, "memory size %llx (%lld) too large",
1984 smm->local_endpoints_table_memory = tmp;
1986 else if (unformat (input, "local-endpoints-table-buckets %d",
1987 &smm->local_endpoints_table_buckets))
1989 /* Deprecated but maintained for compatibility */
1990 else if (unformat (input, "evt_qs_memfd_seg"))
1992 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1993 &smm->evt_qs_segment_size))
1995 else if (unformat (input, "enable"))
1996 smm->session_enable_asap = 1;
1997 else if (unformat (input, "segment-baseva 0x%lx", &smm->session_baseva))
1999 else if (unformat (input, "use-app-socket-api"))
2000 appns_sapi_enable ();
2001 else if (unformat (input, "poll-main"))
2003 else if (unformat (input, "use-private-rx-mqs"))
2004 smm->use_private_rx_mqs = 1;
2005 else if (unformat (input, "no-adaptive"))
2006 smm->no_adaptive = 1;
2008 return clib_error_return (0, "unknown input `%U'",
2009 format_unformat_error, input);
2014 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2017 * fd.io coding-style-patch-verification: ON
2020 * eval: (c-set-style "gnu")