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];
205 u8 will_expand = pool_get_will_expand (wrk->sessions);
207 /* If we have peekers, let them finish */
208 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
210 clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
211 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
212 clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
216 pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
218 clib_memset (s, 0, sizeof (*s));
219 s->session_index = s - wrk->sessions;
220 s->thread_index = thread_index;
221 s->app_index = APP_INVALID_INDEX;
226 session_free (session_t * s)
230 u8 thread_index = s->thread_index;
231 clib_memset (s, 0xFA, sizeof (*s));
232 pool_put (session_main.wrk[thread_index].sessions, s);
235 SESSION_EVT (SESSION_EVT_FREE, s);
236 pool_put (session_main.wrk[s->thread_index].sessions, s);
240 session_is_valid (u32 si, u8 thread_index)
243 transport_connection_t *tc;
245 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
247 if (s->thread_index != thread_index || s->session_index != si)
250 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED
251 || s->session_state <= SESSION_STATE_LISTENING)
254 if (s->session_state == SESSION_STATE_CONNECTING &&
255 (s->flags & SESSION_F_HALF_OPEN))
258 tc = session_get_transport (s);
259 if (s->connection_index != tc->c_index
260 || s->thread_index != tc->thread_index || tc->s_index != si)
267 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
269 app_worker_t *app_wrk;
271 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
274 app_worker_cleanup_notify (app_wrk, s, ntf);
278 session_free_w_fifos (session_t * s)
280 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
281 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
286 * Cleans up session and lookup table.
288 * Transport connection must still be valid.
291 session_delete (session_t * s)
295 /* Delete from the main lookup table. */
296 if ((rv = session_lookup_del_session (s)))
297 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
299 session_free_w_fifos (s);
303 session_cleanup_half_open (session_handle_t ho_handle)
305 session_t *ho = session_get_from_handle (ho_handle);
307 /* App transports can migrate their half-opens */
308 if (ho->flags & SESSION_F_IS_MIGRATING)
310 /* Session still migrating, move to closed state to signal that the
311 * session should be removed. */
312 if (ho->connection_index == ~0)
314 ho->session_state = SESSION_STATE_CLOSED;
317 /* Migrated transports are no longer half-opens */
318 transport_cleanup (session_get_transport_proto (ho),
319 ho->connection_index, ho->app_index /* overloaded */);
322 transport_cleanup_half_open (session_get_transport_proto (ho),
323 ho->connection_index);
328 session_half_open_free (session_t *ho)
330 app_worker_t *app_wrk;
332 ASSERT (vlib_get_thread_index () <= 1);
333 app_wrk = app_worker_get (ho->app_wrk_index);
334 app_worker_del_half_open (app_wrk, ho);
339 session_half_open_free_rpc (void *args)
341 session_t *ho = ho_session_get (pointer_to_uword (args));
342 session_half_open_free (ho);
346 session_half_open_delete_notify (transport_connection_t *tc)
348 /* Notification from ctrl thread accepted without rpc */
349 if (!tc->thread_index)
351 session_half_open_free (ho_session_get (tc->s_index));
355 void *args = uword_to_pointer ((uword) tc->s_index, void *);
356 session_send_rpc_evt_to_thread_force (0, session_half_open_free_rpc,
362 session_half_open_migrate_notify (transport_connection_t *tc)
366 ho = ho_session_get (tc->s_index);
367 ho->flags |= SESSION_F_IS_MIGRATING;
368 ho->connection_index = ~0;
372 session_half_open_migrated_notify (transport_connection_t *tc)
376 ho = ho_session_get (tc->s_index);
378 /* App probably detached so the half-open must be cleaned up */
379 if (ho->session_state == SESSION_STATE_CLOSED)
381 session_half_open_delete_notify (tc);
384 ho->connection_index = tc->c_index;
385 /* Overload app index for half-open with new thread */
386 ho->app_index = tc->thread_index;
391 session_alloc_for_connection (transport_connection_t * tc)
394 u32 thread_index = tc->thread_index;
396 ASSERT (thread_index == vlib_get_thread_index ()
397 || transport_protocol_is_cl (tc->proto));
399 s = session_alloc (thread_index);
400 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
401 s->session_state = SESSION_STATE_CLOSED;
403 /* Attach transport to session and vice versa */
404 s->connection_index = tc->c_index;
405 tc->s_index = s->session_index;
410 session_alloc_for_half_open (transport_connection_t *tc)
414 s = ho_session_alloc ();
415 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
416 s->connection_index = tc->c_index;
417 tc->s_index = s->session_index;
422 * Discards bytes from buffer chain
424 * It discards n_bytes_to_drop starting at first buffer after chain_b
427 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
428 vlib_buffer_t ** chain_b,
431 vlib_buffer_t *next = *chain_b;
432 u32 to_drop = n_bytes_to_drop;
433 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
434 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
436 next = vlib_get_buffer (vm, next->next_buffer);
437 if (next->current_length > to_drop)
439 vlib_buffer_advance (next, to_drop);
444 to_drop -= next->current_length;
445 next->current_length = 0;
451 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
455 * Enqueue buffer chain tail
458 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
459 u32 offset, u8 is_in_order)
461 vlib_buffer_t *chain_b;
462 u32 chain_bi, len, diff;
463 vlib_main_t *vm = vlib_get_main ();
468 if (is_in_order && offset)
470 diff = offset - b->current_length;
471 if (diff > b->total_length_not_including_first_buffer)
474 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
475 chain_bi = vlib_get_buffer_index (vm, chain_b);
478 chain_bi = b->next_buffer;
482 chain_b = vlib_get_buffer (vm, chain_bi);
483 data = vlib_buffer_get_current (chain_b);
484 len = chain_b->current_length;
489 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
496 return (rv > 0) ? (written + rv) : written;
502 /* written more than what was left in chain */
503 if (written > b->total_length_not_including_first_buffer)
506 /* drop the bytes that have already been delivered */
507 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
512 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
515 clib_warning ("failed to enqueue multi-buffer seg");
521 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
522 ? chain_b->next_buffer : 0));
531 session_fifo_tuning (session_t * s, svm_fifo_t * f,
532 session_ft_action_t act, u32 len)
534 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
536 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
537 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
538 if (CLIB_ASSERT_ENABLE)
540 segment_manager_t *sm;
541 sm = segment_manager_get (f->segment_manager);
542 ASSERT (f->shr->size >= 4096);
543 ASSERT (f->shr->size <= sm->max_fifo_size);
549 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
550 * event but on request can queue notification events for later delivery by
551 * calling stream_server_flush_enqueue_events().
553 * @param tc Transport connection which is to be enqueued data
554 * @param b Buffer to be enqueued
555 * @param offset Offset at which to start enqueueing if out-of-order
556 * @param queue_event Flag to indicate if peer is to be notified or if event
557 * is to be queued. The former is useful when more data is
558 * enqueued and only one event is to be generated.
559 * @param is_in_order Flag to indicate if data is in order
560 * @return Number of bytes enqueued or a negative value if enqueueing failed.
563 session_enqueue_stream_connection (transport_connection_t * tc,
564 vlib_buffer_t * b, u32 offset,
565 u8 queue_event, u8 is_in_order)
568 int enqueued = 0, rv, in_order_off;
570 s = session_get (tc->s_index, tc->thread_index);
574 enqueued = svm_fifo_enqueue (s->rx_fifo,
576 vlib_buffer_get_current (b));
577 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
580 in_order_off = enqueued > b->current_length ? enqueued : 0;
581 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
588 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
590 vlib_buffer_get_current (b));
591 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
592 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
593 /* if something was enqueued, report even this as success for ooo
594 * segment handling */
600 /* Queue RX event on this fifo. Eventually these will need to be flushed
601 * by calling stream_server_flush_enqueue_events () */
602 session_worker_t *wrk;
604 wrk = session_main_get_worker (s->thread_index);
605 if (!(s->flags & SESSION_F_RX_EVT))
607 s->flags |= SESSION_F_RX_EVT;
608 vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
611 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
618 session_enqueue_dgram_connection (session_t * s,
619 session_dgram_hdr_t * hdr,
620 vlib_buffer_t * b, u8 proto, u8 queue_event)
624 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
625 >= b->current_length + sizeof (*hdr));
627 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
630 svm_fifo_seg_t segs[2] = {
631 { (u8 *) hdr, sizeof (*hdr) },
632 { vlib_buffer_get_current (b), b->current_length }
636 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
637 0 /* allow_partial */ );
641 vlib_main_t *vm = vlib_get_main ();
642 svm_fifo_seg_t *segs = 0, *seg;
643 vlib_buffer_t *it = b;
646 vec_add2 (segs, seg, 1);
647 seg->data = (u8 *) hdr;
648 seg->len = sizeof (*hdr);
651 vec_add2 (segs, seg, 1);
652 seg->data = vlib_buffer_get_current (it);
653 seg->len = it->current_length;
655 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
657 it = vlib_get_buffer (vm, it->next_buffer);
659 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
660 0 /* allow partial */ );
664 if (queue_event && rv > 0)
666 /* Queue RX event on this fifo. Eventually these will need to be flushed
667 * by calling stream_server_flush_enqueue_events () */
668 session_worker_t *wrk;
670 wrk = session_main_get_worker (s->thread_index);
671 if (!(s->flags & SESSION_F_RX_EVT))
673 s->flags |= SESSION_F_RX_EVT;
674 vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
677 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
679 return rv > 0 ? rv : 0;
683 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
684 u32 offset, u32 max_bytes)
686 session_t *s = session_get (tc->s_index, tc->thread_index);
687 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
691 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
693 session_t *s = session_get (tc->s_index, tc->thread_index);
696 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
697 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
699 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
700 session_dequeue_notify (s);
706 session_notify_subscribers (u32 app_index, session_t * s,
707 svm_fifo_t * f, session_evt_type_t evt_type)
709 app_worker_t *app_wrk;
713 app = application_get (app_index);
717 for (i = 0; i < f->shr->n_subscribers; i++)
719 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
722 if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
730 * Notify session peer that new data has been enqueued.
732 * @param s Stream session for which the event is to be generated.
733 * @param lock Flag to indicate if call should lock message queue.
735 * @return 0 on success or negative number if failed to send notification.
738 session_enqueue_notify_inline (session_t * s)
740 app_worker_t *app_wrk;
744 session_index = s->session_index;
745 n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
747 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
748 if (PREDICT_FALSE (!app_wrk))
750 SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
754 SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
756 s->flags &= ~SESSION_F_RX_EVT;
758 /* Application didn't confirm accept yet */
759 if (PREDICT_FALSE (s->session_state == SESSION_STATE_ACCEPTING))
762 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
766 if (PREDICT_FALSE (n_subscribers))
768 s = session_get (session_index, vlib_get_thread_index ());
769 return session_notify_subscribers (app_wrk->app_index, s,
770 s->rx_fifo, SESSION_IO_EVT_RX);
777 session_enqueue_notify (session_t * s)
779 return session_enqueue_notify_inline (s);
783 session_enqueue_notify_rpc (void *arg)
785 u32 session_index = pointer_to_uword (arg);
788 s = session_get_if_valid (session_index, vlib_get_thread_index ());
792 session_enqueue_notify (s);
796 * Like session_enqueue_notify, but can be called from a thread that does not
800 session_enqueue_notify_thread (session_handle_t sh)
802 u32 thread_index = session_thread_from_handle (sh);
803 u32 session_index = session_index_from_handle (sh);
806 * Pass session index (u32) as opposed to handle (u64) in case pointers
809 session_send_rpc_evt_to_thread (thread_index,
810 session_enqueue_notify_rpc,
811 uword_to_pointer (session_index, void *));
815 session_dequeue_notify (session_t * s)
817 app_worker_t *app_wrk;
819 svm_fifo_clear_deq_ntf (s->tx_fifo);
821 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
822 if (PREDICT_FALSE (!app_wrk))
825 if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
829 if (PREDICT_FALSE (s->tx_fifo->shr->n_subscribers))
830 return session_notify_subscribers (app_wrk->app_index, s,
831 s->tx_fifo, SESSION_IO_EVT_TX);
837 * Flushes queue of sessions that are to be notified of new data
840 * @param thread_index Thread index for which the flush is to be performed.
841 * @return 0 on success or a positive number indicating the number of
842 * failures due to API queue being full.
845 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
847 session_worker_t *wrk = session_main_get_worker (thread_index);
852 indices = wrk->session_to_enqueue[transport_proto];
854 for (i = 0; i < vec_len (indices); i++)
856 s = session_get_if_valid (indices[i], thread_index);
857 if (PREDICT_FALSE (!s))
863 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
864 0 /* TODO/not needed */ );
866 if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
870 vec_reset_length (indices);
871 wrk->session_to_enqueue[transport_proto] = indices;
877 session_main_flush_all_enqueue_events (u8 transport_proto)
879 vlib_thread_main_t *vtm = vlib_get_thread_main ();
881 for (i = 0; i < 1 + vtm->n_threads; i++)
882 errors += session_main_flush_enqueue_events (transport_proto, i);
887 session_stream_connect_notify (transport_connection_t * tc,
890 u32 opaque = 0, new_ti, new_si;
891 app_worker_t *app_wrk;
892 session_t *s = 0, *ho;
895 * Cleanup half-open table
897 session_lookup_del_half_open (tc);
899 ho = ho_session_get (tc->s_index);
901 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
906 return app_worker_connect_notify (app_wrk, s, err, opaque);
908 s = session_alloc_for_connection (tc);
909 s->session_state = SESSION_STATE_CONNECTING;
910 s->app_wrk_index = app_wrk->wrk_index;
911 new_si = s->session_index;
912 new_ti = s->thread_index;
914 if ((err = app_worker_init_connected (app_wrk, s)))
917 app_worker_connect_notify (app_wrk, 0, err, opaque);
921 s = session_get (new_si, new_ti);
922 s->session_state = SESSION_STATE_READY;
923 session_lookup_add_connection (tc, session_handle (s));
925 if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
927 session_lookup_del_connection (tc);
928 /* Avoid notifying app about rejected session cleanup */
929 s = session_get (new_si, new_ti);
930 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
938 typedef union session_switch_pool_reply_args_
947 } session_switch_pool_reply_args_t;
949 STATIC_ASSERT (sizeof (session_switch_pool_reply_args_t) <= sizeof (uword),
950 "switch pool reply args size");
953 session_switch_pool_reply (void *arg)
955 session_switch_pool_reply_args_t rargs;
958 rargs.as_u64 = pointer_to_uword (arg);
959 s = session_get_if_valid (rargs.session_index, rargs.thread_index);
963 /* Session closed during migration. Clean everything up */
966 transport_cleanup (session_get_transport_proto (s), s->connection_index,
968 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
973 /* Notify app that it has data on the new session */
974 session_enqueue_notify (s);
977 typedef struct _session_switch_pool_args
981 u32 new_thread_index;
982 u32 new_session_index;
983 } session_switch_pool_args_t;
986 * Notify old thread of the session pool switch
989 session_switch_pool (void *cb_args)
991 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
992 session_switch_pool_reply_args_t rargs;
993 session_handle_t new_sh;
994 segment_manager_t *sm;
995 app_worker_t *app_wrk;
998 ASSERT (args->thread_index == vlib_get_thread_index ());
999 s = session_get (args->session_index, args->thread_index);
1001 /* Check if session closed during migration */
1002 rargs.is_closed = s->session_state >= SESSION_STATE_TRANSPORT_CLOSING;
1004 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1007 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1010 /* Cleanup fifo segment slice state for fifos */
1011 sm = app_worker_get_connect_segment_manager (app_wrk);
1012 segment_manager_detach_fifo (sm, &s->rx_fifo);
1013 segment_manager_detach_fifo (sm, &s->tx_fifo);
1015 /* Notify app, using old session, about the migration event */
1016 if (!rargs.is_closed)
1018 new_sh = session_make_handle (args->new_session_index,
1019 args->new_thread_index);
1020 app_worker_migrate_notify (app_wrk, s, new_sh);
1024 /* Trigger app read and fifo updates on the new thread */
1025 rargs.session_index = args->new_session_index;
1026 rargs.thread_index = args->new_thread_index;
1027 session_send_rpc_evt_to_thread (args->new_thread_index,
1028 session_switch_pool_reply,
1029 uword_to_pointer (rargs.as_u64, void *));
1032 clib_mem_free (cb_args);
1036 * Move dgram session to the right thread
1039 session_dgram_connect_notify (transport_connection_t * tc,
1040 u32 old_thread_index, session_t ** new_session)
1043 session_switch_pool_args_t *rpc_args;
1044 segment_manager_t *sm;
1045 app_worker_t *app_wrk;
1048 * Clone half-open session to the right thread.
1050 new_s = session_clone_safe (tc->s_index, old_thread_index);
1051 new_s->connection_index = tc->c_index;
1052 new_s->session_state = SESSION_STATE_READY;
1053 new_s->flags |= SESSION_F_IS_MIGRATING;
1055 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1056 session_lookup_add_connection (tc, session_handle (new_s));
1058 app_wrk = app_worker_get_if_valid (new_s->app_wrk_index);
1061 /* New set of fifos attached to the same shared memory */
1062 sm = app_worker_get_connect_segment_manager (app_wrk);
1063 segment_manager_attach_fifo (sm, &new_s->rx_fifo, new_s);
1064 segment_manager_attach_fifo (sm, &new_s->tx_fifo, new_s);
1068 * Ask thread owning the old session to clean it up and make us the tx
1071 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
1072 rpc_args->new_session_index = new_s->session_index;
1073 rpc_args->new_thread_index = new_s->thread_index;
1074 rpc_args->session_index = tc->s_index;
1075 rpc_args->thread_index = old_thread_index;
1076 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
1079 tc->s_index = new_s->session_index;
1080 new_s->connection_index = tc->c_index;
1081 *new_session = new_s;
1086 * Notification from transport that connection is being closed.
1088 * A disconnect is sent to application but state is not removed. Once
1089 * disconnect is acknowledged by application, session disconnect is called.
1090 * Ultimately this leads to close being called on transport (passive close).
1093 session_transport_closing_notify (transport_connection_t * tc)
1095 app_worker_t *app_wrk;
1098 s = session_get (tc->s_index, tc->thread_index);
1099 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1102 /* Wait for reply from app before sending notification as the
1103 * accept might be rejected */
1104 if (s->session_state == SESSION_STATE_ACCEPTING)
1106 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1110 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1111 app_wrk = app_worker_get (s->app_wrk_index);
1112 app_worker_close_notify (app_wrk, s);
1116 * Notification from transport that connection is being deleted
1118 * This removes the session if it is still valid. It should be called only on
1119 * previously fully established sessions. For instance failed connects should
1120 * call stream_session_connect_notify and indicate that the connect has
1124 session_transport_delete_notify (transport_connection_t * tc)
1128 /* App might've been removed already */
1129 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1132 switch (s->session_state)
1134 case SESSION_STATE_CREATED:
1135 /* Session was created but accept notification was not yet sent to the
1136 * app. Cleanup everything. */
1137 session_lookup_del_session (s);
1138 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1141 case SESSION_STATE_ACCEPTING:
1142 case SESSION_STATE_TRANSPORT_CLOSING:
1143 case SESSION_STATE_CLOSING:
1144 case SESSION_STATE_TRANSPORT_CLOSED:
1145 /* If transport finishes or times out before we get a reply
1146 * from the app, mark transport as closed and wait for reply
1147 * before removing the session. Cleanup session table in advance
1148 * because transport will soon be closed and closed sessions
1149 * are assumed to have been removed from the lookup table */
1150 session_lookup_del_session (s);
1151 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
1152 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1153 svm_fifo_dequeue_drop_all (s->tx_fifo);
1155 case SESSION_STATE_APP_CLOSED:
1156 /* Cleanup lookup table as transport needs to still be valid.
1157 * Program transport close to ensure that all session events
1158 * have been cleaned up. Once transport close is called, the
1159 * session is just removed because both transport and app have
1160 * confirmed the close*/
1161 session_lookup_del_session (s);
1162 s->session_state = SESSION_STATE_TRANSPORT_DELETED;
1163 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1164 svm_fifo_dequeue_drop_all (s->tx_fifo);
1165 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1167 case SESSION_STATE_TRANSPORT_DELETED:
1169 case SESSION_STATE_CLOSED:
1170 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1174 clib_warning ("session state %u", s->session_state);
1175 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1182 * Notification from transport that it is closed
1184 * Should be called by transport, prior to calling delete notify, once it
1185 * knows that no more data will be exchanged. This could serve as an
1186 * early acknowledgment of an active close especially if transport delete
1187 * can be delayed a long time, e.g., tcp time-wait.
1190 session_transport_closed_notify (transport_connection_t * tc)
1192 app_worker_t *app_wrk;
1195 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1198 /* Transport thinks that app requested close but it actually didn't.
1199 * Can happen for tcp:
1200 * 1)if fin and rst are received in close succession.
1201 * 2)if app shutdown the connection. */
1202 if (s->session_state == SESSION_STATE_READY)
1204 session_transport_closing_notify (tc);
1205 svm_fifo_dequeue_drop_all (s->tx_fifo);
1206 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1208 /* If app close has not been received or has not yet resulted in
1209 * a transport close, only mark the session transport as closed */
1210 else if (s->session_state <= SESSION_STATE_CLOSING)
1212 s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1214 /* If app also closed, switch to closed */
1215 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1216 s->session_state = SESSION_STATE_CLOSED;
1218 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1220 app_worker_transport_closed_notify (app_wrk, s);
1224 * Notify application that connection has been reset.
1227 session_transport_reset_notify (transport_connection_t * tc)
1229 app_worker_t *app_wrk;
1232 s = session_get (tc->s_index, tc->thread_index);
1233 svm_fifo_dequeue_drop_all (s->tx_fifo);
1234 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1236 if (s->session_state == SESSION_STATE_ACCEPTING)
1238 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1241 s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1242 app_wrk = app_worker_get (s->app_wrk_index);
1243 app_worker_reset_notify (app_wrk, s);
1247 session_stream_accept_notify (transport_connection_t * tc)
1249 app_worker_t *app_wrk;
1252 s = session_get (tc->s_index, tc->thread_index);
1253 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1256 if (s->session_state != SESSION_STATE_CREATED)
1258 s->session_state = SESSION_STATE_ACCEPTING;
1259 if (app_worker_accept_notify (app_wrk, s))
1261 /* On transport delete, no notifications should be sent. Unless, the
1262 * accept is retried and successful. */
1263 s->session_state = SESSION_STATE_CREATED;
1270 * Accept a stream session. Optionally ping the server by callback.
1273 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1274 u32 thread_index, u8 notify)
1279 s = session_alloc_for_connection (tc);
1280 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1281 s->session_state = SESSION_STATE_CREATED;
1283 if ((rv = app_worker_init_accepted (s)))
1289 session_lookup_add_connection (tc, session_handle (s));
1291 /* Shoulder-tap the server */
1294 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1295 if ((rv = app_worker_accept_notify (app_wrk, s)))
1297 session_lookup_del_session (s);
1298 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1308 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1311 app_worker_t *app_wrk;
1315 s = session_alloc_for_connection (tc);
1316 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1318 if ((rv = app_worker_init_accepted (s)))
1324 session_lookup_add_connection (tc, session_handle (s));
1326 app_wrk = app_worker_get (s->app_wrk_index);
1327 if ((rv = app_worker_accept_notify (app_wrk, s)))
1329 session_lookup_del_session (s);
1330 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1339 session_open_cl (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1341 transport_connection_t *tc;
1342 transport_endpoint_cfg_t *tep;
1343 app_worker_t *app_wrk;
1344 session_handle_t sh;
1348 tep = session_endpoint_to_transport_cfg (rmt);
1349 rv = transport_connect (rmt->transport_proto, tep);
1352 SESSION_DBG ("Transport failed to open connection.");
1356 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1358 /* For dgram type of service, allocate session and fifos now */
1359 app_wrk = app_worker_get (rmt->app_wrk_index);
1360 s = session_alloc_for_connection (tc);
1361 s->app_wrk_index = app_wrk->wrk_index;
1362 s->session_state = SESSION_STATE_OPENED;
1363 if (app_worker_init_connected (app_wrk, s))
1369 sh = session_handle (s);
1372 session_lookup_add_connection (tc, sh);
1373 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, rmt->opaque);
1377 session_open_vc (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1379 transport_connection_t *tc;
1380 transport_endpoint_cfg_t *tep;
1381 app_worker_t *app_wrk;
1385 tep = session_endpoint_to_transport_cfg (rmt);
1386 rv = transport_connect (rmt->transport_proto, tep);
1389 SESSION_DBG ("Transport failed to open connection.");
1393 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1395 app_wrk = app_worker_get (rmt->app_wrk_index);
1397 /* If transport offers a vc service, only allocate established
1398 * session once the connection has been established.
1399 * In the meantime allocate half-open session for tracking purposes
1400 * associate half-open connection to it and add session to app-worker
1401 * half-open table. These are needed to allocate the established
1402 * session on transport notification, and to cleanup the half-open
1403 * session if the app detaches before connection establishment.
1405 ho = session_alloc_for_half_open (tc);
1406 ho->app_wrk_index = app_wrk->wrk_index;
1407 ho->ho_index = app_worker_add_half_open (app_wrk, session_handle (ho));
1408 ho->opaque = rmt->opaque;
1409 *rsh = session_handle (ho);
1411 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1412 session_lookup_add_half_open (tc, tc->c_index);
1418 session_open_app (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1420 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (rmt);
1422 /* Not supported for now */
1423 *rsh = SESSION_INVALID_HANDLE;
1424 return transport_connect (rmt->transport_proto, tep_cfg);
1427 typedef int (*session_open_service_fn) (session_endpoint_cfg_t *,
1428 session_handle_t *);
1431 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1439 * Ask transport to open connection to remote transport endpoint.
1441 * Stores handle for matching request with reply since the call can be
1442 * asynchronous. For instance, for TCP the 3-way handshake must complete
1443 * before reply comes. Session is only created once connection is established.
1445 * @param app_index Index of the application requesting the connect
1446 * @param st Session type requested.
1447 * @param tep Remote transport endpoint
1448 * @param opaque Opaque data (typically, api_context) the application expects
1449 * on open completion.
1452 session_open (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1454 transport_service_type_t tst;
1455 tst = transport_protocol_service_type (rmt->transport_proto);
1456 return session_open_srv_fns[tst](rmt, rsh);
1460 * Ask transport to listen on session endpoint.
1462 * @param s Session for which listen will be called. Note that unlike
1463 * established sessions, listen sessions are not associated to a
1465 * @param sep Local endpoint to be listened on.
1468 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1470 transport_endpoint_cfg_t *tep;
1474 /* Transport bind/listen */
1475 tep = session_endpoint_to_transport_cfg (sep);
1476 s_index = ls->session_index;
1477 tc_index = transport_start_listen (session_get_transport_proto (ls),
1483 /* Attach transport to session. Lookup tables are populated by the app
1484 * worker because local tables (for ct sessions) are not backed by a fib */
1485 ls = listen_session_get (s_index);
1486 ls->connection_index = tc_index;
1492 * Ask transport to stop listening on local transport endpoint.
1494 * @param s Session to stop listening on. It must be in state LISTENING.
1497 session_stop_listen (session_t * s)
1499 transport_proto_t tp = session_get_transport_proto (s);
1500 transport_connection_t *tc;
1502 if (s->session_state != SESSION_STATE_LISTENING)
1503 return SESSION_E_NOLISTEN;
1505 tc = transport_get_listener (tp, s->connection_index);
1507 /* If no transport, assume everything was cleaned up already */
1509 return SESSION_E_NONE;
1511 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1512 session_lookup_del_connection (tc);
1514 transport_stop_listen (tp, s->connection_index);
1519 * Initialize session half-closing procedure.
1521 * Note that half-closing will not change the state of the session.
1524 session_half_close (session_t *s)
1529 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_HALF_CLOSE);
1533 * Initialize session closing procedure.
1535 * Request is always sent to session node to ensure that all outstanding
1536 * requests are served before transport is notified.
1539 session_close (session_t * s)
1544 if (s->session_state >= SESSION_STATE_CLOSING)
1546 /* Session will only be removed once both app and transport
1547 * acknowledge the close */
1548 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1549 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1550 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1554 /* App closed so stop propagating dequeue notifications */
1555 svm_fifo_clear_deq_ntf (s->tx_fifo);
1556 s->session_state = SESSION_STATE_CLOSING;
1557 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1561 * Force a close without waiting for data to be flushed
1564 session_reset (session_t * s)
1566 if (s->session_state >= SESSION_STATE_CLOSING)
1568 /* Drop all outstanding tx data */
1569 svm_fifo_dequeue_drop_all (s->tx_fifo);
1570 s->session_state = SESSION_STATE_CLOSING;
1571 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1575 * Notify transport the session can be half-disconnected.
1577 * Must be called from the session's thread.
1580 session_transport_half_close (session_t *s)
1582 /* Only READY session can be half-closed */
1583 if (s->session_state != SESSION_STATE_READY)
1588 transport_half_close (session_get_transport_proto (s), s->connection_index,
1593 * Notify transport the session can be disconnected. This should eventually
1594 * result in a delete notification that allows us to cleanup session state.
1595 * Called for both active/passive disconnects.
1597 * Must be called from the session's thread.
1600 session_transport_close (session_t * s)
1602 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1604 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1605 s->session_state = SESSION_STATE_CLOSED;
1606 /* If transport is already deleted, just free the session */
1607 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1608 session_free_w_fifos (s);
1612 /* If the tx queue wasn't drained, the transport can continue to try
1613 * sending the outstanding data (in closed state it cannot). It MUST however
1614 * at one point, either after sending everything or after a timeout, call
1615 * delete notify. This will finally lead to the complete cleanup of the
1618 s->session_state = SESSION_STATE_APP_CLOSED;
1620 transport_close (session_get_transport_proto (s), s->connection_index,
1625 * Force transport close
1628 session_transport_reset (session_t * s)
1630 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1632 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1633 s->session_state = SESSION_STATE_CLOSED;
1634 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1635 session_free_w_fifos (s);
1639 s->session_state = SESSION_STATE_APP_CLOSED;
1640 transport_reset (session_get_transport_proto (s), s->connection_index,
1645 * Cleanup transport and session state.
1647 * Notify transport of the cleanup and free the session. This should
1648 * be called only if transport reported some error and is already
1652 session_transport_cleanup (session_t * s)
1654 /* Delete from main lookup table before we axe the the transport */
1655 session_lookup_del_session (s);
1656 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1657 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1659 /* Since we called cleanup, no delete notification will come. So, make
1660 * sure the session is properly freed. */
1661 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1666 * Allocate worker mqs in share-able segment
1668 * That can only be a newly created memfd segment, that must be mapped
1669 * by all apps/stack users unless private rx mqs are enabled.
1672 session_vpp_wrk_mqs_alloc (session_main_t *smm)
1674 u32 mq_q_length = 2048, evt_size = sizeof (session_event_t);
1675 fifo_segment_t *mqs_seg = &smm->wrk_mqs_segment;
1676 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1680 mq_q_length = clib_max (mq_q_length, smm->configured_wrk_mq_length);
1682 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1683 { mq_q_length, evt_size, 0 }, { mq_q_length >> 1, 256, 0 }
1685 cfg->consumer_pid = 0;
1687 cfg->q_nitems = mq_q_length;
1688 cfg->ring_cfgs = rc;
1691 * Compute mqs segment size based on rings config and leave space
1692 * for passing extended configuration messages, i.e., data allocated
1693 * outside of the rings. If provided with a config value, accept it
1694 * if larger than minimum size.
1696 mqs_seg_size = svm_msg_q_size_to_alloc (cfg) * vec_len (smm->wrk);
1697 mqs_seg_size = mqs_seg_size + (32 << 10);
1698 mqs_seg_size = clib_max (mqs_seg_size, smm->wrk_mqs_segment_size);
1700 mqs_seg->ssvm.ssvm_size = mqs_seg_size;
1701 mqs_seg->ssvm.my_pid = getpid ();
1702 mqs_seg->ssvm.name = format (0, "%s%c", "session: wrk-mqs-segment", 0);
1704 if (ssvm_server_init (&mqs_seg->ssvm, SSVM_SEGMENT_MEMFD))
1706 clib_warning ("failed to initialize queue segment");
1710 fifo_segment_init (mqs_seg);
1712 /* Special fifo segment that's filled only with mqs */
1713 mqs_seg->h->n_mqs = vec_len (smm->wrk);
1715 for (i = 0; i < vec_len (smm->wrk); i++)
1716 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (mqs_seg, i, cfg);
1720 session_main_get_wrk_mqs_segment (void)
1722 return &session_main.wrk_mqs_segment;
1726 session_segment_handle (session_t * s)
1731 return SESSION_INVALID_HANDLE;
1734 return segment_manager_make_segment_handle (f->segment_manager,
1739 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1740 session_tx_fifo_peek_and_snd,
1741 session_tx_fifo_dequeue_and_snd,
1742 session_tx_fifo_dequeue_internal,
1743 session_tx_fifo_dequeue_and_snd
1748 session_register_transport (transport_proto_t transport_proto,
1749 const transport_proto_vft_t * vft, u8 is_ip4,
1752 session_main_t *smm = &session_main;
1753 session_type_t session_type;
1754 u32 next_index = ~0;
1756 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1758 vec_validate (smm->session_type_to_next, session_type);
1759 vec_validate (smm->session_tx_fns, session_type);
1761 if (output_node != ~0)
1762 next_index = vlib_node_add_next (vlib_get_main (),
1763 session_queue_node.index, output_node);
1765 smm->session_type_to_next[session_type] = next_index;
1766 smm->session_tx_fns[session_type] =
1767 session_tx_fns[vft->transport_options.tx_type];
1771 session_register_update_time_fn (session_update_time_fn fn, u8 is_add)
1773 session_main_t *smm = &session_main;
1774 session_update_time_fn *fi;
1778 vec_foreach (fi, smm->update_time_fns)
1782 fi_pos = fi - smm->update_time_fns;
1792 clib_warning ("update time fn %p already registered", fn);
1795 vec_add1 (smm->update_time_fns, fn);
1799 vec_del1 (smm->update_time_fns, fi_pos);
1804 session_add_transport_proto (void)
1806 session_main_t *smm = &session_main;
1807 session_worker_t *wrk;
1810 smm->last_transport_proto_type += 1;
1812 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1814 wrk = session_main_get_worker (thread);
1815 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1818 return smm->last_transport_proto_type;
1821 transport_connection_t *
1822 session_get_transport (session_t * s)
1824 if (s->session_state != SESSION_STATE_LISTENING)
1825 return transport_get_connection (session_get_transport_proto (s),
1826 s->connection_index, s->thread_index);
1828 return transport_get_listener (session_get_transport_proto (s),
1829 s->connection_index);
1833 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1835 if (s->session_state != SESSION_STATE_LISTENING)
1836 return transport_get_endpoint (session_get_transport_proto (s),
1837 s->connection_index, s->thread_index, tep,
1840 return transport_get_listener_endpoint (session_get_transport_proto (s),
1841 s->connection_index, tep, is_lcl);
1845 session_transport_attribute (session_t *s, u8 is_get,
1846 transport_endpt_attr_t *attr)
1848 if (s->session_state < SESSION_STATE_READY)
1851 return transport_connection_attribute (session_get_transport_proto (s),
1852 s->connection_index, s->thread_index,
1856 transport_connection_t *
1857 listen_session_get_transport (session_t * s)
1859 return transport_get_listener (session_get_transport_proto (s),
1860 s->connection_index);
1864 session_queue_run_on_main_thread (vlib_main_t * vm)
1866 ASSERT (vlib_get_thread_index () == 0);
1867 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1870 static clib_error_t *
1871 session_manager_main_enable (vlib_main_t * vm)
1873 session_main_t *smm = &session_main;
1874 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1875 u32 num_threads, preallocated_sessions_per_worker;
1876 session_worker_t *wrk;
1879 /* We only initialize once and do not de-initialized on disable */
1880 if (smm->is_initialized)
1883 num_threads = 1 /* main thread */ + vtm->n_threads;
1885 if (num_threads < 1)
1886 return clib_error_return (0, "n_thread_stacks not set");
1888 /* Allocate cache line aligned worker contexts */
1889 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1890 clib_spinlock_init (&session_main.pool_realloc_lock);
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->evts_pending_main =
1900 clib_llist_make_head (wrk->event_elts, evt_list);
1901 wrk->vm = vlib_get_main_by_index (i);
1902 wrk->last_vlib_time = vlib_time_now (vm);
1903 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1905 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1907 if (num_threads > 1)
1908 clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1910 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1911 session_wrk_enable_adaptive_mode (wrk);
1914 /* Allocate vpp event queues segment and queue */
1915 session_vpp_wrk_mqs_alloc (smm);
1917 /* Initialize segment manager properties */
1918 segment_manager_main_init ();
1920 /* Preallocate sessions */
1921 if (smm->preallocated_sessions)
1923 if (num_threads == 1)
1925 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1930 preallocated_sessions_per_worker =
1931 (1.1 * (f64) smm->preallocated_sessions /
1932 (f64) (num_threads - 1));
1934 for (j = 1; j < num_threads; j++)
1936 pool_init_fixed (smm->wrk[j].sessions,
1937 preallocated_sessions_per_worker);
1942 session_lookup_init ();
1943 app_namespaces_init ();
1945 smm->is_initialized = 1;
1949 smm->is_enabled = 1;
1951 /* Enable transports */
1952 transport_enable_disable (vm, 1);
1953 session_debug_init ();
1959 session_manager_main_disable (vlib_main_t * vm)
1961 transport_enable_disable (vm, 0 /* is_en */ );
1965 session_node_enable_disable (u8 is_en)
1967 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
1968 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1969 session_main_t *sm = &session_main;
1974 n_vlibs = vlib_get_n_threads ();
1975 for (i = 0; i < n_vlibs; i++)
1977 vm = vlib_get_main_by_index (i);
1978 /* main thread with workers and not polling */
1979 if (i == 0 && n_vlibs > 1)
1981 vlib_node_set_state (vm, session_queue_node.index, mstate);
1984 session_main_get_worker (0)->state = SESSION_WRK_INTERRUPT;
1985 vlib_node_set_state (vm, session_queue_process_node.index,
1987 n = vlib_get_node (vm, session_queue_process_node.index);
1988 vlib_start_process (vm, n->runtime_index);
1992 vlib_process_signal_event_mt (vm,
1993 session_queue_process_node.index,
1994 SESSION_Q_PROCESS_STOP, 0);
1999 vlib_node_set_state (vm, session_queue_node.index, state);
2002 if (sm->use_private_rx_mqs)
2003 application_enable_rx_mqs_nodes (is_en);
2007 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
2009 clib_error_t *error = 0;
2012 if (session_main.is_enabled)
2015 error = session_manager_main_enable (vm);
2016 session_node_enable_disable (is_en);
2020 session_main.is_enabled = 0;
2021 session_manager_main_disable (vm);
2022 session_node_enable_disable (is_en);
2029 session_main_init (vlib_main_t * vm)
2031 session_main_t *smm = &session_main;
2033 smm->is_enabled = 0;
2034 smm->session_enable_asap = 0;
2036 smm->use_private_rx_mqs = 0;
2037 smm->no_adaptive = 0;
2038 smm->last_transport_proto_type = TRANSPORT_PROTO_HTTP;
2043 static clib_error_t *
2044 session_main_loop_init (vlib_main_t * vm)
2046 session_main_t *smm = &session_main;
2047 if (smm->session_enable_asap)
2049 vlib_worker_thread_barrier_sync (vm);
2050 vnet_session_enable_disable (vm, 1 /* is_en */ );
2051 vlib_worker_thread_barrier_release (vm);
2056 VLIB_INIT_FUNCTION (session_main_init);
2057 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
2059 static clib_error_t *
2060 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
2062 session_main_t *smm = &session_main;
2066 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2068 if (unformat (input, "wrk-mq-length %d", &nitems))
2071 smm->configured_wrk_mq_length = nitems;
2073 clib_warning ("event queue length %d too small, ignored", nitems);
2075 else if (unformat (input, "preallocated-sessions %d",
2076 &smm->preallocated_sessions))
2078 else if (unformat (input, "v4-session-table-buckets %d",
2079 &smm->configured_v4_session_table_buckets))
2081 else if (unformat (input, "v4-halfopen-table-buckets %d",
2082 &smm->configured_v4_halfopen_table_buckets))
2084 else if (unformat (input, "v6-session-table-buckets %d",
2085 &smm->configured_v6_session_table_buckets))
2087 else if (unformat (input, "v6-halfopen-table-buckets %d",
2088 &smm->configured_v6_halfopen_table_buckets))
2090 else if (unformat (input, "v4-session-table-memory %U",
2091 unformat_memory_size, &tmp))
2093 if (tmp >= 0x100000000)
2094 return clib_error_return (0, "memory size %llx (%lld) too large",
2096 smm->configured_v4_session_table_memory = tmp;
2098 else if (unformat (input, "v4-halfopen-table-memory %U",
2099 unformat_memory_size, &tmp))
2101 if (tmp >= 0x100000000)
2102 return clib_error_return (0, "memory size %llx (%lld) too large",
2104 smm->configured_v4_halfopen_table_memory = tmp;
2106 else if (unformat (input, "v6-session-table-memory %U",
2107 unformat_memory_size, &tmp))
2109 if (tmp >= 0x100000000)
2110 return clib_error_return (0, "memory size %llx (%lld) too large",
2112 smm->configured_v6_session_table_memory = tmp;
2114 else if (unformat (input, "v6-halfopen-table-memory %U",
2115 unformat_memory_size, &tmp))
2117 if (tmp >= 0x100000000)
2118 return clib_error_return (0, "memory size %llx (%lld) too large",
2120 smm->configured_v6_halfopen_table_memory = tmp;
2122 else if (unformat (input, "local-endpoints-table-memory %U",
2123 unformat_memory_size, &tmp))
2125 if (tmp >= 0x100000000)
2126 return clib_error_return (0, "memory size %llx (%lld) too large",
2128 smm->local_endpoints_table_memory = tmp;
2130 else if (unformat (input, "local-endpoints-table-buckets %d",
2131 &smm->local_endpoints_table_buckets))
2133 else if (unformat (input, "enable"))
2134 smm->session_enable_asap = 1;
2135 else if (unformat (input, "use-app-socket-api"))
2136 (void) appns_sapi_enable_disable (1 /* is_enable */);
2137 else if (unformat (input, "poll-main"))
2139 else if (unformat (input, "use-private-rx-mqs"))
2140 smm->use_private_rx_mqs = 1;
2141 else if (unformat (input, "no-adaptive"))
2142 smm->no_adaptive = 1;
2144 * Deprecated but maintained for compatibility
2146 else if (unformat (input, "evt_qs_memfd_seg"))
2148 else if (unformat (input, "segment-baseva 0x%lx", &tmp))
2150 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
2153 else if (unformat (input, "event-queue-length %d", &nitems))
2156 smm->configured_wrk_mq_length = nitems;
2158 clib_warning ("event queue length %d too small, ignored", nitems);
2161 return clib_error_return (0, "unknown input `%U'",
2162 format_unformat_error, input);
2167 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2170 * fd.io coding-style-patch-verification: ON
2173 * eval: (c-set-style "gnu")