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/plugin/plugin.h>
21 #include <vnet/session/session.h>
22 #include <vnet/session/application.h>
23 #include <vnet/dpo/load_balance.h>
24 #include <vnet/fib/ip4_fib.h>
25 #include <vlib/stats/stats.h>
26 #include <vlib/dma/dma.h>
28 session_main_t session_main;
31 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
32 session_evt_type_t evt_type)
34 session_worker_t *wrk = session_main_get_worker (thread_index);
39 mq = wrk->vpp_event_queue;
40 if (PREDICT_FALSE (svm_msg_q_lock (mq)))
42 if (PREDICT_FALSE (svm_msg_q_or_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
44 svm_msg_q_unlock (mq);
49 case SESSION_CTRL_EVT_RPC:
50 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
51 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
52 evt->rpc_args.fp = data;
53 evt->rpc_args.arg = args;
55 case SESSION_IO_EVT_RX:
56 case SESSION_IO_EVT_TX:
57 case SESSION_IO_EVT_TX_FLUSH:
58 case SESSION_IO_EVT_BUILTIN_RX:
59 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
60 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
61 evt->session_index = *(u32 *) data;
63 case SESSION_IO_EVT_TX_MAIN:
64 case SESSION_CTRL_EVT_CLOSE:
65 case SESSION_CTRL_EVT_RESET:
66 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
67 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
68 evt->session_handle = session_handle ((session_t *) data);
71 clib_warning ("evt unhandled!");
72 svm_msg_q_unlock (mq);
75 evt->event_type = evt_type;
77 svm_msg_q_add_and_unlock (mq, &msg);
79 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
80 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
86 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
88 return session_send_evt_to_thread (&f->shr->master_session_index, 0,
89 f->master_thread_index, evt_type);
93 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
94 session_evt_type_t evt_type)
96 return session_send_evt_to_thread (data, 0, thread_index, evt_type);
100 session_program_tx_io_evt (session_handle_tu_t sh, session_evt_type_t evt_type)
102 return session_send_evt_to_thread ((void *) &sh.session_index, 0,
103 (u32) sh.thread_index, evt_type);
107 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
109 /* only events supported are disconnect, shutdown and reset */
110 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE ||
111 evt_type == SESSION_CTRL_EVT_HALF_CLOSE ||
112 evt_type == SESSION_CTRL_EVT_RESET);
113 return session_send_evt_to_thread (s, 0, s->thread_index, evt_type);
117 session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
120 session_send_evt_to_thread (fp, rpc_args, thread_index,
121 SESSION_CTRL_EVT_RPC);
125 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
127 if (thread_index != vlib_get_thread_index ())
128 session_send_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
131 void (*fnp) (void *) = fp;
137 session_add_self_custom_tx_evt (transport_connection_t * tc, u8 has_prio)
139 session_t *s = session_get (tc->s_index, tc->thread_index);
141 ASSERT (s->thread_index == vlib_get_thread_index ());
142 ASSERT (s->session_state != SESSION_STATE_TRANSPORT_DELETED);
144 if (!(s->flags & SESSION_F_CUSTOM_TX))
146 s->flags |= SESSION_F_CUSTOM_TX;
147 if (svm_fifo_set_event (s->tx_fifo)
148 || transport_connection_is_descheduled (tc))
150 session_evt_elt_t *elt;
151 session_worker_t *wrk;
153 wrk = session_main_get_worker (tc->thread_index);
155 elt = session_evt_alloc_new (wrk);
157 elt = session_evt_alloc_old (wrk);
158 elt->evt.session_index = tc->s_index;
159 elt->evt.event_type = SESSION_IO_EVT_TX;
160 tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
162 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
163 vlib_node_set_interrupt_pending (wrk->vm,
164 session_queue_node.index);
170 sesssion_reschedule_tx (transport_connection_t * tc)
172 session_worker_t *wrk = session_main_get_worker (tc->thread_index);
173 session_evt_elt_t *elt;
175 ASSERT (tc->thread_index == vlib_get_thread_index ());
177 elt = session_evt_alloc_new (wrk);
178 elt->evt.session_index = tc->s_index;
179 elt->evt.event_type = SESSION_IO_EVT_TX;
181 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
182 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
186 session_program_transport_ctrl_evt (session_t * s, session_evt_type_t evt)
188 u32 thread_index = vlib_get_thread_index ();
189 session_evt_elt_t *elt;
190 session_worker_t *wrk;
192 /* If we are in the handler thread, or being called with the worker barrier
193 * held, just append a new event to pending disconnects vector. */
194 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
196 wrk = session_main_get_worker (s->thread_index);
197 elt = session_evt_alloc_ctrl (wrk);
198 clib_memset (&elt->evt, 0, sizeof (session_event_t));
199 elt->evt.session_handle = session_handle (s);
200 elt->evt.event_type = evt;
202 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
203 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
206 session_send_ctrl_evt_to_thread (s, evt);
210 session_alloc (u32 thread_index)
212 session_worker_t *wrk = &session_main.wrk[thread_index];
215 pool_get_aligned_safe (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
216 clib_memset (s, 0, sizeof (*s));
217 s->session_index = s - wrk->sessions;
218 s->thread_index = thread_index;
219 s->al_index = APP_INVALID_INDEX;
225 session_free (session_t * s)
227 session_worker_t *wrk = &session_main.wrk[s->thread_index];
229 SESSION_EVT (SESSION_EVT_FREE, s);
231 clib_memset (s, 0xFA, sizeof (*s));
232 pool_put (wrk->sessions, s);
236 session_is_valid (u32 si, u8 thread_index)
239 transport_connection_t *tc;
241 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
243 if (s->thread_index != thread_index || s->session_index != si)
246 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED
247 || s->session_state <= SESSION_STATE_LISTENING)
250 if ((s->session_state == SESSION_STATE_CONNECTING ||
251 s->session_state == SESSION_STATE_TRANSPORT_CLOSED) &&
252 (s->flags & SESSION_F_HALF_OPEN))
255 tc = session_get_transport (s);
256 if (s->connection_index != tc->c_index ||
257 s->thread_index != tc->thread_index || tc->s_index != si)
264 session_cleanup (session_t *s)
266 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
271 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
273 app_worker_t *app_wrk;
275 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
278 if (ntf == SESSION_CLEANUP_TRANSPORT)
284 app_worker_cleanup_notify (app_wrk, s, ntf);
288 session_program_cleanup (session_t *s)
290 ASSERT (s->session_state == SESSION_STATE_TRANSPORT_DELETED);
291 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
295 * Cleans up session and lookup table.
297 * Transport connection must still be valid.
300 session_delete (session_t * s)
304 /* Delete from the main lookup table. */
305 if ((rv = session_lookup_del_session (s)))
306 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
308 session_program_cleanup (s);
312 session_cleanup_half_open (session_handle_t ho_handle)
314 session_t *ho = session_get_from_handle (ho_handle);
316 /* App transports can migrate their half-opens */
317 if (ho->flags & SESSION_F_IS_MIGRATING)
319 /* Session still migrating, move to closed state to signal that the
320 * session should be removed. */
321 if (ho->connection_index == ~0)
323 session_set_state (ho, SESSION_STATE_CLOSED);
326 /* Migrated transports are no longer half-opens */
327 transport_cleanup (session_get_transport_proto (ho),
328 ho->connection_index, ho->al_index /* overloaded */);
330 else if (ho->session_state != SESSION_STATE_TRANSPORT_DELETED)
332 /* Cleanup half-open session lookup table if need be */
333 if (ho->session_state != SESSION_STATE_TRANSPORT_CLOSED)
335 transport_connection_t *tc;
336 tc = transport_get_half_open (session_get_transport_proto (ho),
337 ho->connection_index);
338 if (tc && !(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
339 session_lookup_del_half_open (tc);
341 transport_cleanup_half_open (session_get_transport_proto (ho),
342 ho->connection_index);
348 session_half_open_free (session_t *ho)
350 app_worker_t *app_wrk;
352 ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
353 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
355 app_worker_del_half_open (app_wrk, ho);
361 session_half_open_free_rpc (void *args)
363 session_t *ho = ho_session_get (pointer_to_uword (args));
364 session_half_open_free (ho);
368 session_half_open_delete_notify (transport_connection_t *tc)
370 session_t *ho = ho_session_get (tc->s_index);
372 /* Cleanup half-open lookup table if need be */
373 if (ho->session_state != SESSION_STATE_TRANSPORT_CLOSED)
375 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
376 session_lookup_del_half_open (tc);
378 session_set_state (ho, SESSION_STATE_TRANSPORT_DELETED);
380 /* Notification from ctrl thread accepted without rpc */
381 if (tc->thread_index == transport_cl_thread ())
383 session_half_open_free (ho);
387 void *args = uword_to_pointer ((uword) tc->s_index, void *);
388 session_send_rpc_evt_to_thread_force (transport_cl_thread (),
389 session_half_open_free_rpc, args);
394 session_half_open_migrate_notify (transport_connection_t *tc)
398 /* Support half-open migrations only for transports with no lookup */
399 ASSERT (tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP);
401 ho = ho_session_get (tc->s_index);
402 ho->flags |= SESSION_F_IS_MIGRATING;
403 ho->connection_index = ~0;
407 session_half_open_migrated_notify (transport_connection_t *tc)
411 ho = ho_session_get (tc->s_index);
413 /* App probably detached so the half-open must be cleaned up */
414 if (ho->session_state == SESSION_STATE_CLOSED)
416 session_half_open_delete_notify (tc);
419 ho->connection_index = tc->c_index;
420 /* Overload al_index for half-open with new thread */
421 ho->al_index = tc->thread_index;
426 session_alloc_for_connection (transport_connection_t * tc)
429 u32 thread_index = tc->thread_index;
431 ASSERT (thread_index == vlib_get_thread_index ()
432 || transport_protocol_is_cl (tc->proto));
434 s = session_alloc (thread_index);
435 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
436 session_set_state (s, SESSION_STATE_CLOSED);
438 /* Attach transport to session and vice versa */
439 s->connection_index = tc->c_index;
440 tc->s_index = s->session_index;
445 session_alloc_for_half_open (transport_connection_t *tc)
449 s = ho_session_alloc ();
450 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
451 s->connection_index = tc->c_index;
452 tc->s_index = s->session_index;
457 * Discards bytes from buffer chain
459 * It discards n_bytes_to_drop starting at first buffer after chain_b
462 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
463 vlib_buffer_t ** chain_b,
466 vlib_buffer_t *next = *chain_b;
467 u32 to_drop = n_bytes_to_drop;
468 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
469 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
471 next = vlib_get_buffer (vm, next->next_buffer);
472 if (next->current_length > to_drop)
474 vlib_buffer_advance (next, to_drop);
479 to_drop -= next->current_length;
480 next->current_length = 0;
486 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
490 * Enqueue buffer chain tail
493 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
494 u32 offset, u8 is_in_order)
496 vlib_buffer_t *chain_b;
497 u32 chain_bi, len, diff;
498 vlib_main_t *vm = vlib_get_main ();
503 if (is_in_order && offset)
505 diff = offset - b->current_length;
506 if (diff > b->total_length_not_including_first_buffer)
509 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
510 chain_bi = vlib_get_buffer_index (vm, chain_b);
513 chain_bi = b->next_buffer;
517 chain_b = vlib_get_buffer (vm, chain_bi);
518 data = vlib_buffer_get_current (chain_b);
519 len = chain_b->current_length;
524 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
531 return (rv > 0) ? (written + rv) : written;
537 /* written more than what was left in chain */
538 if (written > b->total_length_not_including_first_buffer)
541 /* drop the bytes that have already been delivered */
542 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
547 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
550 clib_warning ("failed to enqueue multi-buffer seg");
556 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
557 ? chain_b->next_buffer : 0));
566 session_fifo_tuning (session_t * s, svm_fifo_t * f,
567 session_ft_action_t act, u32 len)
569 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
571 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
572 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
573 if (CLIB_ASSERT_ENABLE)
575 segment_manager_t *sm;
576 sm = segment_manager_get (f->segment_manager);
577 ASSERT (f->shr->size >= 4096);
578 ASSERT (f->shr->size <= sm->max_fifo_size);
584 session_wrk_program_app_wrk_evts (session_worker_t *wrk, u32 app_wrk_index)
588 ASSERT ((wrk - session_main.wrk) == vlib_get_thread_index ());
589 need_interrupt = clib_bitmap_is_zero (wrk->app_wrks_pending_ntf);
590 wrk->app_wrks_pending_ntf =
591 clib_bitmap_set (wrk->app_wrks_pending_ntf, app_wrk_index, 1);
594 vlib_node_set_interrupt_pending (wrk->vm, session_input_node.index);
598 session_program_io_event (app_worker_t *app_wrk, session_t *s,
599 session_evt_type_t et, u8 is_cl)
603 /* Special events for connectionless sessions */
604 et += SESSION_IO_EVT_BUILTIN_RX - SESSION_IO_EVT_RX;
606 ASSERT (s->thread_index == 0 || et == SESSION_IO_EVT_TX_MAIN);
607 session_event_t evt = {
609 .session_handle = session_handle (s),
612 app_worker_add_event_custom (app_wrk, vlib_get_thread_index (), &evt);
616 app_worker_add_event (app_wrk, s, et);
621 session_notify_subscribers (u32 app_index, session_t *s, svm_fifo_t *f,
622 session_evt_type_t evt_type)
624 app_worker_t *app_wrk;
629 app = application_get (app_index);
633 is_cl = s->thread_index != vlib_get_thread_index ();
634 for (i = 0; i < f->shr->n_subscribers; i++)
636 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
639 session_program_io_event (app_wrk, s, evt_type, is_cl ? 1 : 0);
646 session_enqueue_notify_inline (session_t *s, u8 is_cl)
648 app_worker_t *app_wrk;
650 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
651 if (PREDICT_FALSE (!app_wrk))
654 session_program_io_event (app_wrk, s, SESSION_IO_EVT_RX, is_cl);
656 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
657 return session_notify_subscribers (app_wrk->app_index, s, s->rx_fifo,
664 session_enqueue_notify (session_t *s)
666 return session_enqueue_notify_inline (s, 0 /* is_cl */);
670 session_enqueue_notify_cl (session_t *s)
672 return session_enqueue_notify_inline (s, 1 /* is_cl */);
676 session_dequeue_notify (session_t *s)
678 app_worker_t *app_wrk;
681 /* Unset as soon as event is requested */
682 svm_fifo_clear_deq_ntf (s->tx_fifo);
684 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
685 if (PREDICT_FALSE (!app_wrk))
688 is_cl = s->session_state == SESSION_STATE_LISTENING ||
689 s->session_state == SESSION_STATE_OPENED;
690 session_program_io_event (app_wrk, s, SESSION_IO_EVT_TX, is_cl ? 1 : 0);
692 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->tx_fifo)))
693 return session_notify_subscribers (app_wrk->app_index, s, s->tx_fifo,
700 * Flushes queue of sessions that are to be notified of new data
703 * @param transport_proto transport protocol for which queue to be flushed
704 * @param thread_index Thread index for which the flush is to be performed.
705 * @return 0 on success or a positive number indicating the number of
706 * failures due to API queue being full.
709 session_main_flush_enqueue_events (transport_proto_t transport_proto,
712 session_worker_t *wrk = session_main_get_worker (thread_index);
713 session_handle_t *handles;
717 handles = wrk->session_to_enqueue[transport_proto];
719 for (i = 0; i < vec_len (handles); i++)
721 s = session_get_from_handle (handles[i]);
722 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
723 0 /* TODO/not needed */);
725 s->thread_index != thread_index || (s->flags & SESSION_F_IS_CLESS);
727 session_enqueue_notify_inline (s, 0);
729 session_enqueue_notify_inline (s, 1);
732 vec_reset_length (handles);
733 wrk->session_to_enqueue[transport_proto] = handles;
737 * Enqueue data for delivery to app. If requested, it queues app notification
738 * event for later delivery.
740 * @param tc Transport connection which is to be enqueued data
741 * @param b Buffer to be enqueued
742 * @param offset Offset at which to start enqueueing if out-of-order
743 * @param queue_event Flag to indicate if peer is to be notified or if event
744 * is to be queued. The former is useful when more data is
745 * enqueued and only one event is to be generated.
746 * @param is_in_order Flag to indicate if data is in order
747 * @return Number of bytes enqueued or a negative value if enqueueing failed.
750 session_enqueue_stream_connection (transport_connection_t * tc,
751 vlib_buffer_t * b, u32 offset,
752 u8 queue_event, u8 is_in_order)
755 int enqueued = 0, rv, in_order_off;
757 s = session_get (tc->s_index, tc->thread_index);
761 enqueued = svm_fifo_enqueue (s->rx_fifo,
763 vlib_buffer_get_current (b));
764 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
767 in_order_off = enqueued > b->current_length ? enqueued : 0;
768 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
775 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
777 vlib_buffer_get_current (b));
778 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
779 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
780 /* if something was enqueued, report even this as success for ooo
781 * segment handling */
787 /* Queue RX event on this fifo. Eventually these will need to be
788 * flushed by calling @ref session_main_flush_enqueue_events () */
789 if (!(s->flags & SESSION_F_RX_EVT))
791 session_worker_t *wrk = session_main_get_worker (s->thread_index);
792 ASSERT (s->thread_index == vlib_get_thread_index ());
793 s->flags |= SESSION_F_RX_EVT;
794 vec_add1 (wrk->session_to_enqueue[tc->proto], session_handle (s));
797 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
804 session_enqueue_dgram_connection_inline (session_t *s,
805 session_dgram_hdr_t *hdr,
806 vlib_buffer_t *b, u8 proto,
807 u8 queue_event, u32 is_cl)
811 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
812 >= b->current_length + sizeof (*hdr));
814 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
816 svm_fifo_seg_t segs[2] = {
817 { (u8 *) hdr, sizeof (*hdr) },
818 { vlib_buffer_get_current (b), b->current_length }
821 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
822 0 /* allow_partial */ );
826 vlib_main_t *vm = vlib_get_main ();
827 svm_fifo_seg_t *segs = 0, *seg;
828 vlib_buffer_t *it = b;
831 vec_add2 (segs, seg, 1);
832 seg->data = (u8 *) hdr;
833 seg->len = sizeof (*hdr);
836 vec_add2 (segs, seg, 1);
837 seg->data = vlib_buffer_get_current (it);
838 seg->len = it->current_length;
840 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
842 it = vlib_get_buffer (vm, it->next_buffer);
844 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
845 0 /* allow partial */ );
849 if (queue_event && rv > 0)
851 /* Queue RX event on this fifo. Eventually these will need to be
852 * flushed by calling @ref session_main_flush_enqueue_events () */
853 if (!(s->flags & SESSION_F_RX_EVT))
856 is_cl ? vlib_get_thread_index () : s->thread_index;
857 session_worker_t *wrk = session_main_get_worker (thread_index);
858 ASSERT (s->thread_index == vlib_get_thread_index () || is_cl);
859 s->flags |= SESSION_F_RX_EVT;
860 vec_add1 (wrk->session_to_enqueue[proto], session_handle (s));
863 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
865 return rv > 0 ? rv : 0;
869 session_enqueue_dgram_connection (session_t *s, session_dgram_hdr_t *hdr,
870 vlib_buffer_t *b, u8 proto, u8 queue_event)
872 return session_enqueue_dgram_connection_inline (s, hdr, b, proto,
873 queue_event, 0 /* is_cl */);
877 session_enqueue_dgram_connection2 (session_t *s, session_dgram_hdr_t *hdr,
878 vlib_buffer_t *b, u8 proto, u8 queue_event)
880 return session_enqueue_dgram_connection_inline (s, hdr, b, proto,
881 queue_event, 1 /* is_cl */);
885 session_enqueue_dgram_connection_cl (session_t *s, session_dgram_hdr_t *hdr,
886 vlib_buffer_t *b, u8 proto,
891 awls = app_listener_select_wrk_cl_session (s, hdr);
892 return session_enqueue_dgram_connection_inline (awls, hdr, b, proto,
893 queue_event, 1 /* is_cl */);
897 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
898 u32 offset, u32 max_bytes)
900 session_t *s = session_get (tc->s_index, tc->thread_index);
901 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
905 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
907 session_t *s = session_get (tc->s_index, tc->thread_index);
910 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
911 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
913 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
914 session_dequeue_notify (s);
920 session_stream_connect_notify (transport_connection_t * tc,
923 u32 opaque = 0, new_ti, new_si;
924 app_worker_t *app_wrk;
925 session_t *s = 0, *ho;
928 * Cleanup half-open table
930 session_lookup_del_half_open (tc);
932 ho = ho_session_get (tc->s_index);
933 session_set_state (ho, SESSION_STATE_TRANSPORT_CLOSED);
935 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
940 return app_worker_connect_notify (app_wrk, s, err, opaque);
942 s = session_alloc_for_connection (tc);
943 session_set_state (s, SESSION_STATE_CONNECTING);
944 s->app_wrk_index = app_wrk->wrk_index;
946 new_si = s->session_index;
947 new_ti = s->thread_index;
949 if ((err = app_worker_init_connected (app_wrk, s)))
952 app_worker_connect_notify (app_wrk, 0, err, opaque);
956 s = session_get (new_si, new_ti);
957 session_set_state (s, SESSION_STATE_READY);
958 session_lookup_add_connection (tc, session_handle (s));
960 if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
962 session_lookup_del_connection (tc);
963 /* Avoid notifying app about rejected session cleanup */
964 s = session_get (new_si, new_ti);
965 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
974 session_switch_pool_closed_rpc (void *arg)
979 sh = pointer_to_uword (arg);
980 s = session_get_from_handle_if_valid (sh);
984 transport_cleanup (session_get_transport_proto (s), s->connection_index,
989 typedef struct _session_switch_pool_args
993 u32 new_thread_index;
994 u32 new_session_index;
995 } session_switch_pool_args_t;
998 * Notify old thread of the session pool switch
1001 session_switch_pool (void *cb_args)
1003 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
1004 session_handle_t sh, new_sh;
1005 segment_manager_t *sm;
1006 app_worker_t *app_wrk;
1009 ASSERT (args->thread_index == vlib_get_thread_index ());
1010 s = session_get (args->session_index, args->thread_index);
1012 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1016 /* Cleanup fifo segment slice state for fifos */
1017 sm = app_worker_get_connect_segment_manager (app_wrk);
1018 segment_manager_detach_fifo (sm, &s->rx_fifo);
1019 segment_manager_detach_fifo (sm, &s->tx_fifo);
1021 /* Check if session closed during migration */
1022 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1026 session_make_handle (args->new_session_index, args->new_thread_index);
1027 app_worker_migrate_notify (app_wrk, s, new_sh);
1029 clib_mem_free (cb_args);
1033 /* Session closed during migration. Clean everything up */
1034 sh = session_handle (s);
1035 session_send_rpc_evt_to_thread (args->new_thread_index,
1036 session_switch_pool_closed_rpc,
1037 uword_to_pointer (sh, void *));
1038 clib_mem_free (cb_args);
1042 * Move dgram session to the right thread
1045 session_dgram_connect_notify (transport_connection_t * tc,
1046 u32 old_thread_index, session_t ** new_session)
1049 session_switch_pool_args_t *rpc_args;
1050 segment_manager_t *sm;
1051 app_worker_t *app_wrk;
1054 * Clone half-open session to the right thread.
1056 new_s = session_clone_safe (tc->s_index, old_thread_index);
1057 new_s->connection_index = tc->c_index;
1058 session_set_state (new_s, SESSION_STATE_READY);
1059 new_s->flags |= SESSION_F_IS_MIGRATING;
1061 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1062 session_lookup_add_connection (tc, session_handle (new_s));
1064 app_wrk = app_worker_get_if_valid (new_s->app_wrk_index);
1067 /* New set of fifos attached to the same shared memory */
1068 sm = app_worker_get_connect_segment_manager (app_wrk);
1069 segment_manager_attach_fifo (sm, &new_s->rx_fifo, new_s);
1070 segment_manager_attach_fifo (sm, &new_s->tx_fifo, new_s);
1074 * Ask thread owning the old session to clean it up and make us the tx
1077 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
1078 rpc_args->new_session_index = new_s->session_index;
1079 rpc_args->new_thread_index = new_s->thread_index;
1080 rpc_args->session_index = tc->s_index;
1081 rpc_args->thread_index = old_thread_index;
1082 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
1085 tc->s_index = new_s->session_index;
1086 new_s->connection_index = tc->c_index;
1087 *new_session = new_s;
1092 * Notification from transport that connection is being closed.
1094 * A disconnect is sent to application but state is not removed. Once
1095 * disconnect is acknowledged by application, session disconnect is called.
1096 * Ultimately this leads to close being called on transport (passive close).
1099 session_transport_closing_notify (transport_connection_t * tc)
1101 app_worker_t *app_wrk;
1104 s = session_get (tc->s_index, tc->thread_index);
1105 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1108 /* Wait for reply from app before sending notification as the
1109 * accept might be rejected */
1110 if (s->session_state == SESSION_STATE_ACCEPTING)
1112 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1116 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1117 app_wrk = app_worker_get (s->app_wrk_index);
1118 app_worker_close_notify (app_wrk, s);
1122 * Notification from transport that connection is being deleted
1124 * This removes the session if it is still valid. It should be called only on
1125 * previously fully established sessions. For instance failed connects should
1126 * call stream_session_connect_notify and indicate that the connect has
1130 session_transport_delete_notify (transport_connection_t * tc)
1134 /* App might've been removed already */
1135 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1138 switch (s->session_state)
1140 case SESSION_STATE_CREATED:
1141 /* Session was created but accept notification was not yet sent to the
1142 * app. Cleanup everything. */
1143 session_lookup_del_session (s);
1144 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1147 case SESSION_STATE_ACCEPTING:
1148 case SESSION_STATE_TRANSPORT_CLOSING:
1149 case SESSION_STATE_CLOSING:
1150 case SESSION_STATE_TRANSPORT_CLOSED:
1151 /* If transport finishes or times out before we get a reply
1152 * from the app, mark transport as closed and wait for reply
1153 * before removing the session. Cleanup session table in advance
1154 * because transport will soon be closed and closed sessions
1155 * are assumed to have been removed from the lookup table */
1156 session_lookup_del_session (s);
1157 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1158 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1159 svm_fifo_dequeue_drop_all (s->tx_fifo);
1161 case SESSION_STATE_APP_CLOSED:
1162 /* Cleanup lookup table as transport needs to still be valid.
1163 * Program transport close to ensure that all session events
1164 * have been cleaned up. Once transport close is called, the
1165 * session is just removed because both transport and app have
1166 * confirmed the close*/
1167 session_lookup_del_session (s);
1168 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1169 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1170 svm_fifo_dequeue_drop_all (s->tx_fifo);
1171 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1173 case SESSION_STATE_TRANSPORT_DELETED:
1175 case SESSION_STATE_CLOSED:
1176 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1177 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1181 clib_warning ("session state %u", s->session_state);
1182 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1189 * Notification from transport that it is closed
1191 * Should be called by transport, prior to calling delete notify, once it
1192 * knows that no more data will be exchanged. This could serve as an
1193 * early acknowledgment of an active close especially if transport delete
1194 * can be delayed a long time, e.g., tcp time-wait.
1197 session_transport_closed_notify (transport_connection_t * tc)
1199 app_worker_t *app_wrk;
1202 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1205 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1208 /* Transport thinks that app requested close but it actually didn't.
1209 * Can happen for tcp:
1210 * 1)if fin and rst are received in close succession.
1211 * 2)if app shutdown the connection. */
1212 if (s->session_state == SESSION_STATE_READY)
1214 session_transport_closing_notify (tc);
1215 svm_fifo_dequeue_drop_all (s->tx_fifo);
1216 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSED);
1218 /* If app close has not been received or has not yet resulted in
1219 * a transport close, only mark the session transport as closed */
1220 else if (s->session_state <= SESSION_STATE_CLOSING)
1221 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSED);
1222 /* If app also closed, switch to closed */
1223 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1224 session_set_state (s, SESSION_STATE_CLOSED);
1226 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1228 app_worker_transport_closed_notify (app_wrk, s);
1232 * Notify application that connection has been reset.
1235 session_transport_reset_notify (transport_connection_t * tc)
1237 app_worker_t *app_wrk;
1240 s = session_get (tc->s_index, tc->thread_index);
1241 svm_fifo_dequeue_drop_all (s->tx_fifo);
1242 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1244 if (s->session_state == SESSION_STATE_ACCEPTING)
1246 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1249 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1250 app_wrk = app_worker_get (s->app_wrk_index);
1251 app_worker_reset_notify (app_wrk, s);
1255 session_stream_accept_notify (transport_connection_t * tc)
1257 app_worker_t *app_wrk;
1260 s = session_get (tc->s_index, tc->thread_index);
1261 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1264 if (s->session_state != SESSION_STATE_CREATED)
1266 session_set_state (s, SESSION_STATE_ACCEPTING);
1267 if (app_worker_accept_notify (app_wrk, s))
1269 /* On transport delete, no notifications should be sent. Unless, the
1270 * accept is retried and successful. */
1271 session_set_state (s, SESSION_STATE_CREATED);
1278 * Accept a stream session. Optionally ping the server by callback.
1281 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1282 u32 thread_index, u8 notify)
1287 s = session_alloc_for_connection (tc);
1288 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1289 session_set_state (s, SESSION_STATE_CREATED);
1291 if ((rv = app_worker_init_accepted (s)))
1297 session_lookup_add_connection (tc, session_handle (s));
1299 /* Shoulder-tap the server */
1302 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1303 if ((rv = app_worker_accept_notify (app_wrk, s)))
1305 session_lookup_del_session (s);
1306 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1316 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1319 app_worker_t *app_wrk;
1323 s = session_alloc_for_connection (tc);
1324 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1326 if ((rv = app_worker_init_accepted (s)))
1332 session_lookup_add_connection (tc, session_handle (s));
1333 session_set_state (s, SESSION_STATE_ACCEPTING);
1335 app_wrk = app_worker_get (s->app_wrk_index);
1336 if ((rv = app_worker_accept_notify (app_wrk, s)))
1338 session_lookup_del_session (s);
1339 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1348 session_open_cl (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1350 transport_connection_t *tc;
1351 transport_endpoint_cfg_t *tep;
1352 app_worker_t *app_wrk;
1353 session_handle_t sh;
1357 tep = session_endpoint_to_transport_cfg (rmt);
1358 rv = transport_connect (rmt->transport_proto, tep);
1361 SESSION_DBG ("Transport failed to open connection.");
1365 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1367 /* For dgram type of service, allocate session and fifos now */
1368 app_wrk = app_worker_get (rmt->app_wrk_index);
1369 s = session_alloc_for_connection (tc);
1370 s->app_wrk_index = app_wrk->wrk_index;
1371 s->opaque = rmt->opaque;
1372 session_set_state (s, SESSION_STATE_OPENED);
1373 if (transport_connection_is_cless (tc))
1374 s->flags |= SESSION_F_IS_CLESS;
1375 if (app_worker_init_connected (app_wrk, s))
1381 sh = session_handle (s);
1384 session_lookup_add_connection (tc, sh);
1385 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, rmt->opaque);
1389 session_open_vc (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1391 transport_connection_t *tc;
1392 transport_endpoint_cfg_t *tep;
1393 app_worker_t *app_wrk;
1397 tep = session_endpoint_to_transport_cfg (rmt);
1398 rv = transport_connect (rmt->transport_proto, tep);
1401 SESSION_DBG ("Transport failed to open connection.");
1405 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1407 app_wrk = app_worker_get (rmt->app_wrk_index);
1409 /* If transport offers a vc service, only allocate established
1410 * session once the connection has been established.
1411 * In the meantime allocate half-open session for tracking purposes
1412 * associate half-open connection to it and add session to app-worker
1413 * half-open table. These are needed to allocate the established
1414 * session on transport notification, and to cleanup the half-open
1415 * session if the app detaches before connection establishment.
1417 ho = session_alloc_for_half_open (tc);
1418 ho->app_wrk_index = app_wrk->wrk_index;
1419 ho->ho_index = app_worker_add_half_open (app_wrk, session_handle (ho));
1420 ho->opaque = rmt->opaque;
1421 *rsh = session_handle (ho);
1423 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1424 session_lookup_add_half_open (tc, tc->c_index);
1430 session_open_app (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1432 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (rmt);
1434 /* Not supported for now */
1435 *rsh = SESSION_INVALID_HANDLE;
1436 return transport_connect (rmt->transport_proto, tep_cfg);
1439 typedef int (*session_open_service_fn) (session_endpoint_cfg_t *,
1440 session_handle_t *);
1442 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1449 * Ask transport to open connection to remote transport endpoint.
1451 * Stores handle for matching request with reply since the call can be
1452 * asynchronous. For instance, for TCP the 3-way handshake must complete
1453 * before reply comes. Session is only created once connection is established.
1455 * @param app_index Index of the application requesting the connect
1456 * @param st Session type requested.
1457 * @param tep Remote transport endpoint
1458 * @param opaque Opaque data (typically, api_context) the application expects
1459 * on open completion.
1462 session_open (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1464 transport_service_type_t tst;
1465 tst = transport_protocol_service_type (rmt->transport_proto);
1466 return session_open_srv_fns[tst](rmt, rsh);
1470 * Ask transport to listen on session endpoint.
1472 * @param s Session for which listen will be called. Note that unlike
1473 * established sessions, listen sessions are not associated to a
1475 * @param sep Local endpoint to be listened on.
1478 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1480 transport_endpoint_cfg_t *tep;
1484 /* Transport bind/listen */
1485 tep = session_endpoint_to_transport_cfg (sep);
1486 s_index = ls->session_index;
1487 tc_index = transport_start_listen (session_get_transport_proto (ls),
1493 /* Attach transport to session. Lookup tables are populated by the app
1494 * worker because local tables (for ct sessions) are not backed by a fib */
1495 ls = listen_session_get (s_index);
1496 ls->connection_index = tc_index;
1497 ls->opaque = sep->opaque;
1498 if (transport_connection_is_cless (session_get_transport (ls)))
1499 ls->flags |= SESSION_F_IS_CLESS;
1505 * Ask transport to stop listening on local transport endpoint.
1507 * @param s Session to stop listening on. It must be in state LISTENING.
1510 session_stop_listen (session_t * s)
1512 transport_proto_t tp = session_get_transport_proto (s);
1513 transport_connection_t *tc;
1515 if (s->session_state != SESSION_STATE_LISTENING)
1516 return SESSION_E_NOLISTEN;
1518 tc = transport_get_listener (tp, s->connection_index);
1520 /* If no transport, assume everything was cleaned up already */
1522 return SESSION_E_NONE;
1524 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1525 session_lookup_del_connection (tc);
1527 transport_stop_listen (tp, s->connection_index);
1532 * Initialize session half-closing procedure.
1534 * Note that half-closing will not change the state of the session.
1537 session_half_close (session_t *s)
1542 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_HALF_CLOSE);
1546 * Initialize session closing procedure.
1548 * Request is always sent to session node to ensure that all outstanding
1549 * requests are served before transport is notified.
1552 session_close (session_t * s)
1554 if (!s || (s->flags & SESSION_F_APP_CLOSED))
1557 /* Transports can close and delete their state independent of app closes
1558 * and transport initiated state transitions can hide app closes. Instead
1559 * of extending the state machine to support separate tracking of app and
1560 * transport initiated closes, use a flag. */
1561 s->flags |= SESSION_F_APP_CLOSED;
1563 if (s->session_state >= SESSION_STATE_CLOSING)
1565 /* Session will only be removed once both app and transport
1566 * acknowledge the close */
1567 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1568 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1569 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1573 /* App closed so stop propagating dequeue notifications.
1574 * App might disconnect session before connected, in this case,
1575 * tx_fifo may not be setup yet, so clear only it's inited. */
1577 svm_fifo_clear_deq_ntf (s->tx_fifo);
1578 session_set_state (s, SESSION_STATE_CLOSING);
1579 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1583 * Force a close without waiting for data to be flushed
1586 session_reset (session_t * s)
1588 if (s->session_state >= SESSION_STATE_CLOSING)
1590 /* Drop all outstanding tx data
1591 * App might disconnect session before connected, in this case,
1592 * tx_fifo may not be setup yet, so clear only it's inited. */
1594 svm_fifo_dequeue_drop_all (s->tx_fifo);
1595 session_set_state (s, SESSION_STATE_CLOSING);
1596 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1600 session_detach_app (session_t *s)
1602 if (s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
1604 else if (s->session_state < SESSION_STATE_TRANSPORT_CLOSED)
1605 session_set_state (s, SESSION_STATE_APP_CLOSED);
1606 else if (s->session_state < SESSION_STATE_CLOSED)
1607 session_set_state (s, SESSION_STATE_CLOSED);
1609 s->flags |= SESSION_F_APP_CLOSED;
1610 s->app_wrk_index = APP_INVALID_INDEX;
1614 * Notify transport the session can be half-disconnected.
1616 * Must be called from the session's thread.
1619 session_transport_half_close (session_t *s)
1621 /* Only READY session can be half-closed */
1622 if (s->session_state != SESSION_STATE_READY)
1627 transport_half_close (session_get_transport_proto (s), s->connection_index,
1632 * Notify transport the session can be disconnected. This should eventually
1633 * result in a delete notification that allows us to cleanup session state.
1634 * Called for both active/passive disconnects.
1636 * Must be called from the session's thread.
1639 session_transport_close (session_t * s)
1641 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1643 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1644 session_set_state (s, SESSION_STATE_CLOSED);
1645 /* If transport is already deleted, just free the session */
1646 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1647 session_program_cleanup (s);
1651 /* If the tx queue wasn't drained, the transport can continue to try
1652 * sending the outstanding data (in closed state it cannot). It MUST however
1653 * at one point, either after sending everything or after a timeout, call
1654 * delete notify. This will finally lead to the complete cleanup of the
1657 session_set_state (s, SESSION_STATE_APP_CLOSED);
1659 transport_close (session_get_transport_proto (s), s->connection_index,
1664 * Force transport close
1667 session_transport_reset (session_t * s)
1669 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1671 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1672 session_set_state (s, SESSION_STATE_CLOSED);
1673 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1674 session_program_cleanup (s);
1678 session_set_state (s, SESSION_STATE_APP_CLOSED);
1679 transport_reset (session_get_transport_proto (s), s->connection_index,
1684 * Cleanup transport and session state.
1686 * Notify transport of the cleanup and free the session. This should
1687 * be called only if transport reported some error and is already
1691 session_transport_cleanup (session_t * s)
1693 /* Delete from main lookup table before we axe the the transport */
1694 session_lookup_del_session (s);
1695 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1696 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1698 /* Since we called cleanup, no delete notification will come. So, make
1699 * sure the session is properly freed. */
1700 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1705 * Allocate worker mqs in share-able segment
1707 * That can only be a newly created memfd segment, that must be mapped
1708 * by all apps/stack users unless private rx mqs are enabled.
1711 session_vpp_wrk_mqs_alloc (session_main_t *smm)
1713 u32 mq_q_length = 2048, evt_size = sizeof (session_event_t);
1714 fifo_segment_t *mqs_seg = &smm->wrk_mqs_segment;
1715 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1719 mq_q_length = clib_max (mq_q_length, smm->configured_wrk_mq_length);
1721 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1722 { mq_q_length, evt_size, 0 }, { mq_q_length >> 1, 256, 0 }
1724 cfg->consumer_pid = 0;
1726 cfg->q_nitems = mq_q_length;
1727 cfg->ring_cfgs = rc;
1730 * Compute mqs segment size based on rings config and leave space
1731 * for passing extended configuration messages, i.e., data allocated
1732 * outside of the rings. If provided with a config value, accept it
1733 * if larger than minimum size.
1735 mqs_seg_size = svm_msg_q_size_to_alloc (cfg) * vec_len (smm->wrk);
1736 mqs_seg_size = mqs_seg_size + (1 << 20);
1737 mqs_seg_size = clib_max (mqs_seg_size, smm->wrk_mqs_segment_size);
1739 mqs_seg->ssvm.ssvm_size = mqs_seg_size;
1740 mqs_seg->ssvm.my_pid = getpid ();
1741 mqs_seg->ssvm.name = format (0, "%s%c", "session: wrk-mqs-segment", 0);
1743 if (ssvm_server_init (&mqs_seg->ssvm, SSVM_SEGMENT_MEMFD))
1745 clib_warning ("failed to initialize queue segment");
1749 fifo_segment_init (mqs_seg);
1751 /* Special fifo segment that's filled only with mqs */
1752 mqs_seg->h->n_mqs = vec_len (smm->wrk);
1754 for (i = 0; i < vec_len (smm->wrk); i++)
1755 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (mqs_seg, i, cfg);
1759 session_main_get_wrk_mqs_segment (void)
1761 return &session_main.wrk_mqs_segment;
1765 session_segment_handle (session_t * s)
1770 return SESSION_INVALID_HANDLE;
1773 return segment_manager_make_segment_handle (f->segment_manager,
1778 session_get_original_dst (transport_endpoint_t *i2o_src,
1779 transport_endpoint_t *i2o_dst,
1780 transport_proto_t transport_proto, u32 *original_dst,
1781 u16 *original_dst_port)
1783 session_main_t *smm = vnet_get_session_main ();
1784 ip_protocol_t proto =
1785 (transport_proto == TRANSPORT_PROTO_TCP ? IPPROTO_TCP : IPPROTO_UDP);
1786 if (!smm->original_dst_lookup || !i2o_dst->is_ip4)
1788 smm->original_dst_lookup (&i2o_src->ip.ip4, i2o_src->port, &i2o_dst->ip.ip4,
1789 i2o_dst->port, proto, original_dst,
1793 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1794 session_tx_fifo_peek_and_snd,
1795 session_tx_fifo_dequeue_and_snd,
1796 session_tx_fifo_dequeue_internal,
1797 session_tx_fifo_dequeue_and_snd
1801 session_register_transport (transport_proto_t transport_proto,
1802 const transport_proto_vft_t * vft, u8 is_ip4,
1805 session_main_t *smm = &session_main;
1806 session_type_t session_type;
1807 u32 next_index = ~0;
1809 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1811 vec_validate (smm->session_type_to_next, session_type);
1812 vec_validate (smm->session_tx_fns, session_type);
1814 if (output_node != ~0)
1815 next_index = vlib_node_add_next (vlib_get_main (),
1816 session_queue_node.index, output_node);
1818 smm->session_type_to_next[session_type] = next_index;
1819 smm->session_tx_fns[session_type] =
1820 session_tx_fns[vft->transport_options.tx_type];
1824 session_register_update_time_fn (session_update_time_fn fn, u8 is_add)
1826 session_main_t *smm = &session_main;
1827 session_update_time_fn *fi;
1831 vec_foreach (fi, smm->update_time_fns)
1835 fi_pos = fi - smm->update_time_fns;
1845 clib_warning ("update time fn %p already registered", fn);
1848 vec_add1 (smm->update_time_fns, fn);
1852 vec_del1 (smm->update_time_fns, fi_pos);
1857 session_add_transport_proto (void)
1859 session_main_t *smm = &session_main;
1860 session_worker_t *wrk;
1863 smm->last_transport_proto_type += 1;
1865 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1867 wrk = session_main_get_worker (thread);
1868 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1871 return smm->last_transport_proto_type;
1874 transport_connection_t *
1875 session_get_transport (session_t * s)
1877 if (s->session_state != SESSION_STATE_LISTENING)
1878 return transport_get_connection (session_get_transport_proto (s),
1879 s->connection_index, s->thread_index);
1881 return transport_get_listener (session_get_transport_proto (s),
1882 s->connection_index);
1886 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1888 if (s->session_state != SESSION_STATE_LISTENING)
1889 return transport_get_endpoint (session_get_transport_proto (s),
1890 s->connection_index, s->thread_index, tep,
1893 return transport_get_listener_endpoint (session_get_transport_proto (s),
1894 s->connection_index, tep, is_lcl);
1898 session_transport_attribute (session_t *s, u8 is_get,
1899 transport_endpt_attr_t *attr)
1901 if (s->session_state < SESSION_STATE_READY)
1904 return transport_connection_attribute (session_get_transport_proto (s),
1905 s->connection_index, s->thread_index,
1909 transport_connection_t *
1910 listen_session_get_transport (session_t * s)
1912 return transport_get_listener (session_get_transport_proto (s),
1913 s->connection_index);
1917 session_queue_run_on_main_thread (vlib_main_t * vm)
1919 ASSERT (vlib_get_thread_index () == 0);
1920 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1924 session_stats_collector_fn (vlib_stats_collector_data_t *d)
1926 u32 i, n_workers, n_wrk_sessions, n_sessions = 0;
1927 session_main_t *smm = &session_main;
1928 session_worker_t *wrk;
1929 counter_t **counters;
1932 n_workers = vec_len (smm->wrk);
1933 vlib_stats_validate (d->entry_index, 0, n_workers - 1);
1934 counters = d->entry->data;
1937 for (i = 0; i < vec_len (smm->wrk); i++)
1939 wrk = session_main_get_worker (i);
1940 n_wrk_sessions = pool_elts (wrk->sessions);
1941 cb[i] = n_wrk_sessions;
1942 n_sessions += n_wrk_sessions;
1945 vlib_stats_set_gauge (d->private_data, n_sessions);
1949 session_stats_collector_init (void)
1951 vlib_stats_collector_reg_t reg = {};
1954 vlib_stats_add_counter_vector ("/sys/session/sessions_per_worker");
1955 reg.private_data = vlib_stats_add_gauge ("/sys/session/sessions_total");
1956 reg.collect_fn = session_stats_collector_fn;
1957 vlib_stats_register_collector_fn (®);
1958 vlib_stats_validate (reg.entry_index, 0, vlib_get_n_threads ());
1961 static clib_error_t *
1962 session_manager_main_enable (vlib_main_t * vm)
1964 session_main_t *smm = &session_main;
1965 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1966 u32 num_threads, preallocated_sessions_per_worker;
1967 session_worker_t *wrk;
1970 /* We only initialize once and do not de-initialized on disable */
1971 if (smm->is_initialized)
1974 num_threads = 1 /* main thread */ + vtm->n_threads;
1976 if (num_threads < 1)
1977 return clib_error_return (0, "n_thread_stacks not set");
1979 /* Allocate cache line aligned worker contexts */
1980 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1981 clib_spinlock_init (&session_main.pool_realloc_lock);
1983 for (i = 0; i < num_threads; i++)
1986 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1987 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1988 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1989 wrk->pending_connects = clib_llist_make_head (wrk->event_elts, evt_list);
1990 wrk->evts_pending_main =
1991 clib_llist_make_head (wrk->event_elts, evt_list);
1992 wrk->vm = vlib_get_main_by_index (i);
1993 wrk->last_vlib_time = vlib_time_now (vm);
1994 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1996 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1998 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1999 session_wrk_enable_adaptive_mode (wrk);
2002 /* Allocate vpp event queues segment and queue */
2003 session_vpp_wrk_mqs_alloc (smm);
2005 /* Initialize segment manager properties */
2006 segment_manager_main_init ();
2008 /* Preallocate sessions */
2009 if (smm->preallocated_sessions)
2011 if (num_threads == 1)
2013 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
2018 preallocated_sessions_per_worker =
2019 (1.1 * (f64) smm->preallocated_sessions /
2020 (f64) (num_threads - 1));
2022 for (j = 1; j < num_threads; j++)
2024 pool_init_fixed (smm->wrk[j].sessions,
2025 preallocated_sessions_per_worker);
2030 session_lookup_init ();
2031 app_namespaces_init ();
2033 session_stats_collector_init ();
2034 smm->is_initialized = 1;
2038 smm->is_enabled = 1;
2040 /* Enable transports */
2041 transport_enable_disable (vm, 1);
2042 session_debug_init ();
2048 session_manager_main_disable (vlib_main_t * vm)
2050 transport_enable_disable (vm, 0 /* is_en */ );
2053 /* in this new callback, cookie hint the index */
2055 session_dma_completion_cb (vlib_main_t *vm, struct vlib_dma_batch *batch)
2057 session_worker_t *wrk;
2058 wrk = session_main_get_worker (vm->thread_index);
2059 session_dma_transfer *dma_transfer;
2061 dma_transfer = &wrk->dma_trans[wrk->trans_head];
2062 vec_add (wrk->pending_tx_buffers, dma_transfer->pending_tx_buffers,
2063 vec_len (dma_transfer->pending_tx_buffers));
2064 vec_add (wrk->pending_tx_nexts, dma_transfer->pending_tx_nexts,
2065 vec_len (dma_transfer->pending_tx_nexts));
2066 vec_reset_length (dma_transfer->pending_tx_buffers);
2067 vec_reset_length (dma_transfer->pending_tx_nexts);
2069 if (wrk->trans_head == wrk->trans_size)
2070 wrk->trans_head = 0;
2075 session_prepare_dma_args (vlib_dma_config_t *args)
2077 args->max_batches = 16;
2078 args->max_transfers = DMA_TRANS_SIZE;
2079 args->max_transfer_size = 65536;
2081 args->sw_fallback = 1;
2082 args->barrier_before_last = 1;
2083 args->callback_fn = session_dma_completion_cb;
2087 session_node_enable_dma (u8 is_en, int n_vlibs)
2089 vlib_dma_config_t args;
2090 session_prepare_dma_args (&args);
2091 session_worker_t *wrk;
2094 int config_index = -1;
2098 vm = vlib_get_main_by_index (0);
2099 config_index = vlib_dma_config_add (vm, &args);
2103 vm = vlib_get_main_by_index (0);
2104 wrk = session_main_get_worker (0);
2105 if (wrk->config_index >= 0)
2106 vlib_dma_config_del (vm, wrk->config_index);
2109 for (i = 0; i < n_vlibs; i++)
2111 vm = vlib_get_main_by_index (i);
2112 wrk = session_main_get_worker (vm->thread_index);
2113 wrk->config_index = config_index;
2116 if (config_index >= 0)
2117 wrk->dma_enabled = true;
2118 wrk->dma_trans = (session_dma_transfer *) clib_mem_alloc (
2119 sizeof (session_dma_transfer) * DMA_TRANS_SIZE);
2120 bzero (wrk->dma_trans,
2121 sizeof (session_dma_transfer) * DMA_TRANS_SIZE);
2126 clib_mem_free (wrk->dma_trans);
2128 wrk->trans_head = 0;
2129 wrk->trans_tail = 0;
2130 wrk->trans_size = DMA_TRANS_SIZE;
2135 session_node_enable_disable (u8 is_en)
2137 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
2138 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
2139 session_main_t *sm = &session_main;
2144 n_vlibs = vlib_get_n_threads ();
2145 for (i = 0; i < n_vlibs; i++)
2147 vm = vlib_get_main_by_index (i);
2148 /* main thread with workers and not polling */
2149 if (i == 0 && n_vlibs > 1)
2151 vlib_node_set_state (vm, session_queue_node.index, mstate);
2154 session_main_get_worker (0)->state = SESSION_WRK_INTERRUPT;
2155 vlib_node_set_state (vm, session_queue_process_node.index,
2157 n = vlib_get_node (vm, session_queue_process_node.index);
2158 vlib_start_process (vm, n->runtime_index);
2162 vlib_process_signal_event_mt (vm,
2163 session_queue_process_node.index,
2164 SESSION_Q_PROCESS_STOP, 0);
2169 vlib_node_set_state (vm, session_input_node.index, mstate);
2170 vlib_node_set_state (vm, session_queue_node.index, state);
2173 if (sm->use_private_rx_mqs)
2174 application_enable_rx_mqs_nodes (is_en);
2176 if (sm->dma_enabled)
2177 session_node_enable_dma (is_en, n_vlibs);
2181 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
2183 clib_error_t *error = 0;
2186 if (session_main.is_enabled)
2189 error = session_manager_main_enable (vm);
2190 session_node_enable_disable (is_en);
2194 session_main.is_enabled = 0;
2195 session_manager_main_disable (vm);
2196 session_node_enable_disable (is_en);
2203 session_main_init (vlib_main_t * vm)
2205 session_main_t *smm = &session_main;
2207 smm->is_enabled = 0;
2208 smm->session_enable_asap = 0;
2210 smm->use_private_rx_mqs = 0;
2211 smm->no_adaptive = 0;
2212 smm->last_transport_proto_type = TRANSPORT_PROTO_HTTP;
2213 smm->port_allocator_min_src_port = 1024;
2214 smm->port_allocator_max_src_port = 65535;
2219 static clib_error_t *
2220 session_main_loop_init (vlib_main_t * vm)
2222 session_main_t *smm = &session_main;
2223 if (smm->session_enable_asap)
2225 vlib_worker_thread_barrier_sync (vm);
2226 vnet_session_enable_disable (vm, 1 /* is_en */ );
2227 vlib_worker_thread_barrier_release (vm);
2232 VLIB_INIT_FUNCTION (session_main_init);
2233 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
2235 static clib_error_t *
2236 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
2238 session_main_t *smm = &session_main;
2242 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2244 if (unformat (input, "wrk-mq-length %d", &nitems))
2247 smm->configured_wrk_mq_length = nitems;
2249 clib_warning ("event queue length %d too small, ignored", nitems);
2251 else if (unformat (input, "wrk-mqs-segment-size %U",
2252 unformat_memory_size, &smm->wrk_mqs_segment_size))
2254 else if (unformat (input, "preallocated-sessions %d",
2255 &smm->preallocated_sessions))
2257 else if (unformat (input, "v4-session-table-buckets %d",
2258 &smm->configured_v4_session_table_buckets))
2260 else if (unformat (input, "v4-halfopen-table-buckets %d",
2261 &smm->configured_v4_halfopen_table_buckets))
2263 else if (unformat (input, "v6-session-table-buckets %d",
2264 &smm->configured_v6_session_table_buckets))
2266 else if (unformat (input, "v6-halfopen-table-buckets %d",
2267 &smm->configured_v6_halfopen_table_buckets))
2269 else if (unformat (input, "v4-session-table-memory %U",
2270 unformat_memory_size, &tmp))
2272 if (tmp >= 0x100000000)
2273 return clib_error_return (0, "memory size %llx (%lld) too large",
2275 smm->configured_v4_session_table_memory = tmp;
2277 else if (unformat (input, "v4-halfopen-table-memory %U",
2278 unformat_memory_size, &tmp))
2280 if (tmp >= 0x100000000)
2281 return clib_error_return (0, "memory size %llx (%lld) too large",
2283 smm->configured_v4_halfopen_table_memory = tmp;
2285 else if (unformat (input, "v6-session-table-memory %U",
2286 unformat_memory_size, &tmp))
2288 if (tmp >= 0x100000000)
2289 return clib_error_return (0, "memory size %llx (%lld) too large",
2291 smm->configured_v6_session_table_memory = tmp;
2293 else if (unformat (input, "v6-halfopen-table-memory %U",
2294 unformat_memory_size, &tmp))
2296 if (tmp >= 0x100000000)
2297 return clib_error_return (0, "memory size %llx (%lld) too large",
2299 smm->configured_v6_halfopen_table_memory = tmp;
2301 else if (unformat (input, "local-endpoints-table-memory %U",
2302 unformat_memory_size, &tmp))
2304 if (tmp >= 0x100000000)
2305 return clib_error_return (0, "memory size %llx (%lld) too large",
2307 smm->local_endpoints_table_memory = tmp;
2309 else if (unformat (input, "local-endpoints-table-buckets %d",
2310 &smm->local_endpoints_table_buckets))
2312 else if (unformat (input, "min-src-port %d", &tmp))
2313 smm->port_allocator_min_src_port = tmp;
2314 else if (unformat (input, "max-src-port %d", &tmp))
2315 smm->port_allocator_max_src_port = tmp;
2316 else if (unformat (input, "enable"))
2317 smm->session_enable_asap = 1;
2318 else if (unformat (input, "use-app-socket-api"))
2319 (void) appns_sapi_enable_disable (1 /* is_enable */);
2320 else if (unformat (input, "poll-main"))
2322 else if (unformat (input, "use-private-rx-mqs"))
2323 smm->use_private_rx_mqs = 1;
2324 else if (unformat (input, "no-adaptive"))
2325 smm->no_adaptive = 1;
2326 else if (unformat (input, "use-dma"))
2327 smm->dma_enabled = 1;
2328 else if (unformat (input, "nat44-original-dst-enable"))
2330 smm->original_dst_lookup = vlib_get_plugin_symbol (
2331 "nat_plugin.so", "nat44_original_dst_lookup");
2334 * Deprecated but maintained for compatibility
2336 else if (unformat (input, "evt_qs_memfd_seg"))
2338 else if (unformat (input, "segment-baseva 0x%lx", &tmp))
2340 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
2341 &smm->wrk_mqs_segment_size))
2343 else if (unformat (input, "event-queue-length %d", &nitems))
2346 smm->configured_wrk_mq_length = nitems;
2348 clib_warning ("event queue length %d too small, ignored", nitems);
2351 return clib_error_return (0, "unknown input `%U'",
2352 format_unformat_error, input);
2357 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2360 * fd.io coding-style-patch-verification: ON
2363 * eval: (c-set-style "gnu")