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 session_evt_elt_t *he, *elt, *next;
228 session_worker_t *fwrk;
230 ASSERT (session_vlib_thread_is_cl_thread ());
232 /* Pending connects on linked list pertaining to first worker */
233 fwrk = session_main_get_worker (transport_cl_thread ());
234 if (!fwrk->n_pending_connects)
237 he = clib_llist_elt (fwrk->event_elts, fwrk->pending_connects);
238 elt = clib_llist_next (fwrk->event_elts, evt_list, he);
240 /* Avoid holding the worker for too long */
241 while (n_connects < max_connects && elt != he)
243 next = clib_llist_next (fwrk->event_elts, evt_list, elt);
244 clib_llist_remove (fwrk->event_elts, evt_list, elt);
245 session_mq_connect_one (session_evt_ctrl_data (fwrk, elt));
246 session_evt_ctrl_data_free (fwrk, elt);
247 clib_llist_put (fwrk->event_elts, elt);
252 /* Decrement with worker barrier */
253 fwrk->n_pending_connects -= n_connects;
254 if (fwrk->n_pending_connects > 0)
256 session_send_rpc_evt_to_thread_force (fwrk->vm->thread_index,
257 session_mq_handle_connects_rpc, 0);
262 session_mq_connect_handler (session_worker_t *wrk, session_evt_elt_t *elt)
264 u32 thread_index = wrk - session_main.wrk;
265 session_evt_elt_t *he;
267 if (PREDICT_FALSE (thread_index > transport_cl_thread ()))
269 clib_warning ("Connect on wrong thread. Dropping");
273 /* If on worker, check if main has any pending messages. Avoids reordering
274 * with other control messages that need to be handled by main
278 he = clib_llist_elt (wrk->event_elts, wrk->evts_pending_main);
280 /* Events pending on main, postpone to avoid reordering */
281 if (!clib_llist_is_empty (wrk->event_elts, evt_list, he))
283 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
288 /* Add to pending list to be handled by first worker */
289 he = clib_llist_elt (wrk->event_elts, wrk->pending_connects);
290 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
292 /* Decremented with worker barrier */
293 wrk->n_pending_connects += 1;
294 if (wrk->n_pending_connects == 1)
296 session_send_rpc_evt_to_thread_force (thread_index,
297 session_mq_handle_connects_rpc, 0);
302 session_mq_connect_uri_handler (session_worker_t *wrk, session_evt_elt_t *elt)
304 vnet_connect_args_t _a, *a = &_a;
305 session_connect_uri_msg_t *mp;
306 app_worker_t *app_wrk;
310 app_check_thread_and_barrier (wrk, elt);
312 mp = session_evt_ctrl_data (wrk, elt);
313 app = application_lookup (mp->client_index);
317 clib_memset (a, 0, sizeof (*a));
318 a->uri = (char *) mp->uri;
319 a->api_context = mp->context;
320 a->app_index = app->app_index;
321 if ((rv = vnet_connect_uri (a)))
323 clib_warning ("connect_uri returned: %d", rv);
324 app_wrk = application_get_worker (app, 0 /* default wrk only */ );
325 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
330 session_mq_shutdown_handler (void *data)
332 session_shutdown_msg_t *mp = (session_shutdown_msg_t *) data;
333 vnet_shutdown_args_t _a, *a = &_a;
336 app = application_lookup (mp->client_index);
340 a->app_index = app->app_index;
341 a->handle = mp->handle;
342 vnet_shutdown_session (a);
346 session_mq_disconnect_handler (void *data)
348 session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
349 vnet_disconnect_args_t _a, *a = &_a;
352 app = application_lookup (mp->client_index);
356 a->app_index = app->app_index;
357 a->handle = mp->handle;
358 vnet_disconnect_session (a);
362 app_mq_detach_handler (session_worker_t *wrk, session_evt_elt_t *elt)
364 vnet_app_detach_args_t _a, *a = &_a;
365 session_app_detach_msg_t *mp;
368 app_check_thread_and_barrier (wrk, elt);
370 mp = session_evt_ctrl_data (wrk, elt);
371 app = application_lookup (mp->client_index);
375 a->app_index = app->app_index;
376 a->api_client_index = mp->client_index;
377 vnet_application_detach (a);
381 session_mq_unlisten_handler (session_worker_t *wrk, session_evt_elt_t *elt)
383 vnet_unlisten_args_t _a, *a = &_a;
384 session_unlisten_msg_t *mp;
385 app_worker_t *app_wrk;
390 app_check_thread_and_barrier (wrk, elt);
392 mp = session_evt_ctrl_data (wrk, elt);
395 app = application_lookup (mp->client_index);
399 clib_memset (a, 0, sizeof (*a));
400 a->app_index = app->app_index;
402 a->wrk_map_index = mp->wrk_index;
404 if ((rv = vnet_unlisten (a)))
405 clib_warning ("unlisten returned: %d", rv);
407 app_wrk = application_get_worker (app, a->wrk_map_index);
411 mq_send_unlisten_reply (app_wrk, sh, mp->context, rv);
415 session_mq_accepted_reply_handler (session_worker_t *wrk,
416 session_evt_elt_t *elt)
418 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
419 session_accepted_reply_msg_t *mp;
420 session_state_t old_state;
421 app_worker_t *app_wrk;
424 mp = session_evt_ctrl_data (wrk, elt);
426 /* Mail this back from the main thread. We're not polling in main
427 * thread so we're using other workers for notifications. */
428 if (session_thread_from_handle (mp->handle) == 0 && vlib_num_workers () &&
429 vlib_get_thread_index () != 0)
431 session_wrk_send_evt_to_main (wrk, elt);
435 s = session_get_from_handle_if_valid (mp->handle);
439 app_wrk = app_worker_get (s->app_wrk_index);
440 if (app_wrk->app_index != mp->context)
442 clib_warning ("app doesn't own session");
446 /* Server isn't interested, disconnect the session */
449 a->app_index = mp->context;
450 a->handle = mp->handle;
451 vnet_disconnect_session (a);
455 /* Special handling for cut-through sessions */
456 if (!session_has_transport (s))
458 session_set_state (s, SESSION_STATE_READY);
459 ct_session_connect_notify (s, SESSION_E_NONE);
463 old_state = s->session_state;
464 session_set_state (s, SESSION_STATE_READY);
466 if (!svm_fifo_is_empty_prod (s->rx_fifo))
467 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
469 /* Closed while waiting for app to reply. Resend disconnect */
470 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
472 app_worker_close_notify (app_wrk, s);
473 session_set_state (s, old_state);
479 session_mq_reset_reply_handler (void *data)
481 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
482 session_reset_reply_msg_t *mp;
483 app_worker_t *app_wrk;
486 u32 index, thread_index;
488 mp = (session_reset_reply_msg_t *) data;
489 app = application_lookup (mp->context);
493 session_parse_handle (mp->handle, &index, &thread_index);
494 s = session_get_if_valid (index, thread_index);
496 /* No session or not the right session */
497 if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
500 app_wrk = app_worker_get (s->app_wrk_index);
501 if (!app_wrk || app_wrk->app_index != app->app_index)
503 clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
508 /* Client objected to resetting the session, log and continue */
511 clib_warning ("client retval %d", mp->retval);
515 /* This comes as a response to a reset, transport only waiting for
516 * confirmation to remove connection state, no need to disconnect */
517 a->handle = mp->handle;
518 a->app_index = app->app_index;
519 vnet_disconnect_session (a);
523 session_mq_disconnected_handler (void *data)
525 session_disconnected_reply_msg_t *rmp;
526 vnet_disconnect_args_t _a, *a = &_a;
527 svm_msg_q_msg_t _msg, *msg = &_msg;
528 session_disconnected_msg_t *mp;
529 app_worker_t *app_wrk;
530 session_event_t *evt;
535 mp = (session_disconnected_msg_t *) data;
536 if (!(s = session_get_from_handle_if_valid (mp->handle)))
538 clib_warning ("could not disconnect handle %llu", mp->handle);
541 app_wrk = app_worker_get (s->app_wrk_index);
542 app = application_lookup (mp->client_index);
543 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
545 clib_warning ("could not disconnect session: %llu app: %u",
546 mp->handle, mp->client_index);
550 a->handle = mp->handle;
551 a->app_index = app_wrk->wrk_index;
552 rv = vnet_disconnect_session (a);
554 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
555 SESSION_MQ_CTRL_EVT_RING,
557 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
558 clib_memset (evt, 0, sizeof (*evt));
559 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
560 rmp = (session_disconnected_reply_msg_t *) evt->data;
561 rmp->handle = mp->handle;
562 rmp->context = mp->context;
564 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
568 session_mq_disconnected_reply_handler (void *data)
570 session_disconnected_reply_msg_t *mp;
571 vnet_disconnect_args_t _a, *a = &_a;
574 mp = (session_disconnected_reply_msg_t *) data;
576 /* Client objected to disconnecting the session, log and continue */
579 clib_warning ("client retval %d", mp->retval);
583 /* Disconnect has been confirmed. Confirm close to transport */
584 app = application_lookup (mp->context);
587 a->handle = mp->handle;
588 a->app_index = app->app_index;
589 vnet_disconnect_session (a);
594 session_mq_worker_update_handler (void *data)
596 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
597 session_worker_update_reply_msg_t *rmp;
598 svm_msg_q_msg_t _msg, *msg = &_msg;
599 app_worker_t *app_wrk;
600 u32 owner_app_wrk_map;
601 session_event_t *evt;
605 app = application_lookup (mp->client_index);
608 if (!(s = session_get_from_handle_if_valid (mp->handle)))
610 clib_warning ("invalid handle %llu", mp->handle);
613 app_wrk = app_worker_get (s->app_wrk_index);
614 if (app_wrk->app_index != app->app_index)
616 clib_warning ("app %u does not own session %llu", app->app_index,
620 owner_app_wrk_map = app_wrk->wrk_map_index;
621 app_wrk = application_get_worker (app, mp->wrk_index);
623 /* This needs to come from the new owner */
624 if (mp->req_wrk_index == owner_app_wrk_map)
626 session_req_worker_update_msg_t *wump;
628 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
629 SESSION_MQ_CTRL_EVT_RING,
631 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
632 clib_memset (evt, 0, sizeof (*evt));
633 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
634 wump = (session_req_worker_update_msg_t *) evt->data;
635 wump->session_handle = mp->handle;
636 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
640 app_worker_own_session (app_wrk, s);
645 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
646 SESSION_MQ_CTRL_EVT_RING,
648 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
649 clib_memset (evt, 0, sizeof (*evt));
650 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
651 rmp = (session_worker_update_reply_msg_t *) evt->data;
652 rmp->handle = mp->handle;
654 rmp->rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
656 rmp->tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
657 rmp->segment_handle = session_segment_handle (s);
658 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
661 * Retransmit messages that may have been lost
663 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
664 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
666 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
667 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
669 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
670 app_worker_close_notify (app_wrk, s);
674 session_mq_app_wrk_rpc_handler (void *data)
676 session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
677 svm_msg_q_msg_t _msg, *msg = &_msg;
678 session_app_wrk_rpc_msg_t *rmp;
679 app_worker_t *app_wrk;
680 session_event_t *evt;
683 app = application_lookup (mp->client_index);
687 app_wrk = application_get_worker (app, mp->wrk_index);
689 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
690 SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
692 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
693 clib_memset (evt, 0, sizeof (*evt));
694 evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
695 rmp = (session_app_wrk_rpc_msg_t *) evt->data;
696 clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
697 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
701 session_mq_transport_attr_handler (void *data)
703 session_transport_attr_msg_t *mp = (session_transport_attr_msg_t *) data;
704 session_transport_attr_reply_msg_t *rmp;
705 svm_msg_q_msg_t _msg, *msg = &_msg;
706 app_worker_t *app_wrk;
707 session_event_t *evt;
712 app = application_lookup (mp->client_index);
716 if (!(s = session_get_from_handle_if_valid (mp->handle)))
718 clib_warning ("invalid handle %llu", mp->handle);
721 app_wrk = app_worker_get (s->app_wrk_index);
722 if (app_wrk->app_index != app->app_index)
724 clib_warning ("app %u does not own session %llu", app->app_index,
729 rv = session_transport_attribute (s, mp->is_get, &mp->attr);
731 svm_msg_q_lock_and_alloc_msg_w_ring (
732 app_wrk->event_queue, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, msg);
733 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
734 clib_memset (evt, 0, sizeof (*evt));
735 evt->event_type = SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY;
736 rmp = (session_transport_attr_reply_msg_t *) evt->data;
737 rmp->handle = mp->handle;
739 rmp->is_get = mp->is_get;
740 if (!rv && mp->is_get)
741 rmp->attr = mp->attr;
742 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
746 session_wrk_handle_evts_main_rpc (void *args)
748 vlib_main_t *vm = vlib_get_main ();
749 clib_llist_index_t ei, next_ei;
750 session_evt_elt_t *he, *elt;
751 session_worker_t *fwrk;
754 vlib_worker_thread_barrier_sync (vm);
756 thread_index = pointer_to_uword (args);
757 fwrk = session_main_get_worker (thread_index);
759 he = clib_llist_elt (fwrk->event_elts, fwrk->evts_pending_main);
760 ei = clib_llist_next_index (he, evt_list);
762 while (ei != fwrk->evts_pending_main)
764 elt = clib_llist_elt (fwrk->event_elts, ei);
765 next_ei = clib_llist_next_index (elt, evt_list);
766 clib_llist_remove (fwrk->event_elts, evt_list, elt);
767 switch (elt->evt.event_type)
769 case SESSION_CTRL_EVT_LISTEN:
770 session_mq_listen_handler (fwrk, elt);
772 case SESSION_CTRL_EVT_UNLISTEN:
773 session_mq_unlisten_handler (fwrk, elt);
775 case SESSION_CTRL_EVT_APP_DETACH:
776 app_mq_detach_handler (fwrk, elt);
778 case SESSION_CTRL_EVT_CONNECT_URI:
779 session_mq_connect_uri_handler (fwrk, elt);
781 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
782 session_mq_accepted_reply_handler (fwrk, elt);
784 case SESSION_CTRL_EVT_CONNECT:
785 session_mq_connect_handler (fwrk, elt);
788 clib_warning ("unhandled %u", elt->evt.event_type);
793 /* Regrab element in case pool moved */
794 elt = clib_llist_elt (fwrk->event_elts, ei);
795 if (!clib_llist_elt_is_linked (elt, evt_list))
797 session_evt_ctrl_data_free (fwrk, elt);
798 clib_llist_put (fwrk->event_elts, elt);
803 vlib_worker_thread_barrier_release (vm);
806 vlib_node_registration_t session_queue_node;
811 u32 server_thread_index;
812 } session_queue_trace_t;
814 /* packet trace format function */
816 format_session_queue_trace (u8 * s, va_list * args)
818 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
819 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
820 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
822 s = format (s, "session index %d thread index %d",
823 t->session_index, t->server_thread_index);
827 #define foreach_session_queue_error \
828 _ (TX, tx, INFO, "Packets transmitted") \
829 _ (TIMER, timer, INFO, "Timer events") \
830 _ (NO_BUFFER, no_buffer, ERROR, "Out of buffers")
834 #define _(f, n, s, d) SESSION_QUEUE_ERROR_##f,
835 foreach_session_queue_error
837 SESSION_QUEUE_N_ERROR,
838 } session_queue_error_t;
840 static vlib_error_desc_t session_error_counters[] = {
841 #define _(f, n, s, d) { #n, d, VL_COUNTER_SEVERITY_##s },
842 foreach_session_queue_error
848 SESSION_TX_NO_BUFFERS = -2,
854 session_tx_trace_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
855 u32 next_index, vlib_buffer_t **bufs, u16 n_segs,
856 session_t *s, u32 n_trace)
858 vlib_buffer_t **b = bufs;
860 while (n_trace && n_segs)
862 if (PREDICT_TRUE (vlib_trace_buffer (vm, node, next_index, b[0],
863 1 /* follow_chain */)))
865 session_queue_trace_t *t =
866 vlib_add_trace (vm, node, b[0], sizeof (*t));
867 t->session_index = s->session_index;
868 t->server_thread_index = s->thread_index;
874 vlib_set_trace_count (vm, node, n_trace);
878 session_tx_fill_dma_transfers (session_worker_t *wrk,
879 session_tx_context_t *ctx, vlib_buffer_t *b)
881 vlib_main_t *vm = wrk->vm;
884 int n_bytes_read, len_write;
885 svm_fifo_seg_t data_fs[2];
890 * Start with the first buffer in chain
893 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
895 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
896 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
898 n_bytes_read = svm_fifo_segments (ctx->s->tx_fifo, ctx->sp.tx_offset,
899 data_fs, &n_segs, len_to_deq);
901 len_write = n_bytes_read;
902 ASSERT (n_bytes_read == len_to_deq);
907 vlib_dma_batch_add (vm, wrk->batch, data0, data_fs[n_transfers].data,
908 data_fs[n_transfers].len);
909 data0 += data_fs[n_transfers].len;
910 n_bytes_read -= data_fs[n_transfers].len;
917 session_tx_fill_dma_transfers_tail (session_worker_t *wrk,
918 session_tx_context_t *ctx,
919 vlib_buffer_t *b, u32 len_to_deq, u8 *data)
921 vlib_main_t *vm = wrk->vm;
922 int n_bytes_read, len_write;
923 svm_fifo_seg_t data_fs[2];
927 n_bytes_read = svm_fifo_segments (ctx->s->tx_fifo, ctx->sp.tx_offset,
928 data_fs, &n_segs, len_to_deq);
930 len_write = n_bytes_read;
932 ASSERT (n_bytes_read == len_to_deq);
937 vlib_dma_batch_add (vm, wrk->batch, data, data_fs[n_transfers].data,
938 data_fs[n_transfers].len);
939 data += data_fs[n_transfers].len;
940 n_bytes_read -= data_fs[n_transfers].len;
948 session_tx_copy_data (session_worker_t *wrk, session_tx_context_t *ctx,
949 vlib_buffer_t *b, u32 len_to_deq, u8 *data0)
952 if (PREDICT_TRUE (!wrk->dma_enabled))
954 svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset, len_to_deq, data0);
956 n_bytes_read = session_tx_fill_dma_transfers (wrk, ctx, b);
961 session_tx_copy_data_tail (session_worker_t *wrk, session_tx_context_t *ctx,
962 vlib_buffer_t *b, u32 len_to_deq, u8 *data)
965 if (PREDICT_TRUE (!wrk->dma_enabled))
967 svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset, len_to_deq, data);
970 session_tx_fill_dma_transfers_tail (wrk, ctx, b, len_to_deq, data);
975 session_tx_fifo_chain_tail (session_worker_t *wrk, session_tx_context_t *ctx,
976 vlib_buffer_t *b, u16 *n_bufs, u8 peek_data)
978 vlib_main_t *vm = wrk->vm;
979 vlib_buffer_t *chain_b, *prev_b;
980 u32 chain_bi0, to_deq, left_from_seg;
981 int len_to_deq, n_bytes_read;
984 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
985 b->total_length_not_including_first_buffer = 0;
988 left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
990 to_deq = left_from_seg;
991 for (j = 1; j < ctx->n_bufs_per_seg; j++)
994 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
997 chain_bi0 = ctx->tx_buffers[*n_bufs];
998 chain_b = vlib_get_buffer (vm, chain_bi0);
999 chain_b->current_data = 0;
1000 data = vlib_buffer_get_current (chain_b);
1004 session_tx_copy_data_tail (wrk, ctx, b, len_to_deq, data);
1005 ctx->sp.tx_offset += n_bytes_read;
1009 if (ctx->transport_vft->transport_options.tx_type ==
1012 svm_fifo_t *f = ctx->s->tx_fifo;
1013 session_dgram_hdr_t *hdr = &ctx->hdr;
1017 deq_now = clib_min (hdr->data_length - hdr->data_offset,
1019 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
1020 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data);
1021 ASSERT (n_bytes_read > 0);
1023 hdr->data_offset += n_bytes_read;
1024 if (hdr->data_offset == hdr->data_length)
1026 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
1027 svm_fifo_dequeue_drop (f, offset);
1028 if (ctx->left_to_snd > n_bytes_read)
1029 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1032 else if (ctx->left_to_snd == n_bytes_read)
1033 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
1034 sizeof (session_dgram_pre_hdr_t));
1037 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
1040 ASSERT (n_bytes_read == len_to_deq);
1041 chain_b->current_length = n_bytes_read;
1042 b->total_length_not_including_first_buffer += chain_b->current_length;
1044 /* update previous buffer */
1045 prev_b->next_buffer = chain_bi0;
1046 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1048 /* update current buffer */
1049 chain_b->next_buffer = 0;
1051 to_deq -= n_bytes_read;
1056 && b->total_length_not_including_first_buffer == left_from_seg);
1057 ctx->left_to_snd -= left_from_seg;
1061 session_tx_fill_buffer (session_worker_t *wrk, session_tx_context_t *ctx,
1062 vlib_buffer_t *b, u16 *n_bufs, u8 peek_data)
1068 * Start with the first buffer in chain
1071 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
1072 b->current_data = 0;
1074 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
1075 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
1079 n_bytes_read = session_tx_copy_data (wrk, ctx, b, len_to_deq, data0);
1080 ASSERT (n_bytes_read > 0);
1081 /* Keep track of progress locally, transport is also supposed to
1082 * increment it independently when pushing the header */
1083 ctx->sp.tx_offset += n_bytes_read;
1087 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1089 session_dgram_hdr_t *hdr = &ctx->hdr;
1090 svm_fifo_t *f = ctx->s->tx_fifo;
1094 ASSERT (hdr->data_length > hdr->data_offset);
1095 deq_now = clib_min (hdr->data_length - hdr->data_offset,
1097 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
1098 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
1099 ASSERT (n_bytes_read > 0);
1101 if (transport_connection_is_cless (ctx->tc))
1103 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
1104 ctx->tc->rmt_port = hdr->rmt_port;
1106 hdr->data_offset += n_bytes_read;
1107 if (hdr->data_offset == hdr->data_length)
1109 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
1110 svm_fifo_dequeue_drop (f, offset);
1111 if (ctx->left_to_snd > n_bytes_read)
1112 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1115 else if (ctx->left_to_snd == n_bytes_read)
1116 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
1117 sizeof (session_dgram_pre_hdr_t));
1121 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
1123 ASSERT (n_bytes_read > 0);
1127 b->current_length = n_bytes_read;
1128 ctx->left_to_snd -= n_bytes_read;
1131 * Fill in the remaining buffers in the chain, if any
1133 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
1134 session_tx_fifo_chain_tail (wrk, ctx, b, n_bufs, peek_data);
1138 session_tx_not_ready (session_t * s, u8 peek_data)
1142 if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
1144 /* Can retransmit for closed sessions but can't send new data if
1145 * session is not ready or closed */
1146 else if (s->session_state < SESSION_STATE_READY)
1148 /* Allow accepting session to send custom packets.
1149 * For instance, tcp want to send acks in established, but
1150 * the app has not called accept() yet */
1151 if (s->session_state == SESSION_STATE_ACCEPTING &&
1152 (s->flags & SESSION_F_CUSTOM_TX))
1156 else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1158 /* Allow closed transports to still send custom packets.
1159 * For instance, tcp may want to send acks in time-wait. */
1160 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
1161 && (s->flags & SESSION_F_CUSTOM_TX))
1168 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1174 always_inline transport_connection_t *
1175 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
1179 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1180 ctx->s->thread_index);
1184 if (ctx->s->session_state == SESSION_STATE_LISTENING)
1185 return ctx->transport_vft->get_listener (ctx->s->connection_index);
1188 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1189 ctx->s->thread_index);
1195 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
1196 u32 max_segs, u8 peek_data)
1198 u32 n_bytes_per_buf, n_bytes_per_seg;
1200 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
1201 ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
1205 /* Offset in rx fifo from where to peek data */
1206 if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
1208 ctx->max_len_to_snd = 0;
1211 ctx->max_dequeue -= ctx->sp.tx_offset;
1215 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1217 u32 len, chain_limit;
1219 if (ctx->max_dequeue <= sizeof (ctx->hdr))
1221 ctx->max_len_to_snd = 0;
1225 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1227 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
1228 len = ctx->hdr.data_length - ctx->hdr.data_offset;
1230 if (ctx->hdr.gso_size)
1232 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, ctx->hdr.gso_size);
1235 /* Process multiple dgrams if smaller than min (buf_space, mss).
1236 * This avoids handling multiple dgrams if they require buffer
1238 chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
1240 if (ctx->hdr.data_length <= chain_limit)
1242 u32 first_dgram_len, dgram_len, offset, max_offset;
1243 session_dgram_hdr_t hdr;
1245 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
1246 offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
1247 first_dgram_len = len;
1248 max_offset = clib_min (ctx->max_dequeue, 16 << 10);
1250 while (offset < max_offset)
1252 svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
1254 ASSERT (hdr.data_length > hdr.data_offset);
1255 dgram_len = hdr.data_length - hdr.data_offset;
1256 if (offset + sizeof (hdr) + hdr.data_length >
1258 first_dgram_len != dgram_len)
1261 offset += sizeof (hdr) + hdr.data_length;
1265 ctx->max_dequeue = len;
1268 ASSERT (ctx->max_dequeue > 0);
1270 /* Ensure we're not writing more than transport window allows */
1271 if (ctx->max_dequeue < ctx->sp.snd_space)
1273 /* Constrained by tx queue. Try to send only fully formed segments */
1274 ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
1275 (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
1281 /* Expectation is that snd_space0 is already a multiple of snd_mss */
1282 ctx->max_len_to_snd = ctx->sp.snd_space;
1285 /* Check if we're tx constrained by the node */
1286 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
1287 if (ctx->n_segs_per_evt > max_segs)
1289 ctx->n_segs_per_evt = max_segs;
1290 ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
1293 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
1294 if (ctx->n_segs_per_evt > 1)
1296 u32 n_bytes_last_seg, n_bufs_last_seg;
1298 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
1299 n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
1300 - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
1301 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1302 n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
1303 ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
1308 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
1309 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1310 ctx->n_bufs_needed = ctx->n_bufs_per_seg;
1313 ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
1314 ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
1316 TRANSPORT_MAX_HDRS_LEN);
1320 session_tx_maybe_reschedule (session_worker_t * wrk,
1321 session_tx_context_t * ctx,
1322 session_evt_elt_t * elt)
1324 session_t *s = ctx->s;
1326 svm_fifo_unset_event (s->tx_fifo);
1327 if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
1329 if (svm_fifo_set_event (s->tx_fifo))
1330 session_evt_add_head_old (wrk, elt);
1334 transport_connection_deschedule (ctx->tc);
1339 session_tx_add_pending_buffer (session_worker_t *wrk, u32 bi, u32 next_index)
1341 if (PREDICT_TRUE (!wrk->dma_enabled))
1343 vec_add1 (wrk->pending_tx_buffers, bi);
1344 vec_add1 (wrk->pending_tx_nexts, next_index);
1348 session_dma_transfer *dma_transfer = &wrk->dma_trans[wrk->trans_tail];
1349 vec_add1 (dma_transfer->pending_tx_buffers, bi);
1350 vec_add1 (dma_transfer->pending_tx_nexts, next_index);
1355 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
1356 vlib_node_runtime_t * node,
1357 session_evt_elt_t * elt,
1358 int *n_tx_packets, u8 peek_data)
1360 u32 n_trace, n_left, pbi, next_index, max_burst;
1361 session_tx_context_t *ctx = &wrk->ctx;
1362 session_main_t *smm = &session_main;
1363 session_event_t *e = &elt->evt;
1364 vlib_main_t *vm = wrk->vm;
1365 transport_proto_t tp;
1369 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
1372 session_evt_add_old (wrk, elt);
1373 return SESSION_TX_NO_DATA;
1376 next_index = smm->session_type_to_next[ctx->s->session_type];
1377 max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
1379 tp = session_get_transport_proto (ctx->s);
1380 ctx->transport_vft = transport_protocol_get_vft (tp);
1381 ctx->tc = session_tx_get_transport (ctx, peek_data);
1383 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
1385 if (ctx->transport_vft->flush_data)
1386 ctx->transport_vft->flush_data (ctx->tc);
1387 e->event_type = SESSION_IO_EVT_TX;
1390 if (ctx->s->flags & SESSION_F_CUSTOM_TX)
1393 ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
1394 ctx->sp.max_burst_size = max_burst;
1395 n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
1396 *n_tx_packets += n_custom_tx;
1398 (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1399 return SESSION_TX_OK;
1400 max_burst -= n_custom_tx;
1401 if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
1403 session_evt_add_old (wrk, elt);
1404 return SESSION_TX_OK;
1408 /* Connection previously descheduled because it had no data to send.
1409 * Clear descheduled flag and reset pacer if in use */
1410 if (transport_connection_is_descheduled (ctx->tc))
1411 transport_connection_clear_descheduled (ctx->tc);
1413 transport_connection_snd_params (ctx->tc, &ctx->sp);
1415 if (!ctx->sp.snd_space)
1417 /* If the deschedule flag was set, remove session from scheduler.
1418 * Transport is responsible for rescheduling this session. */
1419 if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
1420 transport_connection_deschedule (ctx->tc);
1421 /* Request to postpone the session, e.g., zero-wnd and transport
1422 * is not currently probing */
1423 else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
1424 session_evt_add_old (wrk, elt);
1425 /* This flow queue is "empty" so it should be re-evaluated before
1426 * the ones that have data to send. */
1428 session_evt_add_head_old (wrk, elt);
1430 return SESSION_TX_NO_DATA;
1433 if (transport_connection_is_tx_paced (ctx->tc))
1435 u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1436 if (snd_space < TRANSPORT_PACER_MIN_BURST)
1438 session_evt_add_head_old (wrk, elt);
1439 return SESSION_TX_NO_DATA;
1441 snd_space = clib_min (ctx->sp.snd_space, snd_space);
1442 ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1443 snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1446 /* Check how much we can pull. */
1447 session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1449 if (PREDICT_FALSE (!ctx->max_len_to_snd))
1451 transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1452 session_tx_maybe_reschedule (wrk, ctx, elt);
1453 return SESSION_TX_NO_DATA;
1456 vec_validate_aligned (ctx->tx_buffers, ctx->n_bufs_needed - 1,
1457 CLIB_CACHE_LINE_BYTES);
1458 n_bufs = vlib_buffer_alloc (vm, ctx->tx_buffers, ctx->n_bufs_needed);
1459 if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1462 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1463 session_evt_add_head_old (wrk, elt);
1464 vlib_node_increment_counter (wrk->vm, node->node_index,
1465 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1466 return SESSION_TX_NO_BUFFERS;
1469 if (transport_connection_is_tx_paced (ctx->tc))
1470 transport_connection_tx_pacer_update_bytes (ctx->tc, ctx->max_len_to_snd);
1472 ctx->left_to_snd = ctx->max_len_to_snd;
1473 n_left = ctx->n_segs_per_evt;
1475 vec_validate (ctx->transport_pending_bufs, n_left);
1479 vlib_buffer_t *b0, *b1;
1482 pbi = ctx->tx_buffers[n_bufs - 3];
1483 pb = vlib_get_buffer (vm, pbi);
1484 vlib_prefetch_buffer_header (pb, STORE);
1485 pbi = ctx->tx_buffers[n_bufs - 4];
1486 pb = vlib_get_buffer (vm, pbi);
1487 vlib_prefetch_buffer_header (pb, STORE);
1489 bi0 = ctx->tx_buffers[--n_bufs];
1490 bi1 = ctx->tx_buffers[--n_bufs];
1492 b0 = vlib_get_buffer (vm, bi0);
1493 b1 = vlib_get_buffer (vm, bi1);
1495 session_tx_fill_buffer (wrk, ctx, b0, &n_bufs, peek_data);
1496 session_tx_fill_buffer (wrk, ctx, b1, &n_bufs, peek_data);
1498 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1499 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left + 1] = b1;
1502 session_tx_add_pending_buffer (wrk, bi0, next_index);
1503 session_tx_add_pending_buffer (wrk, bi1, next_index);
1512 pbi = ctx->tx_buffers[n_bufs - 2];
1513 pb = vlib_get_buffer (vm, pbi);
1514 vlib_prefetch_buffer_header (pb, STORE);
1517 bi0 = ctx->tx_buffers[--n_bufs];
1518 b0 = vlib_get_buffer (vm, bi0);
1519 session_tx_fill_buffer (wrk, ctx, b0, &n_bufs, peek_data);
1521 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1524 session_tx_add_pending_buffer (wrk, bi0, next_index);
1527 /* Ask transport to push headers */
1528 ctx->transport_vft->push_header (ctx->tc, ctx->transport_pending_bufs,
1529 ctx->n_segs_per_evt);
1531 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1532 session_tx_trace_frame (vm, node, next_index, ctx->transport_pending_bufs,
1533 ctx->n_segs_per_evt, ctx->s, n_trace);
1535 if (PREDICT_FALSE (n_bufs))
1536 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1538 *n_tx_packets += ctx->n_segs_per_evt;
1540 SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1541 ctx->s->tx_fifo->shr->has_event, wrk->last_vlib_time);
1543 ASSERT (ctx->left_to_snd == 0);
1545 /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1546 * check if application enqueued more data and reschedule accordingly */
1547 if (ctx->max_len_to_snd < ctx->max_dequeue)
1548 session_evt_add_old (wrk, elt);
1550 session_tx_maybe_reschedule (wrk, ctx, elt);
1554 u32 n_dequeued = ctx->max_len_to_snd;
1555 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1556 n_dequeued += ctx->n_segs_per_evt * SESSION_CONN_HDR_LEN;
1557 if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, n_dequeued))
1558 session_dequeue_notify (ctx->s);
1560 return SESSION_TX_OK;
1564 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1565 vlib_node_runtime_t * node,
1566 session_evt_elt_t * e, int *n_tx_packets)
1568 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1572 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1573 vlib_node_runtime_t * node,
1574 session_evt_elt_t * e, int *n_tx_packets)
1576 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1580 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1581 vlib_node_runtime_t * node,
1582 session_evt_elt_t * elt, int *n_tx_packets)
1584 transport_send_params_t *sp = &wrk->ctx.sp;
1585 session_t *s = wrk->ctx.s;
1588 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1591 /* Clear custom-tx flag used to request reschedule for tx */
1592 s->flags &= ~SESSION_F_CUSTOM_TX;
1595 sp->bytes_dequeued = 0;
1596 sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1597 TRANSPORT_PACER_MAX_BURST_PKTS);
1599 n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1600 *n_tx_packets += n_packets;
1602 if (s->flags & SESSION_F_CUSTOM_TX)
1604 session_evt_add_old (wrk, elt);
1606 else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1608 svm_fifo_unset_event (s->tx_fifo);
1609 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1610 if (svm_fifo_set_event (s->tx_fifo))
1611 session_evt_add_head_old (wrk, elt);
1614 if (sp->bytes_dequeued &&
1615 svm_fifo_needs_deq_ntf (s->tx_fifo, sp->bytes_dequeued))
1616 session_dequeue_notify (s);
1621 always_inline session_t *
1622 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1624 if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1627 ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1628 return pool_elt_at_index (wrk->sessions, e->session_index);
1632 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1634 clib_llist_index_t ei;
1635 void (*fp) (void *);
1639 ei = clib_llist_entry_index (wrk->event_elts, elt);
1642 switch (e->event_type)
1644 case SESSION_CTRL_EVT_RPC:
1645 fp = e->rpc_args.fp;
1646 (*fp) (e->rpc_args.arg);
1648 case SESSION_CTRL_EVT_HALF_CLOSE:
1649 s = session_get_from_handle_if_valid (e->session_handle);
1650 if (PREDICT_FALSE (!s))
1652 session_transport_half_close (s);
1654 case SESSION_CTRL_EVT_CLOSE:
1655 s = session_get_from_handle_if_valid (e->session_handle);
1656 if (PREDICT_FALSE (!s))
1658 session_transport_close (s);
1660 case SESSION_CTRL_EVT_RESET:
1661 s = session_get_from_handle_if_valid (e->session_handle);
1662 if (PREDICT_FALSE (!s))
1664 session_transport_reset (s);
1666 case SESSION_CTRL_EVT_LISTEN:
1667 session_mq_listen_handler (wrk, elt);
1669 case SESSION_CTRL_EVT_LISTEN_URI:
1670 session_mq_listen_uri_handler (wrk, elt);
1672 case SESSION_CTRL_EVT_UNLISTEN:
1673 session_mq_unlisten_handler (wrk, elt);
1675 case SESSION_CTRL_EVT_CONNECT:
1676 session_mq_connect_handler (wrk, elt);
1678 case SESSION_CTRL_EVT_CONNECT_URI:
1679 session_mq_connect_uri_handler (wrk, elt);
1681 case SESSION_CTRL_EVT_SHUTDOWN:
1682 session_mq_shutdown_handler (session_evt_ctrl_data (wrk, elt));
1684 case SESSION_CTRL_EVT_DISCONNECT:
1685 session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1687 case SESSION_CTRL_EVT_DISCONNECTED:
1688 session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1690 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1691 session_mq_accepted_reply_handler (wrk, elt);
1693 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1694 session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1697 case SESSION_CTRL_EVT_RESET_REPLY:
1698 session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1700 case SESSION_CTRL_EVT_WORKER_UPDATE:
1701 session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1703 case SESSION_CTRL_EVT_APP_DETACH:
1704 app_mq_detach_handler (wrk, elt);
1706 case SESSION_CTRL_EVT_APP_WRK_RPC:
1707 session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1709 case SESSION_CTRL_EVT_TRANSPORT_ATTR:
1710 session_mq_transport_attr_handler (session_evt_ctrl_data (wrk, elt));
1713 clib_warning ("unhandled event type %d", e->event_type);
1716 /* Regrab elements in case pool moved */
1717 elt = clib_llist_elt (wrk->event_elts, ei);
1718 if (!clib_llist_elt_is_linked (elt, evt_list))
1721 if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1722 session_evt_ctrl_data_free (wrk, elt);
1723 clib_llist_put (wrk->event_elts, elt);
1725 SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1729 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1730 session_evt_elt_t * elt, int *n_tx_packets)
1732 session_main_t *smm = &session_main;
1733 app_worker_t *app_wrk;
1734 clib_llist_index_t ei;
1738 ei = clib_llist_entry_index (wrk->event_elts, elt);
1741 switch (e->event_type)
1743 case SESSION_IO_EVT_TX_FLUSH:
1744 case SESSION_IO_EVT_TX:
1745 s = session_event_get_session (wrk, e);
1746 if (PREDICT_FALSE (!s))
1748 CLIB_PREFETCH (s->tx_fifo, sizeof (*(s->tx_fifo)), LOAD);
1750 /* Spray packets in per session type frames, since they go to
1751 * different nodes */
1752 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1754 case SESSION_IO_EVT_RX:
1755 s = session_event_get_session (wrk, e);
1758 transport_app_rx_evt (session_get_transport_proto (s),
1759 s->connection_index, s->thread_index);
1761 case SESSION_IO_EVT_BUILTIN_RX:
1762 s = session_event_get_session (wrk, e);
1763 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1765 svm_fifo_unset_event (s->rx_fifo);
1766 app_wrk = app_worker_get (s->app_wrk_index);
1767 app_worker_builtin_rx (app_wrk, s);
1769 case SESSION_IO_EVT_BUILTIN_TX:
1770 s = session_get_from_handle_if_valid (e->session_handle);
1772 if (PREDICT_TRUE (s != 0))
1773 session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
1776 clib_warning ("unhandled event type %d", e->event_type);
1779 SESSION_EVT (SESSION_EVT_IO_EVT_COUNTS, e->event_type, 1, wrk);
1781 /* Regrab elements in case pool moved */
1782 elt = clib_llist_elt (wrk->event_elts, ei);
1783 if (!clib_llist_elt_is_linked (elt, evt_list))
1784 clib_llist_put (wrk->event_elts, elt);
1788 static const u32 session_evt_msg_sizes[] = {
1789 #define _(symc, sym) \
1790 [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1791 foreach_session_ctrl_evt
1797 session_update_time_subscribers (session_main_t *smm, clib_time_type_t now,
1800 session_update_time_fn *fn;
1802 vec_foreach (fn, smm->update_time_fns)
1803 (*fn) (now, thread_index);
1807 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1809 session_evt_elt_t *elt;
1811 if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1813 elt = session_evt_alloc_ctrl (wrk);
1814 if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1816 elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1817 elt->evt.event_type = evt->event_type;
1818 clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1819 session_evt_msg_sizes[evt->event_type]);
1823 /* Internal control events fit into io events footprint */
1824 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1829 elt = session_evt_alloc_new (wrk);
1830 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1835 session_flush_pending_tx_buffers (session_worker_t * wrk,
1836 vlib_node_runtime_t * node)
1838 vlib_buffer_enqueue_to_next_vec (wrk->vm, node, &wrk->pending_tx_buffers,
1839 &wrk->pending_tx_nexts,
1840 vec_len (wrk->pending_tx_nexts));
1841 vec_reset_length (wrk->pending_tx_buffers);
1842 vec_reset_length (wrk->pending_tx_nexts);
1846 session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq)
1848 svm_msg_q_msg_t _msg, *msg = &_msg;
1849 u32 i, n_to_dequeue = 0;
1850 session_event_t *evt;
1852 n_to_dequeue = svm_msg_q_size (mq);
1853 for (i = 0; i < n_to_dequeue; i++)
1855 svm_msg_q_sub_raw (mq, msg);
1856 evt = svm_msg_q_msg_data (mq, msg);
1857 session_evt_add_to_list (wrk, evt);
1858 svm_msg_q_free_msg (mq, msg);
1861 return n_to_dequeue;
1865 session_wrk_update_state (session_worker_t *wrk)
1867 vlib_main_t *vm = wrk->vm;
1869 if (wrk->state == SESSION_WRK_POLLING)
1871 if (clib_llist_elts (wrk->event_elts) == 4 &&
1872 vlib_last_vectors_per_main_loop (vm) < 1)
1874 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1875 vlib_node_set_state (vm, session_queue_node.index,
1876 VLIB_NODE_STATE_INTERRUPT);
1879 else if (wrk->state == SESSION_WRK_INTERRUPT)
1881 if (clib_llist_elts (wrk->event_elts) > 4 ||
1882 vlib_last_vectors_per_main_loop (vm) > 1)
1884 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
1885 vlib_node_set_state (vm, session_queue_node.index,
1886 VLIB_NODE_STATE_POLLING);
1888 else if (PREDICT_FALSE (!pool_elts (wrk->sessions)))
1890 session_wrk_set_state (wrk, SESSION_WRK_IDLE);
1895 if (clib_llist_elts (wrk->event_elts))
1897 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1903 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1904 vlib_frame_t * frame)
1906 u32 thread_index = vm->thread_index, __clib_unused n_evts;
1907 session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1908 session_main_t *smm = vnet_get_session_main ();
1909 session_worker_t *wrk = &smm->wrk[thread_index];
1910 clib_llist_index_t ei, next_ei, old_ti;
1913 SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1915 session_wrk_update_time (wrk, vlib_time_now (vm));
1918 * Update transport time
1920 session_update_time_subscribers (smm, wrk->last_vlib_time, thread_index);
1921 n_tx_packets = vec_len (wrk->pending_tx_buffers);
1922 SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1924 if (PREDICT_FALSE (wrk->dma_enabled))
1926 if (wrk->trans_head == ((wrk->trans_tail + 1) & (wrk->trans_size - 1)))
1928 wrk->batch = vlib_dma_batch_new (vm, wrk->config_index);
1932 * Dequeue new internal mq events
1935 n_evts = session_wrk_handle_mq (wrk, wrk->vpp_event_queue);
1936 SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_evts);
1939 * Handle control events
1942 ei = wrk->ctrl_head;
1943 ctrl_he = clib_llist_elt (wrk->event_elts, ei);
1944 next_ei = clib_llist_next_index (ctrl_he, evt_list);
1945 old_ti = clib_llist_prev_index (ctrl_he, evt_list);
1946 while (ei != old_ti)
1949 elt = clib_llist_elt (wrk->event_elts, next_ei);
1950 next_ei = clib_llist_next_index (elt, evt_list);
1951 clib_llist_remove (wrk->event_elts, evt_list, elt);
1952 session_event_dispatch_ctrl (wrk, elt);
1955 SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1958 * Handle the new io events.
1961 new_he = clib_llist_elt (wrk->event_elts, wrk->new_head);
1962 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1963 old_ti = clib_llist_prev_index (old_he, evt_list);
1965 ei = clib_llist_next_index (new_he, evt_list);
1966 while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
1968 elt = clib_llist_elt (wrk->event_elts, ei);
1969 ei = clib_llist_next_index (elt, evt_list);
1970 clib_llist_remove (wrk->event_elts, evt_list, elt);
1971 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1974 SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1977 * Handle the old io events, if we had any prior to processing the new ones
1980 if (old_ti != wrk->old_head)
1982 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1983 ei = clib_llist_next_index (old_he, evt_list);
1985 while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
1987 elt = clib_llist_elt (wrk->event_elts, ei);
1988 next_ei = clib_llist_next_index (elt, evt_list);
1989 clib_llist_remove (wrk->event_elts, evt_list, elt);
1991 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
2000 if (PREDICT_FALSE (wrk->dma_enabled))
2004 vlib_dma_batch_set_cookie (vm, wrk->batch, wrk->trans_tail);
2007 if (wrk->trans_tail == wrk->trans_size)
2008 wrk->trans_tail = 0;
2011 vlib_dma_batch_submit (vm, wrk->batch);
2014 SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
2016 if (vec_len (wrk->pending_tx_buffers))
2017 session_flush_pending_tx_buffers (wrk, node);
2019 vlib_node_increment_counter (vm, session_queue_node.index,
2020 SESSION_QUEUE_ERROR_TX, n_tx_packets);
2022 SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
2024 if (wrk->flags & SESSION_WRK_F_ADAPTIVE)
2025 session_wrk_update_state (wrk);
2027 return n_tx_packets;
2031 VLIB_REGISTER_NODE (session_queue_node) = {
2032 .function = session_queue_node_fn,
2033 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
2034 .name = "session-queue",
2035 .format_trace = format_session_queue_trace,
2036 .type = VLIB_NODE_TYPE_INPUT,
2037 .n_errors = SESSION_QUEUE_N_ERROR,
2038 .error_counters = session_error_counters,
2039 .state = VLIB_NODE_STATE_DISABLED,
2043 static clib_error_t *
2044 session_wrk_tfd_read_ready (clib_file_t *cf)
2046 session_worker_t *wrk = session_main_get_worker (cf->private_data);
2050 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
2051 rv = read (wrk->timerfd, &buf, sizeof (buf));
2052 if (rv < 0 && errno != EAGAIN)
2053 clib_unix_warning ("failed");
2057 static clib_error_t *
2058 session_wrk_tfd_write_ready (clib_file_t *cf)
2064 session_wrk_enable_adaptive_mode (session_worker_t *wrk)
2066 u32 thread_index = wrk->vm->thread_index;
2067 clib_file_t template = { 0 };
2069 if ((wrk->timerfd = timerfd_create (CLOCK_MONOTONIC, TFD_NONBLOCK)) < 0)
2070 clib_warning ("timerfd_create");
2072 template.read_function = session_wrk_tfd_read_ready;
2073 template.write_function = session_wrk_tfd_write_ready;
2074 template.file_descriptor = wrk->timerfd;
2075 template.private_data = thread_index;
2076 template.polling_thread_index = thread_index;
2077 template.description = format (0, "session-wrk-tfd-%u", thread_index);
2079 wrk->timerfd_file = clib_file_add (&file_main, &template);
2080 wrk->flags |= SESSION_WRK_F_ADAPTIVE;
2083 static clib_error_t *
2084 session_queue_exit (vlib_main_t * vm)
2086 if (vlib_get_n_threads () < 2)
2090 * Shut off (especially) worker-thread session nodes.
2091 * Otherwise, vpp can crash as the main thread unmaps the
2094 vlib_worker_thread_barrier_sync (vm);
2095 session_node_enable_disable (0 /* is_enable */ );
2096 vlib_worker_thread_barrier_release (vm);
2100 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
2103 session_queue_run_on_main (vlib_main_t * vm)
2105 vlib_node_runtime_t *node;
2107 node = vlib_node_get_runtime (vm, session_queue_node.index);
2108 return session_queue_node_fn (vm, node, 0);
2112 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
2115 uword *event_data = 0;
2121 vlib_process_wait_for_event_or_clock (vm, timeout);
2122 event_type = vlib_process_get_events (vm, (uword **) & event_data);
2126 case SESSION_Q_PROCESS_RUN_ON_MAIN:
2127 /* Run session queue node on main thread */
2128 session_queue_run_on_main (vm);
2130 case SESSION_Q_PROCESS_STOP:
2131 vlib_node_set_state (vm, session_queue_process_node.index,
2132 VLIB_NODE_STATE_DISABLED);
2136 /* Timed out. Run on main to ensure all events are handled */
2137 session_queue_run_on_main (vm);
2140 vec_reset_length (event_data);
2146 VLIB_REGISTER_NODE (session_queue_process_node) =
2148 .function = session_queue_process,
2149 .type = VLIB_NODE_TYPE_PROCESS,
2150 .name = "session-queue-process",
2151 .state = VLIB_NODE_STATE_DISABLED,
2155 static_always_inline uword
2156 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2157 vlib_frame_t * frame)
2159 session_main_t *sm = &session_main;
2160 if (!sm->wrk[0].vpp_event_queue)
2162 node = vlib_node_get_runtime (vm, session_queue_node.index);
2163 return session_queue_node_fn (vm, node, frame);
2167 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
2169 .function = session_queue_pre_input_inline,
2170 .type = VLIB_NODE_TYPE_PRE_INPUT,
2171 .name = "session-queue-main",
2172 .state = VLIB_NODE_STATE_DISABLED,
2177 * fd.io coding-style-patch-verification: ON
2180 * eval: (c-set-style "gnu")