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 *ho = session_get_from_handle (ho_handle);
308 /* App transports can migrate their half-opens */
309 if (ho->flags & SESSION_F_IS_MIGRATING)
311 /* Session still migrating, move to closed state to signal that the
312 * session should be removed. */
313 if (ho->connection_index == ~0)
315 ho->session_state = SESSION_STATE_CLOSED;
318 /* Migrated transports are no longer half-opens */
319 transport_cleanup (session_get_transport_proto (ho),
320 ho->connection_index, ho->app_index /* overloaded */);
323 transport_cleanup_half_open (session_get_transport_proto (ho),
324 ho->connection_index);
329 session_half_open_free (session_t *ho)
331 app_worker_t *app_wrk;
333 ASSERT (vlib_get_thread_index () <= 1);
334 app_wrk = app_worker_get (ho->app_wrk_index);
335 app_worker_del_half_open (app_wrk, ho);
340 session_half_open_free_rpc (void *args)
342 session_t *ho = ho_session_get (pointer_to_uword (args));
343 session_half_open_free (ho);
347 session_half_open_delete_notify (transport_connection_t *tc)
349 /* Notification from ctrl thread accepted without rpc */
350 if (!tc->thread_index)
352 session_half_open_free (ho_session_get (tc->s_index));
356 void *args = uword_to_pointer ((uword) tc->s_index, void *);
357 session_send_rpc_evt_to_thread_force (0, session_half_open_free_rpc,
363 session_half_open_migrate_notify (transport_connection_t *tc)
367 ho = ho_session_get (tc->s_index);
368 ho->flags |= SESSION_F_IS_MIGRATING;
369 ho->connection_index = ~0;
373 session_half_open_migrated_notify (transport_connection_t *tc)
377 ho = ho_session_get (tc->s_index);
379 /* App probably detached so the half-open must be cleaned up */
380 if (ho->session_state == SESSION_STATE_CLOSED)
382 session_half_open_delete_notify (tc);
385 ho->connection_index = tc->c_index;
386 /* Overload app index for half-open with new thread */
387 ho->app_index = tc->thread_index;
392 session_alloc_for_connection (transport_connection_t * tc)
395 u32 thread_index = tc->thread_index;
397 ASSERT (thread_index == vlib_get_thread_index ()
398 || transport_protocol_is_cl (tc->proto));
400 s = session_alloc (thread_index);
401 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
402 s->session_state = SESSION_STATE_CLOSED;
404 /* Attach transport to session and vice versa */
405 s->connection_index = tc->c_index;
406 tc->s_index = s->session_index;
411 session_alloc_for_half_open (transport_connection_t *tc)
415 s = ho_session_alloc ();
416 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
417 s->connection_index = tc->c_index;
418 tc->s_index = s->session_index;
423 * Discards bytes from buffer chain
425 * It discards n_bytes_to_drop starting at first buffer after chain_b
428 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
429 vlib_buffer_t ** chain_b,
432 vlib_buffer_t *next = *chain_b;
433 u32 to_drop = n_bytes_to_drop;
434 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
435 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
437 next = vlib_get_buffer (vm, next->next_buffer);
438 if (next->current_length > to_drop)
440 vlib_buffer_advance (next, to_drop);
445 to_drop -= next->current_length;
446 next->current_length = 0;
452 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
456 * Enqueue buffer chain tail
459 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
460 u32 offset, u8 is_in_order)
462 vlib_buffer_t *chain_b;
463 u32 chain_bi, len, diff;
464 vlib_main_t *vm = vlib_get_main ();
469 if (is_in_order && offset)
471 diff = offset - b->current_length;
472 if (diff > b->total_length_not_including_first_buffer)
475 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
476 chain_bi = vlib_get_buffer_index (vm, chain_b);
479 chain_bi = b->next_buffer;
483 chain_b = vlib_get_buffer (vm, chain_bi);
484 data = vlib_buffer_get_current (chain_b);
485 len = chain_b->current_length;
490 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
497 return (rv > 0) ? (written + rv) : written;
503 /* written more than what was left in chain */
504 if (written > b->total_length_not_including_first_buffer)
507 /* drop the bytes that have already been delivered */
508 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
513 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
516 clib_warning ("failed to enqueue multi-buffer seg");
522 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
523 ? chain_b->next_buffer : 0));
532 session_fifo_tuning (session_t * s, svm_fifo_t * f,
533 session_ft_action_t act, u32 len)
535 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
537 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
538 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
539 if (CLIB_ASSERT_ENABLE)
541 segment_manager_t *sm;
542 sm = segment_manager_get (f->segment_manager);
543 ASSERT (f->shr->size >= 4096);
544 ASSERT (f->shr->size <= sm->max_fifo_size);
550 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
551 * event but on request can queue notification events for later delivery by
552 * calling stream_server_flush_enqueue_events().
554 * @param tc Transport connection which is to be enqueued data
555 * @param b Buffer to be enqueued
556 * @param offset Offset at which to start enqueueing if out-of-order
557 * @param queue_event Flag to indicate if peer is to be notified or if event
558 * is to be queued. The former is useful when more data is
559 * enqueued and only one event is to be generated.
560 * @param is_in_order Flag to indicate if data is in order
561 * @return Number of bytes enqueued or a negative value if enqueueing failed.
564 session_enqueue_stream_connection (transport_connection_t * tc,
565 vlib_buffer_t * b, u32 offset,
566 u8 queue_event, u8 is_in_order)
569 int enqueued = 0, rv, in_order_off;
571 s = session_get (tc->s_index, tc->thread_index);
575 enqueued = svm_fifo_enqueue (s->rx_fifo,
577 vlib_buffer_get_current (b));
578 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
581 in_order_off = enqueued > b->current_length ? enqueued : 0;
582 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
589 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
591 vlib_buffer_get_current (b));
592 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
593 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
594 /* if something was enqueued, report even this as success for ooo
595 * segment handling */
601 /* Queue RX event on this fifo. Eventually these will need to be flushed
602 * by calling stream_server_flush_enqueue_events () */
603 session_worker_t *wrk;
605 wrk = session_main_get_worker (s->thread_index);
606 if (!(s->flags & SESSION_F_RX_EVT))
608 s->flags |= SESSION_F_RX_EVT;
609 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
612 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
619 session_enqueue_dgram_connection (session_t * s,
620 session_dgram_hdr_t * hdr,
621 vlib_buffer_t * b, u8 proto, u8 queue_event)
625 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
626 >= b->current_length + sizeof (*hdr));
628 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
631 svm_fifo_seg_t segs[2] = {
632 { (u8 *) hdr, sizeof (*hdr) },
633 { vlib_buffer_get_current (b), b->current_length }
637 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
638 0 /* allow_partial */ );
642 vlib_main_t *vm = vlib_get_main ();
643 svm_fifo_seg_t *segs = 0, *seg;
644 vlib_buffer_t *it = b;
647 vec_add2 (segs, seg, 1);
648 seg->data = (u8 *) hdr;
649 seg->len = sizeof (*hdr);
652 vec_add2 (segs, seg, 1);
653 seg->data = vlib_buffer_get_current (it);
654 seg->len = it->current_length;
656 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
658 it = vlib_get_buffer (vm, it->next_buffer);
660 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
661 0 /* allow partial */ );
665 if (queue_event && rv > 0)
667 /* Queue RX event on this fifo. Eventually these will need to be flushed
668 * by calling stream_server_flush_enqueue_events () */
669 session_worker_t *wrk;
671 wrk = session_main_get_worker (s->thread_index);
672 if (!(s->flags & SESSION_F_RX_EVT))
674 s->flags |= SESSION_F_RX_EVT;
675 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
678 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
680 return rv > 0 ? rv : 0;
684 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
685 u32 offset, u32 max_bytes)
687 session_t *s = session_get (tc->s_index, tc->thread_index);
688 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
692 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
694 session_t *s = session_get (tc->s_index, tc->thread_index);
697 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
698 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
700 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
701 session_dequeue_notify (s);
707 session_notify_subscribers (u32 app_index, session_t * s,
708 svm_fifo_t * f, session_evt_type_t evt_type)
710 app_worker_t *app_wrk;
714 app = application_get (app_index);
718 for (i = 0; i < f->shr->n_subscribers; i++)
720 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
723 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
731 * Notify session peer that new data has been enqueued.
733 * @param s Stream session for which the event is to be generated.
734 * @param lock Flag to indicate if call should lock message queue.
736 * @return 0 on success or negative number if failed to send notification.
739 session_enqueue_notify_inline (session_t * s)
741 app_worker_t *app_wrk;
745 session_index = s->session_index;
746 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
748 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
749 if (PREDICT_FALSE (!app_wrk))
751 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
755 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
757 s->flags &= ~SESSION_F_RX_EVT;
759 /* Application didn't confirm accept yet */
760 if (PREDICT_FALSE (s->session_state == SESSION_STATE_ACCEPTING))
763 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
767 if (PREDICT_FALSE (n_subscribers))
769 s = session_get (session_index, vlib_get_thread_index ());
770 return session_notify_subscribers (app_wrk->app_index, s,
771 s->rx_fifo, SESSION_IO_EVT_RX);
778 session_enqueue_notify (session_t * s)
780 return session_enqueue_notify_inline (s);
784 session_enqueue_notify_rpc (void *arg)
786 u32 session_index = pointer_to_uword (arg);
789 s = session_get_if_valid (session_index, vlib_get_thread_index ());
793 session_enqueue_notify (s);
797 * Like session_enqueue_notify, but can be called from a thread that does not
801 session_enqueue_notify_thread (session_handle_t sh)
803 u32 thread_index = session_thread_from_handle (sh);
804 u32 session_index = session_index_from_handle (sh);
807 * Pass session index (u32) as opposed to handle (u64) in case pointers
810 session_send_rpc_evt_to_thread (thread_index,
811 session_enqueue_notify_rpc,
812 uword_to_pointer (session_index, void *));
816 session_dequeue_notify (session_t * s)
818 app_worker_t *app_wrk;
820 svm_fifo_clear_deq_ntf (s->tx_fifo);
822 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
823 if (PREDICT_FALSE (!app_wrk))
826 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
830 if (PREDICT_FALSE (s->tx_fifo->shr->n_subscribers))
831 return session_notify_subscribers (app_wrk->app_index, s,
832 s->tx_fifo, SESSION_IO_EVT_TX);
838 * Flushes queue of sessions that are to be notified of new data
841 * @param thread_index Thread index for which the flush is to be performed.
842 * @return 0 on success or a positive number indicating the number of
843 * failures due to API queue being full.
846 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
848 session_worker_t *wrk = session_main_get_worker (thread_index);
853 indices = wrk->session_to_enqueue[transport_proto];
855 for (i = 0; i < vec_len (indices); i++)
857 s = session_get_if_valid (indices[i], thread_index);
858 if (PREDICT_FALSE (!s))
864 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
865 0 /* TODO/not needed */ );
867 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
871 vec_reset_length (indices);
872 wrk->session_to_enqueue[transport_proto] = indices;
878 session_main_flush_all_enqueue_events (u8 transport_proto)
880 vlib_thread_main_t *vtm = vlib_get_thread_main ();
882 for (i = 0; i < 1 + vtm->n_threads; i++)
883 errors += session_main_flush_enqueue_events (transport_proto, i);
888 session_stream_connect_notify (transport_connection_t * tc,
891 u32 opaque = 0, new_ti, new_si;
892 app_worker_t *app_wrk;
893 session_t *s = 0, *ho;
896 * Cleanup half-open table
898 session_lookup_del_half_open (tc);
900 ho = ho_session_get (tc->s_index);
902 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
907 return app_worker_connect_notify (app_wrk, s, err, opaque);
909 s = session_alloc_for_connection (tc);
910 s->session_state = SESSION_STATE_CONNECTING;
911 s->app_wrk_index = app_wrk->wrk_index;
912 new_si = s->session_index;
913 new_ti = s->thread_index;
915 if ((err = app_worker_init_connected (app_wrk, s)))
918 app_worker_connect_notify (app_wrk, 0, err, opaque);
922 s = session_get (new_si, new_ti);
923 s->session_state = SESSION_STATE_READY;
924 session_lookup_add_connection (tc, session_handle (s));
926 if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
928 session_lookup_del_connection (tc);
929 /* Avoid notifying app about rejected session cleanup */
930 s = session_get (new_si, new_ti);
931 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
939 typedef union session_switch_pool_reply_args_
948 } session_switch_pool_reply_args_t;
950 STATIC_ASSERT (sizeof (session_switch_pool_reply_args_t) <= sizeof (uword),
951 "switch pool reply args size");
954 session_switch_pool_reply (void *arg)
956 session_switch_pool_reply_args_t rargs;
959 rargs.as_u64 = pointer_to_uword (arg);
960 s = session_get_if_valid (rargs.session_index, rargs.thread_index);
964 /* Session closed during migration. Clean everything up */
967 transport_cleanup (session_get_transport_proto (s), s->connection_index,
969 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
974 /* Notify app that it has data on the new session */
975 session_enqueue_notify (s);
978 typedef struct _session_switch_pool_args
982 u32 new_thread_index;
983 u32 new_session_index;
984 } session_switch_pool_args_t;
987 * Notify old thread of the session pool switch
990 session_switch_pool (void *cb_args)
992 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
993 session_switch_pool_reply_args_t rargs;
994 session_handle_t new_sh;
995 segment_manager_t *sm;
996 app_worker_t *app_wrk;
999 ASSERT (args->thread_index == vlib_get_thread_index ());
1000 s = session_get (args->session_index, args->thread_index);
1002 /* Check if session closed during migration */
1003 rargs.is_closed = s->session_state >= SESSION_STATE_TRANSPORT_CLOSING;
1005 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1008 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1011 /* Cleanup fifo segment slice state for fifos */
1012 sm = app_worker_get_connect_segment_manager (app_wrk);
1013 segment_manager_detach_fifo (sm, &s->rx_fifo);
1014 segment_manager_detach_fifo (sm, &s->tx_fifo);
1016 /* Notify app, using old session, about the migration event */
1017 if (!rargs.is_closed)
1019 new_sh = session_make_handle (args->new_session_index,
1020 args->new_thread_index);
1021 app_worker_migrate_notify (app_wrk, s, new_sh);
1025 /* Trigger app read and fifo updates on the new thread */
1026 rargs.session_index = args->new_session_index;
1027 rargs.thread_index = args->new_thread_index;
1028 session_send_rpc_evt_to_thread (args->new_thread_index,
1029 session_switch_pool_reply,
1030 uword_to_pointer (rargs.as_u64, void *));
1033 clib_mem_free (cb_args);
1037 * Move dgram session to the right thread
1040 session_dgram_connect_notify (transport_connection_t * tc,
1041 u32 old_thread_index, session_t ** new_session)
1044 session_switch_pool_args_t *rpc_args;
1045 segment_manager_t *sm;
1046 app_worker_t *app_wrk;
1049 * Clone half-open session to the right thread.
1051 new_s = session_clone_safe (tc->s_index, old_thread_index);
1052 new_s->connection_index = tc->c_index;
1053 new_s->session_state = SESSION_STATE_READY;
1054 new_s->flags |= SESSION_F_IS_MIGRATING;
1056 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1057 session_lookup_add_connection (tc, session_handle (new_s));
1059 app_wrk = app_worker_get_if_valid (new_s->app_wrk_index);
1062 /* New set of fifos attached to the same shared memory */
1063 sm = app_worker_get_connect_segment_manager (app_wrk);
1064 segment_manager_attach_fifo (sm, &new_s->rx_fifo, new_s);
1065 segment_manager_attach_fifo (sm, &new_s->tx_fifo, new_s);
1069 * Ask thread owning the old session to clean it up and make us the tx
1072 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
1073 rpc_args->new_session_index = new_s->session_index;
1074 rpc_args->new_thread_index = new_s->thread_index;
1075 rpc_args->session_index = tc->s_index;
1076 rpc_args->thread_index = old_thread_index;
1077 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
1080 tc->s_index = new_s->session_index;
1081 new_s->connection_index = tc->c_index;
1082 *new_session = new_s;
1087 * Notification from transport that connection is being closed.
1089 * A disconnect is sent to application but state is not removed. Once
1090 * disconnect is acknowledged by application, session disconnect is called.
1091 * Ultimately this leads to close being called on transport (passive close).
1094 session_transport_closing_notify (transport_connection_t * tc)
1096 app_worker_t *app_wrk;
1099 s = session_get (tc->s_index, tc->thread_index);
1100 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1103 /* Wait for reply from app before sending notification as the
1104 * accept might be rejected */
1105 if (s->session_state == SESSION_STATE_ACCEPTING)
1107 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1111 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1112 app_wrk = app_worker_get (s->app_wrk_index);
1113 app_worker_close_notify (app_wrk, s);
1117 * Notification from transport that connection is being deleted
1119 * This removes the session if it is still valid. It should be called only on
1120 * previously fully established sessions. For instance failed connects should
1121 * call stream_session_connect_notify and indicate that the connect has
1125 session_transport_delete_notify (transport_connection_t * tc)
1129 /* App might've been removed already */
1130 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1133 switch (s->session_state)
1135 case SESSION_STATE_CREATED:
1136 /* Session was created but accept notification was not yet sent to the
1137 * app. Cleanup everything. */
1138 session_lookup_del_session (s);
1139 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1142 case SESSION_STATE_ACCEPTING:
1143 case SESSION_STATE_TRANSPORT_CLOSING:
1144 case SESSION_STATE_CLOSING:
1145 case SESSION_STATE_TRANSPORT_CLOSED:
1146 /* If transport finishes or times out before we get a reply
1147 * from the app, mark transport as closed and wait for reply
1148 * before removing the session. Cleanup session table in advance
1149 * because transport will soon be closed and closed sessions
1150 * are assumed to have been removed from the lookup table */
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);
1156 case SESSION_STATE_APP_CLOSED:
1157 /* Cleanup lookup table as transport needs to still be valid.
1158 * Program transport close to ensure that all session events
1159 * have been cleaned up. Once transport close is called, the
1160 * session is just removed because both transport and app have
1161 * confirmed the close*/
1162 session_lookup_del_session (s);
1163 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
1164 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1165 svm_fifo_dequeue_drop_all (s->tx_fifo);
1166 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1168 case SESSION_STATE_TRANSPORT_DELETED:
1170 case SESSION_STATE_CLOSED:
1171 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1175 clib_warning ("session state %u", s->session_state);
1176 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1183 * Notification from transport that it is closed
1185 * Should be called by transport, prior to calling delete notify, once it
1186 * knows that no more data will be exchanged. This could serve as an
1187 * early acknowledgment of an active close especially if transport delete
1188 * can be delayed a long time, e.g., tcp time-wait.
1191 session_transport_closed_notify (transport_connection_t * tc)
1193 app_worker_t *app_wrk;
1196 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1199 /* Transport thinks that app requested close but it actually didn't.
1200 * Can happen for tcp:
1201 * 1)if fin and rst are received in close succession.
1202 * 2)if app shutdown the connection. */
1203 if (s->session_state == SESSION_STATE_READY)
1205 session_transport_closing_notify (tc);
1206 svm_fifo_dequeue_drop_all (s->tx_fifo);
1207 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1209 /* If app close has not been received or has not yet resulted in
1210 * a transport close, only mark the session transport as closed */
1211 else if (s->session_state <= SESSION_STATE_CLOSING)
1213 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1215 /* If app also closed, switch to closed */
1216 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1217 s->session_state = SESSION_STATE_CLOSED;
1219 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1221 app_worker_transport_closed_notify (app_wrk, s);
1225 * Notify application that connection has been reset.
1228 session_transport_reset_notify (transport_connection_t * tc)
1230 app_worker_t *app_wrk;
1233 s = session_get (tc->s_index, tc->thread_index);
1234 svm_fifo_dequeue_drop_all (s->tx_fifo);
1235 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1237 if (s->session_state == SESSION_STATE_ACCEPTING)
1239 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1242 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1243 app_wrk = app_worker_get (s->app_wrk_index);
1244 app_worker_reset_notify (app_wrk, s);
1248 session_stream_accept_notify (transport_connection_t * tc)
1250 app_worker_t *app_wrk;
1253 s = session_get (tc->s_index, tc->thread_index);
1254 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1257 if (s->session_state != SESSION_STATE_CREATED)
1259 s->session_state = SESSION_STATE_ACCEPTING;
1260 if (app_worker_accept_notify (app_wrk, s))
1262 /* On transport delete, no notifications should be sent. Unless, the
1263 * accept is retried and successful. */
1264 s->session_state = SESSION_STATE_CREATED;
1271 * Accept a stream session. Optionally ping the server by callback.
1274 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1275 u32 thread_index, u8 notify)
1280 s = session_alloc_for_connection (tc);
1281 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1282 s->session_state = SESSION_STATE_CREATED;
1284 if ((rv = app_worker_init_accepted (s)))
1290 session_lookup_add_connection (tc, session_handle (s));
1292 /* Shoulder-tap the server */
1295 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1296 if ((rv = app_worker_accept_notify (app_wrk, s)))
1298 session_lookup_del_session (s);
1299 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1309 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1312 app_worker_t *app_wrk;
1316 s = session_alloc_for_connection (tc);
1317 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1319 if ((rv = app_worker_init_accepted (s)))
1325 session_lookup_add_connection (tc, session_handle (s));
1327 app_wrk = app_worker_get (s->app_wrk_index);
1328 if ((rv = app_worker_accept_notify (app_wrk, s)))
1330 session_lookup_del_session (s);
1331 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1340 session_open_cl (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1342 transport_connection_t *tc;
1343 transport_endpoint_cfg_t *tep;
1344 app_worker_t *app_wrk;
1345 session_handle_t sh;
1349 tep = session_endpoint_to_transport_cfg (rmt);
1350 rv = transport_connect (rmt->transport_proto, tep);
1353 SESSION_DBG ("Transport failed to open connection.");
1357 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1359 /* For dgram type of service, allocate session and fifos now */
1360 app_wrk = app_worker_get (rmt->app_wrk_index);
1361 s = session_alloc_for_connection (tc);
1362 s->app_wrk_index = app_wrk->wrk_index;
1363 s->session_state = SESSION_STATE_OPENED;
1364 if (app_worker_init_connected (app_wrk, s))
1370 sh = session_handle (s);
1373 session_lookup_add_connection (tc, sh);
1374 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, rmt->opaque);
1378 session_open_vc (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1380 transport_connection_t *tc;
1381 transport_endpoint_cfg_t *tep;
1382 app_worker_t *app_wrk;
1386 tep = session_endpoint_to_transport_cfg (rmt);
1387 rv = transport_connect (rmt->transport_proto, tep);
1390 SESSION_DBG ("Transport failed to open connection.");
1394 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1396 app_wrk = app_worker_get (rmt->app_wrk_index);
1398 /* If transport offers a vc service, only allocate established
1399 * session once the connection has been established.
1400 * In the meantime allocate half-open session for tracking purposes
1401 * associate half-open connection to it and add session to app-worker
1402 * half-open table. These are needed to allocate the established
1403 * session on transport notification, and to cleanup the half-open
1404 * session if the app detaches before connection establishment.
1406 ho = session_alloc_for_half_open (tc);
1407 ho->app_wrk_index = app_wrk->wrk_index;
1408 ho->ho_index = app_worker_add_half_open (app_wrk, session_handle (ho));
1409 ho->opaque = rmt->opaque;
1410 *rsh = session_handle (ho);
1412 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1413 session_lookup_add_half_open (tc, tc->c_index);
1419 session_open_app (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1421 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (rmt);
1423 /* Not supported for now */
1424 *rsh = SESSION_INVALID_HANDLE;
1425 return transport_connect (rmt->transport_proto, tep_cfg);
1428 typedef int (*session_open_service_fn) (session_endpoint_cfg_t *,
1429 session_handle_t *);
1432 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1440 * Ask transport to open connection to remote transport endpoint.
1442 * Stores handle for matching request with reply since the call can be
1443 * asynchronous. For instance, for TCP the 3-way handshake must complete
1444 * before reply comes. Session is only created once connection is established.
1446 * @param app_index Index of the application requesting the connect
1447 * @param st Session type requested.
1448 * @param tep Remote transport endpoint
1449 * @param opaque Opaque data (typically, api_context) the application expects
1450 * on open completion.
1453 session_open (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1455 transport_service_type_t tst;
1456 tst = transport_protocol_service_type (rmt->transport_proto);
1457 return session_open_srv_fns[tst](rmt, rsh);
1461 * Ask transport to listen on session endpoint.
1463 * @param s Session for which listen will be called. Note that unlike
1464 * established sessions, listen sessions are not associated to a
1466 * @param sep Local endpoint to be listened on.
1469 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1471 transport_endpoint_cfg_t *tep;
1475 /* Transport bind/listen */
1476 tep = session_endpoint_to_transport_cfg (sep);
1477 s_index = ls->session_index;
1478 tc_index = transport_start_listen (session_get_transport_proto (ls),
1484 /* Attach transport to session. Lookup tables are populated by the app
1485 * worker because local tables (for ct sessions) are not backed by a fib */
1486 ls = listen_session_get (s_index);
1487 ls->connection_index = tc_index;
1493 * Ask transport to stop listening on local transport endpoint.
1495 * @param s Session to stop listening on. It must be in state LISTENING.
1498 session_stop_listen (session_t * s)
1500 transport_proto_t tp = session_get_transport_proto (s);
1501 transport_connection_t *tc;
1503 if (s->session_state != SESSION_STATE_LISTENING)
1504 return SESSION_E_NOLISTEN;
1506 tc = transport_get_listener (tp, s->connection_index);
1508 /* If no transport, assume everything was cleaned up already */
1510 return SESSION_E_NONE;
1512 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1513 session_lookup_del_connection (tc);
1515 transport_stop_listen (tp, s->connection_index);
1520 * Initialize session half-closing procedure.
1522 * Note that half-closing will not change the state of the session.
1525 session_half_close (session_t *s)
1530 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_HALF_CLOSE);
1534 * Initialize session closing procedure.
1536 * Request is always sent to session node to ensure that all outstanding
1537 * requests are served before transport is notified.
1540 session_close (session_t * s)
1545 if (s->session_state >= SESSION_STATE_CLOSING)
1547 /* Session will only be removed once both app and transport
1548 * acknowledge the close */
1549 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1550 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1551 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1555 /* App closed so stop propagating dequeue notifications */
1556 svm_fifo_clear_deq_ntf (s->tx_fifo);
1557 s->session_state = SESSION_STATE_CLOSING;
1558 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1562 * Force a close without waiting for data to be flushed
1565 session_reset (session_t * s)
1567 if (s->session_state >= SESSION_STATE_CLOSING)
1569 /* Drop all outstanding tx data */
1570 svm_fifo_dequeue_drop_all (s->tx_fifo);
1571 s->session_state = SESSION_STATE_CLOSING;
1572 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1576 * Notify transport the session can be half-disconnected.
1578 * Must be called from the session's thread.
1581 session_transport_half_close (session_t *s)
1583 /* Only READY session can be half-closed */
1584 if (s->session_state != SESSION_STATE_READY)
1589 transport_half_close (session_get_transport_proto (s), s->connection_index,
1594 * Notify transport the session can be disconnected. This should eventually
1595 * result in a delete notification that allows us to cleanup session state.
1596 * Called for both active/passive disconnects.
1598 * Must be called from the session's thread.
1601 session_transport_close (session_t * s)
1603 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1605 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1606 s->session_state = SESSION_STATE_CLOSED;
1607 /* If transport is already deleted, just free the session */
1608 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1609 session_free_w_fifos (s);
1613 /* If the tx queue wasn't drained, the transport can continue to try
1614 * sending the outstanding data (in closed state it cannot). It MUST however
1615 * at one point, either after sending everything or after a timeout, call
1616 * delete notify. This will finally lead to the complete cleanup of the
1619 s->session_state = SESSION_STATE_APP_CLOSED;
1621 transport_close (session_get_transport_proto (s), s->connection_index,
1626 * Force transport close
1629 session_transport_reset (session_t * s)
1631 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1633 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1634 s->session_state = SESSION_STATE_CLOSED;
1635 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1636 session_free_w_fifos (s);
1640 s->session_state = SESSION_STATE_APP_CLOSED;
1641 transport_reset (session_get_transport_proto (s), s->connection_index,
1646 * Cleanup transport and session state.
1648 * Notify transport of the cleanup and free the session. This should
1649 * be called only if transport reported some error and is already
1653 session_transport_cleanup (session_t * s)
1655 /* Delete from main lookup table before we axe the the transport */
1656 session_lookup_del_session (s);
1657 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1658 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1660 /* Since we called cleanup, no delete notification will come. So, make
1661 * sure the session is properly freed. */
1662 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1667 * Allocate worker mqs in share-able segment
1669 * That can only be a newly created memfd segment, that must be mapped
1670 * by all apps/stack users unless private rx mqs are enabled.
1673 session_vpp_wrk_mqs_alloc (session_main_t *smm)
1675 u32 mq_q_length = 2048, evt_size = sizeof (session_event_t);
1676 fifo_segment_t *mqs_seg = &smm->wrk_mqs_segment;
1677 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1681 mq_q_length = clib_max (mq_q_length, smm->configured_wrk_mq_length);
1683 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1684 { mq_q_length, evt_size, 0 }, { mq_q_length >> 1, 256, 0 }
1686 cfg->consumer_pid = 0;
1688 cfg->q_nitems = mq_q_length;
1689 cfg->ring_cfgs = rc;
1692 * Compute mqs segment size based on rings config and leave space
1693 * for passing extended configuration messages, i.e., data allocated
1694 * outside of the rings. If provided with a config value, accept it
1695 * if larger than minimum size.
1697 mqs_seg_size = svm_msg_q_size_to_alloc (cfg) * vec_len (smm->wrk);
1698 mqs_seg_size = mqs_seg_size + (32 << 10);
1699 mqs_seg_size = clib_max (mqs_seg_size, smm->wrk_mqs_segment_size);
1701 mqs_seg->ssvm.ssvm_size = mqs_seg_size;
1702 mqs_seg->ssvm.my_pid = getpid ();
1703 mqs_seg->ssvm.name = format (0, "%s%c", "session: wrk-mqs-segment", 0);
1705 if (ssvm_server_init (&mqs_seg->ssvm, SSVM_SEGMENT_MEMFD))
1707 clib_warning ("failed to initialize queue segment");
1711 fifo_segment_init (mqs_seg);
1713 /* Special fifo segment that's filled only with mqs */
1714 mqs_seg->h->n_mqs = vec_len (smm->wrk);
1716 for (i = 0; i < vec_len (smm->wrk); i++)
1717 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (mqs_seg, i, cfg);
1721 session_main_get_wrk_mqs_segment (void)
1723 return &session_main.wrk_mqs_segment;
1727 session_segment_handle (session_t * s)
1732 return SESSION_INVALID_HANDLE;
1735 return segment_manager_make_segment_handle (f->segment_manager,
1740 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1741 session_tx_fifo_peek_and_snd,
1742 session_tx_fifo_dequeue_and_snd,
1743 session_tx_fifo_dequeue_internal,
1744 session_tx_fifo_dequeue_and_snd
1749 session_register_transport (transport_proto_t transport_proto,
1750 const transport_proto_vft_t * vft, u8 is_ip4,
1753 session_main_t *smm = &session_main;
1754 session_type_t session_type;
1755 u32 next_index = ~0;
1757 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1759 vec_validate (smm->session_type_to_next, session_type);
1760 vec_validate (smm->session_tx_fns, session_type);
1762 if (output_node != ~0)
1763 next_index = vlib_node_add_next (vlib_get_main (),
1764 session_queue_node.index, output_node);
1766 smm->session_type_to_next[session_type] = next_index;
1767 smm->session_tx_fns[session_type] =
1768 session_tx_fns[vft->transport_options.tx_type];
1772 session_register_update_time_fn (session_update_time_fn fn, u8 is_add)
1774 session_main_t *smm = &session_main;
1775 session_update_time_fn *fi;
1779 vec_foreach (fi, smm->update_time_fns)
1783 fi_pos = fi - smm->update_time_fns;
1793 clib_warning ("update time fn %p already registered", fn);
1796 vec_add1 (smm->update_time_fns, fn);
1800 vec_del1 (smm->update_time_fns, fi_pos);
1805 session_add_transport_proto (void)
1807 session_main_t *smm = &session_main;
1808 session_worker_t *wrk;
1811 smm->last_transport_proto_type += 1;
1813 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1815 wrk = session_main_get_worker (thread);
1816 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1819 return smm->last_transport_proto_type;
1822 transport_connection_t *
1823 session_get_transport (session_t * s)
1825 if (s->session_state != SESSION_STATE_LISTENING)
1826 return transport_get_connection (session_get_transport_proto (s),
1827 s->connection_index, s->thread_index);
1829 return transport_get_listener (session_get_transport_proto (s),
1830 s->connection_index);
1834 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1836 if (s->session_state != SESSION_STATE_LISTENING)
1837 return transport_get_endpoint (session_get_transport_proto (s),
1838 s->connection_index, s->thread_index, tep,
1841 return transport_get_listener_endpoint (session_get_transport_proto (s),
1842 s->connection_index, tep, is_lcl);
1846 session_transport_attribute (session_t *s, u8 is_get,
1847 transport_endpt_attr_t *attr)
1849 if (s->session_state < SESSION_STATE_READY)
1852 return transport_connection_attribute (session_get_transport_proto (s),
1853 s->connection_index, s->thread_index,
1857 transport_connection_t *
1858 listen_session_get_transport (session_t * s)
1860 return transport_get_listener (session_get_transport_proto (s),
1861 s->connection_index);
1865 session_queue_run_on_main_thread (vlib_main_t * vm)
1867 ASSERT (vlib_get_thread_index () == 0);
1868 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1871 static clib_error_t *
1872 session_manager_main_enable (vlib_main_t * vm)
1874 session_main_t *smm = &session_main;
1875 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1876 u32 num_threads, preallocated_sessions_per_worker;
1877 session_worker_t *wrk;
1880 /* We only initialize once and do not de-initialized on disable */
1881 if (smm->is_initialized)
1884 num_threads = 1 /* main thread */ + vtm->n_threads;
1886 if (num_threads < 1)
1887 return clib_error_return (0, "n_thread_stacks not set");
1889 /* Allocate cache line aligned worker contexts */
1890 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1892 for (i = 0; i < num_threads; i++)
1895 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1896 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1897 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1898 wrk->pending_connects = clib_llist_make_head (wrk->event_elts, evt_list);
1899 wrk->vm = vlib_get_main_by_index (i);
1900 wrk->last_vlib_time = vlib_time_now (vm);
1901 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1903 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1905 if (num_threads > 1)
1906 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1908 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1909 session_wrk_enable_adaptive_mode (wrk);
1912 /* Allocate vpp event queues segment and queue */
1913 session_vpp_wrk_mqs_alloc (smm);
1915 /* Initialize segment manager properties */
1916 segment_manager_main_init ();
1918 /* Preallocate sessions */
1919 if (smm->preallocated_sessions)
1921 if (num_threads == 1)
1923 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1928 preallocated_sessions_per_worker =
1929 (1.1 * (f64) smm->preallocated_sessions /
1930 (f64) (num_threads - 1));
1932 for (j = 1; j < num_threads; j++)
1934 pool_init_fixed (smm->wrk[j].sessions,
1935 preallocated_sessions_per_worker);
1940 session_lookup_init ();
1941 app_namespaces_init ();
1943 smm->is_initialized = 1;
1947 smm->is_enabled = 1;
1949 /* Enable transports */
1950 transport_enable_disable (vm, 1);
1951 session_debug_init ();
1957 session_manager_main_disable (vlib_main_t * vm)
1959 transport_enable_disable (vm, 0 /* is_en */ );
1963 session_node_enable_disable (u8 is_en)
1965 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
1966 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1967 session_main_t *sm = &session_main;
1972 n_vlibs = vlib_get_n_threads ();
1973 for (i = 0; i < n_vlibs; i++)
1975 vm = vlib_get_main_by_index (i);
1976 /* main thread with workers and not polling */
1977 if (i == 0 && n_vlibs > 1)
1979 vlib_node_set_state (vm, session_queue_node.index, mstate);
1982 session_main_get_worker (0)->state = SESSION_WRK_INTERRUPT;
1983 vlib_node_set_state (vm, session_queue_process_node.index,
1985 n = vlib_get_node (vm, session_queue_process_node.index);
1986 vlib_start_process (vm, n->runtime_index);
1990 vlib_process_signal_event_mt (vm,
1991 session_queue_process_node.index,
1992 SESSION_Q_PROCESS_STOP, 0);
1997 vlib_node_set_state (vm, session_queue_node.index, state);
2000 if (sm->use_private_rx_mqs)
2001 application_enable_rx_mqs_nodes (is_en);
2005 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
2007 clib_error_t *error = 0;
2010 if (session_main.is_enabled)
2013 error = session_manager_main_enable (vm);
2014 session_node_enable_disable (is_en);
2018 session_main.is_enabled = 0;
2019 session_manager_main_disable (vm);
2020 session_node_enable_disable (is_en);
2027 session_main_init (vlib_main_t * vm)
2029 session_main_t *smm = &session_main;
2031 smm->is_enabled = 0;
2032 smm->session_enable_asap = 0;
2034 smm->use_private_rx_mqs = 0;
2035 smm->no_adaptive = 0;
2036 smm->last_transport_proto_type = TRANSPORT_PROTO_HTTP;
2041 static clib_error_t *
2042 session_main_loop_init (vlib_main_t * vm)
2044 session_main_t *smm = &session_main;
2045 if (smm->session_enable_asap)
2047 vlib_worker_thread_barrier_sync (vm);
2048 vnet_session_enable_disable (vm, 1 /* is_en */ );
2049 vlib_worker_thread_barrier_release (vm);
2054 VLIB_INIT_FUNCTION (session_main_init);
2055 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
2057 static clib_error_t *
2058 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
2060 session_main_t *smm = &session_main;
2064 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2066 if (unformat (input, "wrk-mq-length %d", &nitems))
2069 smm->configured_wrk_mq_length = nitems;
2071 clib_warning ("event queue length %d too small, ignored", nitems);
2073 else if (unformat (input, "preallocated-sessions %d",
2074 &smm->preallocated_sessions))
2076 else if (unformat (input, "v4-session-table-buckets %d",
2077 &smm->configured_v4_session_table_buckets))
2079 else if (unformat (input, "v4-halfopen-table-buckets %d",
2080 &smm->configured_v4_halfopen_table_buckets))
2082 else if (unformat (input, "v6-session-table-buckets %d",
2083 &smm->configured_v6_session_table_buckets))
2085 else if (unformat (input, "v6-halfopen-table-buckets %d",
2086 &smm->configured_v6_halfopen_table_buckets))
2088 else if (unformat (input, "v4-session-table-memory %U",
2089 unformat_memory_size, &tmp))
2091 if (tmp >= 0x100000000)
2092 return clib_error_return (0, "memory size %llx (%lld) too large",
2094 smm->configured_v4_session_table_memory = tmp;
2096 else if (unformat (input, "v4-halfopen-table-memory %U",
2097 unformat_memory_size, &tmp))
2099 if (tmp >= 0x100000000)
2100 return clib_error_return (0, "memory size %llx (%lld) too large",
2102 smm->configured_v4_halfopen_table_memory = tmp;
2104 else if (unformat (input, "v6-session-table-memory %U",
2105 unformat_memory_size, &tmp))
2107 if (tmp >= 0x100000000)
2108 return clib_error_return (0, "memory size %llx (%lld) too large",
2110 smm->configured_v6_session_table_memory = tmp;
2112 else if (unformat (input, "v6-halfopen-table-memory %U",
2113 unformat_memory_size, &tmp))
2115 if (tmp >= 0x100000000)
2116 return clib_error_return (0, "memory size %llx (%lld) too large",
2118 smm->configured_v6_halfopen_table_memory = tmp;
2120 else if (unformat (input, "local-endpoints-table-memory %U",
2121 unformat_memory_size, &tmp))
2123 if (tmp >= 0x100000000)
2124 return clib_error_return (0, "memory size %llx (%lld) too large",
2126 smm->local_endpoints_table_memory = tmp;
2128 else if (unformat (input, "local-endpoints-table-buckets %d",
2129 &smm->local_endpoints_table_buckets))
2131 else if (unformat (input, "enable"))
2132 smm->session_enable_asap = 1;
2133 else if (unformat (input, "use-app-socket-api"))
2134 (void) appns_sapi_enable_disable (1 /* is_enable */);
2135 else if (unformat (input, "poll-main"))
2137 else if (unformat (input, "use-private-rx-mqs"))
2138 smm->use_private_rx_mqs = 1;
2139 else if (unformat (input, "no-adaptive"))
2140 smm->no_adaptive = 1;
2142 * Deprecated but maintained for compatibility
2144 else if (unformat (input, "evt_qs_memfd_seg"))
2146 else if (unformat (input, "segment-baseva 0x%lx", &tmp))
2148 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
2151 else if (unformat (input, "event-queue-length %d", &nitems))
2154 smm->configured_wrk_mq_length = nitems;
2156 clib_warning ("event queue length %d too small, ignored", nitems);
2159 return clib_error_return (0, "unknown input `%U'",
2160 format_unformat_error, input);
2165 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2168 * fd.io coding-style-patch-verification: ON
2171 * eval: (c-set-style "gnu")