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 session_worker_stat_error_inc (wrk, rv, 1);
144 app_wrk = application_get_worker (app, mp->wrk_index);
145 app_worker_listened_notify (app_wrk, a->handle, mp->context, rv);
148 session_mq_free_ext_config (app, mp->ext_config);
150 /* Make sure events are flushed before releasing barrier, to avoid
151 * potential race with accept. */
152 app_wrk_flush_wrk_events (app_wrk, 0);
156 session_mq_listen_uri_handler (session_worker_t *wrk, session_evt_elt_t *elt)
158 vnet_listen_args_t _a, *a = &_a;
159 session_listen_uri_msg_t *mp;
160 app_worker_t *app_wrk;
164 app_check_thread_and_barrier (wrk, elt);
166 mp = session_evt_ctrl_data (wrk, elt);
167 app = application_lookup (mp->client_index);
171 clib_memset (a, 0, sizeof (*a));
172 a->uri = (char *) mp->uri;
173 a->app_index = app->app_index;
174 rv = vnet_bind_uri (a);
176 app_wrk = application_get_worker (app, 0);
177 app_worker_listened_notify (app_wrk, a->handle, mp->context, rv);
178 app_wrk_flush_wrk_events (app_wrk, 0);
182 session_mq_connect_one (session_connect_msg_t *mp)
184 vnet_connect_args_t _a, *a = &_a;
185 app_worker_t *app_wrk;
186 session_worker_t *wrk;
190 app = application_lookup (mp->client_index);
194 clib_memset (a, 0, sizeof (*a));
195 a->sep.is_ip4 = mp->is_ip4;
196 clib_memcpy_fast (&a->sep.ip, &mp->ip, sizeof (mp->ip));
197 a->sep.port = mp->port;
198 a->sep.transport_proto = mp->proto;
199 a->sep.peer.fib_index = mp->vrf;
200 a->sep.dscp = mp->dscp;
201 clib_memcpy_fast (&a->sep.peer.ip, &mp->lcl_ip, sizeof (mp->lcl_ip));
204 ip46_address_mask_ip4 (&a->sep.ip);
205 ip46_address_mask_ip4 (&a->sep.peer.ip);
207 a->sep.peer.port = mp->lcl_port;
208 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
209 a->sep_ext.parent_handle = mp->parent_handle;
210 a->sep_ext.transport_flags = mp->flags;
211 a->api_context = mp->context;
212 a->app_index = app->app_index;
213 a->wrk_map_index = mp->wrk_index;
216 a->sep_ext.ext_cfg = session_mq_get_ext_config (app, mp->ext_config);
218 if ((rv = vnet_connect (a)))
220 wrk = session_main_get_worker (vlib_get_thread_index ());
221 session_worker_stat_error_inc (wrk, rv, 1);
222 app_wrk = application_get_worker (app, mp->wrk_index);
223 app_worker_connect_notify (app_wrk, 0, rv, mp->context);
227 session_mq_free_ext_config (app, mp->ext_config);
231 session_mq_handle_connects_rpc (void *arg)
233 u32 max_connects = 32, n_connects = 0;
234 session_evt_elt_t *he, *elt, *next;
235 session_worker_t *fwrk;
237 ASSERT (session_vlib_thread_is_cl_thread ());
239 /* Pending connects on linked list pertaining to first worker */
240 fwrk = session_main_get_worker (transport_cl_thread ());
241 if (!fwrk->n_pending_connects)
244 he = clib_llist_elt (fwrk->event_elts, fwrk->pending_connects);
245 elt = clib_llist_next (fwrk->event_elts, evt_list, he);
247 /* Avoid holding the worker for too long */
248 while (n_connects < max_connects && elt != he)
250 next = clib_llist_next (fwrk->event_elts, evt_list, elt);
251 clib_llist_remove (fwrk->event_elts, evt_list, elt);
252 session_mq_connect_one (session_evt_ctrl_data (fwrk, elt));
253 session_evt_ctrl_data_free (fwrk, elt);
254 clib_llist_put (fwrk->event_elts, elt);
259 /* Decrement with worker barrier */
260 fwrk->n_pending_connects -= n_connects;
261 if (fwrk->n_pending_connects > 0)
263 session_send_rpc_evt_to_thread_force (fwrk->vm->thread_index,
264 session_mq_handle_connects_rpc, 0);
269 session_mq_connect_handler (session_worker_t *wrk, session_evt_elt_t *elt)
271 u32 thread_index = wrk - session_main.wrk;
272 session_evt_elt_t *he;
274 if (PREDICT_FALSE (thread_index > transport_cl_thread ()))
276 clib_warning ("Connect on wrong thread. Dropping");
280 /* If on worker, check if main has any pending messages. Avoids reordering
281 * with other control messages that need to be handled by main
285 he = clib_llist_elt (wrk->event_elts, wrk->evts_pending_main);
287 /* Events pending on main, postpone to avoid reordering */
288 if (!clib_llist_is_empty (wrk->event_elts, evt_list, he))
290 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
295 /* Add to pending list to be handled by first worker */
296 he = clib_llist_elt (wrk->event_elts, wrk->pending_connects);
297 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
299 /* Decremented with worker barrier */
300 wrk->n_pending_connects += 1;
301 if (wrk->n_pending_connects == 1)
303 session_send_rpc_evt_to_thread_force (thread_index,
304 session_mq_handle_connects_rpc, 0);
309 session_mq_connect_uri_handler (session_worker_t *wrk, session_evt_elt_t *elt)
311 vnet_connect_args_t _a, *a = &_a;
312 session_connect_uri_msg_t *mp;
313 app_worker_t *app_wrk;
317 app_check_thread_and_barrier (wrk, elt);
319 mp = session_evt_ctrl_data (wrk, elt);
320 app = application_lookup (mp->client_index);
324 clib_memset (a, 0, sizeof (*a));
325 a->uri = (char *) mp->uri;
326 a->api_context = mp->context;
327 a->app_index = app->app_index;
328 if ((rv = vnet_connect_uri (a)))
330 session_worker_stat_error_inc (wrk, rv, 1);
331 app_wrk = application_get_worker (app, 0 /* default wrk only */ );
332 app_worker_connect_notify (app_wrk, 0, rv, mp->context);
337 session_mq_shutdown_handler (void *data)
339 session_shutdown_msg_t *mp = (session_shutdown_msg_t *) data;
340 vnet_shutdown_args_t _a, *a = &_a;
343 app = application_lookup (mp->client_index);
347 a->app_index = app->app_index;
348 a->handle = mp->handle;
349 vnet_shutdown_session (a);
353 session_mq_disconnect_handler (void *data)
355 session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
356 vnet_disconnect_args_t _a, *a = &_a;
359 app = application_lookup (mp->client_index);
363 a->app_index = app->app_index;
364 a->handle = mp->handle;
365 vnet_disconnect_session (a);
369 app_mq_detach_handler (session_worker_t *wrk, session_evt_elt_t *elt)
371 vnet_app_detach_args_t _a, *a = &_a;
372 session_app_detach_msg_t *mp;
375 app_check_thread_and_barrier (wrk, elt);
377 mp = session_evt_ctrl_data (wrk, elt);
378 app = application_lookup (mp->client_index);
382 a->app_index = app->app_index;
383 a->api_client_index = mp->client_index;
384 vnet_application_detach (a);
388 session_mq_unlisten_handler (session_worker_t *wrk, session_evt_elt_t *elt)
390 vnet_unlisten_args_t _a, *a = &_a;
391 session_unlisten_msg_t *mp;
392 app_worker_t *app_wrk;
397 app_check_thread_and_barrier (wrk, elt);
399 mp = session_evt_ctrl_data (wrk, elt);
402 app = application_lookup (mp->client_index);
406 clib_memset (a, 0, sizeof (*a));
407 a->app_index = app->app_index;
409 a->wrk_map_index = mp->wrk_index;
411 if ((rv = vnet_unlisten (a)))
412 session_worker_stat_error_inc (wrk, rv, 1);
414 app_wrk = application_get_worker (app, a->wrk_map_index);
418 app_worker_unlisten_reply (app_wrk, sh, mp->context, rv);
422 session_mq_accepted_reply_handler (session_worker_t *wrk,
423 session_evt_elt_t *elt)
425 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
426 session_accepted_reply_msg_t *mp;
427 session_state_t old_state;
428 app_worker_t *app_wrk;
431 mp = session_evt_ctrl_data (wrk, elt);
433 /* Mail this back from the main thread. We're not polling in main
434 * thread so we're using other workers for notifications. */
435 if (session_thread_from_handle (mp->handle) == 0 && vlib_num_workers () &&
436 vlib_get_thread_index () != 0)
438 session_wrk_send_evt_to_main (wrk, elt);
442 s = session_get_from_handle_if_valid (mp->handle);
446 app_wrk = app_worker_get (s->app_wrk_index);
447 if (app_wrk->app_index != mp->context)
449 clib_warning ("app doesn't own session");
453 /* Server isn't interested, disconnect the session */
456 a->app_index = mp->context;
457 a->handle = mp->handle;
458 vnet_disconnect_session (a);
462 /* Special handling for cut-through sessions */
463 if (!session_has_transport (s))
465 session_set_state (s, SESSION_STATE_READY);
466 ct_session_connect_notify (s, SESSION_E_NONE);
470 old_state = s->session_state;
471 session_set_state (s, SESSION_STATE_READY);
473 if (!svm_fifo_is_empty_prod (s->rx_fifo))
474 app_worker_rx_notify (app_wrk, s);
476 /* Closed while waiting for app to reply. Resend disconnect */
477 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
479 app_worker_close_notify (app_wrk, s);
480 session_set_state (s, old_state);
486 session_mq_reset_reply_handler (void *data)
488 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
489 session_reset_reply_msg_t *mp;
490 app_worker_t *app_wrk;
493 u32 index, thread_index;
495 mp = (session_reset_reply_msg_t *) data;
496 app = application_lookup (mp->context);
500 session_parse_handle (mp->handle, &index, &thread_index);
501 s = session_get_if_valid (index, thread_index);
503 /* No session or not the right session */
504 if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
507 app_wrk = app_worker_get (s->app_wrk_index);
508 if (!app_wrk || app_wrk->app_index != app->app_index)
510 clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
515 /* Client objected to resetting the session, log and continue */
518 clib_warning ("client retval %d", mp->retval);
522 /* This comes as a response to a reset, transport only waiting for
523 * confirmation to remove connection state, no need to disconnect */
524 a->handle = mp->handle;
525 a->app_index = app->app_index;
526 vnet_disconnect_session (a);
530 session_mq_disconnected_handler (void *data)
532 session_disconnected_reply_msg_t *rmp;
533 vnet_disconnect_args_t _a, *a = &_a;
534 svm_msg_q_msg_t _msg, *msg = &_msg;
535 session_disconnected_msg_t *mp;
536 app_worker_t *app_wrk;
537 session_event_t *evt;
542 mp = (session_disconnected_msg_t *) data;
543 if (!(s = session_get_from_handle_if_valid (mp->handle)))
545 clib_warning ("could not disconnect handle %llu", mp->handle);
548 app_wrk = app_worker_get (s->app_wrk_index);
549 app = application_lookup (mp->client_index);
550 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
552 clib_warning ("could not disconnect session: %llu app: %u",
553 mp->handle, mp->client_index);
557 a->handle = mp->handle;
558 a->app_index = app_wrk->wrk_index;
559 rv = vnet_disconnect_session (a);
561 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
562 SESSION_MQ_CTRL_EVT_RING,
564 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
565 clib_memset (evt, 0, sizeof (*evt));
566 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
567 rmp = (session_disconnected_reply_msg_t *) evt->data;
568 rmp->handle = mp->handle;
569 rmp->context = mp->context;
571 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
575 session_mq_disconnected_reply_handler (void *data)
577 session_disconnected_reply_msg_t *mp;
578 vnet_disconnect_args_t _a, *a = &_a;
581 mp = (session_disconnected_reply_msg_t *) data;
583 /* Client objected to disconnecting the session, log and continue */
586 clib_warning ("client retval %d", mp->retval);
590 /* Disconnect has been confirmed. Confirm close to transport */
591 app = application_lookup (mp->context);
594 a->handle = mp->handle;
595 a->app_index = app->app_index;
596 vnet_disconnect_session (a);
601 session_mq_worker_update_handler (void *data)
603 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
604 session_worker_update_reply_msg_t *rmp;
605 svm_msg_q_msg_t _msg, *msg = &_msg;
606 app_worker_t *app_wrk;
607 u32 owner_app_wrk_map;
608 session_event_t *evt;
613 app = application_lookup (mp->client_index);
616 if (!(s = session_get_from_handle_if_valid (mp->handle)))
618 clib_warning ("invalid handle %llu", mp->handle);
621 app_wrk = app_worker_get (s->app_wrk_index);
622 if (app_wrk->app_index != app->app_index)
624 clib_warning ("app %u does not own session %llu", app->app_index,
628 owner_app_wrk_map = app_wrk->wrk_map_index;
629 app_wrk = application_get_worker (app, mp->wrk_index);
631 /* This needs to come from the new owner */
632 if (mp->req_wrk_index == owner_app_wrk_map)
634 session_req_worker_update_msg_t *wump;
636 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
637 SESSION_MQ_CTRL_EVT_RING,
639 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
640 clib_memset (evt, 0, sizeof (*evt));
641 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
642 wump = (session_req_worker_update_msg_t *) evt->data;
643 wump->session_handle = mp->handle;
644 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
648 rv = app_worker_own_session (app_wrk, s);
650 session_stat_error_inc (rv, 1);
655 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
656 SESSION_MQ_CTRL_EVT_RING,
658 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
659 clib_memset (evt, 0, sizeof (*evt));
660 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
661 rmp = (session_worker_update_reply_msg_t *) evt->data;
662 rmp->handle = mp->handle;
664 rmp->rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
666 rmp->tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
667 rmp->segment_handle = session_segment_handle (s);
668 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
671 * Retransmit messages that may have been lost
673 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
674 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
676 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
677 app_worker_rx_notify (app_wrk, s);
679 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
680 app_worker_close_notify (app_wrk, s);
684 session_mq_app_wrk_rpc_handler (void *data)
686 session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
687 svm_msg_q_msg_t _msg, *msg = &_msg;
688 session_app_wrk_rpc_msg_t *rmp;
689 app_worker_t *app_wrk;
690 session_event_t *evt;
693 app = application_lookup (mp->client_index);
697 app_wrk = application_get_worker (app, mp->wrk_index);
699 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
700 SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
702 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
703 clib_memset (evt, 0, sizeof (*evt));
704 evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
705 rmp = (session_app_wrk_rpc_msg_t *) evt->data;
706 clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
707 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
711 session_mq_transport_attr_handler (void *data)
713 session_transport_attr_msg_t *mp = (session_transport_attr_msg_t *) data;
714 session_transport_attr_reply_msg_t *rmp;
715 svm_msg_q_msg_t _msg, *msg = &_msg;
716 app_worker_t *app_wrk;
717 session_event_t *evt;
722 app = application_lookup (mp->client_index);
726 if (!(s = session_get_from_handle_if_valid (mp->handle)))
728 clib_warning ("invalid handle %llu", mp->handle);
731 app_wrk = app_worker_get (s->app_wrk_index);
732 if (app_wrk->app_index != app->app_index)
734 clib_warning ("app %u does not own session %llu", app->app_index,
739 rv = session_transport_attribute (s, mp->is_get, &mp->attr);
741 svm_msg_q_lock_and_alloc_msg_w_ring (
742 app_wrk->event_queue, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, msg);
743 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
744 clib_memset (evt, 0, sizeof (*evt));
745 evt->event_type = SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY;
746 rmp = (session_transport_attr_reply_msg_t *) evt->data;
747 rmp->handle = mp->handle;
749 rmp->is_get = mp->is_get;
750 if (!rv && mp->is_get)
751 rmp->attr = mp->attr;
752 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
756 session_wrk_handle_evts_main_rpc (void *args)
758 vlib_main_t *vm = vlib_get_main ();
759 clib_llist_index_t ei, next_ei;
760 session_evt_elt_t *he, *elt;
761 session_worker_t *fwrk;
764 vlib_worker_thread_barrier_sync (vm);
766 thread_index = pointer_to_uword (args);
767 fwrk = session_main_get_worker (thread_index);
769 he = clib_llist_elt (fwrk->event_elts, fwrk->evts_pending_main);
770 ei = clib_llist_next_index (he, evt_list);
772 while (ei != fwrk->evts_pending_main)
774 elt = clib_llist_elt (fwrk->event_elts, ei);
775 next_ei = clib_llist_next_index (elt, evt_list);
776 clib_llist_remove (fwrk->event_elts, evt_list, elt);
777 switch (elt->evt.event_type)
779 case SESSION_CTRL_EVT_LISTEN:
780 session_mq_listen_handler (fwrk, elt);
782 case SESSION_CTRL_EVT_UNLISTEN:
783 session_mq_unlisten_handler (fwrk, elt);
785 case SESSION_CTRL_EVT_APP_DETACH:
786 app_mq_detach_handler (fwrk, elt);
788 case SESSION_CTRL_EVT_CONNECT_URI:
789 session_mq_connect_uri_handler (fwrk, elt);
791 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
792 session_mq_accepted_reply_handler (fwrk, elt);
794 case SESSION_CTRL_EVT_CONNECT:
795 session_mq_connect_handler (fwrk, elt);
798 clib_warning ("unhandled %u", elt->evt.event_type);
803 /* Regrab element in case pool moved */
804 elt = clib_llist_elt (fwrk->event_elts, ei);
805 if (!clib_llist_elt_is_linked (elt, evt_list))
807 session_evt_ctrl_data_free (fwrk, elt);
808 clib_llist_put (fwrk->event_elts, elt);
813 vlib_worker_thread_barrier_release (vm);
816 vlib_node_registration_t session_queue_node;
821 u32 server_thread_index;
822 } session_queue_trace_t;
824 /* packet trace format function */
826 format_session_queue_trace (u8 * s, va_list * args)
828 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
829 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
830 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
832 s = format (s, "session index %d thread index %d",
833 t->session_index, t->server_thread_index);
837 #define foreach_session_queue_error \
838 _ (TX, tx, INFO, "Packets transmitted") \
839 _ (TIMER, timer, INFO, "Timer events") \
840 _ (NO_BUFFER, no_buffer, ERROR, "Out of buffers")
844 #define _(f, n, s, d) SESSION_QUEUE_ERROR_##f,
845 foreach_session_queue_error
847 SESSION_QUEUE_N_ERROR,
848 } session_queue_error_t;
850 static vlib_error_desc_t session_error_counters[] = {
851 #define _(f, n, s, d) { #n, d, VL_COUNTER_SEVERITY_##s },
852 foreach_session_queue_error
858 SESSION_TX_NO_BUFFERS = -2,
864 session_tx_trace_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
865 u32 next_index, vlib_buffer_t **bufs, u16 n_segs,
866 session_t *s, u32 n_trace)
868 vlib_buffer_t **b = bufs;
870 while (n_trace && n_segs)
872 if (PREDICT_TRUE (vlib_trace_buffer (vm, node, next_index, b[0],
873 1 /* follow_chain */)))
875 session_queue_trace_t *t =
876 vlib_add_trace (vm, node, b[0], sizeof (*t));
877 t->session_index = s->session_index;
878 t->server_thread_index = s->thread_index;
884 vlib_set_trace_count (vm, node, n_trace);
888 session_tx_fill_dma_transfers (session_worker_t *wrk,
889 session_tx_context_t *ctx, vlib_buffer_t *b)
891 vlib_main_t *vm = wrk->vm;
894 int n_bytes_read, len_write;
895 svm_fifo_seg_t data_fs[2];
900 * Start with the first buffer in chain
903 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
905 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
906 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
908 n_bytes_read = svm_fifo_segments (ctx->s->tx_fifo, ctx->sp.tx_offset,
909 data_fs, &n_segs, len_to_deq);
911 len_write = n_bytes_read;
912 ASSERT (n_bytes_read == len_to_deq);
917 vlib_dma_batch_add (vm, wrk->batch, data0, data_fs[n_transfers].data,
918 data_fs[n_transfers].len);
919 data0 += data_fs[n_transfers].len;
920 n_bytes_read -= data_fs[n_transfers].len;
927 session_tx_fill_dma_transfers_tail (session_worker_t *wrk,
928 session_tx_context_t *ctx,
929 vlib_buffer_t *b, u32 len_to_deq, u8 *data)
931 vlib_main_t *vm = wrk->vm;
932 int n_bytes_read, len_write;
933 svm_fifo_seg_t data_fs[2];
937 n_bytes_read = svm_fifo_segments (ctx->s->tx_fifo, ctx->sp.tx_offset,
938 data_fs, &n_segs, len_to_deq);
940 len_write = n_bytes_read;
942 ASSERT (n_bytes_read == len_to_deq);
947 vlib_dma_batch_add (vm, wrk->batch, data, data_fs[n_transfers].data,
948 data_fs[n_transfers].len);
949 data += data_fs[n_transfers].len;
950 n_bytes_read -= data_fs[n_transfers].len;
958 session_tx_copy_data (session_worker_t *wrk, session_tx_context_t *ctx,
959 vlib_buffer_t *b, u32 len_to_deq, u8 *data0)
962 if (PREDICT_TRUE (!wrk->dma_enabled))
964 svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset, len_to_deq, data0);
966 n_bytes_read = session_tx_fill_dma_transfers (wrk, ctx, b);
971 session_tx_copy_data_tail (session_worker_t *wrk, session_tx_context_t *ctx,
972 vlib_buffer_t *b, u32 len_to_deq, u8 *data)
975 if (PREDICT_TRUE (!wrk->dma_enabled))
977 svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset, len_to_deq, data);
980 session_tx_fill_dma_transfers_tail (wrk, ctx, b, len_to_deq, data);
985 session_tx_fifo_chain_tail (session_worker_t *wrk, session_tx_context_t *ctx,
986 vlib_buffer_t *b, u16 *n_bufs, u8 peek_data)
988 vlib_main_t *vm = wrk->vm;
989 vlib_buffer_t *chain_b, *prev_b;
990 u32 chain_bi0, to_deq, left_from_seg;
991 int len_to_deq, n_bytes_read;
994 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
995 b->total_length_not_including_first_buffer = 0;
998 left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
1000 to_deq = left_from_seg;
1001 for (j = 1; j < ctx->n_bufs_per_seg; j++)
1004 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
1007 chain_bi0 = ctx->tx_buffers[*n_bufs];
1008 chain_b = vlib_get_buffer (vm, chain_bi0);
1009 chain_b->current_data = 0;
1010 data = vlib_buffer_get_current (chain_b);
1014 session_tx_copy_data_tail (wrk, ctx, b, len_to_deq, data);
1015 ctx->sp.tx_offset += n_bytes_read;
1019 if (ctx->transport_vft->transport_options.tx_type ==
1022 svm_fifo_t *f = ctx->s->tx_fifo;
1023 session_dgram_hdr_t *hdr = &ctx->hdr;
1027 deq_now = clib_min (hdr->data_length - hdr->data_offset,
1029 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
1030 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data);
1031 ASSERT (n_bytes_read > 0);
1033 hdr->data_offset += n_bytes_read;
1034 if (hdr->data_offset == hdr->data_length)
1036 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
1037 svm_fifo_dequeue_drop (f, offset);
1038 if (ctx->left_to_snd > n_bytes_read)
1039 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1042 else if (ctx->left_to_snd == n_bytes_read)
1043 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
1044 sizeof (session_dgram_pre_hdr_t));
1047 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
1050 ASSERT (n_bytes_read == len_to_deq);
1051 chain_b->current_length = n_bytes_read;
1052 b->total_length_not_including_first_buffer += chain_b->current_length;
1054 /* update previous buffer */
1055 prev_b->next_buffer = chain_bi0;
1056 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1058 /* update current buffer */
1059 chain_b->next_buffer = 0;
1061 to_deq -= n_bytes_read;
1066 && b->total_length_not_including_first_buffer == left_from_seg);
1067 ctx->left_to_snd -= left_from_seg;
1071 session_tx_fill_buffer (session_worker_t *wrk, session_tx_context_t *ctx,
1072 vlib_buffer_t *b, u16 *n_bufs, u8 peek_data)
1078 * Start with the first buffer in chain
1081 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
1082 b->current_data = 0;
1084 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
1085 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
1089 n_bytes_read = session_tx_copy_data (wrk, ctx, b, len_to_deq, data0);
1090 ASSERT (n_bytes_read > 0);
1091 /* Keep track of progress locally, transport is also supposed to
1092 * increment it independently when pushing the header */
1093 ctx->sp.tx_offset += n_bytes_read;
1097 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1099 session_dgram_hdr_t *hdr = &ctx->hdr;
1100 svm_fifo_t *f = ctx->s->tx_fifo;
1104 ASSERT (hdr->data_length > hdr->data_offset);
1105 deq_now = clib_min (hdr->data_length - hdr->data_offset,
1107 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
1108 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
1109 ASSERT (n_bytes_read > 0);
1111 if (transport_connection_is_cless (ctx->tc))
1113 clib_memcpy_fast (data0 - sizeof (session_dgram_hdr_t), hdr,
1116 hdr->data_offset += n_bytes_read;
1117 if (hdr->data_offset == hdr->data_length)
1119 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
1120 svm_fifo_dequeue_drop (f, offset);
1121 if (ctx->left_to_snd > n_bytes_read)
1122 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1125 else if (ctx->left_to_snd == n_bytes_read)
1126 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
1127 sizeof (session_dgram_pre_hdr_t));
1131 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
1133 ASSERT (n_bytes_read > 0);
1137 b->current_length = n_bytes_read;
1138 ctx->left_to_snd -= n_bytes_read;
1141 * Fill in the remaining buffers in the chain, if any
1143 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
1144 session_tx_fifo_chain_tail (wrk, ctx, b, n_bufs, peek_data);
1148 session_tx_not_ready (session_t * s, u8 peek_data)
1152 if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
1154 /* Can retransmit for closed sessions but can't send new data if
1155 * session is not ready or closed */
1156 else if (s->session_state < SESSION_STATE_READY)
1158 /* Allow accepting session to send custom packets.
1159 * For instance, tcp want to send acks in established, but
1160 * the app has not called accept() yet */
1161 if (s->session_state == SESSION_STATE_ACCEPTING &&
1162 (s->flags & SESSION_F_CUSTOM_TX))
1166 else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1168 /* Allow closed transports to still send custom packets.
1169 * For instance, tcp may want to send acks in time-wait. */
1170 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
1171 && (s->flags & SESSION_F_CUSTOM_TX))
1178 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1184 always_inline transport_connection_t *
1185 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
1189 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1190 ctx->s->thread_index);
1194 if (ctx->s->session_state == SESSION_STATE_LISTENING)
1195 return ctx->transport_vft->get_listener (ctx->s->connection_index);
1198 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1199 ctx->s->thread_index);
1205 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
1206 u32 max_segs, u8 peek_data)
1208 u32 n_bytes_per_buf, n_bytes_per_seg;
1210 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
1211 ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
1215 /* Offset in rx fifo from where to peek data */
1216 if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
1218 ctx->max_len_to_snd = 0;
1221 ctx->max_dequeue -= ctx->sp.tx_offset;
1225 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1227 u32 len, chain_limit;
1229 if (ctx->max_dequeue <= sizeof (ctx->hdr))
1231 ctx->max_len_to_snd = 0;
1235 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1237 /* Zero length dgrams not supported */
1238 if (PREDICT_FALSE (ctx->hdr.data_length == 0))
1240 svm_fifo_dequeue_drop (ctx->s->tx_fifo, sizeof (ctx->hdr));
1241 ctx->max_len_to_snd = 0;
1244 /* We cannot be sure apps have not enqueued incomplete dgrams */
1245 if (PREDICT_FALSE (ctx->max_dequeue <
1246 ctx->hdr.data_length + sizeof (ctx->hdr)))
1248 ctx->max_len_to_snd = 0;
1251 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
1252 len = ctx->hdr.data_length - ctx->hdr.data_offset;
1254 if (ctx->hdr.gso_size)
1256 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, ctx->hdr.gso_size);
1259 /* Process multiple dgrams if smaller than min (buf_space, mss).
1260 * This avoids handling multiple dgrams if they require buffer
1262 chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
1264 if (ctx->hdr.data_length <= chain_limit)
1266 u32 first_dgram_len, dgram_len, offset, max_offset;
1267 session_dgram_hdr_t hdr;
1269 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
1270 offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
1271 first_dgram_len = len;
1272 max_offset = clib_min (ctx->max_dequeue, 16 << 10);
1274 while (offset < max_offset)
1276 svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
1278 dgram_len = hdr.data_length - hdr.data_offset;
1279 if (offset + sizeof (hdr) + hdr.data_length >
1281 first_dgram_len != dgram_len)
1283 /* Assert here to allow test above with zero length dgrams */
1284 ASSERT (hdr.data_length > hdr.data_offset);
1286 offset += sizeof (hdr) + hdr.data_length;
1290 ctx->max_dequeue = len;
1293 ASSERT (ctx->max_dequeue > 0);
1295 /* Ensure we're not writing more than transport window allows */
1296 if (ctx->max_dequeue < ctx->sp.snd_space)
1298 /* Constrained by tx queue. Try to send only fully formed segments */
1299 ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
1300 (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
1306 /* Expectation is that snd_space0 is already a multiple of snd_mss */
1307 ctx->max_len_to_snd = ctx->sp.snd_space;
1310 /* Check if we're tx constrained by the node */
1311 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
1312 if (ctx->n_segs_per_evt > max_segs)
1314 ctx->n_segs_per_evt = max_segs;
1315 ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
1318 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
1319 if (ctx->n_segs_per_evt > 1)
1321 u32 n_bytes_last_seg, n_bufs_last_seg;
1323 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
1324 n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
1325 - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
1326 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1327 n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
1328 ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
1333 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
1334 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1335 ctx->n_bufs_needed = ctx->n_bufs_per_seg;
1338 ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
1339 ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
1341 TRANSPORT_MAX_HDRS_LEN);
1345 session_tx_maybe_reschedule (session_worker_t * wrk,
1346 session_tx_context_t * ctx,
1347 session_evt_elt_t * elt)
1349 session_t *s = ctx->s;
1351 svm_fifo_unset_event (s->tx_fifo);
1352 if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
1354 if (svm_fifo_set_event (s->tx_fifo))
1355 session_evt_add_head_old (wrk, elt);
1359 transport_connection_deschedule (ctx->tc);
1364 session_tx_add_pending_buffer (session_worker_t *wrk, u32 bi, u32 next_index)
1366 if (PREDICT_TRUE (!wrk->dma_enabled))
1368 vec_add1 (wrk->pending_tx_buffers, bi);
1369 vec_add1 (wrk->pending_tx_nexts, next_index);
1373 session_dma_transfer *dma_transfer = &wrk->dma_trans[wrk->trans_tail];
1374 vec_add1 (dma_transfer->pending_tx_buffers, bi);
1375 vec_add1 (dma_transfer->pending_tx_nexts, next_index);
1380 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
1381 vlib_node_runtime_t * node,
1382 session_evt_elt_t * elt,
1383 int *n_tx_packets, u8 peek_data)
1385 u32 n_trace, n_left, pbi, next_index, max_burst;
1386 session_tx_context_t *ctx = &wrk->ctx;
1387 session_main_t *smm = &session_main;
1388 session_event_t *e = &elt->evt;
1389 vlib_main_t *vm = wrk->vm;
1390 transport_proto_t tp;
1394 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
1397 session_evt_add_old (wrk, elt);
1398 return SESSION_TX_NO_DATA;
1401 next_index = smm->session_type_to_next[ctx->s->session_type];
1402 max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
1404 tp = session_get_transport_proto (ctx->s);
1405 ctx->transport_vft = transport_protocol_get_vft (tp);
1406 ctx->tc = session_tx_get_transport (ctx, peek_data);
1408 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
1410 if (ctx->transport_vft->flush_data)
1411 ctx->transport_vft->flush_data (ctx->tc);
1412 e->event_type = SESSION_IO_EVT_TX;
1415 if (ctx->s->flags & SESSION_F_CUSTOM_TX)
1418 ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
1419 ctx->sp.max_burst_size = max_burst;
1420 n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
1421 *n_tx_packets += n_custom_tx;
1423 (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1424 return SESSION_TX_OK;
1425 max_burst -= n_custom_tx;
1426 if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
1428 session_evt_add_old (wrk, elt);
1429 return SESSION_TX_OK;
1433 /* Connection previously descheduled because it had no data to send.
1434 * Clear descheduled flag and reset pacer if in use */
1435 if (transport_connection_is_descheduled (ctx->tc))
1436 transport_connection_clear_descheduled (ctx->tc);
1438 transport_connection_snd_params (ctx->tc, &ctx->sp);
1440 if (!ctx->sp.snd_space)
1442 /* If the deschedule flag was set, remove session from scheduler.
1443 * Transport is responsible for rescheduling this session. */
1444 if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
1445 transport_connection_deschedule (ctx->tc);
1446 /* Request to postpone the session, e.g., zero-wnd and transport
1447 * is not currently probing */
1448 else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
1449 session_evt_add_old (wrk, elt);
1450 /* This flow queue is "empty" so it should be re-evaluated before
1451 * the ones that have data to send. */
1453 session_evt_add_head_old (wrk, elt);
1455 return SESSION_TX_NO_DATA;
1458 if (transport_connection_is_tx_paced (ctx->tc))
1460 u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1461 if (snd_space < TRANSPORT_PACER_MIN_BURST)
1463 session_evt_add_head_old (wrk, elt);
1464 return SESSION_TX_NO_DATA;
1466 snd_space = clib_min (ctx->sp.snd_space, snd_space);
1467 ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1468 snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1471 /* Check how much we can pull. */
1472 session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1474 if (PREDICT_FALSE (!ctx->max_len_to_snd))
1476 transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1477 session_tx_maybe_reschedule (wrk, ctx, elt);
1478 return SESSION_TX_NO_DATA;
1481 vec_validate_aligned (ctx->tx_buffers, ctx->n_bufs_needed - 1,
1482 CLIB_CACHE_LINE_BYTES);
1483 n_bufs = vlib_buffer_alloc (vm, ctx->tx_buffers, ctx->n_bufs_needed);
1484 if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1487 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1488 session_evt_add_head_old (wrk, elt);
1489 vlib_node_increment_counter (wrk->vm, node->node_index,
1490 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1491 return SESSION_TX_NO_BUFFERS;
1494 if (transport_connection_is_tx_paced (ctx->tc))
1495 transport_connection_tx_pacer_update_bytes (ctx->tc, ctx->max_len_to_snd);
1497 ctx->left_to_snd = ctx->max_len_to_snd;
1498 n_left = ctx->n_segs_per_evt;
1500 vec_validate (ctx->transport_pending_bufs, n_left);
1504 vlib_buffer_t *b0, *b1;
1507 pbi = ctx->tx_buffers[n_bufs - 3];
1508 pb = vlib_get_buffer (vm, pbi);
1509 vlib_prefetch_buffer_header (pb, STORE);
1510 pbi = ctx->tx_buffers[n_bufs - 4];
1511 pb = vlib_get_buffer (vm, pbi);
1512 vlib_prefetch_buffer_header (pb, STORE);
1514 bi0 = ctx->tx_buffers[--n_bufs];
1515 bi1 = ctx->tx_buffers[--n_bufs];
1517 b0 = vlib_get_buffer (vm, bi0);
1518 b1 = vlib_get_buffer (vm, bi1);
1520 session_tx_fill_buffer (wrk, ctx, b0, &n_bufs, peek_data);
1521 session_tx_fill_buffer (wrk, ctx, b1, &n_bufs, peek_data);
1523 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1524 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left + 1] = b1;
1527 session_tx_add_pending_buffer (wrk, bi0, next_index);
1528 session_tx_add_pending_buffer (wrk, bi1, next_index);
1537 pbi = ctx->tx_buffers[n_bufs - 2];
1538 pb = vlib_get_buffer (vm, pbi);
1539 vlib_prefetch_buffer_header (pb, STORE);
1542 bi0 = ctx->tx_buffers[--n_bufs];
1543 b0 = vlib_get_buffer (vm, bi0);
1544 session_tx_fill_buffer (wrk, ctx, b0, &n_bufs, peek_data);
1546 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1549 session_tx_add_pending_buffer (wrk, bi0, next_index);
1552 /* Ask transport to push headers */
1553 ctx->transport_vft->push_header (ctx->tc, ctx->transport_pending_bufs,
1554 ctx->n_segs_per_evt);
1556 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1557 session_tx_trace_frame (vm, node, next_index, ctx->transport_pending_bufs,
1558 ctx->n_segs_per_evt, ctx->s, n_trace);
1560 if (PREDICT_FALSE (n_bufs))
1561 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1563 *n_tx_packets += ctx->n_segs_per_evt;
1565 SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1566 ctx->s->tx_fifo->shr->has_event, wrk->last_vlib_time);
1568 ASSERT (ctx->left_to_snd == 0);
1570 /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1571 * check if application enqueued more data and reschedule accordingly */
1572 if (ctx->max_len_to_snd < ctx->max_dequeue)
1573 session_evt_add_old (wrk, elt);
1575 session_tx_maybe_reschedule (wrk, ctx, elt);
1579 u32 n_dequeued = ctx->max_len_to_snd;
1580 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1581 n_dequeued += ctx->n_segs_per_evt * SESSION_CONN_HDR_LEN;
1582 if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, n_dequeued))
1583 session_dequeue_notify (ctx->s);
1585 return SESSION_TX_OK;
1589 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1590 vlib_node_runtime_t * node,
1591 session_evt_elt_t * e, int *n_tx_packets)
1593 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1597 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1598 vlib_node_runtime_t * node,
1599 session_evt_elt_t * e, int *n_tx_packets)
1601 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1605 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1606 vlib_node_runtime_t * node,
1607 session_evt_elt_t * elt, int *n_tx_packets)
1609 transport_send_params_t *sp = &wrk->ctx.sp;
1610 session_t *s = wrk->ctx.s;
1611 clib_llist_index_t ei;
1614 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1617 /* Clear custom-tx flag used to request reschedule for tx */
1618 s->flags &= ~SESSION_F_CUSTOM_TX;
1621 sp->bytes_dequeued = 0;
1622 sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1623 TRANSPORT_PACER_MAX_BURST_PKTS);
1625 /* Grab elt index since app transports can enqueue events on tx */
1626 ei = clib_llist_entry_index (wrk->event_elts, elt);
1628 n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1629 *n_tx_packets += n_packets;
1631 elt = clib_llist_elt (wrk->event_elts, ei);
1633 if (s->flags & SESSION_F_CUSTOM_TX)
1635 session_evt_add_old (wrk, elt);
1637 else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1639 svm_fifo_unset_event (s->tx_fifo);
1640 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1641 if (svm_fifo_set_event (s->tx_fifo))
1642 session_evt_add_head_old (wrk, elt);
1645 if (sp->bytes_dequeued &&
1646 svm_fifo_needs_deq_ntf (s->tx_fifo, sp->bytes_dequeued))
1647 session_dequeue_notify (s);
1652 always_inline session_t *
1653 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1655 if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1658 ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1659 return pool_elt_at_index (wrk->sessions, e->session_index);
1663 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1665 clib_llist_index_t ei;
1666 void (*fp) (void *);
1670 ei = clib_llist_entry_index (wrk->event_elts, elt);
1673 switch (e->event_type)
1675 case SESSION_CTRL_EVT_RPC:
1676 fp = e->rpc_args.fp;
1677 (*fp) (e->rpc_args.arg);
1679 case SESSION_CTRL_EVT_HALF_CLOSE:
1680 s = session_get_from_handle_if_valid (e->session_handle);
1681 if (PREDICT_FALSE (!s))
1683 session_transport_half_close (s);
1685 case SESSION_CTRL_EVT_CLOSE:
1686 s = session_get_from_handle_if_valid (e->session_handle);
1687 if (PREDICT_FALSE (!s))
1689 session_transport_close (s);
1691 case SESSION_CTRL_EVT_RESET:
1692 s = session_get_from_handle_if_valid (e->session_handle);
1693 if (PREDICT_FALSE (!s))
1695 session_transport_reset (s);
1697 case SESSION_CTRL_EVT_LISTEN:
1698 session_mq_listen_handler (wrk, elt);
1700 case SESSION_CTRL_EVT_LISTEN_URI:
1701 session_mq_listen_uri_handler (wrk, elt);
1703 case SESSION_CTRL_EVT_UNLISTEN:
1704 session_mq_unlisten_handler (wrk, elt);
1706 case SESSION_CTRL_EVT_CONNECT:
1707 session_mq_connect_handler (wrk, elt);
1709 case SESSION_CTRL_EVT_CONNECT_URI:
1710 session_mq_connect_uri_handler (wrk, elt);
1712 case SESSION_CTRL_EVT_SHUTDOWN:
1713 session_mq_shutdown_handler (session_evt_ctrl_data (wrk, elt));
1715 case SESSION_CTRL_EVT_DISCONNECT:
1716 session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1718 case SESSION_CTRL_EVT_DISCONNECTED:
1719 session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1721 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1722 session_mq_accepted_reply_handler (wrk, elt);
1724 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1725 session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1728 case SESSION_CTRL_EVT_RESET_REPLY:
1729 session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1731 case SESSION_CTRL_EVT_WORKER_UPDATE:
1732 session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1734 case SESSION_CTRL_EVT_APP_DETACH:
1735 app_mq_detach_handler (wrk, elt);
1737 case SESSION_CTRL_EVT_APP_WRK_RPC:
1738 session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1740 case SESSION_CTRL_EVT_TRANSPORT_ATTR:
1741 session_mq_transport_attr_handler (session_evt_ctrl_data (wrk, elt));
1744 clib_warning ("unhandled event type %d", e->event_type);
1747 /* Regrab elements in case pool moved */
1748 elt = clib_llist_elt (wrk->event_elts, ei);
1749 if (!clib_llist_elt_is_linked (elt, evt_list))
1752 if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1753 session_evt_ctrl_data_free (wrk, elt);
1754 clib_llist_put (wrk->event_elts, elt);
1756 SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1760 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1761 session_evt_elt_t * elt, int *n_tx_packets)
1763 session_main_t *smm = &session_main;
1764 app_worker_t *app_wrk;
1765 clib_llist_index_t ei;
1769 ei = clib_llist_entry_index (wrk->event_elts, elt);
1772 switch (e->event_type)
1774 case SESSION_IO_EVT_TX_FLUSH:
1775 case SESSION_IO_EVT_TX:
1776 s = session_event_get_session (wrk, e);
1777 if (PREDICT_FALSE (!s))
1779 CLIB_PREFETCH (s->tx_fifo, sizeof (*(s->tx_fifo)), LOAD);
1781 /* Spray packets in per session type frames, since they go to
1782 * different nodes */
1783 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1785 case SESSION_IO_EVT_RX:
1786 s = session_event_get_session (wrk, e);
1789 transport_app_rx_evt (session_get_transport_proto (s),
1790 s->connection_index, s->thread_index);
1792 case SESSION_IO_EVT_BUILTIN_RX:
1793 s = session_event_get_session (wrk, e);
1794 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1796 svm_fifo_unset_event (s->rx_fifo);
1797 app_wrk = app_worker_get (s->app_wrk_index);
1798 app_worker_rx_notify (app_wrk, s);
1800 case SESSION_IO_EVT_TX_MAIN:
1801 s = session_get_if_valid (e->session_index, 0 /* main thread */);
1802 if (PREDICT_FALSE (!s))
1805 if (PREDICT_TRUE (s != 0))
1806 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1809 clib_warning ("unhandled event type %d", e->event_type);
1812 SESSION_EVT (SESSION_EVT_IO_EVT_COUNTS, e->event_type, 1, wrk);
1814 /* Regrab elements in case pool moved */
1815 elt = clib_llist_elt (wrk->event_elts, ei);
1816 if (!clib_llist_elt_is_linked (elt, evt_list))
1817 clib_llist_put (wrk->event_elts, elt);
1821 static const u32 session_evt_msg_sizes[] = {
1822 #define _(symc, sym) \
1823 [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1824 foreach_session_ctrl_evt
1830 session_update_time_subscribers (session_main_t *smm, clib_time_type_t now,
1833 session_update_time_fn *fn;
1835 vec_foreach (fn, smm->update_time_fns)
1836 (*fn) (now, thread_index);
1840 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1842 session_evt_elt_t *elt;
1844 if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1846 elt = session_evt_alloc_ctrl (wrk);
1847 if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1849 elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1850 elt->evt.event_type = evt->event_type;
1851 clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1852 session_evt_msg_sizes[evt->event_type]);
1856 /* Internal control events fit into io events footprint */
1857 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1862 elt = session_evt_alloc_new (wrk);
1863 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1868 session_flush_pending_tx_buffers (session_worker_t * wrk,
1869 vlib_node_runtime_t * node)
1871 vlib_buffer_enqueue_to_next_vec (wrk->vm, node, &wrk->pending_tx_buffers,
1872 &wrk->pending_tx_nexts,
1873 vec_len (wrk->pending_tx_nexts));
1874 vec_reset_length (wrk->pending_tx_buffers);
1875 vec_reset_length (wrk->pending_tx_nexts);
1879 session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq)
1881 svm_msg_q_msg_t _msg, *msg = &_msg;
1882 u32 i, n_to_dequeue = 0;
1883 session_event_t *evt;
1885 n_to_dequeue = svm_msg_q_size (mq);
1886 for (i = 0; i < n_to_dequeue; i++)
1888 svm_msg_q_sub_raw (mq, msg);
1889 evt = svm_msg_q_msg_data (mq, msg);
1890 session_evt_add_to_list (wrk, evt);
1891 svm_msg_q_free_msg (mq, msg);
1894 return n_to_dequeue;
1898 session_wrk_update_state (session_worker_t *wrk)
1900 vlib_main_t *vm = wrk->vm;
1902 if (wrk->state == SESSION_WRK_POLLING)
1904 if (clib_llist_elts (wrk->event_elts) == 5 &&
1905 vlib_last_vectors_per_main_loop (vm) < 1)
1907 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1908 vlib_node_set_state (vm, session_queue_node.index,
1909 VLIB_NODE_STATE_INTERRUPT);
1912 else if (wrk->state == SESSION_WRK_INTERRUPT)
1914 if (clib_llist_elts (wrk->event_elts) > 5 ||
1915 vlib_last_vectors_per_main_loop (vm) > 1)
1917 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
1918 vlib_node_set_state (vm, session_queue_node.index,
1919 VLIB_NODE_STATE_POLLING);
1921 else if (PREDICT_FALSE (!pool_elts (wrk->sessions)))
1923 session_wrk_set_state (wrk, SESSION_WRK_IDLE);
1928 if (clib_llist_elts (wrk->event_elts))
1930 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1936 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1937 vlib_frame_t * frame)
1939 u32 thread_index = vm->thread_index, __clib_unused n_evts;
1940 session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1941 session_main_t *smm = vnet_get_session_main ();
1942 session_worker_t *wrk = &smm->wrk[thread_index];
1943 clib_llist_index_t ei, next_ei, old_ti;
1946 SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1948 session_wrk_update_time (wrk, vlib_time_now (vm));
1951 * Update transport time
1953 session_update_time_subscribers (smm, wrk->last_vlib_time, thread_index);
1954 n_tx_packets = vec_len (wrk->pending_tx_buffers);
1955 SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1957 if (PREDICT_FALSE (wrk->dma_enabled))
1959 if (wrk->trans_head == ((wrk->trans_tail + 1) & (wrk->trans_size - 1)))
1961 wrk->batch = vlib_dma_batch_new (vm, wrk->config_index);
1967 * Dequeue new internal mq events
1970 n_evts = session_wrk_handle_mq (wrk, wrk->vpp_event_queue);
1971 SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_evts);
1974 * Handle control events
1977 ei = wrk->ctrl_head;
1978 ctrl_he = clib_llist_elt (wrk->event_elts, ei);
1979 next_ei = clib_llist_next_index (ctrl_he, evt_list);
1980 old_ti = clib_llist_prev_index (ctrl_he, evt_list);
1981 while (ei != old_ti)
1984 elt = clib_llist_elt (wrk->event_elts, next_ei);
1985 next_ei = clib_llist_next_index (elt, evt_list);
1986 clib_llist_remove (wrk->event_elts, evt_list, elt);
1987 session_event_dispatch_ctrl (wrk, elt);
1990 SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1993 * Handle the new io events.
1996 new_he = clib_llist_elt (wrk->event_elts, wrk->new_head);
1997 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1998 old_ti = clib_llist_prev_index (old_he, evt_list);
2000 ei = clib_llist_next_index (new_he, evt_list);
2001 while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
2003 elt = clib_llist_elt (wrk->event_elts, ei);
2004 ei = clib_llist_next_index (elt, evt_list);
2005 clib_llist_remove (wrk->event_elts, evt_list, elt);
2006 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
2009 SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
2012 * Handle the old io events, if we had any prior to processing the new ones
2015 if (old_ti != wrk->old_head)
2017 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
2018 ei = clib_llist_next_index (old_he, evt_list);
2020 while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
2022 elt = clib_llist_elt (wrk->event_elts, ei);
2023 next_ei = clib_llist_next_index (elt, evt_list);
2024 clib_llist_remove (wrk->event_elts, evt_list, elt);
2026 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
2035 if (PREDICT_FALSE (wrk->dma_enabled))
2039 vlib_dma_batch_set_cookie (vm, wrk->batch, wrk->trans_tail);
2042 if (wrk->trans_tail == wrk->trans_size)
2043 wrk->trans_tail = 0;
2046 vlib_dma_batch_submit (vm, wrk->batch);
2049 SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
2051 if (vec_len (wrk->pending_tx_buffers))
2052 session_flush_pending_tx_buffers (wrk, node);
2054 vlib_node_increment_counter (vm, session_queue_node.index,
2055 SESSION_QUEUE_ERROR_TX, n_tx_packets);
2057 SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
2059 if (wrk->flags & SESSION_WRK_F_ADAPTIVE)
2060 session_wrk_update_state (wrk);
2062 return n_tx_packets;
2066 VLIB_REGISTER_NODE (session_queue_node) = {
2067 .function = session_queue_node_fn,
2068 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
2069 .name = "session-queue",
2070 .format_trace = format_session_queue_trace,
2071 .type = VLIB_NODE_TYPE_INPUT,
2072 .n_errors = SESSION_QUEUE_N_ERROR,
2073 .error_counters = session_error_counters,
2074 .state = VLIB_NODE_STATE_DISABLED,
2078 static clib_error_t *
2079 session_wrk_tfd_read_ready (clib_file_t *cf)
2081 session_worker_t *wrk = session_main_get_worker (cf->private_data);
2085 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
2086 rv = read (wrk->timerfd, &buf, sizeof (buf));
2087 if (rv < 0 && errno != EAGAIN)
2088 clib_unix_warning ("failed");
2092 static clib_error_t *
2093 session_wrk_tfd_write_ready (clib_file_t *cf)
2099 session_wrk_enable_adaptive_mode (session_worker_t *wrk)
2101 u32 thread_index = wrk->vm->thread_index;
2102 clib_file_t template = { 0 };
2104 if ((wrk->timerfd = timerfd_create (CLOCK_MONOTONIC, TFD_NONBLOCK)) < 0)
2105 clib_warning ("timerfd_create");
2107 template.read_function = session_wrk_tfd_read_ready;
2108 template.write_function = session_wrk_tfd_write_ready;
2109 template.file_descriptor = wrk->timerfd;
2110 template.private_data = thread_index;
2111 template.polling_thread_index = thread_index;
2112 template.description = format (0, "session-wrk-tfd-%u", thread_index);
2114 wrk->timerfd_file = clib_file_add (&file_main, &template);
2115 wrk->flags |= SESSION_WRK_F_ADAPTIVE;
2118 static clib_error_t *
2119 session_queue_exit (vlib_main_t * vm)
2121 if (vlib_get_n_threads () < 2)
2125 * Shut off (especially) worker-thread session nodes.
2126 * Otherwise, vpp can crash as the main thread unmaps the
2129 vlib_worker_thread_barrier_sync (vm);
2130 session_node_enable_disable (0 /* is_enable */ );
2131 vlib_worker_thread_barrier_release (vm);
2135 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
2138 session_queue_run_on_main (vlib_main_t * vm)
2140 vlib_node_runtime_t *node;
2142 node = vlib_node_get_runtime (vm, session_queue_node.index);
2143 return session_queue_node_fn (vm, node, 0);
2147 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
2150 uword *event_data = 0;
2156 vlib_process_wait_for_event_or_clock (vm, timeout);
2157 event_type = vlib_process_get_events (vm, (uword **) & event_data);
2161 case SESSION_Q_PROCESS_RUN_ON_MAIN:
2162 /* Run session queue node on main thread */
2163 session_queue_run_on_main (vm);
2165 case SESSION_Q_PROCESS_STOP:
2166 vlib_node_set_state (vm, session_queue_process_node.index,
2167 VLIB_NODE_STATE_DISABLED);
2171 /* Timed out. Run on main to ensure all events are handled */
2172 session_queue_run_on_main (vm);
2175 vec_reset_length (event_data);
2181 VLIB_REGISTER_NODE (session_queue_process_node) =
2183 .function = session_queue_process,
2184 .type = VLIB_NODE_TYPE_PROCESS,
2185 .name = "session-queue-process",
2186 .state = VLIB_NODE_STATE_DISABLED,
2190 static_always_inline uword
2191 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2192 vlib_frame_t * frame)
2194 session_main_t *sm = &session_main;
2195 if (!sm->wrk[0].vpp_event_queue)
2197 node = vlib_node_get_runtime (vm, session_queue_node.index);
2198 return session_queue_node_fn (vm, node, frame);
2202 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
2204 .function = session_queue_pre_input_inline,
2205 .type = VLIB_NODE_TYPE_PRE_INPUT,
2206 .name = "session-queue-main",
2207 .state = VLIB_NODE_STATE_DISABLED,
2212 * fd.io coding-style-patch-verification: ON
2215 * eval: (c-set-style "gnu")