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 <= 1)
352 session_half_open_free (ho_session_get (tc->s_index));
356 void *args = uword_to_pointer ((uword) tc->s_index, void *);
357 u32 ctrl_thread = vlib_num_workers () ? 1 : 0;
358 session_send_rpc_evt_to_thread (ctrl_thread, session_half_open_free_rpc,
364 session_half_open_migrate_notify (transport_connection_t *tc)
368 ho = ho_session_get (tc->s_index);
369 ho->flags |= SESSION_F_IS_MIGRATING;
370 ho->connection_index = ~0;
374 session_half_open_migrated_notify (transport_connection_t *tc)
378 ho = ho_session_get (tc->s_index);
380 /* App probably detached so the half-open must be cleaned up */
381 if (ho->session_state == SESSION_STATE_CLOSED)
383 session_half_open_delete_notify (tc);
386 ho->connection_index = tc->c_index;
387 /* Overload app index for half-open with new thread */
388 ho->app_index = tc->thread_index;
393 session_alloc_for_connection (transport_connection_t * tc)
396 u32 thread_index = tc->thread_index;
398 ASSERT (thread_index == vlib_get_thread_index ()
399 || transport_protocol_is_cl (tc->proto));
401 s = session_alloc (thread_index);
402 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
403 s->session_state = SESSION_STATE_CLOSED;
405 /* Attach transport to session and vice versa */
406 s->connection_index = tc->c_index;
407 tc->s_index = s->session_index;
412 session_alloc_for_half_open (transport_connection_t *tc)
416 s = ho_session_alloc ();
417 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
418 s->connection_index = tc->c_index;
419 tc->s_index = s->session_index;
424 * Discards bytes from buffer chain
426 * It discards n_bytes_to_drop starting at first buffer after chain_b
429 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
430 vlib_buffer_t ** chain_b,
433 vlib_buffer_t *next = *chain_b;
434 u32 to_drop = n_bytes_to_drop;
435 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
436 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
438 next = vlib_get_buffer (vm, next->next_buffer);
439 if (next->current_length > to_drop)
441 vlib_buffer_advance (next, to_drop);
446 to_drop -= next->current_length;
447 next->current_length = 0;
453 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
457 * Enqueue buffer chain tail
460 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
461 u32 offset, u8 is_in_order)
463 vlib_buffer_t *chain_b;
464 u32 chain_bi, len, diff;
465 vlib_main_t *vm = vlib_get_main ();
470 if (is_in_order && offset)
472 diff = offset - b->current_length;
473 if (diff > b->total_length_not_including_first_buffer)
476 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
477 chain_bi = vlib_get_buffer_index (vm, chain_b);
480 chain_bi = b->next_buffer;
484 chain_b = vlib_get_buffer (vm, chain_bi);
485 data = vlib_buffer_get_current (chain_b);
486 len = chain_b->current_length;
491 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
498 return (rv > 0) ? (written + rv) : written;
504 /* written more than what was left in chain */
505 if (written > b->total_length_not_including_first_buffer)
508 /* drop the bytes that have already been delivered */
509 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
514 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
517 clib_warning ("failed to enqueue multi-buffer seg");
523 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
524 ? chain_b->next_buffer : 0));
533 session_fifo_tuning (session_t * s, svm_fifo_t * f,
534 session_ft_action_t act, u32 len)
536 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
538 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
539 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
540 if (CLIB_ASSERT_ENABLE)
542 segment_manager_t *sm;
543 sm = segment_manager_get (f->segment_manager);
544 ASSERT (f->shr->size >= 4096);
545 ASSERT (f->shr->size <= sm->max_fifo_size);
551 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
552 * event but on request can queue notification events for later delivery by
553 * calling stream_server_flush_enqueue_events().
555 * @param tc Transport connection which is to be enqueued data
556 * @param b Buffer to be enqueued
557 * @param offset Offset at which to start enqueueing if out-of-order
558 * @param queue_event Flag to indicate if peer is to be notified or if event
559 * is to be queued. The former is useful when more data is
560 * enqueued and only one event is to be generated.
561 * @param is_in_order Flag to indicate if data is in order
562 * @return Number of bytes enqueued or a negative value if enqueueing failed.
565 session_enqueue_stream_connection (transport_connection_t * tc,
566 vlib_buffer_t * b, u32 offset,
567 u8 queue_event, u8 is_in_order)
570 int enqueued = 0, rv, in_order_off;
572 s = session_get (tc->s_index, tc->thread_index);
576 enqueued = svm_fifo_enqueue (s->rx_fifo,
578 vlib_buffer_get_current (b));
579 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
582 in_order_off = enqueued > b->current_length ? enqueued : 0;
583 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
590 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
592 vlib_buffer_get_current (b));
593 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
594 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
595 /* if something was enqueued, report even this as success for ooo
596 * segment handling */
602 /* Queue RX event on this fifo. Eventually these will need to be flushed
603 * by calling stream_server_flush_enqueue_events () */
604 session_worker_t *wrk;
606 wrk = session_main_get_worker (s->thread_index);
607 if (!(s->flags & SESSION_F_RX_EVT))
609 s->flags |= SESSION_F_RX_EVT;
610 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
613 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
620 session_enqueue_dgram_connection (session_t * s,
621 session_dgram_hdr_t * hdr,
622 vlib_buffer_t * b, u8 proto, u8 queue_event)
626 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
627 >= b->current_length + sizeof (*hdr));
629 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
632 svm_fifo_seg_t segs[2] = {
633 { (u8 *) hdr, sizeof (*hdr) },
634 { vlib_buffer_get_current (b), b->current_length }
638 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
639 0 /* allow_partial */ );
643 vlib_main_t *vm = vlib_get_main ();
644 svm_fifo_seg_t *segs = 0, *seg;
645 vlib_buffer_t *it = b;
648 vec_add2 (segs, seg, 1);
649 seg->data = (u8 *) hdr;
650 seg->len = sizeof (*hdr);
653 vec_add2 (segs, seg, 1);
654 seg->data = vlib_buffer_get_current (it);
655 seg->len = it->current_length;
657 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
659 it = vlib_get_buffer (vm, it->next_buffer);
661 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
662 0 /* allow partial */ );
666 if (queue_event && rv > 0)
668 /* Queue RX event on this fifo. Eventually these will need to be flushed
669 * by calling stream_server_flush_enqueue_events () */
670 session_worker_t *wrk;
672 wrk = session_main_get_worker (s->thread_index);
673 if (!(s->flags & SESSION_F_RX_EVT))
675 s->flags |= SESSION_F_RX_EVT;
676 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
679 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
681 return rv > 0 ? rv : 0;
685 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
686 u32 offset, u32 max_bytes)
688 session_t *s = session_get (tc->s_index, tc->thread_index);
689 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
693 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
695 session_t *s = session_get (tc->s_index, tc->thread_index);
698 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
699 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
701 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
702 session_dequeue_notify (s);
708 session_notify_subscribers (u32 app_index, session_t * s,
709 svm_fifo_t * f, session_evt_type_t evt_type)
711 app_worker_t *app_wrk;
715 app = application_get (app_index);
719 for (i = 0; i < f->shr->n_subscribers; i++)
721 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
724 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
732 * Notify session peer that new data has been enqueued.
734 * @param s Stream session for which the event is to be generated.
735 * @param lock Flag to indicate if call should lock message queue.
737 * @return 0 on success or negative number if failed to send notification.
740 session_enqueue_notify_inline (session_t * s)
742 app_worker_t *app_wrk;
746 session_index = s->session_index;
747 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
749 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
750 if (PREDICT_FALSE (!app_wrk))
752 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
756 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
758 s->flags &= ~SESSION_F_RX_EVT;
760 /* Application didn't confirm accept yet */
761 if (PREDICT_FALSE (s->session_state == SESSION_STATE_ACCEPTING))
764 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
768 if (PREDICT_FALSE (n_subscribers))
770 s = session_get (session_index, vlib_get_thread_index ());
771 return session_notify_subscribers (app_wrk->app_index, s,
772 s->rx_fifo, SESSION_IO_EVT_RX);
779 session_enqueue_notify (session_t * s)
781 return session_enqueue_notify_inline (s);
785 session_enqueue_notify_rpc (void *arg)
787 u32 session_index = pointer_to_uword (arg);
790 s = session_get_if_valid (session_index, vlib_get_thread_index ());
794 session_enqueue_notify (s);
798 * Like session_enqueue_notify, but can be called from a thread that does not
802 session_enqueue_notify_thread (session_handle_t sh)
804 u32 thread_index = session_thread_from_handle (sh);
805 u32 session_index = session_index_from_handle (sh);
808 * Pass session index (u32) as opposed to handle (u64) in case pointers
811 session_send_rpc_evt_to_thread (thread_index,
812 session_enqueue_notify_rpc,
813 uword_to_pointer (session_index, void *));
817 session_dequeue_notify (session_t * s)
819 app_worker_t *app_wrk;
821 svm_fifo_clear_deq_ntf (s->tx_fifo);
823 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
824 if (PREDICT_FALSE (!app_wrk))
827 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
831 if (PREDICT_FALSE (s->tx_fifo->shr->n_subscribers))
832 return session_notify_subscribers (app_wrk->app_index, s,
833 s->tx_fifo, SESSION_IO_EVT_TX);
839 * Flushes queue of sessions that are to be notified of new data
842 * @param thread_index Thread index for which the flush is to be performed.
843 * @return 0 on success or a positive number indicating the number of
844 * failures due to API queue being full.
847 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
849 session_worker_t *wrk = session_main_get_worker (thread_index);
854 indices = wrk->session_to_enqueue[transport_proto];
856 for (i = 0; i < vec_len (indices); i++)
858 s = session_get_if_valid (indices[i], thread_index);
859 if (PREDICT_FALSE (!s))
865 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
866 0 /* TODO/not needed */ );
868 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
872 vec_reset_length (indices);
873 wrk->session_to_enqueue[transport_proto] = indices;
879 session_main_flush_all_enqueue_events (u8 transport_proto)
881 vlib_thread_main_t *vtm = vlib_get_thread_main ();
883 for (i = 0; i < 1 + vtm->n_threads; i++)
884 errors += session_main_flush_enqueue_events (transport_proto, i);
889 session_stream_connect_notify (transport_connection_t * tc,
892 u32 opaque = 0, new_ti, new_si;
893 app_worker_t *app_wrk;
894 session_t *s = 0, *ho;
897 * Cleanup half-open table
899 session_lookup_del_half_open (tc);
901 ho = ho_session_get (tc->s_index);
903 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
908 return app_worker_connect_notify (app_wrk, s, err, opaque);
910 s = session_alloc_for_connection (tc);
911 s->session_state = SESSION_STATE_CONNECTING;
912 s->app_wrk_index = app_wrk->wrk_index;
913 new_si = s->session_index;
914 new_ti = s->thread_index;
916 if ((err = app_worker_init_connected (app_wrk, s)))
919 app_worker_connect_notify (app_wrk, 0, err, opaque);
923 s = session_get (new_si, new_ti);
924 s->session_state = SESSION_STATE_READY;
925 session_lookup_add_connection (tc, session_handle (s));
927 if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
929 session_lookup_del_connection (tc);
930 /* Avoid notifying app about rejected session cleanup */
931 s = session_get (new_si, new_ti);
932 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
941 session_switch_pool_reply (void *arg)
943 u32 session_index = pointer_to_uword (arg);
946 s = session_get_if_valid (session_index, vlib_get_thread_index ());
950 /* Notify app that it has data on the new session */
951 session_enqueue_notify (s);
954 typedef struct _session_switch_pool_args
958 u32 new_thread_index;
959 u32 new_session_index;
960 } session_switch_pool_args_t;
963 * Notify old thread of the session pool switch
966 session_switch_pool (void *cb_args)
968 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
969 session_handle_t new_sh;
970 segment_manager_t *sm;
971 app_worker_t *app_wrk;
975 ASSERT (args->thread_index == vlib_get_thread_index ());
976 s = session_get (args->session_index, args->thread_index);
978 transport_cleanup (session_get_transport_proto (s), s->connection_index,
981 new_sh = session_make_handle (args->new_session_index,
982 args->new_thread_index);
984 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
987 /* Cleanup fifo segment slice state for fifos */
988 sm = app_worker_get_connect_segment_manager (app_wrk);
989 segment_manager_detach_fifo (sm, &s->rx_fifo);
990 segment_manager_detach_fifo (sm, &s->tx_fifo);
992 /* Notify app, using old session, about the migration event */
993 app_worker_migrate_notify (app_wrk, s, new_sh);
996 /* Trigger app read and fifo updates on the new thread */
997 rargs = uword_to_pointer (args->new_session_index, void *);
998 session_send_rpc_evt_to_thread (args->new_thread_index,
999 session_switch_pool_reply, rargs);
1002 clib_mem_free (cb_args);
1006 * Move dgram session to the right thread
1009 session_dgram_connect_notify (transport_connection_t * tc,
1010 u32 old_thread_index, session_t ** new_session)
1013 session_switch_pool_args_t *rpc_args;
1014 segment_manager_t *sm;
1015 app_worker_t *app_wrk;
1018 * Clone half-open session to the right thread.
1020 new_s = session_clone_safe (tc->s_index, old_thread_index);
1021 new_s->connection_index = tc->c_index;
1022 new_s->session_state = SESSION_STATE_READY;
1023 new_s->flags |= SESSION_F_IS_MIGRATING;
1025 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1026 session_lookup_add_connection (tc, session_handle (new_s));
1028 app_wrk = app_worker_get_if_valid (new_s->app_wrk_index);
1031 /* New set of fifos attached to the same shared memory */
1032 sm = app_worker_get_connect_segment_manager (app_wrk);
1033 segment_manager_attach_fifo (sm, &new_s->rx_fifo, new_s);
1034 segment_manager_attach_fifo (sm, &new_s->tx_fifo, new_s);
1038 * Ask thread owning the old session to clean it up and make us the tx
1041 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
1042 rpc_args->new_session_index = new_s->session_index;
1043 rpc_args->new_thread_index = new_s->thread_index;
1044 rpc_args->session_index = tc->s_index;
1045 rpc_args->thread_index = old_thread_index;
1046 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
1049 tc->s_index = new_s->session_index;
1050 new_s->connection_index = tc->c_index;
1051 *new_session = new_s;
1056 * Notification from transport that connection is being closed.
1058 * A disconnect is sent to application but state is not removed. Once
1059 * disconnect is acknowledged by application, session disconnect is called.
1060 * Ultimately this leads to close being called on transport (passive close).
1063 session_transport_closing_notify (transport_connection_t * tc)
1065 app_worker_t *app_wrk;
1068 s = session_get (tc->s_index, tc->thread_index);
1069 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1071 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1072 app_wrk = app_worker_get (s->app_wrk_index);
1073 app_worker_close_notify (app_wrk, s);
1077 * Notification from transport that connection is being deleted
1079 * This removes the session if it is still valid. It should be called only on
1080 * previously fully established sessions. For instance failed connects should
1081 * call stream_session_connect_notify and indicate that the connect has
1085 session_transport_delete_notify (transport_connection_t * tc)
1089 /* App might've been removed already */
1090 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1093 switch (s->session_state)
1095 case SESSION_STATE_CREATED:
1096 /* Session was created but accept notification was not yet sent to the
1097 * app. Cleanup everything. */
1098 session_lookup_del_session (s);
1099 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1102 case SESSION_STATE_ACCEPTING:
1103 case SESSION_STATE_TRANSPORT_CLOSING:
1104 case SESSION_STATE_CLOSING:
1105 case SESSION_STATE_TRANSPORT_CLOSED:
1106 /* If transport finishes or times out before we get a reply
1107 * from the app, mark transport as closed and wait for reply
1108 * before removing the session. Cleanup session table in advance
1109 * because transport will soon be closed and closed sessions
1110 * are assumed to have been removed from the lookup table */
1111 session_lookup_del_session (s);
1112 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
1113 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1114 svm_fifo_dequeue_drop_all (s->tx_fifo);
1116 case SESSION_STATE_APP_CLOSED:
1117 /* Cleanup lookup table as transport needs to still be valid.
1118 * Program transport close to ensure that all session events
1119 * have been cleaned up. Once transport close is called, the
1120 * session is just removed because both transport and app have
1121 * confirmed the close*/
1122 session_lookup_del_session (s);
1123 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
1124 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1125 svm_fifo_dequeue_drop_all (s->tx_fifo);
1126 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1128 case SESSION_STATE_TRANSPORT_DELETED:
1130 case SESSION_STATE_CLOSED:
1131 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1135 clib_warning ("session state %u", s->session_state);
1136 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1143 * Notification from transport that it is closed
1145 * Should be called by transport, prior to calling delete notify, once it
1146 * knows that no more data will be exchanged. This could serve as an
1147 * early acknowledgment of an active close especially if transport delete
1148 * can be delayed a long time, e.g., tcp time-wait.
1151 session_transport_closed_notify (transport_connection_t * tc)
1153 app_worker_t *app_wrk;
1156 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1159 /* Transport thinks that app requested close but it actually didn't.
1160 * Can happen for tcp:
1161 * 1)if fin and rst are received in close succession.
1162 * 2)if app shutdown the connection. */
1163 if (s->session_state == SESSION_STATE_READY)
1165 session_transport_closing_notify (tc);
1166 svm_fifo_dequeue_drop_all (s->tx_fifo);
1167 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1169 /* If app close has not been received or has not yet resulted in
1170 * a transport close, only mark the session transport as closed */
1171 else if (s->session_state <= SESSION_STATE_CLOSING)
1173 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1175 /* If app also closed, switch to closed */
1176 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1177 s->session_state = SESSION_STATE_CLOSED;
1179 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1181 app_worker_transport_closed_notify (app_wrk, s);
1185 * Notify application that connection has been reset.
1188 session_transport_reset_notify (transport_connection_t * tc)
1190 app_worker_t *app_wrk;
1193 s = session_get (tc->s_index, tc->thread_index);
1194 svm_fifo_dequeue_drop_all (s->tx_fifo);
1195 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1197 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1198 app_wrk = app_worker_get (s->app_wrk_index);
1199 app_worker_reset_notify (app_wrk, s);
1203 session_stream_accept_notify (transport_connection_t * tc)
1205 app_worker_t *app_wrk;
1208 s = session_get (tc->s_index, tc->thread_index);
1209 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1212 if (s->session_state != SESSION_STATE_CREATED)
1214 s->session_state = SESSION_STATE_ACCEPTING;
1215 if (app_worker_accept_notify (app_wrk, s))
1217 /* On transport delete, no notifications should be sent. Unless, the
1218 * accept is retried and successful. */
1219 s->session_state = SESSION_STATE_CREATED;
1226 * Accept a stream session. Optionally ping the server by callback.
1229 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1230 u32 thread_index, u8 notify)
1235 s = session_alloc_for_connection (tc);
1236 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1237 s->session_state = SESSION_STATE_CREATED;
1239 if ((rv = app_worker_init_accepted (s)))
1245 session_lookup_add_connection (tc, session_handle (s));
1247 /* Shoulder-tap the server */
1250 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1251 if ((rv = app_worker_accept_notify (app_wrk, s)))
1253 session_lookup_del_session (s);
1254 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1264 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1267 app_worker_t *app_wrk;
1271 s = session_alloc_for_connection (tc);
1272 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1274 if ((rv = app_worker_init_accepted (s)))
1280 session_lookup_add_connection (tc, session_handle (s));
1282 app_wrk = app_worker_get (s->app_wrk_index);
1283 if ((rv = app_worker_accept_notify (app_wrk, s)))
1285 session_lookup_del_session (s);
1286 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1291 s->session_state = SESSION_STATE_READY;
1297 session_open_cl (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1299 transport_connection_t *tc;
1300 transport_endpoint_cfg_t *tep;
1301 app_worker_t *app_wrk;
1302 session_handle_t sh;
1306 tep = session_endpoint_to_transport_cfg (rmt);
1307 rv = transport_connect (rmt->transport_proto, tep);
1310 SESSION_DBG ("Transport failed to open connection.");
1314 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1316 /* For dgram type of service, allocate session and fifos now */
1317 app_wrk = app_worker_get (rmt->app_wrk_index);
1318 s = session_alloc_for_connection (tc);
1319 s->app_wrk_index = app_wrk->wrk_index;
1320 s->session_state = SESSION_STATE_OPENED;
1321 if (app_worker_init_connected (app_wrk, s))
1327 sh = session_handle (s);
1330 session_lookup_add_connection (tc, sh);
1331 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, rmt->opaque);
1335 session_open_vc (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1337 transport_connection_t *tc;
1338 transport_endpoint_cfg_t *tep;
1339 app_worker_t *app_wrk;
1343 tep = session_endpoint_to_transport_cfg (rmt);
1344 rv = transport_connect (rmt->transport_proto, tep);
1347 SESSION_DBG ("Transport failed to open connection.");
1351 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1353 app_wrk = app_worker_get (rmt->app_wrk_index);
1355 /* If transport offers a vc service, only allocate established
1356 * session once the connection has been established.
1357 * In the meantime allocate half-open session for tracking purposes
1358 * associate half-open connection to it and add session to app-worker
1359 * half-open table. These are needed to allocate the established
1360 * session on transport notification, and to cleanup the half-open
1361 * session if the app detaches before connection establishment.
1363 ho = session_alloc_for_half_open (tc);
1364 ho->app_wrk_index = app_wrk->wrk_index;
1365 ho->ho_index = app_worker_add_half_open (app_wrk, session_handle (ho));
1366 ho->opaque = rmt->opaque;
1367 *rsh = session_handle (ho);
1369 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1370 session_lookup_add_half_open (tc, tc->c_index);
1376 session_open_app (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1378 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (rmt);
1380 /* Not supported for now */
1381 *rsh = SESSION_INVALID_HANDLE;
1382 return transport_connect (rmt->transport_proto, tep_cfg);
1385 typedef int (*session_open_service_fn) (session_endpoint_cfg_t *,
1386 session_handle_t *);
1389 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1397 * Ask transport to open connection to remote transport endpoint.
1399 * Stores handle for matching request with reply since the call can be
1400 * asynchronous. For instance, for TCP the 3-way handshake must complete
1401 * before reply comes. Session is only created once connection is established.
1403 * @param app_index Index of the application requesting the connect
1404 * @param st Session type requested.
1405 * @param tep Remote transport endpoint
1406 * @param opaque Opaque data (typically, api_context) the application expects
1407 * on open completion.
1410 session_open (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1412 transport_service_type_t tst;
1413 tst = transport_protocol_service_type (rmt->transport_proto);
1414 return session_open_srv_fns[tst](rmt, rsh);
1418 * Ask transport to listen on session endpoint.
1420 * @param s Session for which listen will be called. Note that unlike
1421 * established sessions, listen sessions are not associated to a
1423 * @param sep Local endpoint to be listened on.
1426 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1428 transport_endpoint_t *tep;
1432 /* Transport bind/listen */
1433 tep = session_endpoint_to_transport (sep);
1434 s_index = ls->session_index;
1435 tc_index = transport_start_listen (session_get_transport_proto (ls),
1441 /* Attach transport to session. Lookup tables are populated by the app
1442 * worker because local tables (for ct sessions) are not backed by a fib */
1443 ls = listen_session_get (s_index);
1444 ls->connection_index = tc_index;
1450 * Ask transport to stop listening on local transport endpoint.
1452 * @param s Session to stop listening on. It must be in state LISTENING.
1455 session_stop_listen (session_t * s)
1457 transport_proto_t tp = session_get_transport_proto (s);
1458 transport_connection_t *tc;
1460 if (s->session_state != SESSION_STATE_LISTENING)
1461 return SESSION_E_NOLISTEN;
1463 tc = transport_get_listener (tp, s->connection_index);
1465 /* If no transport, assume everything was cleaned up already */
1467 return SESSION_E_NONE;
1469 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1470 session_lookup_del_connection (tc);
1472 transport_stop_listen (tp, s->connection_index);
1477 * Initialize session half-closing procedure.
1479 * Note that half-closing will not change the state of the session.
1482 session_half_close (session_t *s)
1487 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_HALF_CLOSE);
1491 * Initialize session closing procedure.
1493 * Request is always sent to session node to ensure that all outstanding
1494 * requests are served before transport is notified.
1497 session_close (session_t * s)
1502 if (s->session_state >= SESSION_STATE_CLOSING)
1504 /* Session will only be removed once both app and transport
1505 * acknowledge the close */
1506 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1507 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1508 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1512 s->session_state = SESSION_STATE_CLOSING;
1513 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1517 * Force a close without waiting for data to be flushed
1520 session_reset (session_t * s)
1522 if (s->session_state >= SESSION_STATE_CLOSING)
1524 /* Drop all outstanding tx data */
1525 svm_fifo_dequeue_drop_all (s->tx_fifo);
1526 s->session_state = SESSION_STATE_CLOSING;
1527 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1531 * Notify transport the session can be half-disconnected.
1533 * Must be called from the session's thread.
1536 session_transport_half_close (session_t *s)
1538 /* Only READY session can be half-closed */
1539 if (s->session_state != SESSION_STATE_READY)
1544 transport_half_close (session_get_transport_proto (s), s->connection_index,
1549 * Notify transport the session can be disconnected. This should eventually
1550 * result in a delete notification that allows us to cleanup session state.
1551 * Called for both active/passive disconnects.
1553 * Must be called from the session's thread.
1556 session_transport_close (session_t * s)
1558 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1560 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1561 s->session_state = SESSION_STATE_CLOSED;
1562 /* If transport is already deleted, just free the session */
1563 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1564 session_free_w_fifos (s);
1568 /* If the tx queue wasn't drained, the transport can continue to try
1569 * sending the outstanding data (in closed state it cannot). It MUST however
1570 * at one point, either after sending everything or after a timeout, call
1571 * delete notify. This will finally lead to the complete cleanup of the
1574 s->session_state = SESSION_STATE_APP_CLOSED;
1576 transport_close (session_get_transport_proto (s), s->connection_index,
1581 * Force transport close
1584 session_transport_reset (session_t * s)
1586 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1588 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1589 s->session_state = SESSION_STATE_CLOSED;
1590 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1591 session_free_w_fifos (s);
1595 s->session_state = SESSION_STATE_APP_CLOSED;
1596 transport_reset (session_get_transport_proto (s), s->connection_index,
1601 * Cleanup transport and session state.
1603 * Notify transport of the cleanup and free the session. This should
1604 * be called only if transport reported some error and is already
1608 session_transport_cleanup (session_t * s)
1610 /* Delete from main lookup table before we axe the the transport */
1611 session_lookup_del_session (s);
1612 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1613 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1615 /* Since we called cleanup, no delete notification will come. So, make
1616 * sure the session is properly freed. */
1617 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1622 * Allocate event queues in the shared-memory segment
1624 * That can only be a newly created memfd segment, that must be
1625 * mapped by all apps/stack users.
1628 session_vpp_event_queues_allocate (session_main_t * smm)
1630 u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1631 fifo_segment_t *eqs = &smm->evt_qs_segment;
1632 uword eqs_size = 64 << 20;
1633 pid_t vpp_pid = getpid ();
1636 if (smm->configured_event_queue_length)
1637 evt_q_length = smm->configured_event_queue_length;
1639 if (smm->evt_qs_segment_size)
1640 eqs_size = smm->evt_qs_segment_size;
1642 eqs->ssvm.ssvm_size = eqs_size;
1643 eqs->ssvm.my_pid = vpp_pid;
1644 eqs->ssvm.name = format (0, "%s%c", "session: evt-qs-segment", 0);
1645 /* clib_mem_vm_map_shared consumes first page before requested_va */
1646 eqs->ssvm.requested_va = smm->session_baseva + clib_mem_get_page_size ();
1648 if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
1650 clib_warning ("failed to initialize queue segment");
1654 fifo_segment_init (eqs);
1656 /* Special fifo segment that's filled only with mqs */
1657 eqs->h->n_mqs = vec_len (smm->wrk);
1659 for (i = 0; i < vec_len (smm->wrk); i++)
1661 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1662 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1663 {evt_q_length, evt_size, 0}
1665 {evt_q_length >> 1, 256, 0}
1667 cfg->consumer_pid = 0;
1669 cfg->q_nitems = evt_q_length;
1670 cfg->ring_cfgs = rc;
1672 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (eqs, i, cfg);
1677 session_main_get_evt_q_segment (void)
1679 return &session_main.evt_qs_segment;
1683 session_segment_handle (session_t * s)
1688 return SESSION_INVALID_HANDLE;
1691 return segment_manager_make_segment_handle (f->segment_manager,
1696 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1697 session_tx_fifo_peek_and_snd,
1698 session_tx_fifo_dequeue_and_snd,
1699 session_tx_fifo_dequeue_internal,
1700 session_tx_fifo_dequeue_and_snd
1705 session_register_transport (transport_proto_t transport_proto,
1706 const transport_proto_vft_t * vft, u8 is_ip4,
1709 session_main_t *smm = &session_main;
1710 session_type_t session_type;
1711 u32 next_index = ~0;
1713 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1715 vec_validate (smm->session_type_to_next, session_type);
1716 vec_validate (smm->session_tx_fns, session_type);
1718 if (output_node != ~0)
1719 next_index = vlib_node_add_next (vlib_get_main (),
1720 session_queue_node.index, output_node);
1722 smm->session_type_to_next[session_type] = next_index;
1723 smm->session_tx_fns[session_type] =
1724 session_tx_fns[vft->transport_options.tx_type];
1728 session_add_transport_proto (void)
1730 session_main_t *smm = &session_main;
1731 session_worker_t *wrk;
1734 smm->last_transport_proto_type += 1;
1736 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1738 wrk = session_main_get_worker (thread);
1739 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1742 return smm->last_transport_proto_type;
1745 transport_connection_t *
1746 session_get_transport (session_t * s)
1748 if (s->session_state != SESSION_STATE_LISTENING)
1749 return transport_get_connection (session_get_transport_proto (s),
1750 s->connection_index, s->thread_index);
1752 return transport_get_listener (session_get_transport_proto (s),
1753 s->connection_index);
1757 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1759 if (s->session_state != SESSION_STATE_LISTENING)
1760 return transport_get_endpoint (session_get_transport_proto (s),
1761 s->connection_index, s->thread_index, tep,
1764 return transport_get_listener_endpoint (session_get_transport_proto (s),
1765 s->connection_index, tep, is_lcl);
1769 session_transport_attribute (session_t *s, u8 is_get,
1770 transport_endpt_attr_t *attr)
1772 if (s->session_state < SESSION_STATE_READY)
1775 return transport_connection_attribute (session_get_transport_proto (s),
1776 s->connection_index, s->thread_index,
1780 transport_connection_t *
1781 listen_session_get_transport (session_t * s)
1783 return transport_get_listener (session_get_transport_proto (s),
1784 s->connection_index);
1788 session_queue_run_on_main_thread (vlib_main_t * vm)
1790 ASSERT (vlib_get_thread_index () == 0);
1791 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1794 static clib_error_t *
1795 session_manager_main_enable (vlib_main_t * vm)
1797 session_main_t *smm = &session_main;
1798 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1799 u32 num_threads, preallocated_sessions_per_worker;
1800 session_worker_t *wrk;
1803 /* We only initialize once and do not de-initialized on disable */
1804 if (smm->is_initialized)
1807 num_threads = 1 /* main thread */ + vtm->n_threads;
1809 if (num_threads < 1)
1810 return clib_error_return (0, "n_thread_stacks not set");
1812 /* Allocate cache line aligned worker contexts */
1813 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1815 for (i = 0; i < num_threads; i++)
1818 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1819 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1820 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1821 wrk->vm = vlib_get_main_by_index (i);
1822 wrk->last_vlib_time = vlib_time_now (vm);
1823 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1824 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1826 if (num_threads > 1)
1827 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1829 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1830 session_wrk_enable_adaptive_mode (wrk);
1833 /* Allocate vpp event queues segment and queue */
1834 session_vpp_event_queues_allocate (smm);
1836 /* Initialize segment manager properties */
1837 segment_manager_main_init ();
1839 /* Preallocate sessions */
1840 if (smm->preallocated_sessions)
1842 if (num_threads == 1)
1844 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1849 preallocated_sessions_per_worker =
1850 (1.1 * (f64) smm->preallocated_sessions /
1851 (f64) (num_threads - 1));
1853 for (j = 1; j < num_threads; j++)
1855 pool_init_fixed (smm->wrk[j].sessions,
1856 preallocated_sessions_per_worker);
1861 session_lookup_init ();
1862 app_namespaces_init ();
1864 smm->is_initialized = 1;
1868 smm->is_enabled = 1;
1870 /* Enable transports */
1871 transport_enable_disable (vm, 1);
1872 session_debug_init ();
1878 session_manager_main_disable (vlib_main_t * vm)
1880 transport_enable_disable (vm, 0 /* is_en */ );
1884 session_node_enable_disable (u8 is_en)
1886 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
1887 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1888 session_main_t *sm = &session_main;
1893 n_vlibs = vlib_get_n_threads ();
1894 for (i = 0; i < n_vlibs; i++)
1896 vm = vlib_get_main_by_index (i);
1897 /* main thread with workers and not polling */
1898 if (i == 0 && n_vlibs > 1)
1900 vlib_node_set_state (vm, session_queue_node.index, mstate);
1903 vlib_node_set_state (vm, session_queue_process_node.index,
1905 n = vlib_get_node (vm, session_queue_process_node.index);
1906 vlib_start_process (vm, n->runtime_index);
1910 vlib_process_signal_event_mt (vm,
1911 session_queue_process_node.index,
1912 SESSION_Q_PROCESS_STOP, 0);
1917 vlib_node_set_state (vm, session_queue_node.index, state);
1920 if (sm->use_private_rx_mqs)
1921 application_enable_rx_mqs_nodes (is_en);
1925 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1927 clib_error_t *error = 0;
1930 if (session_main.is_enabled)
1933 error = session_manager_main_enable (vm);
1934 session_node_enable_disable (is_en);
1938 session_main.is_enabled = 0;
1939 session_manager_main_disable (vm);
1940 session_node_enable_disable (is_en);
1947 session_main_init (vlib_main_t * vm)
1949 session_main_t *smm = &session_main;
1951 smm->is_enabled = 0;
1952 smm->session_enable_asap = 0;
1954 smm->use_private_rx_mqs = 0;
1955 smm->no_adaptive = 0;
1956 smm->session_baseva = HIGH_SEGMENT_BASEVA;
1958 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1959 smm->session_va_space_size = 128ULL << 30;
1960 smm->evt_qs_segment_size = 64 << 20;
1962 smm->session_va_space_size = 128 << 20;
1963 smm->evt_qs_segment_size = 1 << 20;
1966 smm->last_transport_proto_type = TRANSPORT_PROTO_DTLS;
1971 static clib_error_t *
1972 session_main_loop_init (vlib_main_t * vm)
1974 session_main_t *smm = &session_main;
1975 if (smm->session_enable_asap)
1977 vlib_worker_thread_barrier_sync (vm);
1978 vnet_session_enable_disable (vm, 1 /* is_en */ );
1979 vlib_worker_thread_barrier_release (vm);
1984 VLIB_INIT_FUNCTION (session_main_init);
1985 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
1987 static clib_error_t *
1988 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1990 session_main_t *smm = &session_main;
1994 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1996 if (unformat (input, "event-queue-length %d", &nitems))
1999 smm->configured_event_queue_length = nitems;
2001 clib_warning ("event queue length %d too small, ignored", nitems);
2003 else if (unformat (input, "preallocated-sessions %d",
2004 &smm->preallocated_sessions))
2006 else if (unformat (input, "v4-session-table-buckets %d",
2007 &smm->configured_v4_session_table_buckets))
2009 else if (unformat (input, "v4-halfopen-table-buckets %d",
2010 &smm->configured_v4_halfopen_table_buckets))
2012 else if (unformat (input, "v6-session-table-buckets %d",
2013 &smm->configured_v6_session_table_buckets))
2015 else if (unformat (input, "v6-halfopen-table-buckets %d",
2016 &smm->configured_v6_halfopen_table_buckets))
2018 else if (unformat (input, "v4-session-table-memory %U",
2019 unformat_memory_size, &tmp))
2021 if (tmp >= 0x100000000)
2022 return clib_error_return (0, "memory size %llx (%lld) too large",
2024 smm->configured_v4_session_table_memory = tmp;
2026 else if (unformat (input, "v4-halfopen-table-memory %U",
2027 unformat_memory_size, &tmp))
2029 if (tmp >= 0x100000000)
2030 return clib_error_return (0, "memory size %llx (%lld) too large",
2032 smm->configured_v4_halfopen_table_memory = tmp;
2034 else if (unformat (input, "v6-session-table-memory %U",
2035 unformat_memory_size, &tmp))
2037 if (tmp >= 0x100000000)
2038 return clib_error_return (0, "memory size %llx (%lld) too large",
2040 smm->configured_v6_session_table_memory = tmp;
2042 else if (unformat (input, "v6-halfopen-table-memory %U",
2043 unformat_memory_size, &tmp))
2045 if (tmp >= 0x100000000)
2046 return clib_error_return (0, "memory size %llx (%lld) too large",
2048 smm->configured_v6_halfopen_table_memory = tmp;
2050 else if (unformat (input, "local-endpoints-table-memory %U",
2051 unformat_memory_size, &tmp))
2053 if (tmp >= 0x100000000)
2054 return clib_error_return (0, "memory size %llx (%lld) too large",
2056 smm->local_endpoints_table_memory = tmp;
2058 else if (unformat (input, "local-endpoints-table-buckets %d",
2059 &smm->local_endpoints_table_buckets))
2061 /* Deprecated but maintained for compatibility */
2062 else if (unformat (input, "evt_qs_memfd_seg"))
2064 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
2065 &smm->evt_qs_segment_size))
2067 else if (unformat (input, "enable"))
2068 smm->session_enable_asap = 1;
2069 else if (unformat (input, "segment-baseva 0x%lx", &smm->session_baseva))
2071 else if (unformat (input, "use-app-socket-api"))
2072 appns_sapi_enable ();
2073 else if (unformat (input, "poll-main"))
2075 else if (unformat (input, "use-private-rx-mqs"))
2076 smm->use_private_rx_mqs = 1;
2077 else if (unformat (input, "no-adaptive"))
2078 smm->no_adaptive = 1;
2080 return clib_error_return (0, "unknown input `%U'",
2081 format_unformat_error, input);
2086 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2089 * fd.io coding-style-patch-verification: ON
2092 * eval: (c-set-style "gnu")