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_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
102 /* only events supported are disconnect, shutdown and reset */
103 ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE ||
104 evt_type == SESSION_CTRL_EVT_HALF_CLOSE ||
105 evt_type == SESSION_CTRL_EVT_RESET);
106 return session_send_evt_to_thread (s, 0, s->thread_index, evt_type);
110 session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
113 session_send_evt_to_thread (fp, rpc_args, thread_index,
114 SESSION_CTRL_EVT_RPC);
118 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
120 if (thread_index != vlib_get_thread_index ())
121 session_send_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
124 void (*fnp) (void *) = fp;
130 session_add_self_custom_tx_evt (transport_connection_t * tc, u8 has_prio)
132 session_t *s = session_get (tc->s_index, tc->thread_index);
134 ASSERT (s->thread_index == vlib_get_thread_index ());
135 ASSERT (s->session_state != SESSION_STATE_TRANSPORT_DELETED);
137 if (!(s->flags & SESSION_F_CUSTOM_TX))
139 s->flags |= SESSION_F_CUSTOM_TX;
140 if (svm_fifo_set_event (s->tx_fifo)
141 || transport_connection_is_descheduled (tc))
143 session_evt_elt_t *elt;
144 session_worker_t *wrk;
146 wrk = session_main_get_worker (tc->thread_index);
148 elt = session_evt_alloc_new (wrk);
150 elt = session_evt_alloc_old (wrk);
151 elt->evt.session_index = tc->s_index;
152 elt->evt.event_type = SESSION_IO_EVT_TX;
153 tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
155 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
156 vlib_node_set_interrupt_pending (wrk->vm,
157 session_queue_node.index);
163 sesssion_reschedule_tx (transport_connection_t * tc)
165 session_worker_t *wrk = session_main_get_worker (tc->thread_index);
166 session_evt_elt_t *elt;
168 ASSERT (tc->thread_index == vlib_get_thread_index ());
170 elt = session_evt_alloc_new (wrk);
171 elt->evt.session_index = tc->s_index;
172 elt->evt.event_type = SESSION_IO_EVT_TX;
174 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
175 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
179 session_program_transport_ctrl_evt (session_t * s, session_evt_type_t evt)
181 u32 thread_index = vlib_get_thread_index ();
182 session_evt_elt_t *elt;
183 session_worker_t *wrk;
185 /* If we are in the handler thread, or being called with the worker barrier
186 * held, just append a new event to pending disconnects vector. */
187 if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
189 wrk = session_main_get_worker (s->thread_index);
190 elt = session_evt_alloc_ctrl (wrk);
191 clib_memset (&elt->evt, 0, sizeof (session_event_t));
192 elt->evt.session_handle = session_handle (s);
193 elt->evt.event_type = evt;
195 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
196 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
199 session_send_ctrl_evt_to_thread (s, evt);
203 session_alloc (u32 thread_index)
205 session_worker_t *wrk = &session_main.wrk[thread_index];
208 pool_get_aligned_safe (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
209 clib_memset (s, 0, sizeof (*s));
210 s->session_index = s - wrk->sessions;
211 s->thread_index = thread_index;
212 s->al_index = APP_INVALID_INDEX;
218 session_free (session_t * s)
220 session_worker_t *wrk = &session_main.wrk[s->thread_index];
222 SESSION_EVT (SESSION_EVT_FREE, s);
224 clib_memset (s, 0xFA, sizeof (*s));
225 pool_put (wrk->sessions, s);
229 session_is_valid (u32 si, u8 thread_index)
232 transport_connection_t *tc;
234 s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
236 if (s->thread_index != thread_index || s->session_index != si)
239 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED
240 || s->session_state <= SESSION_STATE_LISTENING)
243 if ((s->session_state == SESSION_STATE_CONNECTING ||
244 s->session_state == SESSION_STATE_TRANSPORT_CLOSED) &&
245 (s->flags & SESSION_F_HALF_OPEN))
248 tc = session_get_transport (s);
249 if (s->connection_index != tc->c_index ||
250 s->thread_index != tc->thread_index || tc->s_index != si)
257 session_cleanup (session_t *s)
259 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
264 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
266 app_worker_t *app_wrk;
268 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
271 if (ntf == SESSION_CLEANUP_TRANSPORT)
277 app_worker_cleanup_notify (app_wrk, s, ntf);
281 session_program_cleanup (session_t *s)
283 ASSERT (s->session_state == SESSION_STATE_TRANSPORT_DELETED);
284 session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
288 * Cleans up session and lookup table.
290 * Transport connection must still be valid.
293 session_delete (session_t * s)
297 /* Delete from the main lookup table. */
298 if ((rv = session_lookup_del_session (s)))
299 clib_warning ("session %u hash delete rv %d", s->session_index, rv);
301 session_program_cleanup (s);
305 session_cleanup_half_open (session_handle_t ho_handle)
307 session_t *ho = session_get_from_handle (ho_handle);
309 /* App transports can migrate their half-opens */
310 if (ho->flags & SESSION_F_IS_MIGRATING)
312 /* Session still migrating, move to closed state to signal that the
313 * session should be removed. */
314 if (ho->connection_index == ~0)
316 session_set_state (ho, SESSION_STATE_CLOSED);
319 /* Migrated transports are no longer half-opens */
320 transport_cleanup (session_get_transport_proto (ho),
321 ho->connection_index, ho->al_index /* overloaded */);
323 else if (ho->session_state != SESSION_STATE_TRANSPORT_DELETED)
325 /* Cleanup half-open session lookup table if need be */
326 if (ho->session_state != SESSION_STATE_TRANSPORT_CLOSED)
328 transport_connection_t *tc;
329 tc = transport_get_half_open (session_get_transport_proto (ho),
330 ho->connection_index);
331 if (tc && !(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
332 session_lookup_del_half_open (tc);
334 transport_cleanup_half_open (session_get_transport_proto (ho),
335 ho->connection_index);
341 session_half_open_free (session_t *ho)
343 app_worker_t *app_wrk;
345 ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
346 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
348 app_worker_del_half_open (app_wrk, ho);
354 session_half_open_free_rpc (void *args)
356 session_t *ho = ho_session_get (pointer_to_uword (args));
357 session_half_open_free (ho);
361 session_half_open_delete_notify (transport_connection_t *tc)
363 session_t *ho = ho_session_get (tc->s_index);
365 /* Cleanup half-open lookup table if need be */
366 if (ho->session_state != SESSION_STATE_TRANSPORT_CLOSED)
368 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
369 session_lookup_del_half_open (tc);
371 session_set_state (ho, SESSION_STATE_TRANSPORT_DELETED);
373 /* Notification from ctrl thread accepted without rpc */
374 if (tc->thread_index == transport_cl_thread ())
376 session_half_open_free (ho);
380 void *args = uword_to_pointer ((uword) tc->s_index, void *);
381 session_send_rpc_evt_to_thread_force (transport_cl_thread (),
382 session_half_open_free_rpc, args);
387 session_half_open_migrate_notify (transport_connection_t *tc)
391 /* Support half-open migrations only for transports with no lookup */
392 ASSERT (tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP);
394 ho = ho_session_get (tc->s_index);
395 ho->flags |= SESSION_F_IS_MIGRATING;
396 ho->connection_index = ~0;
400 session_half_open_migrated_notify (transport_connection_t *tc)
404 ho = ho_session_get (tc->s_index);
406 /* App probably detached so the half-open must be cleaned up */
407 if (ho->session_state == SESSION_STATE_CLOSED)
409 session_half_open_delete_notify (tc);
412 ho->connection_index = tc->c_index;
413 /* Overload al_index for half-open with new thread */
414 ho->al_index = tc->thread_index;
419 session_alloc_for_connection (transport_connection_t * tc)
422 u32 thread_index = tc->thread_index;
424 ASSERT (thread_index == vlib_get_thread_index ()
425 || transport_protocol_is_cl (tc->proto));
427 s = session_alloc (thread_index);
428 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
429 session_set_state (s, SESSION_STATE_CLOSED);
431 /* Attach transport to session and vice versa */
432 s->connection_index = tc->c_index;
433 tc->s_index = s->session_index;
438 session_alloc_for_half_open (transport_connection_t *tc)
442 s = ho_session_alloc ();
443 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
444 s->connection_index = tc->c_index;
445 tc->s_index = s->session_index;
450 * Discards bytes from buffer chain
452 * It discards n_bytes_to_drop starting at first buffer after chain_b
455 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
456 vlib_buffer_t ** chain_b,
459 vlib_buffer_t *next = *chain_b;
460 u32 to_drop = n_bytes_to_drop;
461 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
462 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
464 next = vlib_get_buffer (vm, next->next_buffer);
465 if (next->current_length > to_drop)
467 vlib_buffer_advance (next, to_drop);
472 to_drop -= next->current_length;
473 next->current_length = 0;
479 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
483 * Enqueue buffer chain tail
486 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
487 u32 offset, u8 is_in_order)
489 vlib_buffer_t *chain_b;
490 u32 chain_bi, len, diff;
491 vlib_main_t *vm = vlib_get_main ();
496 if (is_in_order && offset)
498 diff = offset - b->current_length;
499 if (diff > b->total_length_not_including_first_buffer)
502 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
503 chain_bi = vlib_get_buffer_index (vm, chain_b);
506 chain_bi = b->next_buffer;
510 chain_b = vlib_get_buffer (vm, chain_bi);
511 data = vlib_buffer_get_current (chain_b);
512 len = chain_b->current_length;
517 rv = svm_fifo_enqueue (s->rx_fifo, len, data);
524 return (rv > 0) ? (written + rv) : written;
530 /* written more than what was left in chain */
531 if (written > b->total_length_not_including_first_buffer)
534 /* drop the bytes that have already been delivered */
535 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
540 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
543 clib_warning ("failed to enqueue multi-buffer seg");
549 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
550 ? chain_b->next_buffer : 0));
559 session_fifo_tuning (session_t * s, svm_fifo_t * f,
560 session_ft_action_t act, u32 len)
562 if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
564 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
565 app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
566 if (CLIB_ASSERT_ENABLE)
568 segment_manager_t *sm;
569 sm = segment_manager_get (f->segment_manager);
570 ASSERT (f->shr->size >= 4096);
571 ASSERT (f->shr->size <= sm->max_fifo_size);
577 session_wrk_program_app_wrk_evts (session_worker_t *wrk, u32 app_wrk_index)
581 ASSERT ((wrk - session_main.wrk) == vlib_get_thread_index ());
582 need_interrupt = clib_bitmap_is_zero (wrk->app_wrks_pending_ntf);
583 wrk->app_wrks_pending_ntf =
584 clib_bitmap_set (wrk->app_wrks_pending_ntf, app_wrk_index, 1);
587 vlib_node_set_interrupt_pending (wrk->vm, session_input_node.index);
591 session_program_io_event (app_worker_t *app_wrk, session_t *s,
592 session_evt_type_t et, u8 is_cl)
596 /* Special events for connectionless sessions */
597 et += SESSION_IO_EVT_BUILTIN_RX - SESSION_IO_EVT_RX;
599 ASSERT (s->thread_index == 0 || et == SESSION_IO_EVT_TX_MAIN);
600 session_event_t evt = {
602 .session_handle = session_handle (s),
605 app_worker_add_event_custom (app_wrk, vlib_get_thread_index (), &evt);
609 app_worker_add_event (app_wrk, s, et);
614 session_notify_subscribers (u32 app_index, session_t *s, svm_fifo_t *f,
615 session_evt_type_t evt_type)
617 app_worker_t *app_wrk;
622 app = application_get (app_index);
626 is_cl = s->thread_index != vlib_get_thread_index ();
627 for (i = 0; i < f->shr->n_subscribers; i++)
629 app_wrk = application_get_worker (app, f->shr->subscribers[i]);
632 session_program_io_event (app_wrk, s, evt_type, is_cl ? 1 : 0);
639 session_enqueue_notify_inline (session_t *s, u8 is_cl)
641 app_worker_t *app_wrk;
643 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
644 if (PREDICT_FALSE (!app_wrk))
647 session_program_io_event (app_wrk, s, SESSION_IO_EVT_RX, is_cl);
649 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->rx_fifo)))
650 return session_notify_subscribers (app_wrk->app_index, s, s->rx_fifo,
657 session_enqueue_notify (session_t *s)
659 return session_enqueue_notify_inline (s, 0 /* is_cl */);
663 session_enqueue_notify_cl (session_t *s)
665 return session_enqueue_notify_inline (s, 1 /* is_cl */);
669 session_dequeue_notify (session_t *s)
671 app_worker_t *app_wrk;
674 /* Unset as soon as event is requested */
675 svm_fifo_clear_deq_ntf (s->tx_fifo);
677 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
678 if (PREDICT_FALSE (!app_wrk))
681 is_cl = s->session_state == SESSION_STATE_LISTENING ||
682 s->session_state == SESSION_STATE_OPENED;
683 session_program_io_event (app_wrk, s, SESSION_IO_EVT_TX, is_cl ? 1 : 0);
685 if (PREDICT_FALSE (svm_fifo_n_subscribers (s->tx_fifo)))
686 return session_notify_subscribers (app_wrk->app_index, s, s->tx_fifo,
693 * Flushes queue of sessions that are to be notified of new data
696 * @param transport_proto transport protocol for which queue to be flushed
697 * @param thread_index Thread index for which the flush is to be performed.
698 * @return 0 on success or a positive number indicating the number of
699 * failures due to API queue being full.
702 session_main_flush_enqueue_events (transport_proto_t transport_proto,
705 session_worker_t *wrk = session_main_get_worker (thread_index);
706 session_handle_t *handles;
710 handles = wrk->session_to_enqueue[transport_proto];
712 for (i = 0; i < vec_len (handles); i++)
714 s = session_get_from_handle (handles[i]);
715 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
716 0 /* TODO/not needed */);
718 s->thread_index != thread_index || (s->flags & SESSION_F_IS_CLESS);
720 session_enqueue_notify_inline (s, 0);
722 session_enqueue_notify_inline (s, 1);
725 vec_reset_length (handles);
726 wrk->session_to_enqueue[transport_proto] = handles;
730 * Enqueue data for delivery to app. If requested, it queues app notification
731 * event for later delivery.
733 * @param tc Transport connection which is to be enqueued data
734 * @param b Buffer to be enqueued
735 * @param offset Offset at which to start enqueueing if out-of-order
736 * @param queue_event Flag to indicate if peer is to be notified or if event
737 * is to be queued. The former is useful when more data is
738 * enqueued and only one event is to be generated.
739 * @param is_in_order Flag to indicate if data is in order
740 * @return Number of bytes enqueued or a negative value if enqueueing failed.
743 session_enqueue_stream_connection (transport_connection_t * tc,
744 vlib_buffer_t * b, u32 offset,
745 u8 queue_event, u8 is_in_order)
748 int enqueued = 0, rv, in_order_off;
750 s = session_get (tc->s_index, tc->thread_index);
754 enqueued = svm_fifo_enqueue (s->rx_fifo,
756 vlib_buffer_get_current (b));
757 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
760 in_order_off = enqueued > b->current_length ? enqueued : 0;
761 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
768 rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
770 vlib_buffer_get_current (b));
771 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
772 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
773 /* if something was enqueued, report even this as success for ooo
774 * segment handling */
780 /* Queue RX event on this fifo. Eventually these will need to be
781 * flushed by calling @ref session_main_flush_enqueue_events () */
782 if (!(s->flags & SESSION_F_RX_EVT))
784 session_worker_t *wrk = session_main_get_worker (s->thread_index);
785 ASSERT (s->thread_index == vlib_get_thread_index ());
786 s->flags |= SESSION_F_RX_EVT;
787 vec_add1 (wrk->session_to_enqueue[tc->proto], session_handle (s));
790 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
797 session_enqueue_dgram_connection_inline (session_t *s,
798 session_dgram_hdr_t *hdr,
799 vlib_buffer_t *b, u8 proto,
800 u8 queue_event, u32 is_cl)
804 ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
805 >= b->current_length + sizeof (*hdr));
807 if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
809 svm_fifo_seg_t segs[2] = {
810 { (u8 *) hdr, sizeof (*hdr) },
811 { vlib_buffer_get_current (b), b->current_length }
814 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, 2,
815 0 /* allow_partial */ );
819 vlib_main_t *vm = vlib_get_main ();
820 svm_fifo_seg_t *segs = 0, *seg;
821 vlib_buffer_t *it = b;
824 vec_add2 (segs, seg, 1);
825 seg->data = (u8 *) hdr;
826 seg->len = sizeof (*hdr);
829 vec_add2 (segs, seg, 1);
830 seg->data = vlib_buffer_get_current (it);
831 seg->len = it->current_length;
833 if (!(it->flags & VLIB_BUFFER_NEXT_PRESENT))
835 it = vlib_get_buffer (vm, it->next_buffer);
837 rv = svm_fifo_enqueue_segments (s->rx_fifo, segs, n_segs,
838 0 /* allow partial */ );
842 if (queue_event && rv > 0)
844 /* Queue RX event on this fifo. Eventually these will need to be
845 * flushed by calling @ref session_main_flush_enqueue_events () */
846 if (!(s->flags & SESSION_F_RX_EVT))
849 is_cl ? vlib_get_thread_index () : s->thread_index;
850 session_worker_t *wrk = session_main_get_worker (thread_index);
851 ASSERT (s->thread_index == vlib_get_thread_index () || is_cl);
852 s->flags |= SESSION_F_RX_EVT;
853 vec_add1 (wrk->session_to_enqueue[proto], session_handle (s));
856 session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
858 return rv > 0 ? rv : 0;
862 session_enqueue_dgram_connection (session_t *s, session_dgram_hdr_t *hdr,
863 vlib_buffer_t *b, u8 proto, u8 queue_event)
865 return session_enqueue_dgram_connection_inline (s, hdr, b, proto,
866 queue_event, 0 /* is_cl */);
870 session_enqueue_dgram_connection2 (session_t *s, session_dgram_hdr_t *hdr,
871 vlib_buffer_t *b, u8 proto, u8 queue_event)
873 return session_enqueue_dgram_connection_inline (s, hdr, b, proto,
874 queue_event, 1 /* is_cl */);
878 session_enqueue_dgram_connection_cl (session_t *s, session_dgram_hdr_t *hdr,
879 vlib_buffer_t *b, u8 proto,
884 awls = app_listener_select_wrk_cl_session (s, hdr);
885 return session_enqueue_dgram_connection_inline (awls, hdr, b, proto,
886 queue_event, 1 /* is_cl */);
890 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
891 u32 offset, u32 max_bytes)
893 session_t *s = session_get (tc->s_index, tc->thread_index);
894 return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
898 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
900 session_t *s = session_get (tc->s_index, tc->thread_index);
903 rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
904 session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
906 if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
907 session_dequeue_notify (s);
913 session_stream_connect_notify (transport_connection_t * tc,
916 u32 opaque = 0, new_ti, new_si;
917 app_worker_t *app_wrk;
918 session_t *s = 0, *ho;
921 * Cleanup half-open table
923 session_lookup_del_half_open (tc);
925 ho = ho_session_get (tc->s_index);
926 session_set_state (ho, SESSION_STATE_TRANSPORT_CLOSED);
928 app_wrk = app_worker_get_if_valid (ho->app_wrk_index);
933 return app_worker_connect_notify (app_wrk, s, err, opaque);
935 s = session_alloc_for_connection (tc);
936 session_set_state (s, SESSION_STATE_CONNECTING);
937 s->app_wrk_index = app_wrk->wrk_index;
939 new_si = s->session_index;
940 new_ti = s->thread_index;
942 if ((err = app_worker_init_connected (app_wrk, s)))
945 app_worker_connect_notify (app_wrk, 0, err, opaque);
949 s = session_get (new_si, new_ti);
950 session_set_state (s, SESSION_STATE_READY);
951 session_lookup_add_connection (tc, session_handle (s));
953 if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
955 session_lookup_del_connection (tc);
956 /* Avoid notifying app about rejected session cleanup */
957 s = session_get (new_si, new_ti);
958 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
967 session_switch_pool_closed_rpc (void *arg)
972 sh = pointer_to_uword (arg);
973 s = session_get_from_handle_if_valid (sh);
977 transport_cleanup (session_get_transport_proto (s), s->connection_index,
982 typedef struct _session_switch_pool_args
986 u32 new_thread_index;
987 u32 new_session_index;
988 } session_switch_pool_args_t;
991 * Notify old thread of the session pool switch
994 session_switch_pool (void *cb_args)
996 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
997 session_handle_t sh, new_sh;
998 segment_manager_t *sm;
999 app_worker_t *app_wrk;
1002 ASSERT (args->thread_index == vlib_get_thread_index ());
1003 s = session_get (args->session_index, args->thread_index);
1005 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1009 /* Cleanup fifo segment slice state for fifos */
1010 sm = app_worker_get_connect_segment_manager (app_wrk);
1011 segment_manager_detach_fifo (sm, &s->rx_fifo);
1012 segment_manager_detach_fifo (sm, &s->tx_fifo);
1014 /* Check if session closed during migration */
1015 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1019 session_make_handle (args->new_session_index, args->new_thread_index);
1020 app_worker_migrate_notify (app_wrk, s, new_sh);
1022 clib_mem_free (cb_args);
1026 /* Session closed during migration. Clean everything up */
1027 sh = session_handle (s);
1028 session_send_rpc_evt_to_thread (args->new_thread_index,
1029 session_switch_pool_closed_rpc,
1030 uword_to_pointer (sh, void *));
1031 clib_mem_free (cb_args);
1035 * Move dgram session to the right thread
1038 session_dgram_connect_notify (transport_connection_t * tc,
1039 u32 old_thread_index, session_t ** new_session)
1042 session_switch_pool_args_t *rpc_args;
1043 segment_manager_t *sm;
1044 app_worker_t *app_wrk;
1047 * Clone half-open session to the right thread.
1049 new_s = session_clone_safe (tc->s_index, old_thread_index);
1050 new_s->connection_index = tc->c_index;
1051 session_set_state (new_s, SESSION_STATE_READY);
1052 new_s->flags |= SESSION_F_IS_MIGRATING;
1054 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1055 session_lookup_add_connection (tc, session_handle (new_s));
1057 app_wrk = app_worker_get_if_valid (new_s->app_wrk_index);
1060 /* New set of fifos attached to the same shared memory */
1061 sm = app_worker_get_connect_segment_manager (app_wrk);
1062 segment_manager_attach_fifo (sm, &new_s->rx_fifo, new_s);
1063 segment_manager_attach_fifo (sm, &new_s->tx_fifo, new_s);
1067 * Ask thread owning the old session to clean it up and make us the tx
1070 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
1071 rpc_args->new_session_index = new_s->session_index;
1072 rpc_args->new_thread_index = new_s->thread_index;
1073 rpc_args->session_index = tc->s_index;
1074 rpc_args->thread_index = old_thread_index;
1075 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
1078 tc->s_index = new_s->session_index;
1079 new_s->connection_index = tc->c_index;
1080 *new_session = new_s;
1085 * Notification from transport that connection is being closed.
1087 * A disconnect is sent to application but state is not removed. Once
1088 * disconnect is acknowledged by application, session disconnect is called.
1089 * Ultimately this leads to close being called on transport (passive close).
1092 session_transport_closing_notify (transport_connection_t * tc)
1094 app_worker_t *app_wrk;
1097 s = session_get (tc->s_index, tc->thread_index);
1098 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1101 /* Wait for reply from app before sending notification as the
1102 * accept might be rejected */
1103 if (s->session_state == SESSION_STATE_ACCEPTING)
1105 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1109 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1110 app_wrk = app_worker_get (s->app_wrk_index);
1111 app_worker_close_notify (app_wrk, s);
1115 * Notification from transport that connection is being deleted
1117 * This removes the session if it is still valid. It should be called only on
1118 * previously fully established sessions. For instance failed connects should
1119 * call stream_session_connect_notify and indicate that the connect has
1123 session_transport_delete_notify (transport_connection_t * tc)
1127 /* App might've been removed already */
1128 if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1131 switch (s->session_state)
1133 case SESSION_STATE_CREATED:
1134 /* Session was created but accept notification was not yet sent to the
1135 * app. Cleanup everything. */
1136 session_lookup_del_session (s);
1137 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1140 case SESSION_STATE_ACCEPTING:
1141 case SESSION_STATE_TRANSPORT_CLOSING:
1142 case SESSION_STATE_CLOSING:
1143 case SESSION_STATE_TRANSPORT_CLOSED:
1144 /* If transport finishes or times out before we get a reply
1145 * from the app, mark transport as closed and wait for reply
1146 * before removing the session. Cleanup session table in advance
1147 * because transport will soon be closed and closed sessions
1148 * are assumed to have been removed from the lookup table */
1149 session_lookup_del_session (s);
1150 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1151 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1152 svm_fifo_dequeue_drop_all (s->tx_fifo);
1154 case SESSION_STATE_APP_CLOSED:
1155 /* Cleanup lookup table as transport needs to still be valid.
1156 * Program transport close to ensure that all session events
1157 * have been cleaned up. Once transport close is called, the
1158 * session is just removed because both transport and app have
1159 * confirmed the close*/
1160 session_lookup_del_session (s);
1161 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1162 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1163 svm_fifo_dequeue_drop_all (s->tx_fifo);
1164 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1166 case SESSION_STATE_TRANSPORT_DELETED:
1168 case SESSION_STATE_CLOSED:
1169 session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1170 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
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 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1201 /* Transport thinks that app requested close but it actually didn't.
1202 * Can happen for tcp:
1203 * 1)if fin and rst are received in close succession.
1204 * 2)if app shutdown the connection. */
1205 if (s->session_state == SESSION_STATE_READY)
1207 session_transport_closing_notify (tc);
1208 svm_fifo_dequeue_drop_all (s->tx_fifo);
1209 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSED);
1211 /* If app close has not been received or has not yet resulted in
1212 * a transport close, only mark the session transport as closed */
1213 else if (s->session_state <= SESSION_STATE_CLOSING)
1214 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSED);
1215 /* If app also closed, switch to closed */
1216 else if (s->session_state == SESSION_STATE_APP_CLOSED)
1217 session_set_state (s, SESSION_STATE_CLOSED);
1219 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1221 app_worker_transport_closed_notify (app_wrk, s);
1225 * Notify application that connection has been reset.
1228 session_transport_reset_notify (transport_connection_t * tc)
1230 app_worker_t *app_wrk;
1233 s = session_get (tc->s_index, tc->thread_index);
1234 svm_fifo_dequeue_drop_all (s->tx_fifo);
1235 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1237 if (s->session_state == SESSION_STATE_ACCEPTING)
1239 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1242 session_set_state (s, SESSION_STATE_TRANSPORT_CLOSING);
1243 app_wrk = app_worker_get (s->app_wrk_index);
1244 app_worker_reset_notify (app_wrk, s);
1248 session_stream_accept_notify (transport_connection_t * tc)
1250 app_worker_t *app_wrk;
1253 s = session_get (tc->s_index, tc->thread_index);
1254 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1257 if (s->session_state != SESSION_STATE_CREATED)
1259 session_set_state (s, SESSION_STATE_ACCEPTING);
1260 if (app_worker_accept_notify (app_wrk, s))
1262 /* On transport delete, no notifications should be sent. Unless, the
1263 * accept is retried and successful. */
1264 session_set_state (s, SESSION_STATE_CREATED);
1271 * Accept a stream session. Optionally ping the server by callback.
1274 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1275 u32 thread_index, u8 notify)
1280 s = session_alloc_for_connection (tc);
1281 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1282 session_set_state (s, SESSION_STATE_CREATED);
1284 if ((rv = app_worker_init_accepted (s)))
1290 session_lookup_add_connection (tc, session_handle (s));
1292 /* Shoulder-tap the server */
1295 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1296 if ((rv = app_worker_accept_notify (app_wrk, s)))
1298 session_lookup_del_session (s);
1299 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1309 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1312 app_worker_t *app_wrk;
1316 s = session_alloc_for_connection (tc);
1317 s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1319 if ((rv = app_worker_init_accepted (s)))
1325 session_lookup_add_connection (tc, session_handle (s));
1326 session_set_state (s, SESSION_STATE_ACCEPTING);
1328 app_wrk = app_worker_get (s->app_wrk_index);
1329 if ((rv = app_worker_accept_notify (app_wrk, s)))
1331 session_lookup_del_session (s);
1332 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1341 session_open_cl (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1343 transport_connection_t *tc;
1344 transport_endpoint_cfg_t *tep;
1345 app_worker_t *app_wrk;
1346 session_handle_t sh;
1350 tep = session_endpoint_to_transport_cfg (rmt);
1351 rv = transport_connect (rmt->transport_proto, tep);
1354 SESSION_DBG ("Transport failed to open connection.");
1358 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1360 /* For dgram type of service, allocate session and fifos now */
1361 app_wrk = app_worker_get (rmt->app_wrk_index);
1362 s = session_alloc_for_connection (tc);
1363 s->app_wrk_index = app_wrk->wrk_index;
1364 s->opaque = rmt->opaque;
1365 session_set_state (s, SESSION_STATE_OPENED);
1366 if (transport_connection_is_cless (tc))
1367 s->flags |= SESSION_F_IS_CLESS;
1368 if (app_worker_init_connected (app_wrk, s))
1374 sh = session_handle (s);
1377 session_lookup_add_connection (tc, sh);
1378 return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, rmt->opaque);
1382 session_open_vc (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1384 transport_connection_t *tc;
1385 transport_endpoint_cfg_t *tep;
1386 app_worker_t *app_wrk;
1390 tep = session_endpoint_to_transport_cfg (rmt);
1391 rv = transport_connect (rmt->transport_proto, tep);
1394 SESSION_DBG ("Transport failed to open connection.");
1398 tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1400 app_wrk = app_worker_get (rmt->app_wrk_index);
1402 /* If transport offers a vc service, only allocate established
1403 * session once the connection has been established.
1404 * In the meantime allocate half-open session for tracking purposes
1405 * associate half-open connection to it and add session to app-worker
1406 * half-open table. These are needed to allocate the established
1407 * session on transport notification, and to cleanup the half-open
1408 * session if the app detaches before connection establishment.
1410 ho = session_alloc_for_half_open (tc);
1411 ho->app_wrk_index = app_wrk->wrk_index;
1412 ho->ho_index = app_worker_add_half_open (app_wrk, session_handle (ho));
1413 ho->opaque = rmt->opaque;
1414 *rsh = session_handle (ho);
1416 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1417 session_lookup_add_half_open (tc, tc->c_index);
1423 session_open_app (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1425 transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (rmt);
1427 /* Not supported for now */
1428 *rsh = SESSION_INVALID_HANDLE;
1429 return transport_connect (rmt->transport_proto, tep_cfg);
1432 typedef int (*session_open_service_fn) (session_endpoint_cfg_t *,
1433 session_handle_t *);
1435 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1442 * Ask transport to open connection to remote transport endpoint.
1444 * Stores handle for matching request with reply since the call can be
1445 * asynchronous. For instance, for TCP the 3-way handshake must complete
1446 * before reply comes. Session is only created once connection is established.
1448 * @param app_index Index of the application requesting the connect
1449 * @param st Session type requested.
1450 * @param tep Remote transport endpoint
1451 * @param opaque Opaque data (typically, api_context) the application expects
1452 * on open completion.
1455 session_open (session_endpoint_cfg_t *rmt, session_handle_t *rsh)
1457 transport_service_type_t tst;
1458 tst = transport_protocol_service_type (rmt->transport_proto);
1459 return session_open_srv_fns[tst](rmt, rsh);
1463 * Ask transport to listen on session endpoint.
1465 * @param s Session for which listen will be called. Note that unlike
1466 * established sessions, listen sessions are not associated to a
1468 * @param sep Local endpoint to be listened on.
1471 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1473 transport_endpoint_cfg_t *tep;
1477 /* Transport bind/listen */
1478 tep = session_endpoint_to_transport_cfg (sep);
1479 s_index = ls->session_index;
1480 tc_index = transport_start_listen (session_get_transport_proto (ls),
1486 /* Attach transport to session. Lookup tables are populated by the app
1487 * worker because local tables (for ct sessions) are not backed by a fib */
1488 ls = listen_session_get (s_index);
1489 ls->connection_index = tc_index;
1490 ls->opaque = sep->opaque;
1491 if (transport_connection_is_cless (session_get_transport (ls)))
1492 ls->flags |= SESSION_F_IS_CLESS;
1498 * Ask transport to stop listening on local transport endpoint.
1500 * @param s Session to stop listening on. It must be in state LISTENING.
1503 session_stop_listen (session_t * s)
1505 transport_proto_t tp = session_get_transport_proto (s);
1506 transport_connection_t *tc;
1508 if (s->session_state != SESSION_STATE_LISTENING)
1509 return SESSION_E_NOLISTEN;
1511 tc = transport_get_listener (tp, s->connection_index);
1513 /* If no transport, assume everything was cleaned up already */
1515 return SESSION_E_NONE;
1517 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1518 session_lookup_del_connection (tc);
1520 transport_stop_listen (tp, s->connection_index);
1525 * Initialize session half-closing procedure.
1527 * Note that half-closing will not change the state of the session.
1530 session_half_close (session_t *s)
1535 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_HALF_CLOSE);
1539 * Initialize session closing procedure.
1541 * Request is always sent to session node to ensure that all outstanding
1542 * requests are served before transport is notified.
1545 session_close (session_t * s)
1547 if (!s || (s->flags & SESSION_F_APP_CLOSED))
1550 /* Transports can close and delete their state independent of app closes
1551 * and transport initiated state transitions can hide app closes. Instead
1552 * of extending the state machine to support separate tracking of app and
1553 * transport initiated closes, use a flag. */
1554 s->flags |= SESSION_F_APP_CLOSED;
1556 if (s->session_state >= SESSION_STATE_CLOSING)
1558 /* Session will only be removed once both app and transport
1559 * acknowledge the close */
1560 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1561 || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1562 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1566 /* App closed so stop propagating dequeue notifications.
1567 * App might disconnect session before connected, in this case,
1568 * tx_fifo may not be setup yet, so clear only it's inited. */
1570 svm_fifo_clear_deq_ntf (s->tx_fifo);
1571 session_set_state (s, SESSION_STATE_CLOSING);
1572 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1576 * Force a close without waiting for data to be flushed
1579 session_reset (session_t * s)
1581 if (s->session_state >= SESSION_STATE_CLOSING)
1583 /* Drop all outstanding tx data
1584 * App might disconnect session before connected, in this case,
1585 * tx_fifo may not be setup yet, so clear only it's inited. */
1587 svm_fifo_dequeue_drop_all (s->tx_fifo);
1588 session_set_state (s, SESSION_STATE_CLOSING);
1589 session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1593 * Notify transport the session can be half-disconnected.
1595 * Must be called from the session's thread.
1598 session_transport_half_close (session_t *s)
1600 /* Only READY session can be half-closed */
1601 if (s->session_state != SESSION_STATE_READY)
1606 transport_half_close (session_get_transport_proto (s), s->connection_index,
1611 * Notify transport the session can be disconnected. This should eventually
1612 * result in a delete notification that allows us to cleanup session state.
1613 * Called for both active/passive disconnects.
1615 * Must be called from the session's thread.
1618 session_transport_close (session_t * s)
1620 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1622 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1623 session_set_state (s, SESSION_STATE_CLOSED);
1624 /* If transport is already deleted, just free the session */
1625 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1626 session_program_cleanup (s);
1630 /* If the tx queue wasn't drained, the transport can continue to try
1631 * sending the outstanding data (in closed state it cannot). It MUST however
1632 * at one point, either after sending everything or after a timeout, call
1633 * delete notify. This will finally lead to the complete cleanup of the
1636 session_set_state (s, SESSION_STATE_APP_CLOSED);
1638 transport_close (session_get_transport_proto (s), s->connection_index,
1643 * Force transport close
1646 session_transport_reset (session_t * s)
1648 if (s->session_state >= SESSION_STATE_APP_CLOSED)
1650 if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1651 session_set_state (s, SESSION_STATE_CLOSED);
1652 else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1653 session_program_cleanup (s);
1657 session_set_state (s, SESSION_STATE_APP_CLOSED);
1658 transport_reset (session_get_transport_proto (s), s->connection_index,
1663 * Cleanup transport and session state.
1665 * Notify transport of the cleanup and free the session. This should
1666 * be called only if transport reported some error and is already
1670 session_transport_cleanup (session_t * s)
1672 /* Delete from main lookup table before we axe the the transport */
1673 session_lookup_del_session (s);
1674 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1675 transport_cleanup (session_get_transport_proto (s), s->connection_index,
1677 /* Since we called cleanup, no delete notification will come. So, make
1678 * sure the session is properly freed. */
1679 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1684 * Allocate worker mqs in share-able segment
1686 * That can only be a newly created memfd segment, that must be mapped
1687 * by all apps/stack users unless private rx mqs are enabled.
1690 session_vpp_wrk_mqs_alloc (session_main_t *smm)
1692 u32 mq_q_length = 2048, evt_size = sizeof (session_event_t);
1693 fifo_segment_t *mqs_seg = &smm->wrk_mqs_segment;
1694 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1698 mq_q_length = clib_max (mq_q_length, smm->configured_wrk_mq_length);
1700 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1701 { mq_q_length, evt_size, 0 }, { mq_q_length >> 1, 256, 0 }
1703 cfg->consumer_pid = 0;
1705 cfg->q_nitems = mq_q_length;
1706 cfg->ring_cfgs = rc;
1709 * Compute mqs segment size based on rings config and leave space
1710 * for passing extended configuration messages, i.e., data allocated
1711 * outside of the rings. If provided with a config value, accept it
1712 * if larger than minimum size.
1714 mqs_seg_size = svm_msg_q_size_to_alloc (cfg) * vec_len (smm->wrk);
1715 mqs_seg_size = mqs_seg_size + (1 << 20);
1716 mqs_seg_size = clib_max (mqs_seg_size, smm->wrk_mqs_segment_size);
1718 mqs_seg->ssvm.ssvm_size = mqs_seg_size;
1719 mqs_seg->ssvm.my_pid = getpid ();
1720 mqs_seg->ssvm.name = format (0, "%s%c", "session: wrk-mqs-segment", 0);
1722 if (ssvm_server_init (&mqs_seg->ssvm, SSVM_SEGMENT_MEMFD))
1724 clib_warning ("failed to initialize queue segment");
1728 fifo_segment_init (mqs_seg);
1730 /* Special fifo segment that's filled only with mqs */
1731 mqs_seg->h->n_mqs = vec_len (smm->wrk);
1733 for (i = 0; i < vec_len (smm->wrk); i++)
1734 smm->wrk[i].vpp_event_queue = fifo_segment_msg_q_alloc (mqs_seg, i, cfg);
1738 session_main_get_wrk_mqs_segment (void)
1740 return &session_main.wrk_mqs_segment;
1744 session_segment_handle (session_t * s)
1749 return SESSION_INVALID_HANDLE;
1752 return segment_manager_make_segment_handle (f->segment_manager,
1757 session_get_original_dst (transport_endpoint_t *i2o_src,
1758 transport_endpoint_t *i2o_dst,
1759 transport_proto_t transport_proto, u32 *original_dst,
1760 u16 *original_dst_port)
1762 session_main_t *smm = vnet_get_session_main ();
1763 ip_protocol_t proto =
1764 (transport_proto == TRANSPORT_PROTO_TCP ? IPPROTO_TCP : IPPROTO_UDP);
1765 if (!smm->original_dst_lookup || !i2o_dst->is_ip4)
1767 smm->original_dst_lookup (&i2o_src->ip.ip4, i2o_src->port, &i2o_dst->ip.ip4,
1768 i2o_dst->port, proto, original_dst,
1772 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1773 session_tx_fifo_peek_and_snd,
1774 session_tx_fifo_dequeue_and_snd,
1775 session_tx_fifo_dequeue_internal,
1776 session_tx_fifo_dequeue_and_snd
1780 session_register_transport (transport_proto_t transport_proto,
1781 const transport_proto_vft_t * vft, u8 is_ip4,
1784 session_main_t *smm = &session_main;
1785 session_type_t session_type;
1786 u32 next_index = ~0;
1788 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1790 vec_validate (smm->session_type_to_next, session_type);
1791 vec_validate (smm->session_tx_fns, session_type);
1793 if (output_node != ~0)
1794 next_index = vlib_node_add_next (vlib_get_main (),
1795 session_queue_node.index, output_node);
1797 smm->session_type_to_next[session_type] = next_index;
1798 smm->session_tx_fns[session_type] =
1799 session_tx_fns[vft->transport_options.tx_type];
1803 session_register_update_time_fn (session_update_time_fn fn, u8 is_add)
1805 session_main_t *smm = &session_main;
1806 session_update_time_fn *fi;
1810 vec_foreach (fi, smm->update_time_fns)
1814 fi_pos = fi - smm->update_time_fns;
1824 clib_warning ("update time fn %p already registered", fn);
1827 vec_add1 (smm->update_time_fns, fn);
1831 vec_del1 (smm->update_time_fns, fi_pos);
1836 session_add_transport_proto (void)
1838 session_main_t *smm = &session_main;
1839 session_worker_t *wrk;
1842 smm->last_transport_proto_type += 1;
1844 for (thread = 0; thread < vec_len (smm->wrk); thread++)
1846 wrk = session_main_get_worker (thread);
1847 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1850 return smm->last_transport_proto_type;
1853 transport_connection_t *
1854 session_get_transport (session_t * s)
1856 if (s->session_state != SESSION_STATE_LISTENING)
1857 return transport_get_connection (session_get_transport_proto (s),
1858 s->connection_index, s->thread_index);
1860 return transport_get_listener (session_get_transport_proto (s),
1861 s->connection_index);
1865 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1867 if (s->session_state != SESSION_STATE_LISTENING)
1868 return transport_get_endpoint (session_get_transport_proto (s),
1869 s->connection_index, s->thread_index, tep,
1872 return transport_get_listener_endpoint (session_get_transport_proto (s),
1873 s->connection_index, tep, is_lcl);
1877 session_transport_attribute (session_t *s, u8 is_get,
1878 transport_endpt_attr_t *attr)
1880 if (s->session_state < SESSION_STATE_READY)
1883 return transport_connection_attribute (session_get_transport_proto (s),
1884 s->connection_index, s->thread_index,
1888 transport_connection_t *
1889 listen_session_get_transport (session_t * s)
1891 return transport_get_listener (session_get_transport_proto (s),
1892 s->connection_index);
1896 session_queue_run_on_main_thread (vlib_main_t * vm)
1898 ASSERT (vlib_get_thread_index () == 0);
1899 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
1903 session_stats_collector_fn (vlib_stats_collector_data_t *d)
1905 u32 i, n_workers, n_wrk_sessions, n_sessions = 0;
1906 session_main_t *smm = &session_main;
1907 session_worker_t *wrk;
1908 counter_t **counters;
1911 n_workers = vec_len (smm->wrk);
1912 vlib_stats_validate (d->entry_index, 0, n_workers - 1);
1913 counters = d->entry->data;
1916 for (i = 0; i < vec_len (smm->wrk); i++)
1918 wrk = session_main_get_worker (i);
1919 n_wrk_sessions = pool_elts (wrk->sessions);
1920 cb[i] = n_wrk_sessions;
1921 n_sessions += n_wrk_sessions;
1924 vlib_stats_set_gauge (d->private_data, n_sessions);
1928 session_stats_collector_init (void)
1930 vlib_stats_collector_reg_t reg = {};
1933 vlib_stats_add_counter_vector ("/sys/session/sessions_per_worker");
1934 reg.private_data = vlib_stats_add_gauge ("/sys/session/sessions_total");
1935 reg.collect_fn = session_stats_collector_fn;
1936 vlib_stats_register_collector_fn (®);
1937 vlib_stats_validate (reg.entry_index, 0, vlib_get_n_threads ());
1940 static clib_error_t *
1941 session_manager_main_enable (vlib_main_t * vm)
1943 session_main_t *smm = &session_main;
1944 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1945 u32 num_threads, preallocated_sessions_per_worker;
1946 session_worker_t *wrk;
1949 /* We only initialize once and do not de-initialized on disable */
1950 if (smm->is_initialized)
1953 num_threads = 1 /* main thread */ + vtm->n_threads;
1955 if (num_threads < 1)
1956 return clib_error_return (0, "n_thread_stacks not set");
1958 /* Allocate cache line aligned worker contexts */
1959 vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1960 clib_spinlock_init (&session_main.pool_realloc_lock);
1962 for (i = 0; i < num_threads; i++)
1965 wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1966 wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1967 wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1968 wrk->pending_connects = clib_llist_make_head (wrk->event_elts, evt_list);
1969 wrk->evts_pending_main =
1970 clib_llist_make_head (wrk->event_elts, evt_list);
1971 wrk->vm = vlib_get_main_by_index (i);
1972 wrk->last_vlib_time = vlib_time_now (vm);
1973 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1975 vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1977 if (!smm->no_adaptive && smm->use_private_rx_mqs)
1978 session_wrk_enable_adaptive_mode (wrk);
1981 /* Allocate vpp event queues segment and queue */
1982 session_vpp_wrk_mqs_alloc (smm);
1984 /* Initialize segment manager properties */
1985 segment_manager_main_init ();
1987 /* Preallocate sessions */
1988 if (smm->preallocated_sessions)
1990 if (num_threads == 1)
1992 pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1997 preallocated_sessions_per_worker =
1998 (1.1 * (f64) smm->preallocated_sessions /
1999 (f64) (num_threads - 1));
2001 for (j = 1; j < num_threads; j++)
2003 pool_init_fixed (smm->wrk[j].sessions,
2004 preallocated_sessions_per_worker);
2009 session_lookup_init ();
2010 app_namespaces_init ();
2012 session_stats_collector_init ();
2013 smm->is_initialized = 1;
2017 smm->is_enabled = 1;
2019 /* Enable transports */
2020 transport_enable_disable (vm, 1);
2021 session_debug_init ();
2027 session_manager_main_disable (vlib_main_t * vm)
2029 transport_enable_disable (vm, 0 /* is_en */ );
2032 /* in this new callback, cookie hint the index */
2034 session_dma_completion_cb (vlib_main_t *vm, struct vlib_dma_batch *batch)
2036 session_worker_t *wrk;
2037 wrk = session_main_get_worker (vm->thread_index);
2038 session_dma_transfer *dma_transfer;
2040 dma_transfer = &wrk->dma_trans[wrk->trans_head];
2041 vec_add (wrk->pending_tx_buffers, dma_transfer->pending_tx_buffers,
2042 vec_len (dma_transfer->pending_tx_buffers));
2043 vec_add (wrk->pending_tx_nexts, dma_transfer->pending_tx_nexts,
2044 vec_len (dma_transfer->pending_tx_nexts));
2045 vec_reset_length (dma_transfer->pending_tx_buffers);
2046 vec_reset_length (dma_transfer->pending_tx_nexts);
2048 if (wrk->trans_head == wrk->trans_size)
2049 wrk->trans_head = 0;
2054 session_prepare_dma_args (vlib_dma_config_t *args)
2056 args->max_batches = 16;
2057 args->max_transfers = DMA_TRANS_SIZE;
2058 args->max_transfer_size = 65536;
2060 args->sw_fallback = 1;
2061 args->barrier_before_last = 1;
2062 args->callback_fn = session_dma_completion_cb;
2066 session_node_enable_dma (u8 is_en, int n_vlibs)
2068 vlib_dma_config_t args;
2069 session_prepare_dma_args (&args);
2070 session_worker_t *wrk;
2073 int config_index = -1;
2077 vm = vlib_get_main_by_index (0);
2078 config_index = vlib_dma_config_add (vm, &args);
2082 vm = vlib_get_main_by_index (0);
2083 wrk = session_main_get_worker (0);
2084 if (wrk->config_index >= 0)
2085 vlib_dma_config_del (vm, wrk->config_index);
2088 for (i = 0; i < n_vlibs; i++)
2090 vm = vlib_get_main_by_index (i);
2091 wrk = session_main_get_worker (vm->thread_index);
2092 wrk->config_index = config_index;
2095 if (config_index >= 0)
2096 wrk->dma_enabled = true;
2097 wrk->dma_trans = (session_dma_transfer *) clib_mem_alloc (
2098 sizeof (session_dma_transfer) * DMA_TRANS_SIZE);
2099 bzero (wrk->dma_trans,
2100 sizeof (session_dma_transfer) * DMA_TRANS_SIZE);
2105 clib_mem_free (wrk->dma_trans);
2107 wrk->trans_head = 0;
2108 wrk->trans_tail = 0;
2109 wrk->trans_size = DMA_TRANS_SIZE;
2114 session_node_enable_disable (u8 is_en)
2116 u8 mstate = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
2117 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
2118 session_main_t *sm = &session_main;
2123 n_vlibs = vlib_get_n_threads ();
2124 for (i = 0; i < n_vlibs; i++)
2126 vm = vlib_get_main_by_index (i);
2127 /* main thread with workers and not polling */
2128 if (i == 0 && n_vlibs > 1)
2130 vlib_node_set_state (vm, session_queue_node.index, mstate);
2133 session_main_get_worker (0)->state = SESSION_WRK_INTERRUPT;
2134 vlib_node_set_state (vm, session_queue_process_node.index,
2136 n = vlib_get_node (vm, session_queue_process_node.index);
2137 vlib_start_process (vm, n->runtime_index);
2141 vlib_process_signal_event_mt (vm,
2142 session_queue_process_node.index,
2143 SESSION_Q_PROCESS_STOP, 0);
2148 vlib_node_set_state (vm, session_input_node.index, mstate);
2149 vlib_node_set_state (vm, session_queue_node.index, state);
2152 if (sm->use_private_rx_mqs)
2153 application_enable_rx_mqs_nodes (is_en);
2155 if (sm->dma_enabled)
2156 session_node_enable_dma (is_en, n_vlibs);
2160 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
2162 clib_error_t *error = 0;
2165 if (session_main.is_enabled)
2168 error = session_manager_main_enable (vm);
2169 session_node_enable_disable (is_en);
2173 session_main.is_enabled = 0;
2174 session_manager_main_disable (vm);
2175 session_node_enable_disable (is_en);
2182 session_main_init (vlib_main_t * vm)
2184 session_main_t *smm = &session_main;
2186 smm->is_enabled = 0;
2187 smm->session_enable_asap = 0;
2189 smm->use_private_rx_mqs = 0;
2190 smm->no_adaptive = 0;
2191 smm->last_transport_proto_type = TRANSPORT_PROTO_HTTP;
2192 smm->port_allocator_min_src_port = 1024;
2193 smm->port_allocator_max_src_port = 65535;
2198 static clib_error_t *
2199 session_main_loop_init (vlib_main_t * vm)
2201 session_main_t *smm = &session_main;
2202 if (smm->session_enable_asap)
2204 vlib_worker_thread_barrier_sync (vm);
2205 vnet_session_enable_disable (vm, 1 /* is_en */ );
2206 vlib_worker_thread_barrier_release (vm);
2211 VLIB_INIT_FUNCTION (session_main_init);
2212 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
2214 static clib_error_t *
2215 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
2217 session_main_t *smm = &session_main;
2221 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2223 if (unformat (input, "wrk-mq-length %d", &nitems))
2226 smm->configured_wrk_mq_length = nitems;
2228 clib_warning ("event queue length %d too small, ignored", nitems);
2230 else if (unformat (input, "wrk-mqs-segment-size %U",
2231 unformat_memory_size, &smm->wrk_mqs_segment_size))
2233 else if (unformat (input, "preallocated-sessions %d",
2234 &smm->preallocated_sessions))
2236 else if (unformat (input, "v4-session-table-buckets %d",
2237 &smm->configured_v4_session_table_buckets))
2239 else if (unformat (input, "v4-halfopen-table-buckets %d",
2240 &smm->configured_v4_halfopen_table_buckets))
2242 else if (unformat (input, "v6-session-table-buckets %d",
2243 &smm->configured_v6_session_table_buckets))
2245 else if (unformat (input, "v6-halfopen-table-buckets %d",
2246 &smm->configured_v6_halfopen_table_buckets))
2248 else if (unformat (input, "v4-session-table-memory %U",
2249 unformat_memory_size, &tmp))
2251 if (tmp >= 0x100000000)
2252 return clib_error_return (0, "memory size %llx (%lld) too large",
2254 smm->configured_v4_session_table_memory = tmp;
2256 else if (unformat (input, "v4-halfopen-table-memory %U",
2257 unformat_memory_size, &tmp))
2259 if (tmp >= 0x100000000)
2260 return clib_error_return (0, "memory size %llx (%lld) too large",
2262 smm->configured_v4_halfopen_table_memory = tmp;
2264 else if (unformat (input, "v6-session-table-memory %U",
2265 unformat_memory_size, &tmp))
2267 if (tmp >= 0x100000000)
2268 return clib_error_return (0, "memory size %llx (%lld) too large",
2270 smm->configured_v6_session_table_memory = tmp;
2272 else if (unformat (input, "v6-halfopen-table-memory %U",
2273 unformat_memory_size, &tmp))
2275 if (tmp >= 0x100000000)
2276 return clib_error_return (0, "memory size %llx (%lld) too large",
2278 smm->configured_v6_halfopen_table_memory = tmp;
2280 else if (unformat (input, "local-endpoints-table-memory %U",
2281 unformat_memory_size, &tmp))
2283 if (tmp >= 0x100000000)
2284 return clib_error_return (0, "memory size %llx (%lld) too large",
2286 smm->local_endpoints_table_memory = tmp;
2288 else if (unformat (input, "local-endpoints-table-buckets %d",
2289 &smm->local_endpoints_table_buckets))
2291 else if (unformat (input, "min-src-port %d", &tmp))
2292 smm->port_allocator_min_src_port = tmp;
2293 else if (unformat (input, "max-src-port %d", &tmp))
2294 smm->port_allocator_max_src_port = tmp;
2295 else if (unformat (input, "enable"))
2296 smm->session_enable_asap = 1;
2297 else if (unformat (input, "use-app-socket-api"))
2298 (void) appns_sapi_enable_disable (1 /* is_enable */);
2299 else if (unformat (input, "poll-main"))
2301 else if (unformat (input, "use-private-rx-mqs"))
2302 smm->use_private_rx_mqs = 1;
2303 else if (unformat (input, "no-adaptive"))
2304 smm->no_adaptive = 1;
2305 else if (unformat (input, "use-dma"))
2306 smm->dma_enabled = 1;
2307 else if (unformat (input, "nat44-original-dst-enable"))
2309 smm->original_dst_lookup = vlib_get_plugin_symbol (
2310 "nat_plugin.so", "nat44_original_dst_lookup");
2313 * Deprecated but maintained for compatibility
2315 else if (unformat (input, "evt_qs_memfd_seg"))
2317 else if (unformat (input, "segment-baseva 0x%lx", &tmp))
2319 else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
2320 &smm->wrk_mqs_segment_size))
2322 else if (unformat (input, "event-queue-length %d", &nitems))
2325 smm->configured_wrk_mq_length = nitems;
2327 clib_warning ("event queue length %d too small, ignored", nitems);
2330 return clib_error_return (0, "unknown input `%U'",
2331 format_unformat_error, input);
2336 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
2339 * fd.io coding-style-patch-verification: ON
2342 * eval: (c-set-style "gnu")