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 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;
181 session_worker_t *wrk;
185 app = application_lookup (mp->client_index);
189 clib_memset (a, 0, sizeof (*a));
190 a->sep.is_ip4 = mp->is_ip4;
191 clib_memcpy_fast (&a->sep.ip, &mp->ip, sizeof (mp->ip));
192 a->sep.port = mp->port;
193 a->sep.transport_proto = mp->proto;
194 a->sep.peer.fib_index = mp->vrf;
195 a->sep.dscp = mp->dscp;
196 clib_memcpy_fast (&a->sep.peer.ip, &mp->lcl_ip, sizeof (mp->lcl_ip));
199 ip46_address_mask_ip4 (&a->sep.ip);
200 ip46_address_mask_ip4 (&a->sep.peer.ip);
202 a->sep.peer.port = mp->lcl_port;
203 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
204 a->sep_ext.parent_handle = mp->parent_handle;
205 a->sep_ext.transport_flags = mp->flags;
206 a->api_context = mp->context;
207 a->app_index = app->app_index;
208 a->wrk_map_index = mp->wrk_index;
211 a->sep_ext.ext_cfg = session_mq_get_ext_config (app, mp->ext_config);
213 if ((rv = vnet_connect (a)))
215 wrk = session_main_get_worker (vlib_get_thread_index ());
216 session_worker_stat_error_inc (wrk, rv, 1);
217 app_wrk = application_get_worker (app, mp->wrk_index);
218 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
222 session_mq_free_ext_config (app, mp->ext_config);
226 session_mq_handle_connects_rpc (void *arg)
228 u32 max_connects = 32, n_connects = 0;
229 session_evt_elt_t *he, *elt, *next;
230 session_worker_t *fwrk;
232 ASSERT (session_vlib_thread_is_cl_thread ());
234 /* Pending connects on linked list pertaining to first worker */
235 fwrk = session_main_get_worker (transport_cl_thread ());
236 if (!fwrk->n_pending_connects)
239 he = clib_llist_elt (fwrk->event_elts, fwrk->pending_connects);
240 elt = clib_llist_next (fwrk->event_elts, evt_list, he);
242 /* Avoid holding the worker for too long */
243 while (n_connects < max_connects && elt != he)
245 next = clib_llist_next (fwrk->event_elts, evt_list, elt);
246 clib_llist_remove (fwrk->event_elts, evt_list, elt);
247 session_mq_connect_one (session_evt_ctrl_data (fwrk, elt));
248 session_evt_ctrl_data_free (fwrk, elt);
249 clib_llist_put (fwrk->event_elts, elt);
254 /* Decrement with worker barrier */
255 fwrk->n_pending_connects -= n_connects;
256 if (fwrk->n_pending_connects > 0)
258 session_send_rpc_evt_to_thread_force (fwrk->vm->thread_index,
259 session_mq_handle_connects_rpc, 0);
264 session_mq_connect_handler (session_worker_t *wrk, session_evt_elt_t *elt)
266 u32 thread_index = wrk - session_main.wrk;
267 session_evt_elt_t *he;
269 if (PREDICT_FALSE (thread_index > transport_cl_thread ()))
271 clib_warning ("Connect on wrong thread. Dropping");
275 /* If on worker, check if main has any pending messages. Avoids reordering
276 * with other control messages that need to be handled by main
280 he = clib_llist_elt (wrk->event_elts, wrk->evts_pending_main);
282 /* Events pending on main, postpone to avoid reordering */
283 if (!clib_llist_is_empty (wrk->event_elts, evt_list, he))
285 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
290 /* Add to pending list to be handled by first worker */
291 he = clib_llist_elt (wrk->event_elts, wrk->pending_connects);
292 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
294 /* Decremented with worker barrier */
295 wrk->n_pending_connects += 1;
296 if (wrk->n_pending_connects == 1)
298 session_send_rpc_evt_to_thread_force (thread_index,
299 session_mq_handle_connects_rpc, 0);
304 session_mq_connect_uri_handler (session_worker_t *wrk, session_evt_elt_t *elt)
306 vnet_connect_args_t _a, *a = &_a;
307 session_connect_uri_msg_t *mp;
308 app_worker_t *app_wrk;
312 app_check_thread_and_barrier (wrk, elt);
314 mp = session_evt_ctrl_data (wrk, elt);
315 app = application_lookup (mp->client_index);
319 clib_memset (a, 0, sizeof (*a));
320 a->uri = (char *) mp->uri;
321 a->api_context = mp->context;
322 a->app_index = app->app_index;
323 if ((rv = vnet_connect_uri (a)))
325 session_worker_stat_error_inc (wrk, rv, 1);
326 app_wrk = application_get_worker (app, 0 /* default wrk only */ );
327 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
332 session_mq_shutdown_handler (void *data)
334 session_shutdown_msg_t *mp = (session_shutdown_msg_t *) data;
335 vnet_shutdown_args_t _a, *a = &_a;
338 app = application_lookup (mp->client_index);
342 a->app_index = app->app_index;
343 a->handle = mp->handle;
344 vnet_shutdown_session (a);
348 session_mq_disconnect_handler (void *data)
350 session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
351 vnet_disconnect_args_t _a, *a = &_a;
354 app = application_lookup (mp->client_index);
358 a->app_index = app->app_index;
359 a->handle = mp->handle;
360 vnet_disconnect_session (a);
364 app_mq_detach_handler (session_worker_t *wrk, session_evt_elt_t *elt)
366 vnet_app_detach_args_t _a, *a = &_a;
367 session_app_detach_msg_t *mp;
370 app_check_thread_and_barrier (wrk, elt);
372 mp = session_evt_ctrl_data (wrk, elt);
373 app = application_lookup (mp->client_index);
377 a->app_index = app->app_index;
378 a->api_client_index = mp->client_index;
379 vnet_application_detach (a);
383 session_mq_unlisten_handler (session_worker_t *wrk, session_evt_elt_t *elt)
385 vnet_unlisten_args_t _a, *a = &_a;
386 session_unlisten_msg_t *mp;
387 app_worker_t *app_wrk;
392 app_check_thread_and_barrier (wrk, elt);
394 mp = session_evt_ctrl_data (wrk, elt);
397 app = application_lookup (mp->client_index);
401 clib_memset (a, 0, sizeof (*a));
402 a->app_index = app->app_index;
404 a->wrk_map_index = mp->wrk_index;
406 if ((rv = vnet_unlisten (a)))
407 session_worker_stat_error_inc (wrk, rv, 1);
409 app_wrk = application_get_worker (app, a->wrk_map_index);
413 mq_send_unlisten_reply (app_wrk, sh, mp->context, rv);
417 session_mq_accepted_reply_handler (session_worker_t *wrk,
418 session_evt_elt_t *elt)
420 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
421 session_accepted_reply_msg_t *mp;
422 session_state_t old_state;
423 app_worker_t *app_wrk;
426 mp = session_evt_ctrl_data (wrk, elt);
428 /* Mail this back from the main thread. We're not polling in main
429 * thread so we're using other workers for notifications. */
430 if (session_thread_from_handle (mp->handle) == 0 && vlib_num_workers () &&
431 vlib_get_thread_index () != 0)
433 session_wrk_send_evt_to_main (wrk, elt);
437 s = session_get_from_handle_if_valid (mp->handle);
441 app_wrk = app_worker_get (s->app_wrk_index);
442 if (app_wrk->app_index != mp->context)
444 clib_warning ("app doesn't own session");
448 /* Server isn't interested, disconnect the session */
451 a->app_index = mp->context;
452 a->handle = mp->handle;
453 vnet_disconnect_session (a);
457 /* Special handling for cut-through sessions */
458 if (!session_has_transport (s))
460 session_set_state (s, SESSION_STATE_READY);
461 ct_session_connect_notify (s, SESSION_E_NONE);
465 old_state = s->session_state;
466 session_set_state (s, SESSION_STATE_READY);
468 if (!svm_fifo_is_empty_prod (s->rx_fifo))
469 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
471 /* Closed while waiting for app to reply. Resend disconnect */
472 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
474 app_worker_close_notify (app_wrk, s);
475 session_set_state (s, old_state);
481 session_mq_reset_reply_handler (void *data)
483 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
484 session_reset_reply_msg_t *mp;
485 app_worker_t *app_wrk;
488 u32 index, thread_index;
490 mp = (session_reset_reply_msg_t *) data;
491 app = application_lookup (mp->context);
495 session_parse_handle (mp->handle, &index, &thread_index);
496 s = session_get_if_valid (index, thread_index);
498 /* No session or not the right session */
499 if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
502 app_wrk = app_worker_get (s->app_wrk_index);
503 if (!app_wrk || app_wrk->app_index != app->app_index)
505 clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
510 /* Client objected to resetting the session, log and continue */
513 clib_warning ("client retval %d", mp->retval);
517 /* This comes as a response to a reset, transport only waiting for
518 * confirmation to remove connection state, no need to disconnect */
519 a->handle = mp->handle;
520 a->app_index = app->app_index;
521 vnet_disconnect_session (a);
525 session_mq_disconnected_handler (void *data)
527 session_disconnected_reply_msg_t *rmp;
528 vnet_disconnect_args_t _a, *a = &_a;
529 svm_msg_q_msg_t _msg, *msg = &_msg;
530 session_disconnected_msg_t *mp;
531 app_worker_t *app_wrk;
532 session_event_t *evt;
537 mp = (session_disconnected_msg_t *) data;
538 if (!(s = session_get_from_handle_if_valid (mp->handle)))
540 clib_warning ("could not disconnect handle %llu", mp->handle);
543 app_wrk = app_worker_get (s->app_wrk_index);
544 app = application_lookup (mp->client_index);
545 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
547 clib_warning ("could not disconnect session: %llu app: %u",
548 mp->handle, mp->client_index);
552 a->handle = mp->handle;
553 a->app_index = app_wrk->wrk_index;
554 rv = vnet_disconnect_session (a);
556 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
557 SESSION_MQ_CTRL_EVT_RING,
559 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
560 clib_memset (evt, 0, sizeof (*evt));
561 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
562 rmp = (session_disconnected_reply_msg_t *) evt->data;
563 rmp->handle = mp->handle;
564 rmp->context = mp->context;
566 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
570 session_mq_disconnected_reply_handler (void *data)
572 session_disconnected_reply_msg_t *mp;
573 vnet_disconnect_args_t _a, *a = &_a;
576 mp = (session_disconnected_reply_msg_t *) data;
578 /* Client objected to disconnecting the session, log and continue */
581 clib_warning ("client retval %d", mp->retval);
585 /* Disconnect has been confirmed. Confirm close to transport */
586 app = application_lookup (mp->context);
589 a->handle = mp->handle;
590 a->app_index = app->app_index;
591 vnet_disconnect_session (a);
596 session_mq_worker_update_handler (void *data)
598 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
599 session_worker_update_reply_msg_t *rmp;
600 svm_msg_q_msg_t _msg, *msg = &_msg;
601 app_worker_t *app_wrk;
602 u32 owner_app_wrk_map;
603 session_event_t *evt;
608 app = application_lookup (mp->client_index);
611 if (!(s = session_get_from_handle_if_valid (mp->handle)))
613 clib_warning ("invalid handle %llu", mp->handle);
616 app_wrk = app_worker_get (s->app_wrk_index);
617 if (app_wrk->app_index != app->app_index)
619 clib_warning ("app %u does not own session %llu", app->app_index,
623 owner_app_wrk_map = app_wrk->wrk_map_index;
624 app_wrk = application_get_worker (app, mp->wrk_index);
626 /* This needs to come from the new owner */
627 if (mp->req_wrk_index == owner_app_wrk_map)
629 session_req_worker_update_msg_t *wump;
631 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
632 SESSION_MQ_CTRL_EVT_RING,
634 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
635 clib_memset (evt, 0, sizeof (*evt));
636 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
637 wump = (session_req_worker_update_msg_t *) evt->data;
638 wump->session_handle = mp->handle;
639 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
643 rv = app_worker_own_session (app_wrk, s);
645 session_stat_error_inc (rv, 1);
650 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
651 SESSION_MQ_CTRL_EVT_RING,
653 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
654 clib_memset (evt, 0, sizeof (*evt));
655 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
656 rmp = (session_worker_update_reply_msg_t *) evt->data;
657 rmp->handle = mp->handle;
659 rmp->rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
661 rmp->tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
662 rmp->segment_handle = session_segment_handle (s);
663 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
666 * Retransmit messages that may have been lost
668 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
669 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
671 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
672 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
674 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
675 app_worker_close_notify (app_wrk, s);
679 session_mq_app_wrk_rpc_handler (void *data)
681 session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
682 svm_msg_q_msg_t _msg, *msg = &_msg;
683 session_app_wrk_rpc_msg_t *rmp;
684 app_worker_t *app_wrk;
685 session_event_t *evt;
688 app = application_lookup (mp->client_index);
692 app_wrk = application_get_worker (app, mp->wrk_index);
694 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
695 SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
697 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
698 clib_memset (evt, 0, sizeof (*evt));
699 evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
700 rmp = (session_app_wrk_rpc_msg_t *) evt->data;
701 clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
702 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
706 session_mq_transport_attr_handler (void *data)
708 session_transport_attr_msg_t *mp = (session_transport_attr_msg_t *) data;
709 session_transport_attr_reply_msg_t *rmp;
710 svm_msg_q_msg_t _msg, *msg = &_msg;
711 app_worker_t *app_wrk;
712 session_event_t *evt;
717 app = application_lookup (mp->client_index);
721 if (!(s = session_get_from_handle_if_valid (mp->handle)))
723 clib_warning ("invalid handle %llu", mp->handle);
726 app_wrk = app_worker_get (s->app_wrk_index);
727 if (app_wrk->app_index != app->app_index)
729 clib_warning ("app %u does not own session %llu", app->app_index,
734 rv = session_transport_attribute (s, mp->is_get, &mp->attr);
736 svm_msg_q_lock_and_alloc_msg_w_ring (
737 app_wrk->event_queue, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, msg);
738 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
739 clib_memset (evt, 0, sizeof (*evt));
740 evt->event_type = SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY;
741 rmp = (session_transport_attr_reply_msg_t *) evt->data;
742 rmp->handle = mp->handle;
744 rmp->is_get = mp->is_get;
745 if (!rv && mp->is_get)
746 rmp->attr = mp->attr;
747 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
751 session_wrk_handle_evts_main_rpc (void *args)
753 vlib_main_t *vm = vlib_get_main ();
754 clib_llist_index_t ei, next_ei;
755 session_evt_elt_t *he, *elt;
756 session_worker_t *fwrk;
759 vlib_worker_thread_barrier_sync (vm);
761 thread_index = pointer_to_uword (args);
762 fwrk = session_main_get_worker (thread_index);
764 he = clib_llist_elt (fwrk->event_elts, fwrk->evts_pending_main);
765 ei = clib_llist_next_index (he, evt_list);
767 while (ei != fwrk->evts_pending_main)
769 elt = clib_llist_elt (fwrk->event_elts, ei);
770 next_ei = clib_llist_next_index (elt, evt_list);
771 clib_llist_remove (fwrk->event_elts, evt_list, elt);
772 switch (elt->evt.event_type)
774 case SESSION_CTRL_EVT_LISTEN:
775 session_mq_listen_handler (fwrk, elt);
777 case SESSION_CTRL_EVT_UNLISTEN:
778 session_mq_unlisten_handler (fwrk, elt);
780 case SESSION_CTRL_EVT_APP_DETACH:
781 app_mq_detach_handler (fwrk, elt);
783 case SESSION_CTRL_EVT_CONNECT_URI:
784 session_mq_connect_uri_handler (fwrk, elt);
786 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
787 session_mq_accepted_reply_handler (fwrk, elt);
789 case SESSION_CTRL_EVT_CONNECT:
790 session_mq_connect_handler (fwrk, elt);
793 clib_warning ("unhandled %u", elt->evt.event_type);
798 /* Regrab element in case pool moved */
799 elt = clib_llist_elt (fwrk->event_elts, ei);
800 if (!clib_llist_elt_is_linked (elt, evt_list))
802 session_evt_ctrl_data_free (fwrk, elt);
803 clib_llist_put (fwrk->event_elts, elt);
808 vlib_worker_thread_barrier_release (vm);
811 vlib_node_registration_t session_queue_node;
816 u32 server_thread_index;
817 } session_queue_trace_t;
819 /* packet trace format function */
821 format_session_queue_trace (u8 * s, va_list * args)
823 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
824 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
825 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
827 s = format (s, "session index %d thread index %d",
828 t->session_index, t->server_thread_index);
832 #define foreach_session_queue_error \
833 _ (TX, tx, INFO, "Packets transmitted") \
834 _ (TIMER, timer, INFO, "Timer events") \
835 _ (NO_BUFFER, no_buffer, ERROR, "Out of buffers")
839 #define _(f, n, s, d) SESSION_QUEUE_ERROR_##f,
840 foreach_session_queue_error
842 SESSION_QUEUE_N_ERROR,
843 } session_queue_error_t;
845 static vlib_error_desc_t session_error_counters[] = {
846 #define _(f, n, s, d) { #n, d, VL_COUNTER_SEVERITY_##s },
847 foreach_session_queue_error
853 SESSION_TX_NO_BUFFERS = -2,
859 session_tx_trace_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
860 u32 next_index, vlib_buffer_t **bufs, u16 n_segs,
861 session_t *s, u32 n_trace)
863 vlib_buffer_t **b = bufs;
865 while (n_trace && n_segs)
867 if (PREDICT_TRUE (vlib_trace_buffer (vm, node, next_index, b[0],
868 1 /* follow_chain */)))
870 session_queue_trace_t *t =
871 vlib_add_trace (vm, node, b[0], sizeof (*t));
872 t->session_index = s->session_index;
873 t->server_thread_index = s->thread_index;
879 vlib_set_trace_count (vm, node, n_trace);
883 session_tx_fill_dma_transfers (session_worker_t *wrk,
884 session_tx_context_t *ctx, vlib_buffer_t *b)
886 vlib_main_t *vm = wrk->vm;
889 int n_bytes_read, len_write;
890 svm_fifo_seg_t data_fs[2];
895 * Start with the first buffer in chain
898 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
900 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
901 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
903 n_bytes_read = svm_fifo_segments (ctx->s->tx_fifo, ctx->sp.tx_offset,
904 data_fs, &n_segs, len_to_deq);
906 len_write = n_bytes_read;
907 ASSERT (n_bytes_read == len_to_deq);
912 vlib_dma_batch_add (vm, wrk->batch, data0, data_fs[n_transfers].data,
913 data_fs[n_transfers].len);
914 data0 += data_fs[n_transfers].len;
915 n_bytes_read -= data_fs[n_transfers].len;
922 session_tx_fill_dma_transfers_tail (session_worker_t *wrk,
923 session_tx_context_t *ctx,
924 vlib_buffer_t *b, u32 len_to_deq, u8 *data)
926 vlib_main_t *vm = wrk->vm;
927 int n_bytes_read, len_write;
928 svm_fifo_seg_t data_fs[2];
932 n_bytes_read = svm_fifo_segments (ctx->s->tx_fifo, ctx->sp.tx_offset,
933 data_fs, &n_segs, len_to_deq);
935 len_write = n_bytes_read;
937 ASSERT (n_bytes_read == len_to_deq);
942 vlib_dma_batch_add (vm, wrk->batch, data, data_fs[n_transfers].data,
943 data_fs[n_transfers].len);
944 data += data_fs[n_transfers].len;
945 n_bytes_read -= data_fs[n_transfers].len;
953 session_tx_copy_data (session_worker_t *wrk, session_tx_context_t *ctx,
954 vlib_buffer_t *b, u32 len_to_deq, u8 *data0)
957 if (PREDICT_TRUE (!wrk->dma_enabled))
959 svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset, len_to_deq, data0);
961 n_bytes_read = session_tx_fill_dma_transfers (wrk, ctx, b);
966 session_tx_copy_data_tail (session_worker_t *wrk, session_tx_context_t *ctx,
967 vlib_buffer_t *b, u32 len_to_deq, u8 *data)
970 if (PREDICT_TRUE (!wrk->dma_enabled))
972 svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset, len_to_deq, data);
975 session_tx_fill_dma_transfers_tail (wrk, ctx, b, len_to_deq, data);
980 session_tx_fifo_chain_tail (session_worker_t *wrk, session_tx_context_t *ctx,
981 vlib_buffer_t *b, u16 *n_bufs, u8 peek_data)
983 vlib_main_t *vm = wrk->vm;
984 vlib_buffer_t *chain_b, *prev_b;
985 u32 chain_bi0, to_deq, left_from_seg;
986 int len_to_deq, n_bytes_read;
989 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
990 b->total_length_not_including_first_buffer = 0;
993 left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
995 to_deq = left_from_seg;
996 for (j = 1; j < ctx->n_bufs_per_seg; j++)
999 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
1002 chain_bi0 = ctx->tx_buffers[*n_bufs];
1003 chain_b = vlib_get_buffer (vm, chain_bi0);
1004 chain_b->current_data = 0;
1005 data = vlib_buffer_get_current (chain_b);
1009 session_tx_copy_data_tail (wrk, ctx, b, len_to_deq, data);
1010 ctx->sp.tx_offset += n_bytes_read;
1014 if (ctx->transport_vft->transport_options.tx_type ==
1017 svm_fifo_t *f = ctx->s->tx_fifo;
1018 session_dgram_hdr_t *hdr = &ctx->hdr;
1022 deq_now = clib_min (hdr->data_length - hdr->data_offset,
1024 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
1025 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data);
1026 ASSERT (n_bytes_read > 0);
1028 hdr->data_offset += n_bytes_read;
1029 if (hdr->data_offset == hdr->data_length)
1031 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
1032 svm_fifo_dequeue_drop (f, offset);
1033 if (ctx->left_to_snd > n_bytes_read)
1034 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1037 else if (ctx->left_to_snd == n_bytes_read)
1038 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
1039 sizeof (session_dgram_pre_hdr_t));
1042 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
1045 ASSERT (n_bytes_read == len_to_deq);
1046 chain_b->current_length = n_bytes_read;
1047 b->total_length_not_including_first_buffer += chain_b->current_length;
1049 /* update previous buffer */
1050 prev_b->next_buffer = chain_bi0;
1051 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1053 /* update current buffer */
1054 chain_b->next_buffer = 0;
1056 to_deq -= n_bytes_read;
1061 && b->total_length_not_including_first_buffer == left_from_seg);
1062 ctx->left_to_snd -= left_from_seg;
1066 session_tx_fill_buffer (session_worker_t *wrk, session_tx_context_t *ctx,
1067 vlib_buffer_t *b, u16 *n_bufs, u8 peek_data)
1073 * Start with the first buffer in chain
1076 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
1077 b->current_data = 0;
1079 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
1080 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
1084 n_bytes_read = session_tx_copy_data (wrk, ctx, b, len_to_deq, data0);
1085 ASSERT (n_bytes_read > 0);
1086 /* Keep track of progress locally, transport is also supposed to
1087 * increment it independently when pushing the header */
1088 ctx->sp.tx_offset += n_bytes_read;
1092 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1094 session_dgram_hdr_t *hdr = &ctx->hdr;
1095 svm_fifo_t *f = ctx->s->tx_fifo;
1099 ASSERT (hdr->data_length > hdr->data_offset);
1100 deq_now = clib_min (hdr->data_length - hdr->data_offset,
1102 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
1103 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
1104 ASSERT (n_bytes_read > 0);
1106 if (transport_connection_is_cless (ctx->tc))
1108 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
1109 ip_copy (&ctx->tc->lcl_ip, &hdr->lcl_ip, ctx->tc->is_ip4);
1110 /* Local port assumed to be bound, not overwriting it */
1111 ctx->tc->rmt_port = hdr->rmt_port;
1113 hdr->data_offset += n_bytes_read;
1114 if (hdr->data_offset == hdr->data_length)
1116 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
1117 svm_fifo_dequeue_drop (f, offset);
1118 if (ctx->left_to_snd > n_bytes_read)
1119 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1122 else if (ctx->left_to_snd == n_bytes_read)
1123 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
1124 sizeof (session_dgram_pre_hdr_t));
1128 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
1130 ASSERT (n_bytes_read > 0);
1134 b->current_length = n_bytes_read;
1135 ctx->left_to_snd -= n_bytes_read;
1138 * Fill in the remaining buffers in the chain, if any
1140 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
1141 session_tx_fifo_chain_tail (wrk, ctx, b, n_bufs, peek_data);
1145 session_tx_not_ready (session_t * s, u8 peek_data)
1149 if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
1151 /* Can retransmit for closed sessions but can't send new data if
1152 * session is not ready or closed */
1153 else if (s->session_state < SESSION_STATE_READY)
1155 /* Allow accepting session to send custom packets.
1156 * For instance, tcp want to send acks in established, but
1157 * the app has not called accept() yet */
1158 if (s->session_state == SESSION_STATE_ACCEPTING &&
1159 (s->flags & SESSION_F_CUSTOM_TX))
1163 else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1165 /* Allow closed transports to still send custom packets.
1166 * For instance, tcp may want to send acks in time-wait. */
1167 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
1168 && (s->flags & SESSION_F_CUSTOM_TX))
1175 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1181 always_inline transport_connection_t *
1182 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
1186 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1187 ctx->s->thread_index);
1191 if (ctx->s->session_state == SESSION_STATE_LISTENING)
1192 return ctx->transport_vft->get_listener (ctx->s->connection_index);
1195 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1196 ctx->s->thread_index);
1202 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
1203 u32 max_segs, u8 peek_data)
1205 u32 n_bytes_per_buf, n_bytes_per_seg;
1207 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
1208 ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
1212 /* Offset in rx fifo from where to peek data */
1213 if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
1215 ctx->max_len_to_snd = 0;
1218 ctx->max_dequeue -= ctx->sp.tx_offset;
1222 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1224 u32 len, chain_limit;
1226 if (ctx->max_dequeue <= sizeof (ctx->hdr))
1228 ctx->max_len_to_snd = 0;
1232 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1234 /* Zero length dgrams not supported */
1235 if (PREDICT_FALSE (ctx->hdr.data_length == 0))
1237 svm_fifo_dequeue_drop (ctx->s->tx_fifo, sizeof (ctx->hdr));
1238 ctx->max_len_to_snd = 0;
1241 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
1242 len = ctx->hdr.data_length - ctx->hdr.data_offset;
1244 if (ctx->hdr.gso_size)
1246 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, ctx->hdr.gso_size);
1249 /* Process multiple dgrams if smaller than min (buf_space, mss).
1250 * This avoids handling multiple dgrams if they require buffer
1252 chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
1254 if (ctx->hdr.data_length <= chain_limit)
1256 u32 first_dgram_len, dgram_len, offset, max_offset;
1257 session_dgram_hdr_t hdr;
1259 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
1260 offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
1261 first_dgram_len = len;
1262 max_offset = clib_min (ctx->max_dequeue, 16 << 10);
1264 while (offset < max_offset)
1266 svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
1268 dgram_len = hdr.data_length - hdr.data_offset;
1269 if (offset + sizeof (hdr) + hdr.data_length >
1271 first_dgram_len != dgram_len)
1273 /* Assert here to allow test above with zero length dgrams */
1274 ASSERT (hdr.data_length > hdr.data_offset);
1276 offset += sizeof (hdr) + hdr.data_length;
1280 ctx->max_dequeue = len;
1283 ASSERT (ctx->max_dequeue > 0);
1285 /* Ensure we're not writing more than transport window allows */
1286 if (ctx->max_dequeue < ctx->sp.snd_space)
1288 /* Constrained by tx queue. Try to send only fully formed segments */
1289 ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
1290 (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
1296 /* Expectation is that snd_space0 is already a multiple of snd_mss */
1297 ctx->max_len_to_snd = ctx->sp.snd_space;
1300 /* Check if we're tx constrained by the node */
1301 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
1302 if (ctx->n_segs_per_evt > max_segs)
1304 ctx->n_segs_per_evt = max_segs;
1305 ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
1308 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
1309 if (ctx->n_segs_per_evt > 1)
1311 u32 n_bytes_last_seg, n_bufs_last_seg;
1313 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
1314 n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
1315 - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
1316 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1317 n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
1318 ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
1323 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
1324 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1325 ctx->n_bufs_needed = ctx->n_bufs_per_seg;
1328 ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
1329 ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
1331 TRANSPORT_MAX_HDRS_LEN);
1335 session_tx_maybe_reschedule (session_worker_t * wrk,
1336 session_tx_context_t * ctx,
1337 session_evt_elt_t * elt)
1339 session_t *s = ctx->s;
1341 svm_fifo_unset_event (s->tx_fifo);
1342 if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
1344 if (svm_fifo_set_event (s->tx_fifo))
1345 session_evt_add_head_old (wrk, elt);
1349 transport_connection_deschedule (ctx->tc);
1354 session_tx_add_pending_buffer (session_worker_t *wrk, u32 bi, u32 next_index)
1356 if (PREDICT_TRUE (!wrk->dma_enabled))
1358 vec_add1 (wrk->pending_tx_buffers, bi);
1359 vec_add1 (wrk->pending_tx_nexts, next_index);
1363 session_dma_transfer *dma_transfer = &wrk->dma_trans[wrk->trans_tail];
1364 vec_add1 (dma_transfer->pending_tx_buffers, bi);
1365 vec_add1 (dma_transfer->pending_tx_nexts, next_index);
1370 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
1371 vlib_node_runtime_t * node,
1372 session_evt_elt_t * elt,
1373 int *n_tx_packets, u8 peek_data)
1375 u32 n_trace, n_left, pbi, next_index, max_burst;
1376 session_tx_context_t *ctx = &wrk->ctx;
1377 session_main_t *smm = &session_main;
1378 session_event_t *e = &elt->evt;
1379 vlib_main_t *vm = wrk->vm;
1380 transport_proto_t tp;
1384 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
1387 session_evt_add_old (wrk, elt);
1388 return SESSION_TX_NO_DATA;
1391 next_index = smm->session_type_to_next[ctx->s->session_type];
1392 max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
1394 tp = session_get_transport_proto (ctx->s);
1395 ctx->transport_vft = transport_protocol_get_vft (tp);
1396 ctx->tc = session_tx_get_transport (ctx, peek_data);
1398 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
1400 if (ctx->transport_vft->flush_data)
1401 ctx->transport_vft->flush_data (ctx->tc);
1402 e->event_type = SESSION_IO_EVT_TX;
1405 if (ctx->s->flags & SESSION_F_CUSTOM_TX)
1408 ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
1409 ctx->sp.max_burst_size = max_burst;
1410 n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
1411 *n_tx_packets += n_custom_tx;
1413 (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1414 return SESSION_TX_OK;
1415 max_burst -= n_custom_tx;
1416 if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
1418 session_evt_add_old (wrk, elt);
1419 return SESSION_TX_OK;
1423 /* Connection previously descheduled because it had no data to send.
1424 * Clear descheduled flag and reset pacer if in use */
1425 if (transport_connection_is_descheduled (ctx->tc))
1426 transport_connection_clear_descheduled (ctx->tc);
1428 transport_connection_snd_params (ctx->tc, &ctx->sp);
1430 if (!ctx->sp.snd_space)
1432 /* If the deschedule flag was set, remove session from scheduler.
1433 * Transport is responsible for rescheduling this session. */
1434 if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
1435 transport_connection_deschedule (ctx->tc);
1436 /* Request to postpone the session, e.g., zero-wnd and transport
1437 * is not currently probing */
1438 else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
1439 session_evt_add_old (wrk, elt);
1440 /* This flow queue is "empty" so it should be re-evaluated before
1441 * the ones that have data to send. */
1443 session_evt_add_head_old (wrk, elt);
1445 return SESSION_TX_NO_DATA;
1448 if (transport_connection_is_tx_paced (ctx->tc))
1450 u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1451 if (snd_space < TRANSPORT_PACER_MIN_BURST)
1453 session_evt_add_head_old (wrk, elt);
1454 return SESSION_TX_NO_DATA;
1456 snd_space = clib_min (ctx->sp.snd_space, snd_space);
1457 ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1458 snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1461 /* Check how much we can pull. */
1462 session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1464 if (PREDICT_FALSE (!ctx->max_len_to_snd))
1466 transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1467 session_tx_maybe_reschedule (wrk, ctx, elt);
1468 return SESSION_TX_NO_DATA;
1471 vec_validate_aligned (ctx->tx_buffers, ctx->n_bufs_needed - 1,
1472 CLIB_CACHE_LINE_BYTES);
1473 n_bufs = vlib_buffer_alloc (vm, ctx->tx_buffers, ctx->n_bufs_needed);
1474 if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1477 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1478 session_evt_add_head_old (wrk, elt);
1479 vlib_node_increment_counter (wrk->vm, node->node_index,
1480 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1481 return SESSION_TX_NO_BUFFERS;
1484 if (transport_connection_is_tx_paced (ctx->tc))
1485 transport_connection_tx_pacer_update_bytes (ctx->tc, ctx->max_len_to_snd);
1487 ctx->left_to_snd = ctx->max_len_to_snd;
1488 n_left = ctx->n_segs_per_evt;
1490 vec_validate (ctx->transport_pending_bufs, n_left);
1494 vlib_buffer_t *b0, *b1;
1497 pbi = ctx->tx_buffers[n_bufs - 3];
1498 pb = vlib_get_buffer (vm, pbi);
1499 vlib_prefetch_buffer_header (pb, STORE);
1500 pbi = ctx->tx_buffers[n_bufs - 4];
1501 pb = vlib_get_buffer (vm, pbi);
1502 vlib_prefetch_buffer_header (pb, STORE);
1504 bi0 = ctx->tx_buffers[--n_bufs];
1505 bi1 = ctx->tx_buffers[--n_bufs];
1507 b0 = vlib_get_buffer (vm, bi0);
1508 b1 = vlib_get_buffer (vm, bi1);
1510 session_tx_fill_buffer (wrk, ctx, b0, &n_bufs, peek_data);
1511 session_tx_fill_buffer (wrk, ctx, b1, &n_bufs, peek_data);
1513 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1514 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left + 1] = b1;
1517 session_tx_add_pending_buffer (wrk, bi0, next_index);
1518 session_tx_add_pending_buffer (wrk, bi1, next_index);
1527 pbi = ctx->tx_buffers[n_bufs - 2];
1528 pb = vlib_get_buffer (vm, pbi);
1529 vlib_prefetch_buffer_header (pb, STORE);
1532 bi0 = ctx->tx_buffers[--n_bufs];
1533 b0 = vlib_get_buffer (vm, bi0);
1534 session_tx_fill_buffer (wrk, ctx, b0, &n_bufs, peek_data);
1536 ctx->transport_pending_bufs[ctx->n_segs_per_evt - n_left] = b0;
1539 session_tx_add_pending_buffer (wrk, bi0, next_index);
1542 /* Ask transport to push headers */
1543 ctx->transport_vft->push_header (ctx->tc, ctx->transport_pending_bufs,
1544 ctx->n_segs_per_evt);
1546 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1547 session_tx_trace_frame (vm, node, next_index, ctx->transport_pending_bufs,
1548 ctx->n_segs_per_evt, ctx->s, n_trace);
1550 if (PREDICT_FALSE (n_bufs))
1551 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1553 *n_tx_packets += ctx->n_segs_per_evt;
1555 SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1556 ctx->s->tx_fifo->shr->has_event, wrk->last_vlib_time);
1558 ASSERT (ctx->left_to_snd == 0);
1560 /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1561 * check if application enqueued more data and reschedule accordingly */
1562 if (ctx->max_len_to_snd < ctx->max_dequeue)
1563 session_evt_add_old (wrk, elt);
1565 session_tx_maybe_reschedule (wrk, ctx, elt);
1569 u32 n_dequeued = ctx->max_len_to_snd;
1570 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1571 n_dequeued += ctx->n_segs_per_evt * SESSION_CONN_HDR_LEN;
1572 if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, n_dequeued))
1573 session_dequeue_notify (ctx->s);
1575 return SESSION_TX_OK;
1579 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1580 vlib_node_runtime_t * node,
1581 session_evt_elt_t * e, int *n_tx_packets)
1583 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1587 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1588 vlib_node_runtime_t * node,
1589 session_evt_elt_t * e, int *n_tx_packets)
1591 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1595 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1596 vlib_node_runtime_t * node,
1597 session_evt_elt_t * elt, int *n_tx_packets)
1599 transport_send_params_t *sp = &wrk->ctx.sp;
1600 session_t *s = wrk->ctx.s;
1603 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1606 /* Clear custom-tx flag used to request reschedule for tx */
1607 s->flags &= ~SESSION_F_CUSTOM_TX;
1610 sp->bytes_dequeued = 0;
1611 sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1612 TRANSPORT_PACER_MAX_BURST_PKTS);
1614 n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1615 *n_tx_packets += n_packets;
1617 if (s->flags & SESSION_F_CUSTOM_TX)
1619 session_evt_add_old (wrk, elt);
1621 else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1623 svm_fifo_unset_event (s->tx_fifo);
1624 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1625 if (svm_fifo_set_event (s->tx_fifo))
1626 session_evt_add_head_old (wrk, elt);
1629 if (sp->bytes_dequeued &&
1630 svm_fifo_needs_deq_ntf (s->tx_fifo, sp->bytes_dequeued))
1631 session_dequeue_notify (s);
1636 always_inline session_t *
1637 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1639 if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1642 ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1643 return pool_elt_at_index (wrk->sessions, e->session_index);
1647 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1649 clib_llist_index_t ei;
1650 void (*fp) (void *);
1654 ei = clib_llist_entry_index (wrk->event_elts, elt);
1657 switch (e->event_type)
1659 case SESSION_CTRL_EVT_RPC:
1660 fp = e->rpc_args.fp;
1661 (*fp) (e->rpc_args.arg);
1663 case SESSION_CTRL_EVT_HALF_CLOSE:
1664 s = session_get_from_handle_if_valid (e->session_handle);
1665 if (PREDICT_FALSE (!s))
1667 session_transport_half_close (s);
1669 case SESSION_CTRL_EVT_CLOSE:
1670 s = session_get_from_handle_if_valid (e->session_handle);
1671 if (PREDICT_FALSE (!s))
1673 session_transport_close (s);
1675 case SESSION_CTRL_EVT_RESET:
1676 s = session_get_from_handle_if_valid (e->session_handle);
1677 if (PREDICT_FALSE (!s))
1679 session_transport_reset (s);
1681 case SESSION_CTRL_EVT_LISTEN:
1682 session_mq_listen_handler (wrk, elt);
1684 case SESSION_CTRL_EVT_LISTEN_URI:
1685 session_mq_listen_uri_handler (wrk, elt);
1687 case SESSION_CTRL_EVT_UNLISTEN:
1688 session_mq_unlisten_handler (wrk, elt);
1690 case SESSION_CTRL_EVT_CONNECT:
1691 session_mq_connect_handler (wrk, elt);
1693 case SESSION_CTRL_EVT_CONNECT_URI:
1694 session_mq_connect_uri_handler (wrk, elt);
1696 case SESSION_CTRL_EVT_SHUTDOWN:
1697 session_mq_shutdown_handler (session_evt_ctrl_data (wrk, elt));
1699 case SESSION_CTRL_EVT_DISCONNECT:
1700 session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1702 case SESSION_CTRL_EVT_DISCONNECTED:
1703 session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1705 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1706 session_mq_accepted_reply_handler (wrk, elt);
1708 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1709 session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1712 case SESSION_CTRL_EVT_RESET_REPLY:
1713 session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1715 case SESSION_CTRL_EVT_WORKER_UPDATE:
1716 session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1718 case SESSION_CTRL_EVT_APP_DETACH:
1719 app_mq_detach_handler (wrk, elt);
1721 case SESSION_CTRL_EVT_APP_WRK_RPC:
1722 session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1724 case SESSION_CTRL_EVT_TRANSPORT_ATTR:
1725 session_mq_transport_attr_handler (session_evt_ctrl_data (wrk, elt));
1728 clib_warning ("unhandled event type %d", e->event_type);
1731 /* Regrab elements in case pool moved */
1732 elt = clib_llist_elt (wrk->event_elts, ei);
1733 if (!clib_llist_elt_is_linked (elt, evt_list))
1736 if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1737 session_evt_ctrl_data_free (wrk, elt);
1738 clib_llist_put (wrk->event_elts, elt);
1740 SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1744 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1745 session_evt_elt_t * elt, int *n_tx_packets)
1747 session_main_t *smm = &session_main;
1748 app_worker_t *app_wrk;
1749 clib_llist_index_t ei;
1753 ei = clib_llist_entry_index (wrk->event_elts, elt);
1756 switch (e->event_type)
1758 case SESSION_IO_EVT_TX_FLUSH:
1759 case SESSION_IO_EVT_TX:
1760 s = session_event_get_session (wrk, e);
1761 if (PREDICT_FALSE (!s))
1763 CLIB_PREFETCH (s->tx_fifo, sizeof (*(s->tx_fifo)), LOAD);
1765 /* Spray packets in per session type frames, since they go to
1766 * different nodes */
1767 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1769 case SESSION_IO_EVT_RX:
1770 s = session_event_get_session (wrk, e);
1773 transport_app_rx_evt (session_get_transport_proto (s),
1774 s->connection_index, s->thread_index);
1776 case SESSION_IO_EVT_BUILTIN_RX:
1777 s = session_event_get_session (wrk, e);
1778 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1780 svm_fifo_unset_event (s->rx_fifo);
1781 app_wrk = app_worker_get (s->app_wrk_index);
1782 app_worker_builtin_rx (app_wrk, s);
1784 case SESSION_IO_EVT_TX_MAIN:
1785 s = session_get_if_valid (e->session_index, 0 /* main thread */);
1786 if (PREDICT_FALSE (!s))
1789 if (PREDICT_TRUE (s != 0))
1790 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1793 clib_warning ("unhandled event type %d", e->event_type);
1796 SESSION_EVT (SESSION_EVT_IO_EVT_COUNTS, e->event_type, 1, wrk);
1798 /* Regrab elements in case pool moved */
1799 elt = clib_llist_elt (wrk->event_elts, ei);
1800 if (!clib_llist_elt_is_linked (elt, evt_list))
1801 clib_llist_put (wrk->event_elts, elt);
1805 static const u32 session_evt_msg_sizes[] = {
1806 #define _(symc, sym) \
1807 [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1808 foreach_session_ctrl_evt
1814 session_update_time_subscribers (session_main_t *smm, clib_time_type_t now,
1817 session_update_time_fn *fn;
1819 vec_foreach (fn, smm->update_time_fns)
1820 (*fn) (now, thread_index);
1824 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1826 session_evt_elt_t *elt;
1828 if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1830 elt = session_evt_alloc_ctrl (wrk);
1831 if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1833 elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1834 elt->evt.event_type = evt->event_type;
1835 clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1836 session_evt_msg_sizes[evt->event_type]);
1840 /* Internal control events fit into io events footprint */
1841 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1846 elt = session_evt_alloc_new (wrk);
1847 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1852 session_flush_pending_tx_buffers (session_worker_t * wrk,
1853 vlib_node_runtime_t * node)
1855 vlib_buffer_enqueue_to_next_vec (wrk->vm, node, &wrk->pending_tx_buffers,
1856 &wrk->pending_tx_nexts,
1857 vec_len (wrk->pending_tx_nexts));
1858 vec_reset_length (wrk->pending_tx_buffers);
1859 vec_reset_length (wrk->pending_tx_nexts);
1863 session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq)
1865 svm_msg_q_msg_t _msg, *msg = &_msg;
1866 u32 i, n_to_dequeue = 0;
1867 session_event_t *evt;
1869 n_to_dequeue = svm_msg_q_size (mq);
1870 for (i = 0; i < n_to_dequeue; i++)
1872 svm_msg_q_sub_raw (mq, msg);
1873 evt = svm_msg_q_msg_data (mq, msg);
1874 session_evt_add_to_list (wrk, evt);
1875 svm_msg_q_free_msg (mq, msg);
1878 return n_to_dequeue;
1882 session_wrk_update_state (session_worker_t *wrk)
1884 vlib_main_t *vm = wrk->vm;
1886 if (wrk->state == SESSION_WRK_POLLING)
1888 if (clib_llist_elts (wrk->event_elts) == 4 &&
1889 vlib_last_vectors_per_main_loop (vm) < 1)
1891 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1892 vlib_node_set_state (vm, session_queue_node.index,
1893 VLIB_NODE_STATE_INTERRUPT);
1896 else if (wrk->state == SESSION_WRK_INTERRUPT)
1898 if (clib_llist_elts (wrk->event_elts) > 4 ||
1899 vlib_last_vectors_per_main_loop (vm) > 1)
1901 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
1902 vlib_node_set_state (vm, session_queue_node.index,
1903 VLIB_NODE_STATE_POLLING);
1905 else if (PREDICT_FALSE (!pool_elts (wrk->sessions)))
1907 session_wrk_set_state (wrk, SESSION_WRK_IDLE);
1912 if (clib_llist_elts (wrk->event_elts))
1914 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1920 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1921 vlib_frame_t * frame)
1923 u32 thread_index = vm->thread_index, __clib_unused n_evts;
1924 session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1925 session_main_t *smm = vnet_get_session_main ();
1926 session_worker_t *wrk = &smm->wrk[thread_index];
1927 clib_llist_index_t ei, next_ei, old_ti;
1930 SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1932 session_wrk_update_time (wrk, vlib_time_now (vm));
1935 * Update transport time
1937 session_update_time_subscribers (smm, wrk->last_vlib_time, thread_index);
1938 n_tx_packets = vec_len (wrk->pending_tx_buffers);
1939 SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1941 if (PREDICT_FALSE (wrk->dma_enabled))
1943 if (wrk->trans_head == ((wrk->trans_tail + 1) & (wrk->trans_size - 1)))
1945 wrk->batch = vlib_dma_batch_new (vm, wrk->config_index);
1951 * Dequeue new internal mq events
1954 n_evts = session_wrk_handle_mq (wrk, wrk->vpp_event_queue);
1955 SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_evts);
1958 * Handle control events
1961 ei = wrk->ctrl_head;
1962 ctrl_he = clib_llist_elt (wrk->event_elts, ei);
1963 next_ei = clib_llist_next_index (ctrl_he, evt_list);
1964 old_ti = clib_llist_prev_index (ctrl_he, evt_list);
1965 while (ei != old_ti)
1968 elt = clib_llist_elt (wrk->event_elts, next_ei);
1969 next_ei = clib_llist_next_index (elt, evt_list);
1970 clib_llist_remove (wrk->event_elts, evt_list, elt);
1971 session_event_dispatch_ctrl (wrk, elt);
1974 SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1977 * Handle the new io events.
1980 new_he = clib_llist_elt (wrk->event_elts, wrk->new_head);
1981 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1982 old_ti = clib_llist_prev_index (old_he, evt_list);
1984 ei = clib_llist_next_index (new_he, evt_list);
1985 while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
1987 elt = clib_llist_elt (wrk->event_elts, ei);
1988 ei = clib_llist_next_index (elt, evt_list);
1989 clib_llist_remove (wrk->event_elts, evt_list, elt);
1990 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1993 SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1996 * Handle the old io events, if we had any prior to processing the new ones
1999 if (old_ti != wrk->old_head)
2001 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
2002 ei = clib_llist_next_index (old_he, evt_list);
2004 while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
2006 elt = clib_llist_elt (wrk->event_elts, ei);
2007 next_ei = clib_llist_next_index (elt, evt_list);
2008 clib_llist_remove (wrk->event_elts, evt_list, elt);
2010 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
2019 if (PREDICT_FALSE (wrk->dma_enabled))
2023 vlib_dma_batch_set_cookie (vm, wrk->batch, wrk->trans_tail);
2026 if (wrk->trans_tail == wrk->trans_size)
2027 wrk->trans_tail = 0;
2030 vlib_dma_batch_submit (vm, wrk->batch);
2033 SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
2035 if (vec_len (wrk->pending_tx_buffers))
2036 session_flush_pending_tx_buffers (wrk, node);
2038 vlib_node_increment_counter (vm, session_queue_node.index,
2039 SESSION_QUEUE_ERROR_TX, n_tx_packets);
2041 SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
2043 if (wrk->flags & SESSION_WRK_F_ADAPTIVE)
2044 session_wrk_update_state (wrk);
2046 return n_tx_packets;
2050 VLIB_REGISTER_NODE (session_queue_node) = {
2051 .function = session_queue_node_fn,
2052 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
2053 .name = "session-queue",
2054 .format_trace = format_session_queue_trace,
2055 .type = VLIB_NODE_TYPE_INPUT,
2056 .n_errors = SESSION_QUEUE_N_ERROR,
2057 .error_counters = session_error_counters,
2058 .state = VLIB_NODE_STATE_DISABLED,
2062 static clib_error_t *
2063 session_wrk_tfd_read_ready (clib_file_t *cf)
2065 session_worker_t *wrk = session_main_get_worker (cf->private_data);
2069 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
2070 rv = read (wrk->timerfd, &buf, sizeof (buf));
2071 if (rv < 0 && errno != EAGAIN)
2072 clib_unix_warning ("failed");
2076 static clib_error_t *
2077 session_wrk_tfd_write_ready (clib_file_t *cf)
2083 session_wrk_enable_adaptive_mode (session_worker_t *wrk)
2085 u32 thread_index = wrk->vm->thread_index;
2086 clib_file_t template = { 0 };
2088 if ((wrk->timerfd = timerfd_create (CLOCK_MONOTONIC, TFD_NONBLOCK)) < 0)
2089 clib_warning ("timerfd_create");
2091 template.read_function = session_wrk_tfd_read_ready;
2092 template.write_function = session_wrk_tfd_write_ready;
2093 template.file_descriptor = wrk->timerfd;
2094 template.private_data = thread_index;
2095 template.polling_thread_index = thread_index;
2096 template.description = format (0, "session-wrk-tfd-%u", thread_index);
2098 wrk->timerfd_file = clib_file_add (&file_main, &template);
2099 wrk->flags |= SESSION_WRK_F_ADAPTIVE;
2102 static clib_error_t *
2103 session_queue_exit (vlib_main_t * vm)
2105 if (vlib_get_n_threads () < 2)
2109 * Shut off (especially) worker-thread session nodes.
2110 * Otherwise, vpp can crash as the main thread unmaps the
2113 vlib_worker_thread_barrier_sync (vm);
2114 session_node_enable_disable (0 /* is_enable */ );
2115 vlib_worker_thread_barrier_release (vm);
2119 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
2122 session_queue_run_on_main (vlib_main_t * vm)
2124 vlib_node_runtime_t *node;
2126 node = vlib_node_get_runtime (vm, session_queue_node.index);
2127 return session_queue_node_fn (vm, node, 0);
2131 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
2134 uword *event_data = 0;
2140 vlib_process_wait_for_event_or_clock (vm, timeout);
2141 event_type = vlib_process_get_events (vm, (uword **) & event_data);
2145 case SESSION_Q_PROCESS_RUN_ON_MAIN:
2146 /* Run session queue node on main thread */
2147 session_queue_run_on_main (vm);
2149 case SESSION_Q_PROCESS_STOP:
2150 vlib_node_set_state (vm, session_queue_process_node.index,
2151 VLIB_NODE_STATE_DISABLED);
2155 /* Timed out. Run on main to ensure all events are handled */
2156 session_queue_run_on_main (vm);
2159 vec_reset_length (event_data);
2165 VLIB_REGISTER_NODE (session_queue_process_node) =
2167 .function = session_queue_process,
2168 .type = VLIB_NODE_TYPE_PROCESS,
2169 .name = "session-queue-process",
2170 .state = VLIB_NODE_STATE_DISABLED,
2174 static_always_inline uword
2175 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2176 vlib_frame_t * frame)
2178 session_main_t *sm = &session_main;
2179 if (!sm->wrk[0].vpp_event_queue)
2181 node = vlib_node_get_runtime (vm, session_queue_node.index);
2182 return session_queue_node_fn (vm, node, frame);
2186 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
2188 .function = session_queue_pre_input_inline,
2189 .type = VLIB_NODE_TYPE_PRE_INPUT,
2190 .name = "session-queue-main",
2191 .state = VLIB_NODE_STATE_DISABLED,
2196 * fd.io coding-style-patch-verification: ON
2199 * eval: (c-set-style "gnu")