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>
29 #define app_check_thread_and_barrier(_fn, _arg) \
30 if (!vlib_thread_is_main_w_barrier ()) \
32 vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg)); \
37 session_wrk_timerfd_update (session_worker_t *wrk, u64 time_ns)
39 struct itimerspec its;
41 its.it_value.tv_sec = 0;
42 its.it_value.tv_nsec = time_ns;
43 its.it_interval.tv_sec = 0;
44 its.it_interval.tv_nsec = its.it_value.tv_nsec;
46 if (timerfd_settime (wrk->timerfd, 0, &its, NULL) == -1)
47 clib_warning ("timerfd_settime");
51 session_wrk_tfd_timeout (session_wrk_state_t state, u32 thread_index)
53 if (state == SESSION_WRK_INTERRUPT)
54 return thread_index ? 1e6 : vlib_num_workers () ? 5e8 : 1e6;
55 else if (state == SESSION_WRK_IDLE)
56 return thread_index ? 1e8 : vlib_num_workers () ? 5e8 : 1e8;
62 session_wrk_set_state (session_worker_t *wrk, session_wrk_state_t state)
67 if (wrk->timerfd == -1)
69 time_ns = session_wrk_tfd_timeout (state, wrk->vm->thread_index);
70 session_wrk_timerfd_update (wrk, time_ns);
73 static transport_endpt_ext_cfg_t *
74 session_mq_get_ext_config (application_t *app, uword offset)
79 fs = application_get_rx_mqs_segment (app);
80 c = fs_chunk_ptr (fs->h, offset);
81 return (transport_endpt_ext_cfg_t *) c->data;
85 session_mq_free_ext_config (application_t *app, uword offset)
90 fs = application_get_rx_mqs_segment (app);
91 c = fs_chunk_ptr (fs->h, offset);
92 fifo_segment_collect_chunk (fs, 0 /* only one slice */, c);
96 session_mq_listen_handler (void *data)
98 session_listen_msg_t *mp = (session_listen_msg_t *) data;
99 vnet_listen_args_t _a, *a = &_a;
100 app_worker_t *app_wrk;
104 app_check_thread_and_barrier (session_mq_listen_handler, mp);
106 app = application_lookup (mp->client_index);
110 clib_memset (a, 0, sizeof (*a));
111 a->sep.is_ip4 = mp->is_ip4;
112 ip_copy (&a->sep.ip, &mp->ip, mp->is_ip4);
113 a->sep.port = mp->port;
114 a->sep.fib_index = mp->vrf;
115 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
116 a->sep.transport_proto = mp->proto;
117 a->app_index = app->app_index;
118 a->wrk_map_index = mp->wrk_index;
119 a->sep_ext.transport_flags = mp->flags;
122 a->sep_ext.ext_cfg = session_mq_get_ext_config (app, mp->ext_config);
124 if ((rv = vnet_listen (a)))
125 clib_warning ("listen returned: %U", format_session_error, rv);
127 app_wrk = application_get_worker (app, mp->wrk_index);
128 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
131 session_mq_free_ext_config (app, mp->ext_config);
135 session_mq_listen_uri_handler (void *data)
137 session_listen_uri_msg_t *mp = (session_listen_uri_msg_t *) data;
138 vnet_listen_args_t _a, *a = &_a;
139 app_worker_t *app_wrk;
143 app_check_thread_and_barrier (session_mq_listen_uri_handler, mp);
145 app = application_lookup (mp->client_index);
149 clib_memset (a, 0, sizeof (*a));
150 a->uri = (char *) mp->uri;
151 a->app_index = app->app_index;
152 rv = vnet_bind_uri (a);
154 app_wrk = application_get_worker (app, 0);
155 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
159 session_mq_connect_one (session_connect_msg_t *mp)
161 vnet_connect_args_t _a, *a = &_a;
162 app_worker_t *app_wrk;
166 app = application_lookup (mp->client_index);
170 clib_memset (a, 0, sizeof (*a));
171 a->sep.is_ip4 = mp->is_ip4;
172 clib_memcpy_fast (&a->sep.ip, &mp->ip, sizeof (mp->ip));
173 a->sep.port = mp->port;
174 a->sep.transport_proto = mp->proto;
175 a->sep.peer.fib_index = mp->vrf;
176 clib_memcpy_fast (&a->sep.peer.ip, &mp->lcl_ip, sizeof (mp->lcl_ip));
179 ip46_address_mask_ip4 (&a->sep.ip);
180 ip46_address_mask_ip4 (&a->sep.peer.ip);
182 a->sep.peer.port = mp->lcl_port;
183 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
184 a->sep_ext.parent_handle = mp->parent_handle;
185 a->sep_ext.transport_flags = mp->flags;
186 a->api_context = mp->context;
187 a->app_index = app->app_index;
188 a->wrk_map_index = mp->wrk_index;
191 a->sep_ext.ext_cfg = session_mq_get_ext_config (app, mp->ext_config);
193 if ((rv = vnet_connect (a)))
195 clib_warning ("connect returned: %U", format_session_error, rv);
196 app_wrk = application_get_worker (app, mp->wrk_index);
197 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
201 session_mq_free_ext_config (app, mp->ext_config);
205 session_mq_handle_connects_rpc (void *arg)
207 u32 max_connects = 32, n_connects = 0;
208 vlib_main_t *vm = vlib_get_main ();
209 session_evt_elt_t *he, *elt, *next;
210 session_worker_t *fwrk, *wrk;
212 ASSERT (vlib_get_thread_index () == 0);
214 /* Pending connects on linked list pertaining to first worker */
215 fwrk = session_main_get_worker (1);
216 if (!fwrk->n_pending_connects)
219 vlib_worker_thread_barrier_sync (vm);
221 he = clib_llist_elt (fwrk->event_elts, fwrk->pending_connects);
222 elt = clib_llist_next (fwrk->event_elts, evt_list, he);
224 /* Avoid holding the barrier for too long */
225 while (n_connects < max_connects && elt != he)
227 next = clib_llist_next (fwrk->event_elts, evt_list, elt);
228 clib_llist_remove (fwrk->event_elts, evt_list, elt);
229 session_mq_connect_one (session_evt_ctrl_data (fwrk, elt));
230 session_evt_ctrl_data_free (fwrk, elt);
231 clib_llist_put (fwrk->event_elts, elt);
236 /* Decrement with worker barrier */
237 fwrk->n_pending_connects -= n_connects;
239 vlib_worker_thread_barrier_release (vm);
243 /* Switch worker to poll mode if it was in interrupt mode and had work or
244 * back to interrupt if threshold of loops without a connect is passed.
245 * While in poll mode, reprogram connects rpc */
246 wrk = session_main_get_worker (0);
247 if (wrk->state != SESSION_WRK_POLLING)
251 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
252 vlib_node_set_state (vm, session_queue_node.index,
253 VLIB_NODE_STATE_POLLING);
254 wrk->no_connect_loops = 0;
261 if (++wrk->no_connect_loops > 1e5)
263 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
264 vlib_node_set_state (vm, session_queue_node.index,
265 VLIB_NODE_STATE_INTERRUPT);
269 wrk->no_connect_loops = 0;
272 if (wrk->state == SESSION_WRK_POLLING)
274 elt = session_evt_alloc_ctrl (wrk);
275 elt->evt.event_type = SESSION_CTRL_EVT_RPC;
276 elt->evt.rpc_args.fp = session_mq_handle_connects_rpc;
281 session_mq_connect_handler (session_worker_t *wrk, session_evt_elt_t *elt)
283 u32 thread_index = wrk - session_main.wrk;
284 session_evt_elt_t *he;
286 /* No workers, so just deal with the connect now */
287 if (PREDICT_FALSE (!thread_index))
289 session_mq_connect_one (session_evt_ctrl_data (wrk, elt));
293 if (PREDICT_FALSE (thread_index != 1))
295 clib_warning ("Connect on wrong thread. Dropping");
299 /* Add to pending list to be handled by main thread */
300 he = clib_llist_elt (wrk->event_elts, wrk->pending_connects);
301 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
303 /* Decremented with worker barrier */
304 wrk->n_pending_connects += 1;
305 if (wrk->n_pending_connects == 1)
307 vlib_node_set_interrupt_pending (vlib_get_main_by_index (0),
308 session_queue_node.index);
309 session_send_rpc_evt_to_thread (0, session_mq_handle_connects_rpc, 0);
314 session_mq_connect_uri_handler (void *data)
316 session_connect_uri_msg_t *mp = (session_connect_uri_msg_t *) data;
317 vnet_connect_args_t _a, *a = &_a;
318 app_worker_t *app_wrk;
322 app_check_thread_and_barrier (session_mq_connect_uri_handler, mp);
324 app = application_lookup (mp->client_index);
328 clib_memset (a, 0, sizeof (*a));
329 a->uri = (char *) mp->uri;
330 a->api_context = mp->context;
331 a->app_index = app->app_index;
332 if ((rv = vnet_connect_uri (a)))
334 clib_warning ("connect_uri returned: %d", rv);
335 app_wrk = application_get_worker (app, 0 /* default wrk only */ );
336 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
341 session_mq_shutdown_handler (void *data)
343 session_shutdown_msg_t *mp = (session_shutdown_msg_t *) data;
344 vnet_shutdown_args_t _a, *a = &_a;
347 app = application_lookup (mp->client_index);
351 a->app_index = app->app_index;
352 a->handle = mp->handle;
353 vnet_shutdown_session (a);
357 session_mq_disconnect_handler (void *data)
359 session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
360 vnet_disconnect_args_t _a, *a = &_a;
363 app = application_lookup (mp->client_index);
367 a->app_index = app->app_index;
368 a->handle = mp->handle;
369 vnet_disconnect_session (a);
373 app_mq_detach_handler (void *data)
375 session_app_detach_msg_t *mp = (session_app_detach_msg_t *) data;
376 vnet_app_detach_args_t _a, *a = &_a;
379 app_check_thread_and_barrier (app_mq_detach_handler, mp);
381 app = application_lookup (mp->client_index);
385 a->app_index = app->app_index;
386 a->api_client_index = mp->client_index;
387 vnet_application_detach (a);
391 session_mq_unlisten_rpc (session_unlisten_msg_t *mp)
393 vlib_main_t *vm = vlib_get_main ();
394 vnet_unlisten_args_t _a, *a = &_a;
395 app_worker_t *app_wrk;
402 context = mp->context;
404 app = application_lookup (mp->client_index);
408 clib_memset (a, 0, sizeof (*a));
409 a->app_index = app->app_index;
411 a->wrk_map_index = mp->wrk_index;
413 vlib_worker_thread_barrier_sync (vm);
415 if ((rv = vnet_unlisten (a)))
416 clib_warning ("unlisten returned: %d", rv);
418 vlib_worker_thread_barrier_release (vm);
420 app_wrk = application_get_worker (app, a->wrk_map_index);
424 mq_send_unlisten_reply (app_wrk, sh, context, rv);
429 session_mq_unlisten_handler (session_worker_t *wrk, session_evt_elt_t *elt)
431 u32 thread_index = wrk - session_main.wrk;
432 session_unlisten_msg_t *mp, *arg;
434 mp = session_evt_ctrl_data (wrk, elt);
435 arg = clib_mem_alloc (sizeof (session_unlisten_msg_t));
436 clib_memcpy_fast (arg, mp, sizeof (*arg));
438 if (PREDICT_FALSE (!thread_index))
440 session_mq_unlisten_rpc (arg);
444 session_send_rpc_evt_to_thread_force (0, session_mq_unlisten_rpc, arg);
448 session_mq_accepted_reply_handler (void *data)
450 session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
451 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
452 session_state_t old_state;
453 app_worker_t *app_wrk;
456 /* Server isn't interested, kill the session */
459 a->app_index = mp->context;
460 a->handle = mp->handle;
461 vnet_disconnect_session (a);
465 /* Mail this back from the main thread. We're not polling in main
466 * thread so we're using other workers for notifications. */
467 if (vlib_num_workers () && vlib_get_thread_index () != 0
468 && session_thread_from_handle (mp->handle) == 0)
470 vlib_rpc_call_main_thread (session_mq_accepted_reply_handler,
471 (u8 *) mp, sizeof (*mp));
475 s = session_get_from_handle_if_valid (mp->handle);
479 app_wrk = app_worker_get (s->app_wrk_index);
480 if (app_wrk->app_index != mp->context)
482 clib_warning ("app doesn't own session");
486 if (!session_has_transport (s))
488 s->session_state = SESSION_STATE_READY;
489 if (ct_session_connect_notify (s, SESSION_E_NONE))
494 old_state = s->session_state;
495 s->session_state = SESSION_STATE_READY;
497 if (!svm_fifo_is_empty_prod (s->rx_fifo))
498 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
500 /* Closed while waiting for app to reply. Resend disconnect */
501 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
503 app_worker_close_notify (app_wrk, s);
504 s->session_state = old_state;
511 session_mq_reset_reply_handler (void *data)
513 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
514 session_reset_reply_msg_t *mp;
515 app_worker_t *app_wrk;
518 u32 index, thread_index;
520 mp = (session_reset_reply_msg_t *) data;
521 app = application_lookup (mp->context);
525 session_parse_handle (mp->handle, &index, &thread_index);
526 s = session_get_if_valid (index, thread_index);
528 /* No session or not the right session */
529 if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
532 app_wrk = app_worker_get (s->app_wrk_index);
533 if (!app_wrk || app_wrk->app_index != app->app_index)
535 clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
540 /* Client objected to resetting the session, log and continue */
543 clib_warning ("client retval %d", mp->retval);
547 /* This comes as a response to a reset, transport only waiting for
548 * confirmation to remove connection state, no need to disconnect */
549 a->handle = mp->handle;
550 a->app_index = app->app_index;
551 vnet_disconnect_session (a);
555 session_mq_disconnected_handler (void *data)
557 session_disconnected_reply_msg_t *rmp;
558 vnet_disconnect_args_t _a, *a = &_a;
559 svm_msg_q_msg_t _msg, *msg = &_msg;
560 session_disconnected_msg_t *mp;
561 app_worker_t *app_wrk;
562 session_event_t *evt;
567 mp = (session_disconnected_msg_t *) data;
568 if (!(s = session_get_from_handle_if_valid (mp->handle)))
570 clib_warning ("could not disconnect handle %llu", mp->handle);
573 app_wrk = app_worker_get (s->app_wrk_index);
574 app = application_lookup (mp->client_index);
575 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
577 clib_warning ("could not disconnect session: %llu app: %u",
578 mp->handle, mp->client_index);
582 a->handle = mp->handle;
583 a->app_index = app_wrk->wrk_index;
584 rv = vnet_disconnect_session (a);
586 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
587 SESSION_MQ_CTRL_EVT_RING,
589 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
590 clib_memset (evt, 0, sizeof (*evt));
591 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
592 rmp = (session_disconnected_reply_msg_t *) evt->data;
593 rmp->handle = mp->handle;
594 rmp->context = mp->context;
596 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
600 session_mq_disconnected_reply_handler (void *data)
602 session_disconnected_reply_msg_t *mp;
603 vnet_disconnect_args_t _a, *a = &_a;
606 mp = (session_disconnected_reply_msg_t *) data;
608 /* Client objected to disconnecting the session, log and continue */
611 clib_warning ("client retval %d", mp->retval);
615 /* Disconnect has been confirmed. Confirm close to transport */
616 app = application_lookup (mp->context);
619 a->handle = mp->handle;
620 a->app_index = app->app_index;
621 vnet_disconnect_session (a);
626 session_mq_worker_update_handler (void *data)
628 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
629 session_worker_update_reply_msg_t *rmp;
630 svm_msg_q_msg_t _msg, *msg = &_msg;
631 app_worker_t *app_wrk;
632 u32 owner_app_wrk_map;
633 session_event_t *evt;
637 app = application_lookup (mp->client_index);
640 if (!(s = session_get_from_handle_if_valid (mp->handle)))
642 clib_warning ("invalid handle %llu", mp->handle);
645 app_wrk = app_worker_get (s->app_wrk_index);
646 if (app_wrk->app_index != app->app_index)
648 clib_warning ("app %u does not own session %llu", app->app_index,
652 owner_app_wrk_map = app_wrk->wrk_map_index;
653 app_wrk = application_get_worker (app, mp->wrk_index);
655 /* This needs to come from the new owner */
656 if (mp->req_wrk_index == owner_app_wrk_map)
658 session_req_worker_update_msg_t *wump;
660 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
661 SESSION_MQ_CTRL_EVT_RING,
663 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
664 clib_memset (evt, 0, sizeof (*evt));
665 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
666 wump = (session_req_worker_update_msg_t *) evt->data;
667 wump->session_handle = mp->handle;
668 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
672 app_worker_own_session (app_wrk, s);
677 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
678 SESSION_MQ_CTRL_EVT_RING,
680 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
681 clib_memset (evt, 0, sizeof (*evt));
682 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
683 rmp = (session_worker_update_reply_msg_t *) evt->data;
684 rmp->handle = mp->handle;
686 rmp->rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
688 rmp->tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
689 rmp->segment_handle = session_segment_handle (s);
690 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
693 * Retransmit messages that may have been lost
695 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
696 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
698 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
699 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
701 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
702 app_worker_close_notify (app_wrk, s);
706 session_mq_app_wrk_rpc_handler (void *data)
708 session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
709 svm_msg_q_msg_t _msg, *msg = &_msg;
710 session_app_wrk_rpc_msg_t *rmp;
711 app_worker_t *app_wrk;
712 session_event_t *evt;
715 app = application_lookup (mp->client_index);
719 app_wrk = application_get_worker (app, mp->wrk_index);
721 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
722 SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
724 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
725 clib_memset (evt, 0, sizeof (*evt));
726 evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
727 rmp = (session_app_wrk_rpc_msg_t *) evt->data;
728 clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
729 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
733 session_mq_transport_attr_handler (void *data)
735 session_transport_attr_msg_t *mp = (session_transport_attr_msg_t *) data;
736 session_transport_attr_reply_msg_t *rmp;
737 svm_msg_q_msg_t _msg, *msg = &_msg;
738 app_worker_t *app_wrk;
739 session_event_t *evt;
744 app = application_lookup (mp->client_index);
748 if (!(s = session_get_from_handle_if_valid (mp->handle)))
750 clib_warning ("invalid handle %llu", mp->handle);
753 app_wrk = app_worker_get (s->app_wrk_index);
754 if (app_wrk->app_index != app->app_index)
756 clib_warning ("app %u does not own session %llu", app->app_index,
761 rv = session_transport_attribute (s, mp->is_get, &mp->attr);
763 svm_msg_q_lock_and_alloc_msg_w_ring (
764 app_wrk->event_queue, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, msg);
765 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
766 clib_memset (evt, 0, sizeof (*evt));
767 evt->event_type = SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY;
768 rmp = (session_transport_attr_reply_msg_t *) evt->data;
769 rmp->handle = mp->handle;
771 rmp->is_get = mp->is_get;
772 if (!rv && mp->is_get)
773 rmp->attr = mp->attr;
774 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
777 vlib_node_registration_t session_queue_node;
782 u32 server_thread_index;
783 } session_queue_trace_t;
785 /* packet trace format function */
787 format_session_queue_trace (u8 * s, va_list * args)
789 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
790 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
791 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
793 s = format (s, "session index %d thread index %d",
794 t->session_index, t->server_thread_index);
798 #define foreach_session_queue_error \
799 _(TX, "Packets transmitted") \
800 _(TIMER, "Timer events") \
801 _(NO_BUFFER, "Out of buffers")
805 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
806 foreach_session_queue_error
808 SESSION_QUEUE_N_ERROR,
809 } session_queue_error_t;
811 static char *session_queue_error_strings[] = {
812 #define _(sym,string) string,
813 foreach_session_queue_error
819 SESSION_TX_NO_BUFFERS = -2,
825 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
826 u32 next_index, u32 * to_next, u16 n_segs,
827 session_t * s, u32 n_trace)
829 while (n_trace && n_segs)
831 vlib_buffer_t *b = vlib_get_buffer (vm, to_next[0]);
834 (vm, node, next_index, b, 1 /* follow_chain */ )))
836 session_queue_trace_t *t =
837 vlib_add_trace (vm, node, b, sizeof (*t));
838 t->session_index = s->session_index;
839 t->server_thread_index = s->thread_index;
845 vlib_set_trace_count (vm, node, n_trace);
849 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
850 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
852 vlib_buffer_t *chain_b, *prev_b;
853 u32 chain_bi0, to_deq, left_from_seg;
854 u16 len_to_deq, n_bytes_read;
857 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
858 b->total_length_not_including_first_buffer = 0;
861 left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
863 to_deq = left_from_seg;
864 for (j = 1; j < ctx->n_bufs_per_seg; j++)
867 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
870 chain_bi0 = ctx->tx_buffers[*n_bufs];
871 chain_b = vlib_get_buffer (vm, chain_bi0);
872 chain_b->current_data = 0;
873 data = vlib_buffer_get_current (chain_b);
876 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
877 ctx->sp.tx_offset, len_to_deq, data);
878 ctx->sp.tx_offset += n_bytes_read;
882 if (ctx->transport_vft->transport_options.tx_type ==
885 svm_fifo_t *f = ctx->s->tx_fifo;
886 session_dgram_hdr_t *hdr = &ctx->hdr;
890 deq_now = clib_min (hdr->data_length - hdr->data_offset,
892 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
893 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data);
894 ASSERT (n_bytes_read > 0);
896 hdr->data_offset += n_bytes_read;
897 if (hdr->data_offset == hdr->data_length)
899 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
900 svm_fifo_dequeue_drop (f, offset);
901 if (ctx->left_to_snd > n_bytes_read)
902 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
905 else if (ctx->left_to_snd == n_bytes_read)
906 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
907 sizeof (session_dgram_pre_hdr_t));
910 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
913 ASSERT (n_bytes_read == len_to_deq);
914 chain_b->current_length = n_bytes_read;
915 b->total_length_not_including_first_buffer += chain_b->current_length;
917 /* update previous buffer */
918 prev_b->next_buffer = chain_bi0;
919 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
921 /* update current buffer */
922 chain_b->next_buffer = 0;
924 to_deq -= n_bytes_read;
929 && b->total_length_not_including_first_buffer == left_from_seg);
930 ctx->left_to_snd -= left_from_seg;
934 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
935 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
942 * Start with the first buffer in chain
945 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
948 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
949 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
953 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset,
955 ASSERT (n_bytes_read > 0);
956 /* Keep track of progress locally, transport is also supposed to
957 * increment it independently when pushing the header */
958 ctx->sp.tx_offset += n_bytes_read;
962 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
964 session_dgram_hdr_t *hdr = &ctx->hdr;
965 svm_fifo_t *f = ctx->s->tx_fifo;
969 ASSERT (hdr->data_length > hdr->data_offset);
970 deq_now = clib_min (hdr->data_length - hdr->data_offset,
972 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
973 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
974 ASSERT (n_bytes_read > 0);
976 if (ctx->s->session_state == SESSION_STATE_LISTENING)
978 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
979 ctx->tc->rmt_port = hdr->rmt_port;
981 hdr->data_offset += n_bytes_read;
982 if (hdr->data_offset == hdr->data_length)
984 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
985 svm_fifo_dequeue_drop (f, offset);
986 if (ctx->left_to_snd > n_bytes_read)
987 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
990 else if (ctx->left_to_snd == n_bytes_read)
991 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
992 sizeof (session_dgram_pre_hdr_t));
996 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
998 ASSERT (n_bytes_read > 0);
1001 b->current_length = n_bytes_read;
1002 ctx->left_to_snd -= n_bytes_read;
1005 * Fill in the remaining buffers in the chain, if any
1007 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
1008 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
1012 session_tx_not_ready (session_t * s, u8 peek_data)
1016 if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
1018 /* Can retransmit for closed sessions but can't send new data if
1019 * session is not ready or closed */
1020 else if (s->session_state < SESSION_STATE_READY)
1022 else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1024 /* Allow closed transports to still send custom packets.
1025 * For instance, tcp may want to send acks in time-wait. */
1026 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
1027 && (s->flags & SESSION_F_CUSTOM_TX))
1035 always_inline transport_connection_t *
1036 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
1040 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1041 ctx->s->thread_index);
1045 if (ctx->s->session_state == SESSION_STATE_LISTENING)
1046 return ctx->transport_vft->get_listener (ctx->s->connection_index);
1049 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1050 ctx->s->thread_index);
1056 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
1057 u32 max_segs, u8 peek_data)
1059 u32 n_bytes_per_buf, n_bytes_per_seg;
1061 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
1062 ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
1066 /* Offset in rx fifo from where to peek data */
1067 if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
1069 ctx->max_len_to_snd = 0;
1072 ctx->max_dequeue -= ctx->sp.tx_offset;
1076 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1078 u32 len, chain_limit;
1080 if (ctx->max_dequeue <= sizeof (ctx->hdr))
1082 ctx->max_len_to_snd = 0;
1086 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1088 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
1089 len = ctx->hdr.data_length - ctx->hdr.data_offset;
1091 /* Process multiple dgrams if smaller than min (buf_space, mss).
1092 * This avoids handling multiple dgrams if they require buffer
1094 chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
1096 if (ctx->hdr.data_length <= chain_limit)
1098 u32 first_dgram_len, dgram_len, offset, max_offset;
1099 session_dgram_hdr_t hdr;
1101 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
1102 offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
1103 first_dgram_len = len;
1104 max_offset = clib_min (ctx->max_dequeue, 16 << 10);
1106 while (offset < max_offset)
1108 svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
1110 ASSERT (hdr.data_length > hdr.data_offset);
1111 dgram_len = hdr.data_length - hdr.data_offset;
1112 if (len + dgram_len > ctx->max_dequeue
1113 || first_dgram_len != dgram_len)
1116 offset += sizeof (hdr) + hdr.data_length;
1120 ctx->max_dequeue = len;
1123 ASSERT (ctx->max_dequeue > 0);
1125 /* Ensure we're not writing more than transport window allows */
1126 if (ctx->max_dequeue < ctx->sp.snd_space)
1128 /* Constrained by tx queue. Try to send only fully formed segments */
1129 ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
1130 (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
1136 /* Expectation is that snd_space0 is already a multiple of snd_mss */
1137 ctx->max_len_to_snd = ctx->sp.snd_space;
1140 /* Check if we're tx constrained by the node */
1141 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
1142 if (ctx->n_segs_per_evt > max_segs)
1144 ctx->n_segs_per_evt = max_segs;
1145 ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
1148 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
1149 if (ctx->n_segs_per_evt > 1)
1151 u32 n_bytes_last_seg, n_bufs_last_seg;
1153 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
1154 n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
1155 - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
1156 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1157 n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
1158 ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
1163 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
1164 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1165 ctx->n_bufs_needed = ctx->n_bufs_per_seg;
1168 ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
1169 ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
1171 TRANSPORT_MAX_HDRS_LEN);
1175 session_tx_maybe_reschedule (session_worker_t * wrk,
1176 session_tx_context_t * ctx,
1177 session_evt_elt_t * elt)
1179 session_t *s = ctx->s;
1181 svm_fifo_unset_event (s->tx_fifo);
1182 if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
1183 if (svm_fifo_set_event (s->tx_fifo))
1184 session_evt_add_head_old (wrk, elt);
1188 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
1189 vlib_node_runtime_t * node,
1190 session_evt_elt_t * elt,
1191 int *n_tx_packets, u8 peek_data)
1193 u32 n_trace, n_left, pbi, next_index, max_burst;
1194 session_tx_context_t *ctx = &wrk->ctx;
1195 session_main_t *smm = &session_main;
1196 session_event_t *e = &elt->evt;
1197 vlib_main_t *vm = wrk->vm;
1198 transport_proto_t tp;
1202 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
1205 session_evt_add_old (wrk, elt);
1206 return SESSION_TX_NO_DATA;
1209 next_index = smm->session_type_to_next[ctx->s->session_type];
1210 max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
1212 tp = session_get_transport_proto (ctx->s);
1213 ctx->transport_vft = transport_protocol_get_vft (tp);
1214 ctx->tc = session_tx_get_transport (ctx, peek_data);
1216 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
1218 if (ctx->transport_vft->flush_data)
1219 ctx->transport_vft->flush_data (ctx->tc);
1220 e->event_type = SESSION_IO_EVT_TX;
1223 if (ctx->s->flags & SESSION_F_CUSTOM_TX)
1226 ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
1227 ctx->sp.max_burst_size = max_burst;
1228 n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
1229 *n_tx_packets += n_custom_tx;
1231 (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1232 return SESSION_TX_OK;
1233 max_burst -= n_custom_tx;
1234 if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
1236 session_evt_add_old (wrk, elt);
1237 return SESSION_TX_OK;
1241 transport_connection_snd_params (ctx->tc, &ctx->sp);
1243 if (!ctx->sp.snd_space)
1245 /* If the deschedule flag was set, remove session from scheduler.
1246 * Transport is responsible for rescheduling this session. */
1247 if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
1248 transport_connection_deschedule (ctx->tc);
1249 /* Request to postpone the session, e.g., zero-wnd and transport
1250 * is not currently probing */
1251 else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
1252 session_evt_add_old (wrk, elt);
1253 /* This flow queue is "empty" so it should be re-evaluated before
1254 * the ones that have data to send. */
1256 session_evt_add_head_old (wrk, elt);
1258 return SESSION_TX_NO_DATA;
1261 if (transport_connection_is_tx_paced (ctx->tc))
1263 u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1264 if (snd_space < TRANSPORT_PACER_MIN_BURST)
1266 session_evt_add_head_old (wrk, elt);
1267 return SESSION_TX_NO_DATA;
1269 snd_space = clib_min (ctx->sp.snd_space, snd_space);
1270 ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1271 snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1274 /* Check how much we can pull. */
1275 session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1277 if (PREDICT_FALSE (!ctx->max_len_to_snd))
1279 transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1280 session_tx_maybe_reschedule (wrk, ctx, elt);
1281 return SESSION_TX_NO_DATA;
1284 vec_validate_aligned (ctx->tx_buffers, ctx->n_bufs_needed - 1,
1285 CLIB_CACHE_LINE_BYTES);
1286 n_bufs = vlib_buffer_alloc (vm, ctx->tx_buffers, ctx->n_bufs_needed);
1287 if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1290 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1291 session_evt_add_head_old (wrk, elt);
1292 vlib_node_increment_counter (wrk->vm, node->node_index,
1293 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1294 return SESSION_TX_NO_BUFFERS;
1297 if (transport_connection_is_tx_paced (ctx->tc))
1298 transport_connection_tx_pacer_update_bytes (ctx->tc, ctx->max_len_to_snd);
1300 ctx->left_to_snd = ctx->max_len_to_snd;
1301 n_left = ctx->n_segs_per_evt;
1305 vlib_buffer_t *b0, *b1;
1308 pbi = ctx->tx_buffers[n_bufs - 3];
1309 pb = vlib_get_buffer (vm, pbi);
1310 vlib_prefetch_buffer_header (pb, STORE);
1311 pbi = ctx->tx_buffers[n_bufs - 4];
1312 pb = vlib_get_buffer (vm, pbi);
1313 vlib_prefetch_buffer_header (pb, STORE);
1315 bi0 = ctx->tx_buffers[--n_bufs];
1316 bi1 = ctx->tx_buffers[--n_bufs];
1318 b0 = vlib_get_buffer (vm, bi0);
1319 b1 = vlib_get_buffer (vm, bi1);
1321 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1322 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
1324 ctx->transport_vft->push_header (ctx->tc, b0);
1325 ctx->transport_vft->push_header (ctx->tc, b1);
1329 vec_add1 (wrk->pending_tx_buffers, bi0);
1330 vec_add1 (wrk->pending_tx_buffers, bi1);
1331 vec_add1 (wrk->pending_tx_nexts, next_index);
1332 vec_add1 (wrk->pending_tx_nexts, next_index);
1341 pbi = ctx->tx_buffers[n_bufs - 2];
1342 pb = vlib_get_buffer (vm, pbi);
1343 vlib_prefetch_buffer_header (pb, STORE);
1346 bi0 = ctx->tx_buffers[--n_bufs];
1347 b0 = vlib_get_buffer (vm, bi0);
1348 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1350 /* Ask transport to push header after current_length and
1351 * total_length_not_including_first_buffer are updated */
1352 ctx->transport_vft->push_header (ctx->tc, b0);
1356 vec_add1 (wrk->pending_tx_buffers, bi0);
1357 vec_add1 (wrk->pending_tx_nexts, next_index);
1360 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1361 session_tx_trace_frame (vm, node, next_index, wrk->pending_tx_buffers,
1362 ctx->n_segs_per_evt, ctx->s, n_trace);
1364 if (PREDICT_FALSE (n_bufs))
1365 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1367 *n_tx_packets += ctx->n_segs_per_evt;
1369 SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1370 ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
1372 ASSERT (ctx->left_to_snd == 0);
1374 /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1375 * check if application enqueued more data and reschedule accordingly */
1376 if (ctx->max_len_to_snd < ctx->max_dequeue)
1377 session_evt_add_old (wrk, elt);
1379 session_tx_maybe_reschedule (wrk, ctx, elt);
1383 u32 n_dequeued = ctx->max_len_to_snd;
1384 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1385 n_dequeued += ctx->n_segs_per_evt * SESSION_CONN_HDR_LEN;
1386 if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, n_dequeued))
1387 session_dequeue_notify (ctx->s);
1389 return SESSION_TX_OK;
1393 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1394 vlib_node_runtime_t * node,
1395 session_evt_elt_t * e, int *n_tx_packets)
1397 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1401 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1402 vlib_node_runtime_t * node,
1403 session_evt_elt_t * e, int *n_tx_packets)
1405 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1409 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1410 vlib_node_runtime_t * node,
1411 session_evt_elt_t * elt, int *n_tx_packets)
1413 transport_send_params_t *sp = &wrk->ctx.sp;
1414 session_t *s = wrk->ctx.s;
1417 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1420 /* Clear custom-tx flag used to request reschedule for tx */
1421 s->flags &= ~SESSION_F_CUSTOM_TX;
1423 sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1424 TRANSPORT_PACER_MAX_BURST_PKTS);
1426 n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1427 *n_tx_packets += n_packets;
1429 if (s->flags & SESSION_F_CUSTOM_TX)
1431 session_evt_add_old (wrk, elt);
1433 else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1435 svm_fifo_unset_event (s->tx_fifo);
1436 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1437 if (svm_fifo_set_event (s->tx_fifo))
1438 session_evt_add_head_old (wrk, elt);
1441 if (sp->max_burst_size &&
1442 svm_fifo_needs_deq_ntf (s->tx_fifo, sp->max_burst_size))
1443 session_dequeue_notify (s);
1448 always_inline session_t *
1449 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1451 if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1454 ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1455 return pool_elt_at_index (wrk->sessions, e->session_index);
1459 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1461 clib_llist_index_t ei;
1462 void (*fp) (void *);
1466 ei = clib_llist_entry_index (wrk->event_elts, elt);
1469 switch (e->event_type)
1471 case SESSION_CTRL_EVT_RPC:
1472 fp = e->rpc_args.fp;
1473 (*fp) (e->rpc_args.arg);
1475 case SESSION_CTRL_EVT_HALF_CLOSE:
1476 s = session_get_from_handle_if_valid (e->session_handle);
1477 if (PREDICT_FALSE (!s))
1479 session_transport_half_close (s);
1481 case SESSION_CTRL_EVT_CLOSE:
1482 s = session_get_from_handle_if_valid (e->session_handle);
1483 if (PREDICT_FALSE (!s))
1485 session_transport_close (s);
1487 case SESSION_CTRL_EVT_RESET:
1488 s = session_get_from_handle_if_valid (e->session_handle);
1489 if (PREDICT_FALSE (!s))
1491 session_transport_reset (s);
1493 case SESSION_CTRL_EVT_LISTEN:
1494 session_mq_listen_handler (session_evt_ctrl_data (wrk, elt));
1496 case SESSION_CTRL_EVT_LISTEN_URI:
1497 session_mq_listen_uri_handler (session_evt_ctrl_data (wrk, elt));
1499 case SESSION_CTRL_EVT_UNLISTEN:
1500 session_mq_unlisten_handler (wrk, elt);
1502 case SESSION_CTRL_EVT_CONNECT:
1503 session_mq_connect_handler (wrk, elt);
1505 case SESSION_CTRL_EVT_CONNECT_URI:
1506 session_mq_connect_uri_handler (session_evt_ctrl_data (wrk, elt));
1508 case SESSION_CTRL_EVT_SHUTDOWN:
1509 session_mq_shutdown_handler (session_evt_ctrl_data (wrk, elt));
1511 case SESSION_CTRL_EVT_DISCONNECT:
1512 session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1514 case SESSION_CTRL_EVT_DISCONNECTED:
1515 session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1517 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1518 session_mq_accepted_reply_handler (session_evt_ctrl_data (wrk, elt));
1520 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1521 session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1524 case SESSION_CTRL_EVT_RESET_REPLY:
1525 session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1527 case SESSION_CTRL_EVT_WORKER_UPDATE:
1528 session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1530 case SESSION_CTRL_EVT_APP_DETACH:
1531 app_mq_detach_handler (session_evt_ctrl_data (wrk, elt));
1533 case SESSION_CTRL_EVT_APP_WRK_RPC:
1534 session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1536 case SESSION_CTRL_EVT_TRANSPORT_ATTR:
1537 session_mq_transport_attr_handler (session_evt_ctrl_data (wrk, elt));
1540 clib_warning ("unhandled event type %d", e->event_type);
1543 /* Regrab elements in case pool moved */
1544 elt = clib_llist_elt (wrk->event_elts, ei);
1545 if (!clib_llist_elt_is_linked (elt, evt_list))
1548 if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1549 session_evt_ctrl_data_free (wrk, elt);
1550 clib_llist_put (wrk->event_elts, elt);
1552 SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1556 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1557 session_evt_elt_t * elt, int *n_tx_packets)
1559 session_main_t *smm = &session_main;
1560 app_worker_t *app_wrk;
1561 clib_llist_index_t ei;
1565 ei = clib_llist_entry_index (wrk->event_elts, elt);
1568 switch (e->event_type)
1570 case SESSION_IO_EVT_TX_FLUSH:
1571 case SESSION_IO_EVT_TX:
1572 s = session_event_get_session (wrk, e);
1573 if (PREDICT_FALSE (!s))
1575 CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
1577 /* Spray packets in per session type frames, since they go to
1578 * different nodes */
1579 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1581 case SESSION_IO_EVT_RX:
1582 s = session_event_get_session (wrk, e);
1585 transport_app_rx_evt (session_get_transport_proto (s),
1586 s->connection_index, s->thread_index);
1588 case SESSION_IO_EVT_BUILTIN_RX:
1589 s = session_event_get_session (wrk, e);
1590 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1592 svm_fifo_unset_event (s->rx_fifo);
1593 app_wrk = app_worker_get (s->app_wrk_index);
1594 app_worker_builtin_rx (app_wrk, s);
1596 case SESSION_IO_EVT_BUILTIN_TX:
1597 s = session_get_from_handle_if_valid (e->session_handle);
1599 if (PREDICT_TRUE (s != 0))
1600 session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
1603 clib_warning ("unhandled event type %d", e->event_type);
1606 SESSION_EVT (SESSION_IO_EVT_COUNTS, e->event_type, 1, wrk);
1608 /* Regrab elements in case pool moved */
1609 elt = clib_llist_elt (wrk->event_elts, ei);
1610 if (!clib_llist_elt_is_linked (elt, evt_list))
1611 clib_llist_put (wrk->event_elts, elt);
1615 static const u32 session_evt_msg_sizes[] = {
1616 #define _(symc, sym) \
1617 [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1618 foreach_session_ctrl_evt
1624 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1626 session_evt_elt_t *elt;
1628 if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1630 elt = session_evt_alloc_ctrl (wrk);
1631 if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1633 elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1634 elt->evt.event_type = evt->event_type;
1635 clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1636 session_evt_msg_sizes[evt->event_type]);
1640 /* Internal control events fit into io events footprint */
1641 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1646 elt = session_evt_alloc_new (wrk);
1647 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1652 session_flush_pending_tx_buffers (session_worker_t * wrk,
1653 vlib_node_runtime_t * node)
1655 vlib_buffer_enqueue_to_next (wrk->vm, node, wrk->pending_tx_buffers,
1656 wrk->pending_tx_nexts,
1657 vec_len (wrk->pending_tx_nexts));
1658 vec_reset_length (wrk->pending_tx_buffers);
1659 vec_reset_length (wrk->pending_tx_nexts);
1663 session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq)
1665 svm_msg_q_msg_t _msg, *msg = &_msg;
1666 u32 i, n_to_dequeue = 0;
1667 session_event_t *evt;
1669 n_to_dequeue = svm_msg_q_size (mq);
1670 for (i = 0; i < n_to_dequeue; i++)
1672 svm_msg_q_sub_raw (mq, msg);
1673 evt = svm_msg_q_msg_data (mq, msg);
1674 session_evt_add_to_list (wrk, evt);
1675 svm_msg_q_free_msg (mq, msg);
1678 return n_to_dequeue;
1682 session_wrk_update_state (session_worker_t *wrk)
1684 vlib_main_t *vm = wrk->vm;
1686 if (wrk->state == SESSION_WRK_POLLING)
1688 if (clib_llist_elts (wrk->event_elts) == 4 &&
1689 vlib_last_vectors_per_main_loop (vm) < 1)
1691 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1692 vlib_node_set_state (vm, session_queue_node.index,
1693 VLIB_NODE_STATE_INTERRUPT);
1696 else if (wrk->state == SESSION_WRK_INTERRUPT)
1698 if (clib_llist_elts (wrk->event_elts) > 4 ||
1699 vlib_last_vectors_per_main_loop (vm) > 1)
1701 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
1702 vlib_node_set_state (vm, session_queue_node.index,
1703 VLIB_NODE_STATE_POLLING);
1705 else if (PREDICT_FALSE (!pool_elts (wrk->sessions)))
1707 session_wrk_set_state (wrk, SESSION_WRK_IDLE);
1712 if (clib_llist_elts (wrk->event_elts))
1714 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1720 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1721 vlib_frame_t * frame)
1723 u32 thread_index = vm->thread_index, __clib_unused n_evts;
1724 session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1725 session_main_t *smm = vnet_get_session_main ();
1726 session_worker_t *wrk = &smm->wrk[thread_index];
1727 clib_llist_index_t ei, next_ei, old_ti;
1730 SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1732 session_wrk_update_time (wrk, vlib_time_now (vm));
1735 * Update transport time
1737 transport_update_time (wrk->last_vlib_time, thread_index);
1738 n_tx_packets = vec_len (wrk->pending_tx_buffers);
1739 SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1742 * Dequeue new internal mq events
1745 n_evts = session_wrk_handle_mq (wrk, wrk->vpp_event_queue);
1746 SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_evts);
1749 * Handle control events
1752 ei = wrk->ctrl_head;
1753 ctrl_he = clib_llist_elt (wrk->event_elts, ei);
1754 next_ei = clib_llist_next_index (ctrl_he, evt_list);
1755 old_ti = clib_llist_prev_index (ctrl_he, evt_list);
1756 while (ei != old_ti)
1759 elt = clib_llist_elt (wrk->event_elts, next_ei);
1760 next_ei = clib_llist_next_index (elt, evt_list);
1761 clib_llist_remove (wrk->event_elts, evt_list, elt);
1762 session_event_dispatch_ctrl (wrk, elt);
1765 SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1768 * Handle the new io events.
1771 new_he = clib_llist_elt (wrk->event_elts, wrk->new_head);
1772 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1773 old_ti = clib_llist_prev_index (old_he, evt_list);
1775 ei = clib_llist_next_index (new_he, evt_list);
1776 while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
1778 elt = clib_llist_elt (wrk->event_elts, ei);
1779 ei = clib_llist_next_index (elt, evt_list);
1780 clib_llist_remove (wrk->event_elts, evt_list, elt);
1781 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1784 SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1787 * Handle the old io events, if we had any prior to processing the new ones
1790 if (old_ti != wrk->old_head)
1792 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1793 ei = clib_llist_next_index (old_he, evt_list);
1795 while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
1797 elt = clib_llist_elt (wrk->event_elts, ei);
1798 next_ei = clib_llist_next_index (elt, evt_list);
1799 clib_llist_remove (wrk->event_elts, evt_list, elt);
1801 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1810 SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
1812 if (vec_len (wrk->pending_tx_buffers))
1813 session_flush_pending_tx_buffers (wrk, node);
1815 vlib_node_increment_counter (vm, session_queue_node.index,
1816 SESSION_QUEUE_ERROR_TX, n_tx_packets);
1818 SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1820 if (wrk->flags & SESSION_WRK_F_ADAPTIVE)
1821 session_wrk_update_state (wrk);
1823 return n_tx_packets;
1827 VLIB_REGISTER_NODE (session_queue_node) =
1829 .function = session_queue_node_fn,
1830 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1831 .name = "session-queue",
1832 .format_trace = format_session_queue_trace,
1833 .type = VLIB_NODE_TYPE_INPUT,
1834 .n_errors = ARRAY_LEN (session_queue_error_strings),
1835 .error_strings = session_queue_error_strings,
1836 .state = VLIB_NODE_STATE_DISABLED,
1840 static clib_error_t *
1841 session_wrk_tfd_read_ready (clib_file_t *cf)
1843 session_worker_t *wrk = session_main_get_worker (cf->private_data);
1847 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
1848 rv = read (wrk->timerfd, &buf, sizeof (buf));
1849 if (rv < 0 && errno != EAGAIN)
1850 clib_unix_warning ("failed");
1854 static clib_error_t *
1855 session_wrk_tfd_write_ready (clib_file_t *cf)
1861 session_wrk_enable_adaptive_mode (session_worker_t *wrk)
1863 u32 thread_index = wrk->vm->thread_index;
1864 clib_file_t template = { 0 };
1866 if ((wrk->timerfd = timerfd_create (CLOCK_MONOTONIC, TFD_NONBLOCK)) < 0)
1867 clib_warning ("timerfd_create");
1869 template.read_function = session_wrk_tfd_read_ready;
1870 template.write_function = session_wrk_tfd_write_ready;
1871 template.file_descriptor = wrk->timerfd;
1872 template.private_data = thread_index;
1873 template.polling_thread_index = thread_index;
1874 template.description = format (0, "session-wrk-tfd-%u", thread_index);
1876 wrk->timerfd_file = clib_file_add (&file_main, &template);
1877 wrk->flags |= SESSION_WRK_F_ADAPTIVE;
1880 static clib_error_t *
1881 session_queue_exit (vlib_main_t * vm)
1883 if (vlib_get_n_threads () < 2)
1887 * Shut off (especially) worker-thread session nodes.
1888 * Otherwise, vpp can crash as the main thread unmaps the
1891 vlib_worker_thread_barrier_sync (vm);
1892 session_node_enable_disable (0 /* is_enable */ );
1893 vlib_worker_thread_barrier_release (vm);
1897 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1900 session_queue_run_on_main (vlib_main_t * vm)
1902 vlib_node_runtime_t *node;
1904 node = vlib_node_get_runtime (vm, session_queue_node.index);
1905 return session_queue_node_fn (vm, node, 0);
1909 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1912 uword *event_data = 0;
1918 vlib_process_wait_for_event_or_clock (vm, timeout);
1919 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1923 case SESSION_Q_PROCESS_RUN_ON_MAIN:
1924 /* Run session queue node on main thread */
1925 session_queue_run_on_main (vm);
1927 case SESSION_Q_PROCESS_STOP:
1928 vlib_node_set_state (vm, session_queue_process_node.index,
1929 VLIB_NODE_STATE_DISABLED);
1933 /* Timed out. Run on main to ensure all events are handled */
1934 session_queue_run_on_main (vm);
1937 vec_reset_length (event_data);
1943 VLIB_REGISTER_NODE (session_queue_process_node) =
1945 .function = session_queue_process,
1946 .type = VLIB_NODE_TYPE_PROCESS,
1947 .name = "session-queue-process",
1948 .state = VLIB_NODE_STATE_DISABLED,
1952 static_always_inline uword
1953 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1954 vlib_frame_t * frame)
1956 session_main_t *sm = &session_main;
1957 if (!sm->wrk[0].vpp_event_queue)
1959 node = vlib_node_get_runtime (vm, session_queue_node.index);
1960 return session_queue_node_fn (vm, node, frame);
1964 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1966 .function = session_queue_pre_input_inline,
1967 .type = VLIB_NODE_TYPE_PRE_INPUT,
1968 .name = "session-queue-main",
1969 .state = VLIB_NODE_STATE_DISABLED,
1974 * fd.io coding-style-patch-verification: ON
1977 * eval: (c-set-style "gnu")