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 #include <vlib/vlib.h>
18 #include <vnet/vnet.h>
19 #include <vppinfra/elog.h>
20 #include <vnet/session/transport.h>
21 #include <vnet/session/session.h>
22 #include <vnet/session/application.h>
23 #include <vnet/session/application_interface.h>
24 #include <vnet/session/application_local.h>
25 #include <vnet/session/session_debug.h>
26 #include <svm/queue.h>
27 #include <sys/timerfd.h>
30 session_wrk_send_evt_to_main (session_worker_t *wrk, session_evt_elt_t *elt)
32 session_evt_elt_t *he;
36 thread_index = wrk->vm->thread_index;
37 he = clib_llist_elt (wrk->event_elts, wrk->evts_pending_main);
38 is_empty = clib_llist_is_empty (wrk->event_elts, evt_list, he);
39 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
41 session_send_rpc_evt_to_thread (0, session_wrk_handle_evts_main_rpc,
42 uword_to_pointer (thread_index, void *));
45 #define app_check_thread_and_barrier(_wrk, _elt) \
46 if (!vlib_thread_is_main_w_barrier ()) \
48 session_wrk_send_evt_to_main (wrk, elt); \
53 session_wrk_timerfd_update (session_worker_t *wrk, u64 time_ns)
55 struct itimerspec its;
57 its.it_value.tv_sec = 0;
58 its.it_value.tv_nsec = time_ns;
59 its.it_interval.tv_sec = 0;
60 its.it_interval.tv_nsec = its.it_value.tv_nsec;
62 if (timerfd_settime (wrk->timerfd, 0, &its, NULL) == -1)
63 clib_warning ("timerfd_settime");
67 session_wrk_tfd_timeout (session_wrk_state_t state, u32 thread_index)
69 if (state == SESSION_WRK_INTERRUPT)
70 return thread_index ? 1e6 : vlib_num_workers () ? 5e8 : 1e6;
71 else if (state == SESSION_WRK_IDLE)
72 return thread_index ? 1e8 : vlib_num_workers () ? 5e8 : 1e8;
78 session_wrk_set_state (session_worker_t *wrk, session_wrk_state_t state)
83 if (wrk->timerfd == -1)
85 time_ns = session_wrk_tfd_timeout (state, wrk->vm->thread_index);
86 session_wrk_timerfd_update (wrk, time_ns);
89 static transport_endpt_ext_cfg_t *
90 session_mq_get_ext_config (application_t *app, uword offset)
95 fs = application_get_rx_mqs_segment (app);
96 c = fs_chunk_ptr (fs->h, offset);
97 return (transport_endpt_ext_cfg_t *) c->data;
101 session_mq_free_ext_config (application_t *app, uword offset)
106 fs = application_get_rx_mqs_segment (app);
107 c = fs_chunk_ptr (fs->h, offset);
108 fifo_segment_collect_chunk (fs, 0 /* only one slice */, c);
112 session_mq_listen_handler (session_worker_t *wrk, session_evt_elt_t *elt)
114 vnet_listen_args_t _a, *a = &_a;
115 session_listen_msg_t *mp;
116 app_worker_t *app_wrk;
120 app_check_thread_and_barrier (wrk, elt);
122 mp = session_evt_ctrl_data (wrk, elt);
123 app = application_lookup (mp->client_index);
127 clib_memset (a, 0, sizeof (*a));
128 a->sep.is_ip4 = mp->is_ip4;
129 ip_copy (&a->sep.ip, &mp->ip, mp->is_ip4);
130 a->sep.port = mp->port;
131 a->sep.fib_index = mp->vrf;
132 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
133 a->sep.transport_proto = mp->proto;
134 a->app_index = app->app_index;
135 a->wrk_map_index = mp->wrk_index;
136 a->sep_ext.transport_flags = mp->flags;
139 a->sep_ext.ext_cfg = session_mq_get_ext_config (app, mp->ext_config);
141 if ((rv = vnet_listen (a)))
142 clib_warning ("listen returned: %U", format_session_error, rv);
144 app_wrk = application_get_worker (app, mp->wrk_index);
145 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
148 session_mq_free_ext_config (app, mp->ext_config);
152 session_mq_listen_uri_handler (session_worker_t *wrk, session_evt_elt_t *elt)
154 vnet_listen_args_t _a, *a = &_a;
155 session_listen_uri_msg_t *mp;
156 app_worker_t *app_wrk;
160 app_check_thread_and_barrier (wrk, elt);
162 mp = session_evt_ctrl_data (wrk, elt);
163 app = application_lookup (mp->client_index);
167 clib_memset (a, 0, sizeof (*a));
168 a->uri = (char *) mp->uri;
169 a->app_index = app->app_index;
170 rv = vnet_bind_uri (a);
172 app_wrk = application_get_worker (app, 0);
173 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
177 session_mq_connect_one (session_connect_msg_t *mp)
179 vnet_connect_args_t _a, *a = &_a;
180 app_worker_t *app_wrk;
184 app = application_lookup (mp->client_index);
188 clib_memset (a, 0, sizeof (*a));
189 a->sep.is_ip4 = mp->is_ip4;
190 clib_memcpy_fast (&a->sep.ip, &mp->ip, sizeof (mp->ip));
191 a->sep.port = mp->port;
192 a->sep.transport_proto = mp->proto;
193 a->sep.peer.fib_index = mp->vrf;
194 a->sep.dscp = mp->dscp;
195 clib_memcpy_fast (&a->sep.peer.ip, &mp->lcl_ip, sizeof (mp->lcl_ip));
198 ip46_address_mask_ip4 (&a->sep.ip);
199 ip46_address_mask_ip4 (&a->sep.peer.ip);
201 a->sep.peer.port = mp->lcl_port;
202 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
203 a->sep_ext.parent_handle = mp->parent_handle;
204 a->sep_ext.transport_flags = mp->flags;
205 a->api_context = mp->context;
206 a->app_index = app->app_index;
207 a->wrk_map_index = mp->wrk_index;
210 a->sep_ext.ext_cfg = session_mq_get_ext_config (app, mp->ext_config);
212 if ((rv = vnet_connect (a)))
214 clib_warning ("connect returned: %U", format_session_error, rv);
215 app_wrk = application_get_worker (app, mp->wrk_index);
216 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
220 session_mq_free_ext_config (app, mp->ext_config);
224 session_mq_handle_connects_rpc (void *arg)
226 u32 max_connects = 32, n_connects = 0;
227 vlib_main_t *vm = vlib_get_main ();
228 session_evt_elt_t *he, *elt, *next;
229 session_worker_t *fwrk, *wrk;
231 ASSERT (vlib_get_thread_index () == 0);
233 /* Pending connects on linked list pertaining to first worker */
234 fwrk = session_main_get_worker (1);
235 if (!fwrk->n_pending_connects)
238 vlib_worker_thread_barrier_sync (vm);
240 he = clib_llist_elt (fwrk->event_elts, fwrk->pending_connects);
241 elt = clib_llist_next (fwrk->event_elts, evt_list, he);
243 /* Avoid holding the barrier for too long */
244 while (n_connects < max_connects && elt != he)
246 next = clib_llist_next (fwrk->event_elts, evt_list, elt);
247 clib_llist_remove (fwrk->event_elts, evt_list, elt);
248 session_mq_connect_one (session_evt_ctrl_data (fwrk, elt));
249 session_evt_ctrl_data_free (fwrk, elt);
250 clib_llist_put (fwrk->event_elts, elt);
255 /* Decrement with worker barrier */
256 fwrk->n_pending_connects -= n_connects;
258 vlib_worker_thread_barrier_release (vm);
262 /* Switch worker to poll mode if it was in interrupt mode and had work or
263 * back to interrupt if threshold of loops without a connect is passed.
264 * While in poll mode, reprogram connects rpc */
265 wrk = session_main_get_worker (0);
266 if (wrk->state != SESSION_WRK_POLLING)
270 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
271 vlib_node_set_state (vm, session_queue_node.index,
272 VLIB_NODE_STATE_POLLING);
273 wrk->no_connect_loops = 0;
280 if (++wrk->no_connect_loops > 1e5)
282 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
283 vlib_node_set_state (vm, session_queue_node.index,
284 VLIB_NODE_STATE_INTERRUPT);
288 wrk->no_connect_loops = 0;
291 if (wrk->state == SESSION_WRK_POLLING)
293 elt = session_evt_alloc_ctrl (wrk);
294 elt->evt.event_type = SESSION_CTRL_EVT_RPC;
295 elt->evt.rpc_args.fp = session_mq_handle_connects_rpc;
300 session_mq_connect_handler (session_worker_t *wrk, session_evt_elt_t *elt)
302 u32 thread_index = wrk - session_main.wrk;
303 session_evt_elt_t *he;
305 /* No workers, so just deal with the connect now */
306 if (PREDICT_FALSE (!thread_index))
308 session_mq_connect_one (session_evt_ctrl_data (wrk, elt));
312 if (PREDICT_FALSE (thread_index != 1))
314 clib_warning ("Connect on wrong thread. Dropping");
318 /* Add to pending list to be handled by main thread */
319 he = clib_llist_elt (wrk->event_elts, wrk->pending_connects);
320 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
322 /* Decremented with worker barrier */
323 wrk->n_pending_connects += 1;
324 if (wrk->n_pending_connects == 1)
326 vlib_node_set_interrupt_pending (vlib_get_main_by_index (0),
327 session_queue_node.index);
328 session_send_rpc_evt_to_thread (0, session_mq_handle_connects_rpc, 0);
333 session_mq_connect_uri_handler (session_worker_t *wrk, session_evt_elt_t *elt)
335 vnet_connect_args_t _a, *a = &_a;
336 session_connect_uri_msg_t *mp;
337 app_worker_t *app_wrk;
341 app_check_thread_and_barrier (wrk, elt);
343 mp = session_evt_ctrl_data (wrk, elt);
344 app = application_lookup (mp->client_index);
348 clib_memset (a, 0, sizeof (*a));
349 a->uri = (char *) mp->uri;
350 a->api_context = mp->context;
351 a->app_index = app->app_index;
352 if ((rv = vnet_connect_uri (a)))
354 clib_warning ("connect_uri returned: %d", rv);
355 app_wrk = application_get_worker (app, 0 /* default wrk only */ );
356 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
361 session_mq_shutdown_handler (void *data)
363 session_shutdown_msg_t *mp = (session_shutdown_msg_t *) data;
364 vnet_shutdown_args_t _a, *a = &_a;
367 app = application_lookup (mp->client_index);
371 a->app_index = app->app_index;
372 a->handle = mp->handle;
373 vnet_shutdown_session (a);
377 session_mq_disconnect_handler (void *data)
379 session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
380 vnet_disconnect_args_t _a, *a = &_a;
383 app = application_lookup (mp->client_index);
387 a->app_index = app->app_index;
388 a->handle = mp->handle;
389 vnet_disconnect_session (a);
393 app_mq_detach_handler (session_worker_t *wrk, session_evt_elt_t *elt)
395 vnet_app_detach_args_t _a, *a = &_a;
396 session_app_detach_msg_t *mp;
399 app_check_thread_and_barrier (wrk, elt);
401 mp = session_evt_ctrl_data (wrk, elt);
402 app = application_lookup (mp->client_index);
406 a->app_index = app->app_index;
407 a->api_client_index = mp->client_index;
408 vnet_application_detach (a);
412 session_mq_unlisten_handler (session_worker_t *wrk, session_evt_elt_t *elt)
414 vnet_unlisten_args_t _a, *a = &_a;
415 session_unlisten_msg_t *mp;
416 app_worker_t *app_wrk;
421 app_check_thread_and_barrier (wrk, elt);
423 mp = session_evt_ctrl_data (wrk, elt);
426 app = application_lookup (mp->client_index);
430 clib_memset (a, 0, sizeof (*a));
431 a->app_index = app->app_index;
433 a->wrk_map_index = mp->wrk_index;
435 if ((rv = vnet_unlisten (a)))
436 clib_warning ("unlisten returned: %d", rv);
438 app_wrk = application_get_worker (app, a->wrk_map_index);
442 mq_send_unlisten_reply (app_wrk, sh, mp->context, rv);
446 session_mq_accepted_reply_handler (session_worker_t *wrk,
447 session_evt_elt_t *elt)
449 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
450 session_accepted_reply_msg_t *mp;
451 session_state_t old_state;
452 app_worker_t *app_wrk;
455 mp = session_evt_ctrl_data (wrk, elt);
457 /* Mail this back from the main thread. We're not polling in main
458 * thread so we're using other workers for notifications. */
459 if (session_thread_from_handle (mp->handle) == 0 && vlib_num_workers () &&
460 vlib_get_thread_index () != 0)
462 session_wrk_send_evt_to_main (wrk, elt);
466 s = session_get_from_handle_if_valid (mp->handle);
470 app_wrk = app_worker_get (s->app_wrk_index);
471 if (app_wrk->app_index != mp->context)
473 clib_warning ("app doesn't own session");
477 /* Server isn't interested, disconnect the session */
480 a->app_index = mp->context;
481 a->handle = mp->handle;
482 vnet_disconnect_session (a);
486 /* Special handling for cut-through sessions */
487 if (!session_has_transport (s))
489 s->session_state = SESSION_STATE_READY;
490 ct_session_connect_notify (s, SESSION_E_NONE);
494 old_state = s->session_state;
495 s->session_state = SESSION_STATE_READY;
497 if (!svm_fifo_is_empty_prod (s->rx_fifo))
498 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
500 /* Closed while waiting for app to reply. Resend disconnect */
501 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
503 app_worker_close_notify (app_wrk, s);
504 s->session_state = old_state;
510 session_mq_reset_reply_handler (void *data)
512 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
513 session_reset_reply_msg_t *mp;
514 app_worker_t *app_wrk;
517 u32 index, thread_index;
519 mp = (session_reset_reply_msg_t *) data;
520 app = application_lookup (mp->context);
524 session_parse_handle (mp->handle, &index, &thread_index);
525 s = session_get_if_valid (index, thread_index);
527 /* No session or not the right session */
528 if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
531 app_wrk = app_worker_get (s->app_wrk_index);
532 if (!app_wrk || app_wrk->app_index != app->app_index)
534 clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
539 /* Client objected to resetting the session, log and continue */
542 clib_warning ("client retval %d", mp->retval);
546 /* This comes as a response to a reset, transport only waiting for
547 * confirmation to remove connection state, no need to disconnect */
548 a->handle = mp->handle;
549 a->app_index = app->app_index;
550 vnet_disconnect_session (a);
554 session_mq_disconnected_handler (void *data)
556 session_disconnected_reply_msg_t *rmp;
557 vnet_disconnect_args_t _a, *a = &_a;
558 svm_msg_q_msg_t _msg, *msg = &_msg;
559 session_disconnected_msg_t *mp;
560 app_worker_t *app_wrk;
561 session_event_t *evt;
566 mp = (session_disconnected_msg_t *) data;
567 if (!(s = session_get_from_handle_if_valid (mp->handle)))
569 clib_warning ("could not disconnect handle %llu", mp->handle);
572 app_wrk = app_worker_get (s->app_wrk_index);
573 app = application_lookup (mp->client_index);
574 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
576 clib_warning ("could not disconnect session: %llu app: %u",
577 mp->handle, mp->client_index);
581 a->handle = mp->handle;
582 a->app_index = app_wrk->wrk_index;
583 rv = vnet_disconnect_session (a);
585 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
586 SESSION_MQ_CTRL_EVT_RING,
588 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
589 clib_memset (evt, 0, sizeof (*evt));
590 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
591 rmp = (session_disconnected_reply_msg_t *) evt->data;
592 rmp->handle = mp->handle;
593 rmp->context = mp->context;
595 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
599 session_mq_disconnected_reply_handler (void *data)
601 session_disconnected_reply_msg_t *mp;
602 vnet_disconnect_args_t _a, *a = &_a;
605 mp = (session_disconnected_reply_msg_t *) data;
607 /* Client objected to disconnecting the session, log and continue */
610 clib_warning ("client retval %d", mp->retval);
614 /* Disconnect has been confirmed. Confirm close to transport */
615 app = application_lookup (mp->context);
618 a->handle = mp->handle;
619 a->app_index = app->app_index;
620 vnet_disconnect_session (a);
625 session_mq_worker_update_handler (void *data)
627 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
628 session_worker_update_reply_msg_t *rmp;
629 svm_msg_q_msg_t _msg, *msg = &_msg;
630 app_worker_t *app_wrk;
631 u32 owner_app_wrk_map;
632 session_event_t *evt;
636 app = application_lookup (mp->client_index);
639 if (!(s = session_get_from_handle_if_valid (mp->handle)))
641 clib_warning ("invalid handle %llu", mp->handle);
644 app_wrk = app_worker_get (s->app_wrk_index);
645 if (app_wrk->app_index != app->app_index)
647 clib_warning ("app %u does not own session %llu", app->app_index,
651 owner_app_wrk_map = app_wrk->wrk_map_index;
652 app_wrk = application_get_worker (app, mp->wrk_index);
654 /* This needs to come from the new owner */
655 if (mp->req_wrk_index == owner_app_wrk_map)
657 session_req_worker_update_msg_t *wump;
659 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
660 SESSION_MQ_CTRL_EVT_RING,
662 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
663 clib_memset (evt, 0, sizeof (*evt));
664 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
665 wump = (session_req_worker_update_msg_t *) evt->data;
666 wump->session_handle = mp->handle;
667 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
671 app_worker_own_session (app_wrk, s);
676 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
677 SESSION_MQ_CTRL_EVT_RING,
679 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
680 clib_memset (evt, 0, sizeof (*evt));
681 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
682 rmp = (session_worker_update_reply_msg_t *) evt->data;
683 rmp->handle = mp->handle;
685 rmp->rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
687 rmp->tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
688 rmp->segment_handle = session_segment_handle (s);
689 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
692 * Retransmit messages that may have been lost
694 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
695 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
697 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
698 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
700 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
701 app_worker_close_notify (app_wrk, s);
705 session_mq_app_wrk_rpc_handler (void *data)
707 session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
708 svm_msg_q_msg_t _msg, *msg = &_msg;
709 session_app_wrk_rpc_msg_t *rmp;
710 app_worker_t *app_wrk;
711 session_event_t *evt;
714 app = application_lookup (mp->client_index);
718 app_wrk = application_get_worker (app, mp->wrk_index);
720 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
721 SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
723 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
724 clib_memset (evt, 0, sizeof (*evt));
725 evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
726 rmp = (session_app_wrk_rpc_msg_t *) evt->data;
727 clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
728 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
732 session_mq_transport_attr_handler (void *data)
734 session_transport_attr_msg_t *mp = (session_transport_attr_msg_t *) data;
735 session_transport_attr_reply_msg_t *rmp;
736 svm_msg_q_msg_t _msg, *msg = &_msg;
737 app_worker_t *app_wrk;
738 session_event_t *evt;
743 app = application_lookup (mp->client_index);
747 if (!(s = session_get_from_handle_if_valid (mp->handle)))
749 clib_warning ("invalid handle %llu", mp->handle);
752 app_wrk = app_worker_get (s->app_wrk_index);
753 if (app_wrk->app_index != app->app_index)
755 clib_warning ("app %u does not own session %llu", app->app_index,
760 rv = session_transport_attribute (s, mp->is_get, &mp->attr);
762 svm_msg_q_lock_and_alloc_msg_w_ring (
763 app_wrk->event_queue, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, msg);
764 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
765 clib_memset (evt, 0, sizeof (*evt));
766 evt->event_type = SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY;
767 rmp = (session_transport_attr_reply_msg_t *) evt->data;
768 rmp->handle = mp->handle;
770 rmp->is_get = mp->is_get;
771 if (!rv && mp->is_get)
772 rmp->attr = mp->attr;
773 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
777 session_wrk_handle_evts_main_rpc (void *args)
779 session_evt_elt_t *he, *elt, *next;
780 vlib_main_t *vm = vlib_get_main ();
781 session_worker_t *fwrk;
784 vlib_worker_thread_barrier_sync (vm);
786 thread_index = pointer_to_uword (args);
787 fwrk = session_main_get_worker (thread_index);
789 he = clib_llist_elt (fwrk->event_elts, fwrk->evts_pending_main);
790 elt = clib_llist_next (fwrk->event_elts, evt_list, he);
794 next = clib_llist_next (fwrk->event_elts, evt_list, elt);
795 clib_llist_remove (fwrk->event_elts, evt_list, elt);
796 switch (elt->evt.event_type)
798 case SESSION_CTRL_EVT_LISTEN:
799 session_mq_listen_handler (fwrk, elt);
801 case SESSION_CTRL_EVT_UNLISTEN:
802 session_mq_unlisten_handler (fwrk, elt);
804 case SESSION_CTRL_EVT_APP_DETACH:
805 app_mq_detach_handler (fwrk, elt);
807 case SESSION_CTRL_EVT_CONNECT_URI:
808 session_mq_connect_uri_handler (fwrk, elt);
810 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
811 session_mq_accepted_reply_handler (fwrk, elt);
814 clib_warning ("unhandled %u", elt->evt.event_type);
818 session_evt_ctrl_data_free (fwrk, elt);
819 clib_llist_put (fwrk->event_elts, elt);
823 vlib_worker_thread_barrier_release (vm);
826 vlib_node_registration_t session_queue_node;
831 u32 server_thread_index;
832 } session_queue_trace_t;
834 /* packet trace format function */
836 format_session_queue_trace (u8 * s, va_list * args)
838 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
839 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
840 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
842 s = format (s, "session index %d thread index %d",
843 t->session_index, t->server_thread_index);
847 #define foreach_session_queue_error \
848 _ (TX, tx, INFO, "Packets transmitted") \
849 _ (TIMER, timer, INFO, "Timer events") \
850 _ (NO_BUFFER, no_buffer, ERROR, "Out of buffers")
854 #define _(f, n, s, d) SESSION_QUEUE_ERROR_##f,
855 foreach_session_queue_error
857 SESSION_QUEUE_N_ERROR,
858 } session_queue_error_t;
860 static vlib_error_desc_t session_error_counters[] = {
861 #define _(f, n, s, d) { #n, d, VL_COUNTER_SEVERITY_##s },
862 foreach_session_queue_error
868 SESSION_TX_NO_BUFFERS = -2,
874 session_tx_trace_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
875 u32 next_index, vlib_buffer_t **bufs, u16 n_segs,
876 session_t *s, u32 n_trace)
878 vlib_buffer_t **b = bufs;
880 while (n_trace && n_segs)
882 if (PREDICT_TRUE (vlib_trace_buffer (vm, node, next_index, b[0],
883 1 /* follow_chain */)))
885 session_queue_trace_t *t =
886 vlib_add_trace (vm, node, b[0], sizeof (*t));
887 t->session_index = s->session_index;
888 t->server_thread_index = s->thread_index;
894 vlib_set_trace_count (vm, node, n_trace);
898 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
899 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
901 vlib_buffer_t *chain_b, *prev_b;
902 u32 chain_bi0, to_deq, left_from_seg;
903 u16 len_to_deq, n_bytes_read;
906 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
907 b->total_length_not_including_first_buffer = 0;
910 left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
912 to_deq = left_from_seg;
913 for (j = 1; j < ctx->n_bufs_per_seg; j++)
916 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
919 chain_bi0 = ctx->tx_buffers[*n_bufs];
920 chain_b = vlib_get_buffer (vm, chain_bi0);
921 chain_b->current_data = 0;
922 data = vlib_buffer_get_current (chain_b);
925 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
926 ctx->sp.tx_offset, len_to_deq, data);
927 ctx->sp.tx_offset += n_bytes_read;
931 if (ctx->transport_vft->transport_options.tx_type ==
934 svm_fifo_t *f = ctx->s->tx_fifo;
935 session_dgram_hdr_t *hdr = &ctx->hdr;
939 deq_now = clib_min (hdr->data_length - hdr->data_offset,
941 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
942 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data);
943 ASSERT (n_bytes_read > 0);
945 hdr->data_offset += n_bytes_read;
946 if (hdr->data_offset == hdr->data_length)
948 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
949 svm_fifo_dequeue_drop (f, offset);
950 if (ctx->left_to_snd > n_bytes_read)
951 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
954 else if (ctx->left_to_snd == n_bytes_read)
955 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
956 sizeof (session_dgram_pre_hdr_t));
959 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
962 ASSERT (n_bytes_read == len_to_deq);
963 chain_b->current_length = n_bytes_read;
964 b->total_length_not_including_first_buffer += chain_b->current_length;
966 /* update previous buffer */
967 prev_b->next_buffer = chain_bi0;
968 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
970 /* update current buffer */
971 chain_b->next_buffer = 0;
973 to_deq -= n_bytes_read;
978 && b->total_length_not_including_first_buffer == left_from_seg);
979 ctx->left_to_snd -= left_from_seg;
983 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
984 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
991 * Start with the first buffer in chain
994 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
997 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
998 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
1002 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset,
1004 ASSERT (n_bytes_read > 0);
1005 /* Keep track of progress locally, transport is also supposed to
1006 * increment it independently when pushing the header */
1007 ctx->sp.tx_offset += n_bytes_read;
1011 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1013 session_dgram_hdr_t *hdr = &ctx->hdr;
1014 svm_fifo_t *f = ctx->s->tx_fifo;
1018 ASSERT (hdr->data_length > hdr->data_offset);
1019 deq_now = clib_min (hdr->data_length - hdr->data_offset,
1021 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
1022 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
1023 ASSERT (n_bytes_read > 0);
1025 if (transport_connection_is_cless (ctx->tc))
1027 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
1028 ctx->tc->rmt_port = hdr->rmt_port;
1030 hdr->data_offset += n_bytes_read;
1031 if (hdr->data_offset == hdr->data_length)
1033 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
1034 svm_fifo_dequeue_drop (f, offset);
1035 if (ctx->left_to_snd > n_bytes_read)
1036 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1039 else if (ctx->left_to_snd == n_bytes_read)
1040 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
1041 sizeof (session_dgram_pre_hdr_t));
1045 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
1047 ASSERT (n_bytes_read > 0);
1050 b->current_length = n_bytes_read;
1051 ctx->left_to_snd -= n_bytes_read;
1054 * Fill in the remaining buffers in the chain, if any
1056 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
1057 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
1061 session_tx_not_ready (session_t * s, u8 peek_data)
1065 if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
1067 /* Can retransmit for closed sessions but can't send new data if
1068 * session is not ready or closed */
1069 else if (s->session_state < SESSION_STATE_READY)
1071 /* Allow accepting session to send custom packets.
1072 * For instance, tcp want to send acks in established, but
1073 * the app has not called accept() yet */
1074 if (s->session_state == SESSION_STATE_ACCEPTING &&
1075 (s->flags & SESSION_F_CUSTOM_TX))
1079 else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1081 /* Allow closed transports to still send custom packets.
1082 * For instance, tcp may want to send acks in time-wait. */
1083 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
1084 && (s->flags & SESSION_F_CUSTOM_TX))
1092 always_inline transport_connection_t *
1093 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
1097 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1098 ctx->s->thread_index);
1102 if (ctx->s->session_state == SESSION_STATE_LISTENING)
1103 return ctx->transport_vft->get_listener (ctx->s->connection_index);
1106 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1107 ctx->s->thread_index);
1113 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
1114 u32 max_segs, u8 peek_data)
1116 u32 n_bytes_per_buf, n_bytes_per_seg;
1118 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
1119 ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
1123 /* Offset in rx fifo from where to peek data */
1124 if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
1126 ctx->max_len_to_snd = 0;
1129 ctx->max_dequeue -= ctx->sp.tx_offset;
1133 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1135 u32 len, chain_limit;
1137 if (ctx->max_dequeue <= sizeof (ctx->hdr))
1139 ctx->max_len_to_snd = 0;
1143 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1145 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
1146 len = ctx->hdr.data_length - ctx->hdr.data_offset;
1148 /* Process multiple dgrams if smaller than min (buf_space, mss).
1149 * This avoids handling multiple dgrams if they require buffer
1151 chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
1153 if (ctx->hdr.data_length <= chain_limit)
1155 u32 first_dgram_len, dgram_len, offset, max_offset;
1156 session_dgram_hdr_t hdr;
1158 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
1159 offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
1160 first_dgram_len = len;
1161 max_offset = clib_min (ctx->max_dequeue, 16 << 10);
1163 while (offset < max_offset)
1165 svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
1167 ASSERT (hdr.data_length > hdr.data_offset);
1168 dgram_len = hdr.data_length - hdr.data_offset;
1169 if (len + dgram_len > ctx->max_dequeue
1170 || first_dgram_len != dgram_len)
1173 offset += sizeof (hdr) + hdr.data_length;
1177 ctx->max_dequeue = len;
1180 ASSERT (ctx->max_dequeue > 0);
1182 /* Ensure we're not writing more than transport window allows */
1183 if (ctx->max_dequeue < ctx->sp.snd_space)
1185 /* Constrained by tx queue. Try to send only fully formed segments */
1186 ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
1187 (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
1193 /* Expectation is that snd_space0 is already a multiple of snd_mss */
1194 ctx->max_len_to_snd = ctx->sp.snd_space;
1197 /* Check if we're tx constrained by the node */
1198 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
1199 if (ctx->n_segs_per_evt > max_segs)
1201 ctx->n_segs_per_evt = max_segs;
1202 ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
1205 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
1206 if (ctx->n_segs_per_evt > 1)
1208 u32 n_bytes_last_seg, n_bufs_last_seg;
1210 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
1211 n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
1212 - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
1213 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1214 n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
1215 ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
1220 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
1221 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1222 ctx->n_bufs_needed = ctx->n_bufs_per_seg;
1225 ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
1226 ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
1228 TRANSPORT_MAX_HDRS_LEN);
1232 session_tx_maybe_reschedule (session_worker_t * wrk,
1233 session_tx_context_t * ctx,
1234 session_evt_elt_t * elt)
1236 session_t *s = ctx->s;
1238 svm_fifo_unset_event (s->tx_fifo);
1239 if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
1241 if (svm_fifo_set_event (s->tx_fifo))
1242 session_evt_add_head_old (wrk, elt);
1246 transport_connection_deschedule (ctx->tc);
1251 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
1252 vlib_node_runtime_t * node,
1253 session_evt_elt_t * elt,
1254 int *n_tx_packets, u8 peek_data)
1256 u32 n_trace, n_left, pbi, next_index, max_burst;
1257 session_tx_context_t *ctx = &wrk->ctx;
1258 session_main_t *smm = &session_main;
1259 session_event_t *e = &elt->evt;
1260 vlib_main_t *vm = wrk->vm;
1261 transport_proto_t tp;
1265 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
1268 session_evt_add_old (wrk, elt);
1269 return SESSION_TX_NO_DATA;
1272 next_index = smm->session_type_to_next[ctx->s->session_type];
1273 max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
1275 tp = session_get_transport_proto (ctx->s);
1276 ctx->transport_vft = transport_protocol_get_vft (tp);
1277 ctx->tc = session_tx_get_transport (ctx, peek_data);
1279 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
1281 if (ctx->transport_vft->flush_data)
1282 ctx->transport_vft->flush_data (ctx->tc);
1283 e->event_type = SESSION_IO_EVT_TX;
1286 if (ctx->s->flags & SESSION_F_CUSTOM_TX)
1289 ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
1290 ctx->sp.max_burst_size = max_burst;
1291 n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
1292 *n_tx_packets += n_custom_tx;
1294 (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1295 return SESSION_TX_OK;
1296 max_burst -= n_custom_tx;
1297 if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
1299 session_evt_add_old (wrk, elt);
1300 return SESSION_TX_OK;
1304 /* Connection previously descheduled because it had no data to send.
1305 * Clear descheduled flag and reset pacer if in use */
1306 if (transport_connection_is_descheduled (ctx->tc))
1307 transport_connection_clear_descheduled (ctx->tc);
1309 transport_connection_snd_params (ctx->tc, &ctx->sp);
1311 if (!ctx->sp.snd_space)
1313 /* If the deschedule flag was set, remove session from scheduler.
1314 * Transport is responsible for rescheduling this session. */
1315 if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
1316 transport_connection_deschedule (ctx->tc);
1317 /* Request to postpone the session, e.g., zero-wnd and transport
1318 * is not currently probing */
1319 else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
1320 session_evt_add_old (wrk, elt);
1321 /* This flow queue is "empty" so it should be re-evaluated before
1322 * the ones that have data to send. */
1324 session_evt_add_head_old (wrk, elt);
1326 return SESSION_TX_NO_DATA;
1329 if (transport_connection_is_tx_paced (ctx->tc))
1331 u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1332 if (snd_space < TRANSPORT_PACER_MIN_BURST)
1334 session_evt_add_head_old (wrk, elt);
1335 return SESSION_TX_NO_DATA;
1337 snd_space = clib_min (ctx->sp.snd_space, snd_space);
1338 ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1339 snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1342 /* Check how much we can pull. */
1343 session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1345 if (PREDICT_FALSE (!ctx->max_len_to_snd))
1347 transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1348 session_tx_maybe_reschedule (wrk, ctx, elt);
1349 return SESSION_TX_NO_DATA;
1352 vec_validate_aligned (ctx->tx_buffers, ctx->n_bufs_needed - 1,
1353 CLIB_CACHE_LINE_BYTES);
1354 n_bufs = vlib_buffer_alloc (vm, ctx->tx_buffers, ctx->n_bufs_needed);
1355 if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1358 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1359 session_evt_add_head_old (wrk, elt);
1360 vlib_node_increment_counter (wrk->vm, node->node_index,
1361 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1362 return SESSION_TX_NO_BUFFERS;
1365 if (transport_connection_is_tx_paced (ctx->tc))
1366 transport_connection_tx_pacer_update_bytes (ctx->tc, ctx->max_len_to_snd);
1368 ctx->left_to_snd = ctx->max_len_to_snd;
1369 n_left = ctx->n_segs_per_evt;
1371 vec_validate (ctx->transport_pending_bufs, n_left);
1375 vlib_buffer_t *b0, *b1;
1378 pbi = ctx->tx_buffers[n_bufs - 3];
1379 pb = vlib_get_buffer (vm, pbi);
1380 vlib_prefetch_buffer_header (pb, STORE);
1381 pbi = ctx->tx_buffers[n_bufs - 4];
1382 pb = vlib_get_buffer (vm, pbi);
1383 vlib_prefetch_buffer_header (pb, STORE);
1385 bi0 = ctx->tx_buffers[--n_bufs];
1386 bi1 = ctx->tx_buffers[--n_bufs];
1388 b0 = vlib_get_buffer (vm, bi0);
1389 b1 = vlib_get_buffer (vm, bi1);
1391 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1392 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
1394 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1395 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left + 1] = b1;
1398 vec_add1 (wrk->pending_tx_buffers, bi0);
1399 vec_add1 (wrk->pending_tx_buffers, bi1);
1400 vec_add1 (wrk->pending_tx_nexts, next_index);
1401 vec_add1 (wrk->pending_tx_nexts, next_index);
1410 pbi = ctx->tx_buffers[n_bufs - 2];
1411 pb = vlib_get_buffer (vm, pbi);
1412 vlib_prefetch_buffer_header (pb, STORE);
1415 bi0 = ctx->tx_buffers[--n_bufs];
1416 b0 = vlib_get_buffer (vm, bi0);
1417 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1419 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1422 vec_add1 (wrk->pending_tx_buffers, bi0);
1423 vec_add1 (wrk->pending_tx_nexts, next_index);
1426 /* Ask transport to push headers */
1427 ctx->transport_vft->push_header (ctx->tc, ctx->transport_pending_bufs,
1428 ctx->n_segs_per_evt);
1430 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1431 session_tx_trace_frame (vm, node, next_index, ctx->transport_pending_bufs,
1432 ctx->n_segs_per_evt, ctx->s, n_trace);
1434 if (PREDICT_FALSE (n_bufs))
1435 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1437 *n_tx_packets += ctx->n_segs_per_evt;
1439 SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1440 ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
1442 ASSERT (ctx->left_to_snd == 0);
1444 /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1445 * check if application enqueued more data and reschedule accordingly */
1446 if (ctx->max_len_to_snd < ctx->max_dequeue)
1447 session_evt_add_old (wrk, elt);
1449 session_tx_maybe_reschedule (wrk, ctx, elt);
1453 u32 n_dequeued = ctx->max_len_to_snd;
1454 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1455 n_dequeued += ctx->n_segs_per_evt * SESSION_CONN_HDR_LEN;
1456 if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, n_dequeued))
1457 session_dequeue_notify (ctx->s);
1459 return SESSION_TX_OK;
1463 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1464 vlib_node_runtime_t * node,
1465 session_evt_elt_t * e, int *n_tx_packets)
1467 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1471 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1472 vlib_node_runtime_t * node,
1473 session_evt_elt_t * e, int *n_tx_packets)
1475 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1479 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1480 vlib_node_runtime_t * node,
1481 session_evt_elt_t * elt, int *n_tx_packets)
1483 transport_send_params_t *sp = &wrk->ctx.sp;
1484 session_t *s = wrk->ctx.s;
1487 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1490 /* Clear custom-tx flag used to request reschedule for tx */
1491 s->flags &= ~SESSION_F_CUSTOM_TX;
1494 sp->bytes_dequeued = 0;
1495 sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1496 TRANSPORT_PACER_MAX_BURST_PKTS);
1498 n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1499 *n_tx_packets += n_packets;
1501 if (s->flags & SESSION_F_CUSTOM_TX)
1503 session_evt_add_old (wrk, elt);
1505 else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1507 svm_fifo_unset_event (s->tx_fifo);
1508 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1509 if (svm_fifo_set_event (s->tx_fifo))
1510 session_evt_add_head_old (wrk, elt);
1513 if (sp->bytes_dequeued &&
1514 svm_fifo_needs_deq_ntf (s->tx_fifo, sp->bytes_dequeued))
1515 session_dequeue_notify (s);
1520 always_inline session_t *
1521 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1523 if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1526 ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1527 return pool_elt_at_index (wrk->sessions, e->session_index);
1531 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1533 clib_llist_index_t ei;
1534 void (*fp) (void *);
1538 ei = clib_llist_entry_index (wrk->event_elts, elt);
1541 switch (e->event_type)
1543 case SESSION_CTRL_EVT_RPC:
1544 fp = e->rpc_args.fp;
1545 (*fp) (e->rpc_args.arg);
1547 case SESSION_CTRL_EVT_HALF_CLOSE:
1548 s = session_get_from_handle_if_valid (e->session_handle);
1549 if (PREDICT_FALSE (!s))
1551 session_transport_half_close (s);
1553 case SESSION_CTRL_EVT_CLOSE:
1554 s = session_get_from_handle_if_valid (e->session_handle);
1555 if (PREDICT_FALSE (!s))
1557 session_transport_close (s);
1559 case SESSION_CTRL_EVT_RESET:
1560 s = session_get_from_handle_if_valid (e->session_handle);
1561 if (PREDICT_FALSE (!s))
1563 session_transport_reset (s);
1565 case SESSION_CTRL_EVT_LISTEN:
1566 session_mq_listen_handler (wrk, elt);
1568 case SESSION_CTRL_EVT_LISTEN_URI:
1569 session_mq_listen_uri_handler (wrk, elt);
1571 case SESSION_CTRL_EVT_UNLISTEN:
1572 session_mq_unlisten_handler (wrk, elt);
1574 case SESSION_CTRL_EVT_CONNECT:
1575 session_mq_connect_handler (wrk, elt);
1577 case SESSION_CTRL_EVT_CONNECT_URI:
1578 session_mq_connect_uri_handler (wrk, elt);
1580 case SESSION_CTRL_EVT_SHUTDOWN:
1581 session_mq_shutdown_handler (session_evt_ctrl_data (wrk, elt));
1583 case SESSION_CTRL_EVT_DISCONNECT:
1584 session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1586 case SESSION_CTRL_EVT_DISCONNECTED:
1587 session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1589 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1590 session_mq_accepted_reply_handler (wrk, elt);
1592 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1593 session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1596 case SESSION_CTRL_EVT_RESET_REPLY:
1597 session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1599 case SESSION_CTRL_EVT_WORKER_UPDATE:
1600 session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1602 case SESSION_CTRL_EVT_APP_DETACH:
1603 app_mq_detach_handler (wrk, elt);
1605 case SESSION_CTRL_EVT_APP_WRK_RPC:
1606 session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1608 case SESSION_CTRL_EVT_TRANSPORT_ATTR:
1609 session_mq_transport_attr_handler (session_evt_ctrl_data (wrk, elt));
1612 clib_warning ("unhandled event type %d", e->event_type);
1615 /* Regrab elements in case pool moved */
1616 elt = clib_llist_elt (wrk->event_elts, ei);
1617 if (!clib_llist_elt_is_linked (elt, evt_list))
1620 if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1621 session_evt_ctrl_data_free (wrk, elt);
1622 clib_llist_put (wrk->event_elts, elt);
1624 SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1628 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1629 session_evt_elt_t * elt, int *n_tx_packets)
1631 session_main_t *smm = &session_main;
1632 app_worker_t *app_wrk;
1633 clib_llist_index_t ei;
1637 ei = clib_llist_entry_index (wrk->event_elts, elt);
1640 switch (e->event_type)
1642 case SESSION_IO_EVT_TX_FLUSH:
1643 case SESSION_IO_EVT_TX:
1644 s = session_event_get_session (wrk, e);
1645 if (PREDICT_FALSE (!s))
1647 CLIB_PREFETCH (s->tx_fifo, sizeof (*(s->tx_fifo)), LOAD);
1649 /* Spray packets in per session type frames, since they go to
1650 * different nodes */
1651 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1653 case SESSION_IO_EVT_RX:
1654 s = session_event_get_session (wrk, e);
1657 transport_app_rx_evt (session_get_transport_proto (s),
1658 s->connection_index, s->thread_index);
1660 case SESSION_IO_EVT_BUILTIN_RX:
1661 s = session_event_get_session (wrk, e);
1662 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1664 svm_fifo_unset_event (s->rx_fifo);
1665 app_wrk = app_worker_get (s->app_wrk_index);
1666 app_worker_builtin_rx (app_wrk, s);
1668 case SESSION_IO_EVT_BUILTIN_TX:
1669 s = session_get_from_handle_if_valid (e->session_handle);
1671 if (PREDICT_TRUE (s != 0))
1672 session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
1675 clib_warning ("unhandled event type %d", e->event_type);
1678 SESSION_EVT (SESSION_IO_EVT_COUNTS, e->event_type, 1, wrk);
1680 /* Regrab elements in case pool moved */
1681 elt = clib_llist_elt (wrk->event_elts, ei);
1682 if (!clib_llist_elt_is_linked (elt, evt_list))
1683 clib_llist_put (wrk->event_elts, elt);
1687 static const u32 session_evt_msg_sizes[] = {
1688 #define _(symc, sym) \
1689 [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1690 foreach_session_ctrl_evt
1696 session_update_time_subscribers (session_main_t *smm, clib_time_type_t now,
1699 session_update_time_fn *fn;
1701 vec_foreach (fn, smm->update_time_fns)
1702 (*fn) (now, thread_index);
1706 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1708 session_evt_elt_t *elt;
1710 if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1712 elt = session_evt_alloc_ctrl (wrk);
1713 if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1715 elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1716 elt->evt.event_type = evt->event_type;
1717 clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1718 session_evt_msg_sizes[evt->event_type]);
1722 /* Internal control events fit into io events footprint */
1723 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1728 elt = session_evt_alloc_new (wrk);
1729 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1734 session_flush_pending_tx_buffers (session_worker_t * wrk,
1735 vlib_node_runtime_t * node)
1737 vlib_buffer_enqueue_to_next_vec (wrk->vm, node, &wrk->pending_tx_buffers,
1738 &wrk->pending_tx_nexts,
1739 vec_len (wrk->pending_tx_nexts));
1740 vec_reset_length (wrk->pending_tx_buffers);
1741 vec_reset_length (wrk->pending_tx_nexts);
1745 session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq)
1747 svm_msg_q_msg_t _msg, *msg = &_msg;
1748 u32 i, n_to_dequeue = 0;
1749 session_event_t *evt;
1751 n_to_dequeue = svm_msg_q_size (mq);
1752 for (i = 0; i < n_to_dequeue; i++)
1754 svm_msg_q_sub_raw (mq, msg);
1755 evt = svm_msg_q_msg_data (mq, msg);
1756 session_evt_add_to_list (wrk, evt);
1757 svm_msg_q_free_msg (mq, msg);
1760 return n_to_dequeue;
1764 session_wrk_update_state (session_worker_t *wrk)
1766 vlib_main_t *vm = wrk->vm;
1768 if (wrk->state == SESSION_WRK_POLLING)
1770 if (clib_llist_elts (wrk->event_elts) == 4 &&
1771 vlib_last_vectors_per_main_loop (vm) < 1)
1773 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1774 vlib_node_set_state (vm, session_queue_node.index,
1775 VLIB_NODE_STATE_INTERRUPT);
1778 else if (wrk->state == SESSION_WRK_INTERRUPT)
1780 if (clib_llist_elts (wrk->event_elts) > 4 ||
1781 vlib_last_vectors_per_main_loop (vm) > 1)
1783 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
1784 vlib_node_set_state (vm, session_queue_node.index,
1785 VLIB_NODE_STATE_POLLING);
1787 else if (PREDICT_FALSE (!pool_elts (wrk->sessions)))
1789 session_wrk_set_state (wrk, SESSION_WRK_IDLE);
1794 if (clib_llist_elts (wrk->event_elts))
1796 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1802 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1803 vlib_frame_t * frame)
1805 u32 thread_index = vm->thread_index, __clib_unused n_evts;
1806 session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1807 session_main_t *smm = vnet_get_session_main ();
1808 session_worker_t *wrk = &smm->wrk[thread_index];
1809 clib_llist_index_t ei, next_ei, old_ti;
1812 SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1814 session_wrk_update_time (wrk, vlib_time_now (vm));
1817 * Update transport time
1819 session_update_time_subscribers (smm, wrk->last_vlib_time, thread_index);
1820 n_tx_packets = vec_len (wrk->pending_tx_buffers);
1821 SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1824 * Dequeue new internal mq events
1827 n_evts = session_wrk_handle_mq (wrk, wrk->vpp_event_queue);
1828 SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_evts);
1831 * Handle control events
1834 ei = wrk->ctrl_head;
1835 ctrl_he = clib_llist_elt (wrk->event_elts, ei);
1836 next_ei = clib_llist_next_index (ctrl_he, evt_list);
1837 old_ti = clib_llist_prev_index (ctrl_he, evt_list);
1838 while (ei != old_ti)
1841 elt = clib_llist_elt (wrk->event_elts, next_ei);
1842 next_ei = clib_llist_next_index (elt, evt_list);
1843 clib_llist_remove (wrk->event_elts, evt_list, elt);
1844 session_event_dispatch_ctrl (wrk, elt);
1847 SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1850 * Handle the new io events.
1853 new_he = clib_llist_elt (wrk->event_elts, wrk->new_head);
1854 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1855 old_ti = clib_llist_prev_index (old_he, evt_list);
1857 ei = clib_llist_next_index (new_he, evt_list);
1858 while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
1860 elt = clib_llist_elt (wrk->event_elts, ei);
1861 ei = clib_llist_next_index (elt, evt_list);
1862 clib_llist_remove (wrk->event_elts, evt_list, elt);
1863 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1866 SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1869 * Handle the old io events, if we had any prior to processing the new ones
1872 if (old_ti != wrk->old_head)
1874 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1875 ei = clib_llist_next_index (old_he, evt_list);
1877 while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
1879 elt = clib_llist_elt (wrk->event_elts, ei);
1880 next_ei = clib_llist_next_index (elt, evt_list);
1881 clib_llist_remove (wrk->event_elts, evt_list, elt);
1883 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1892 SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
1894 if (vec_len (wrk->pending_tx_buffers))
1895 session_flush_pending_tx_buffers (wrk, node);
1897 vlib_node_increment_counter (vm, session_queue_node.index,
1898 SESSION_QUEUE_ERROR_TX, n_tx_packets);
1900 SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1902 if (wrk->flags & SESSION_WRK_F_ADAPTIVE)
1903 session_wrk_update_state (wrk);
1905 return n_tx_packets;
1909 VLIB_REGISTER_NODE (session_queue_node) = {
1910 .function = session_queue_node_fn,
1911 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1912 .name = "session-queue",
1913 .format_trace = format_session_queue_trace,
1914 .type = VLIB_NODE_TYPE_INPUT,
1915 .n_errors = SESSION_QUEUE_N_ERROR,
1916 .error_counters = session_error_counters,
1917 .state = VLIB_NODE_STATE_DISABLED,
1921 static clib_error_t *
1922 session_wrk_tfd_read_ready (clib_file_t *cf)
1924 session_worker_t *wrk = session_main_get_worker (cf->private_data);
1928 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
1929 rv = read (wrk->timerfd, &buf, sizeof (buf));
1930 if (rv < 0 && errno != EAGAIN)
1931 clib_unix_warning ("failed");
1935 static clib_error_t *
1936 session_wrk_tfd_write_ready (clib_file_t *cf)
1942 session_wrk_enable_adaptive_mode (session_worker_t *wrk)
1944 u32 thread_index = wrk->vm->thread_index;
1945 clib_file_t template = { 0 };
1947 if ((wrk->timerfd = timerfd_create (CLOCK_MONOTONIC, TFD_NONBLOCK)) < 0)
1948 clib_warning ("timerfd_create");
1950 template.read_function = session_wrk_tfd_read_ready;
1951 template.write_function = session_wrk_tfd_write_ready;
1952 template.file_descriptor = wrk->timerfd;
1953 template.private_data = thread_index;
1954 template.polling_thread_index = thread_index;
1955 template.description = format (0, "session-wrk-tfd-%u", thread_index);
1957 wrk->timerfd_file = clib_file_add (&file_main, &template);
1958 wrk->flags |= SESSION_WRK_F_ADAPTIVE;
1961 static clib_error_t *
1962 session_queue_exit (vlib_main_t * vm)
1964 if (vlib_get_n_threads () < 2)
1968 * Shut off (especially) worker-thread session nodes.
1969 * Otherwise, vpp can crash as the main thread unmaps the
1972 vlib_worker_thread_barrier_sync (vm);
1973 session_node_enable_disable (0 /* is_enable */ );
1974 vlib_worker_thread_barrier_release (vm);
1978 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1981 session_queue_run_on_main (vlib_main_t * vm)
1983 vlib_node_runtime_t *node;
1985 node = vlib_node_get_runtime (vm, session_queue_node.index);
1986 return session_queue_node_fn (vm, node, 0);
1990 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1993 uword *event_data = 0;
1999 vlib_process_wait_for_event_or_clock (vm, timeout);
2000 event_type = vlib_process_get_events (vm, (uword **) & event_data);
2004 case SESSION_Q_PROCESS_RUN_ON_MAIN:
2005 /* Run session queue node on main thread */
2006 session_queue_run_on_main (vm);
2008 case SESSION_Q_PROCESS_STOP:
2009 vlib_node_set_state (vm, session_queue_process_node.index,
2010 VLIB_NODE_STATE_DISABLED);
2014 /* Timed out. Run on main to ensure all events are handled */
2015 session_queue_run_on_main (vm);
2018 vec_reset_length (event_data);
2024 VLIB_REGISTER_NODE (session_queue_process_node) =
2026 .function = session_queue_process,
2027 .type = VLIB_NODE_TYPE_PROCESS,
2028 .name = "session-queue-process",
2029 .state = VLIB_NODE_STATE_DISABLED,
2033 static_always_inline uword
2034 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2035 vlib_frame_t * frame)
2037 session_main_t *sm = &session_main;
2038 if (!sm->wrk[0].vpp_event_queue)
2040 node = vlib_node_get_runtime (vm, session_queue_node.index);
2041 return session_queue_node_fn (vm, node, frame);
2045 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
2047 .function = session_queue_pre_input_inline,
2048 .type = VLIB_NODE_TYPE_PRE_INPUT,
2049 .name = "session-queue-main",
2050 .state = VLIB_NODE_STATE_DISABLED,
2055 * fd.io coding-style-patch-verification: ON
2058 * eval: (c-set-style "gnu")