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 a->sep.dscp = mp->dscp;
177 clib_memcpy_fast (&a->sep.peer.ip, &mp->lcl_ip, sizeof (mp->lcl_ip));
180 ip46_address_mask_ip4 (&a->sep.ip);
181 ip46_address_mask_ip4 (&a->sep.peer.ip);
183 a->sep.peer.port = mp->lcl_port;
184 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
185 a->sep_ext.parent_handle = mp->parent_handle;
186 a->sep_ext.transport_flags = mp->flags;
187 a->api_context = mp->context;
188 a->app_index = app->app_index;
189 a->wrk_map_index = mp->wrk_index;
192 a->sep_ext.ext_cfg = session_mq_get_ext_config (app, mp->ext_config);
194 if ((rv = vnet_connect (a)))
196 clib_warning ("connect returned: %U", format_session_error, rv);
197 app_wrk = application_get_worker (app, mp->wrk_index);
198 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
202 session_mq_free_ext_config (app, mp->ext_config);
206 session_mq_handle_connects_rpc (void *arg)
208 u32 max_connects = 32, n_connects = 0;
209 vlib_main_t *vm = vlib_get_main ();
210 session_evt_elt_t *he, *elt, *next;
211 session_worker_t *fwrk, *wrk;
213 ASSERT (vlib_get_thread_index () == 0);
215 /* Pending connects on linked list pertaining to first worker */
216 fwrk = session_main_get_worker (1);
217 if (!fwrk->n_pending_connects)
220 vlib_worker_thread_barrier_sync (vm);
222 he = clib_llist_elt (fwrk->event_elts, fwrk->pending_connects);
223 elt = clib_llist_next (fwrk->event_elts, evt_list, he);
225 /* Avoid holding the barrier for too long */
226 while (n_connects < max_connects && elt != he)
228 next = clib_llist_next (fwrk->event_elts, evt_list, elt);
229 clib_llist_remove (fwrk->event_elts, evt_list, elt);
230 session_mq_connect_one (session_evt_ctrl_data (fwrk, elt));
231 session_evt_ctrl_data_free (fwrk, elt);
232 clib_llist_put (fwrk->event_elts, elt);
237 /* Decrement with worker barrier */
238 fwrk->n_pending_connects -= n_connects;
240 vlib_worker_thread_barrier_release (vm);
244 /* Switch worker to poll mode if it was in interrupt mode and had work or
245 * back to interrupt if threshold of loops without a connect is passed.
246 * While in poll mode, reprogram connects rpc */
247 wrk = session_main_get_worker (0);
248 if (wrk->state != SESSION_WRK_POLLING)
252 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
253 vlib_node_set_state (vm, session_queue_node.index,
254 VLIB_NODE_STATE_POLLING);
255 wrk->no_connect_loops = 0;
262 if (++wrk->no_connect_loops > 1e5)
264 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
265 vlib_node_set_state (vm, session_queue_node.index,
266 VLIB_NODE_STATE_INTERRUPT);
270 wrk->no_connect_loops = 0;
273 if (wrk->state == SESSION_WRK_POLLING)
275 elt = session_evt_alloc_ctrl (wrk);
276 elt->evt.event_type = SESSION_CTRL_EVT_RPC;
277 elt->evt.rpc_args.fp = session_mq_handle_connects_rpc;
282 session_mq_connect_handler (session_worker_t *wrk, session_evt_elt_t *elt)
284 u32 thread_index = wrk - session_main.wrk;
285 session_evt_elt_t *he;
287 /* No workers, so just deal with the connect now */
288 if (PREDICT_FALSE (!thread_index))
290 session_mq_connect_one (session_evt_ctrl_data (wrk, elt));
294 if (PREDICT_FALSE (thread_index != 1))
296 clib_warning ("Connect on wrong thread. Dropping");
300 /* Add to pending list to be handled by main thread */
301 he = clib_llist_elt (wrk->event_elts, wrk->pending_connects);
302 clib_llist_add_tail (wrk->event_elts, evt_list, elt, he);
304 /* Decremented with worker barrier */
305 wrk->n_pending_connects += 1;
306 if (wrk->n_pending_connects == 1)
308 vlib_node_set_interrupt_pending (vlib_get_main_by_index (0),
309 session_queue_node.index);
310 session_send_rpc_evt_to_thread (0, session_mq_handle_connects_rpc, 0);
315 session_mq_connect_uri_handler (void *data)
317 session_connect_uri_msg_t *mp = (session_connect_uri_msg_t *) data;
318 vnet_connect_args_t _a, *a = &_a;
319 app_worker_t *app_wrk;
323 app_check_thread_and_barrier (session_mq_connect_uri_handler, mp);
325 app = application_lookup (mp->client_index);
329 clib_memset (a, 0, sizeof (*a));
330 a->uri = (char *) mp->uri;
331 a->api_context = mp->context;
332 a->app_index = app->app_index;
333 if ((rv = vnet_connect_uri (a)))
335 clib_warning ("connect_uri returned: %d", rv);
336 app_wrk = application_get_worker (app, 0 /* default wrk only */ );
337 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
342 session_mq_shutdown_handler (void *data)
344 session_shutdown_msg_t *mp = (session_shutdown_msg_t *) data;
345 vnet_shutdown_args_t _a, *a = &_a;
348 app = application_lookup (mp->client_index);
352 a->app_index = app->app_index;
353 a->handle = mp->handle;
354 vnet_shutdown_session (a);
358 session_mq_disconnect_handler (void *data)
360 session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
361 vnet_disconnect_args_t _a, *a = &_a;
364 app = application_lookup (mp->client_index);
368 a->app_index = app->app_index;
369 a->handle = mp->handle;
370 vnet_disconnect_session (a);
374 app_mq_detach_handler (void *data)
376 session_app_detach_msg_t *mp = (session_app_detach_msg_t *) data;
377 vnet_app_detach_args_t _a, *a = &_a;
380 app_check_thread_and_barrier (app_mq_detach_handler, mp);
382 app = application_lookup (mp->client_index);
386 a->app_index = app->app_index;
387 a->api_client_index = mp->client_index;
388 vnet_application_detach (a);
392 session_mq_unlisten_rpc (session_unlisten_msg_t *mp)
394 vlib_main_t *vm = vlib_get_main ();
395 vnet_unlisten_args_t _a, *a = &_a;
396 app_worker_t *app_wrk;
403 context = mp->context;
405 app = application_lookup (mp->client_index);
409 clib_memset (a, 0, sizeof (*a));
410 a->app_index = app->app_index;
412 a->wrk_map_index = mp->wrk_index;
414 vlib_worker_thread_barrier_sync (vm);
416 if ((rv = vnet_unlisten (a)))
417 clib_warning ("unlisten returned: %d", rv);
419 vlib_worker_thread_barrier_release (vm);
421 app_wrk = application_get_worker (app, a->wrk_map_index);
425 mq_send_unlisten_reply (app_wrk, sh, context, rv);
430 session_mq_unlisten_handler (session_worker_t *wrk, session_evt_elt_t *elt)
432 u32 thread_index = wrk - session_main.wrk;
433 session_unlisten_msg_t *mp, *arg;
435 mp = session_evt_ctrl_data (wrk, elt);
436 arg = clib_mem_alloc (sizeof (session_unlisten_msg_t));
437 clib_memcpy_fast (arg, mp, sizeof (*arg));
439 if (PREDICT_FALSE (!thread_index))
441 session_mq_unlisten_rpc (arg);
445 session_send_rpc_evt_to_thread_force (0, session_mq_unlisten_rpc, arg);
449 session_mq_accepted_reply_handler (void *data)
451 session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
452 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
453 session_state_t old_state;
454 app_worker_t *app_wrk;
457 /* Server isn't interested, kill the session */
460 a->app_index = mp->context;
461 a->handle = mp->handle;
462 vnet_disconnect_session (a);
466 /* Mail this back from the main thread. We're not polling in main
467 * thread so we're using other workers for notifications. */
468 if (vlib_num_workers () && vlib_get_thread_index () != 0
469 && session_thread_from_handle (mp->handle) == 0)
471 vlib_rpc_call_main_thread (session_mq_accepted_reply_handler,
472 (u8 *) mp, sizeof (*mp));
476 s = session_get_from_handle_if_valid (mp->handle);
480 app_wrk = app_worker_get (s->app_wrk_index);
481 if (app_wrk->app_index != mp->context)
483 clib_warning ("app doesn't own session");
487 if (!session_has_transport (s))
489 s->session_state = SESSION_STATE_READY;
490 if (ct_session_connect_notify (s, SESSION_E_NONE))
495 old_state = s->session_state;
496 s->session_state = SESSION_STATE_READY;
498 if (!svm_fifo_is_empty_prod (s->rx_fifo))
499 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
501 /* Closed while waiting for app to reply. Resend disconnect */
502 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
504 app_worker_close_notify (app_wrk, s);
505 s->session_state = old_state;
512 session_mq_reset_reply_handler (void *data)
514 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
515 session_reset_reply_msg_t *mp;
516 app_worker_t *app_wrk;
519 u32 index, thread_index;
521 mp = (session_reset_reply_msg_t *) data;
522 app = application_lookup (mp->context);
526 session_parse_handle (mp->handle, &index, &thread_index);
527 s = session_get_if_valid (index, thread_index);
529 /* No session or not the right session */
530 if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
533 app_wrk = app_worker_get (s->app_wrk_index);
534 if (!app_wrk || app_wrk->app_index != app->app_index)
536 clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
541 /* Client objected to resetting the session, log and continue */
544 clib_warning ("client retval %d", mp->retval);
548 /* This comes as a response to a reset, transport only waiting for
549 * confirmation to remove connection state, no need to disconnect */
550 a->handle = mp->handle;
551 a->app_index = app->app_index;
552 vnet_disconnect_session (a);
556 session_mq_disconnected_handler (void *data)
558 session_disconnected_reply_msg_t *rmp;
559 vnet_disconnect_args_t _a, *a = &_a;
560 svm_msg_q_msg_t _msg, *msg = &_msg;
561 session_disconnected_msg_t *mp;
562 app_worker_t *app_wrk;
563 session_event_t *evt;
568 mp = (session_disconnected_msg_t *) data;
569 if (!(s = session_get_from_handle_if_valid (mp->handle)))
571 clib_warning ("could not disconnect handle %llu", mp->handle);
574 app_wrk = app_worker_get (s->app_wrk_index);
575 app = application_lookup (mp->client_index);
576 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
578 clib_warning ("could not disconnect session: %llu app: %u",
579 mp->handle, mp->client_index);
583 a->handle = mp->handle;
584 a->app_index = app_wrk->wrk_index;
585 rv = vnet_disconnect_session (a);
587 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
588 SESSION_MQ_CTRL_EVT_RING,
590 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
591 clib_memset (evt, 0, sizeof (*evt));
592 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
593 rmp = (session_disconnected_reply_msg_t *) evt->data;
594 rmp->handle = mp->handle;
595 rmp->context = mp->context;
597 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
601 session_mq_disconnected_reply_handler (void *data)
603 session_disconnected_reply_msg_t *mp;
604 vnet_disconnect_args_t _a, *a = &_a;
607 mp = (session_disconnected_reply_msg_t *) data;
609 /* Client objected to disconnecting the session, log and continue */
612 clib_warning ("client retval %d", mp->retval);
616 /* Disconnect has been confirmed. Confirm close to transport */
617 app = application_lookup (mp->context);
620 a->handle = mp->handle;
621 a->app_index = app->app_index;
622 vnet_disconnect_session (a);
627 session_mq_worker_update_handler (void *data)
629 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
630 session_worker_update_reply_msg_t *rmp;
631 svm_msg_q_msg_t _msg, *msg = &_msg;
632 app_worker_t *app_wrk;
633 u32 owner_app_wrk_map;
634 session_event_t *evt;
638 app = application_lookup (mp->client_index);
641 if (!(s = session_get_from_handle_if_valid (mp->handle)))
643 clib_warning ("invalid handle %llu", mp->handle);
646 app_wrk = app_worker_get (s->app_wrk_index);
647 if (app_wrk->app_index != app->app_index)
649 clib_warning ("app %u does not own session %llu", app->app_index,
653 owner_app_wrk_map = app_wrk->wrk_map_index;
654 app_wrk = application_get_worker (app, mp->wrk_index);
656 /* This needs to come from the new owner */
657 if (mp->req_wrk_index == owner_app_wrk_map)
659 session_req_worker_update_msg_t *wump;
661 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
662 SESSION_MQ_CTRL_EVT_RING,
664 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
665 clib_memset (evt, 0, sizeof (*evt));
666 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
667 wump = (session_req_worker_update_msg_t *) evt->data;
668 wump->session_handle = mp->handle;
669 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
673 app_worker_own_session (app_wrk, s);
678 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
679 SESSION_MQ_CTRL_EVT_RING,
681 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
682 clib_memset (evt, 0, sizeof (*evt));
683 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
684 rmp = (session_worker_update_reply_msg_t *) evt->data;
685 rmp->handle = mp->handle;
687 rmp->rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
689 rmp->tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
690 rmp->segment_handle = session_segment_handle (s);
691 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
694 * Retransmit messages that may have been lost
696 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
697 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
699 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
700 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
702 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
703 app_worker_close_notify (app_wrk, s);
707 session_mq_app_wrk_rpc_handler (void *data)
709 session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
710 svm_msg_q_msg_t _msg, *msg = &_msg;
711 session_app_wrk_rpc_msg_t *rmp;
712 app_worker_t *app_wrk;
713 session_event_t *evt;
716 app = application_lookup (mp->client_index);
720 app_wrk = application_get_worker (app, mp->wrk_index);
722 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
723 SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
725 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
726 clib_memset (evt, 0, sizeof (*evt));
727 evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
728 rmp = (session_app_wrk_rpc_msg_t *) evt->data;
729 clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
730 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
734 session_mq_transport_attr_handler (void *data)
736 session_transport_attr_msg_t *mp = (session_transport_attr_msg_t *) data;
737 session_transport_attr_reply_msg_t *rmp;
738 svm_msg_q_msg_t _msg, *msg = &_msg;
739 app_worker_t *app_wrk;
740 session_event_t *evt;
745 app = application_lookup (mp->client_index);
749 if (!(s = session_get_from_handle_if_valid (mp->handle)))
751 clib_warning ("invalid handle %llu", mp->handle);
754 app_wrk = app_worker_get (s->app_wrk_index);
755 if (app_wrk->app_index != app->app_index)
757 clib_warning ("app %u does not own session %llu", app->app_index,
762 rv = session_transport_attribute (s, mp->is_get, &mp->attr);
764 svm_msg_q_lock_and_alloc_msg_w_ring (
765 app_wrk->event_queue, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, msg);
766 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
767 clib_memset (evt, 0, sizeof (*evt));
768 evt->event_type = SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY;
769 rmp = (session_transport_attr_reply_msg_t *) evt->data;
770 rmp->handle = mp->handle;
772 rmp->is_get = mp->is_get;
773 if (!rv && mp->is_get)
774 rmp->attr = mp->attr;
775 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
778 vlib_node_registration_t session_queue_node;
783 u32 server_thread_index;
784 } session_queue_trace_t;
786 /* packet trace format function */
788 format_session_queue_trace (u8 * s, va_list * args)
790 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
791 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
792 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
794 s = format (s, "session index %d thread index %d",
795 t->session_index, t->server_thread_index);
799 #define foreach_session_queue_error \
800 _ (TX, tx, INFO, "Packets transmitted") \
801 _ (TIMER, timer, INFO, "Timer events") \
802 _ (NO_BUFFER, no_buffer, ERROR, "Out of buffers")
806 #define _(f, n, s, d) SESSION_QUEUE_ERROR_##f,
807 foreach_session_queue_error
809 SESSION_QUEUE_N_ERROR,
810 } session_queue_error_t;
812 static vlib_error_desc_t session_error_counters[] = {
813 #define _(f, n, s, d) { #n, d, VL_COUNTER_SEVERITY_##s },
814 foreach_session_queue_error
820 SESSION_TX_NO_BUFFERS = -2,
826 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
827 u32 next_index, u32 * to_next, u16 n_segs,
828 session_t * s, u32 n_trace)
830 while (n_trace && n_segs)
832 vlib_buffer_t *b = vlib_get_buffer (vm, to_next[0]);
835 (vm, node, next_index, b, 1 /* follow_chain */ )))
837 session_queue_trace_t *t =
838 vlib_add_trace (vm, node, b, sizeof (*t));
839 t->session_index = s->session_index;
840 t->server_thread_index = s->thread_index;
846 vlib_set_trace_count (vm, node, n_trace);
850 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
851 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
853 vlib_buffer_t *chain_b, *prev_b;
854 u32 chain_bi0, to_deq, left_from_seg;
855 u16 len_to_deq, n_bytes_read;
858 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
859 b->total_length_not_including_first_buffer = 0;
862 left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
864 to_deq = left_from_seg;
865 for (j = 1; j < ctx->n_bufs_per_seg; j++)
868 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
871 chain_bi0 = ctx->tx_buffers[*n_bufs];
872 chain_b = vlib_get_buffer (vm, chain_bi0);
873 chain_b->current_data = 0;
874 data = vlib_buffer_get_current (chain_b);
877 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
878 ctx->sp.tx_offset, len_to_deq, data);
879 ctx->sp.tx_offset += n_bytes_read;
883 if (ctx->transport_vft->transport_options.tx_type ==
886 svm_fifo_t *f = ctx->s->tx_fifo;
887 session_dgram_hdr_t *hdr = &ctx->hdr;
891 deq_now = clib_min (hdr->data_length - hdr->data_offset,
893 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
894 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data);
895 ASSERT (n_bytes_read > 0);
897 hdr->data_offset += n_bytes_read;
898 if (hdr->data_offset == hdr->data_length)
900 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
901 svm_fifo_dequeue_drop (f, offset);
902 if (ctx->left_to_snd > n_bytes_read)
903 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
906 else if (ctx->left_to_snd == n_bytes_read)
907 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
908 sizeof (session_dgram_pre_hdr_t));
911 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
914 ASSERT (n_bytes_read == len_to_deq);
915 chain_b->current_length = n_bytes_read;
916 b->total_length_not_including_first_buffer += chain_b->current_length;
918 /* update previous buffer */
919 prev_b->next_buffer = chain_bi0;
920 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
922 /* update current buffer */
923 chain_b->next_buffer = 0;
925 to_deq -= n_bytes_read;
930 && b->total_length_not_including_first_buffer == left_from_seg);
931 ctx->left_to_snd -= left_from_seg;
935 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
936 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
943 * Start with the first buffer in chain
946 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
949 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
950 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
954 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset,
956 ASSERT (n_bytes_read > 0);
957 /* Keep track of progress locally, transport is also supposed to
958 * increment it independently when pushing the header */
959 ctx->sp.tx_offset += n_bytes_read;
963 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
965 session_dgram_hdr_t *hdr = &ctx->hdr;
966 svm_fifo_t *f = ctx->s->tx_fifo;
970 ASSERT (hdr->data_length > hdr->data_offset);
971 deq_now = clib_min (hdr->data_length - hdr->data_offset,
973 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
974 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
975 ASSERT (n_bytes_read > 0);
977 if (transport_connection_is_cless (ctx->tc))
979 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
980 ctx->tc->rmt_port = hdr->rmt_port;
982 hdr->data_offset += n_bytes_read;
983 if (hdr->data_offset == hdr->data_length)
985 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
986 svm_fifo_dequeue_drop (f, offset);
987 if (ctx->left_to_snd > n_bytes_read)
988 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
991 else if (ctx->left_to_snd == n_bytes_read)
992 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
993 sizeof (session_dgram_pre_hdr_t));
997 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
999 ASSERT (n_bytes_read > 0);
1002 b->current_length = n_bytes_read;
1003 ctx->left_to_snd -= n_bytes_read;
1006 * Fill in the remaining buffers in the chain, if any
1008 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
1009 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
1013 session_tx_not_ready (session_t * s, u8 peek_data)
1017 if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
1019 /* Can retransmit for closed sessions but can't send new data if
1020 * session is not ready or closed */
1021 else if (s->session_state < SESSION_STATE_READY)
1023 /* Allow accepting session to send custom packets.
1024 * For instance, tcp want to send acks in established, but
1025 * the app has not called accept() yet */
1026 if (s->session_state == SESSION_STATE_ACCEPTING &&
1027 (s->flags & SESSION_F_CUSTOM_TX))
1031 else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1033 /* Allow closed transports to still send custom packets.
1034 * For instance, tcp may want to send acks in time-wait. */
1035 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
1036 && (s->flags & SESSION_F_CUSTOM_TX))
1044 always_inline transport_connection_t *
1045 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
1049 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1050 ctx->s->thread_index);
1054 if (ctx->s->session_state == SESSION_STATE_LISTENING)
1055 return ctx->transport_vft->get_listener (ctx->s->connection_index);
1058 return ctx->transport_vft->get_connection (ctx->s->connection_index,
1059 ctx->s->thread_index);
1065 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
1066 u32 max_segs, u8 peek_data)
1068 u32 n_bytes_per_buf, n_bytes_per_seg;
1070 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
1071 ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
1075 /* Offset in rx fifo from where to peek data */
1076 if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
1078 ctx->max_len_to_snd = 0;
1081 ctx->max_dequeue -= ctx->sp.tx_offset;
1085 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1087 u32 len, chain_limit;
1089 if (ctx->max_dequeue <= sizeof (ctx->hdr))
1091 ctx->max_len_to_snd = 0;
1095 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
1097 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
1098 len = ctx->hdr.data_length - ctx->hdr.data_offset;
1100 /* Process multiple dgrams if smaller than min (buf_space, mss).
1101 * This avoids handling multiple dgrams if they require buffer
1103 chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
1105 if (ctx->hdr.data_length <= chain_limit)
1107 u32 first_dgram_len, dgram_len, offset, max_offset;
1108 session_dgram_hdr_t hdr;
1110 ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
1111 offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
1112 first_dgram_len = len;
1113 max_offset = clib_min (ctx->max_dequeue, 16 << 10);
1115 while (offset < max_offset)
1117 svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
1119 ASSERT (hdr.data_length > hdr.data_offset);
1120 dgram_len = hdr.data_length - hdr.data_offset;
1121 if (len + dgram_len > ctx->max_dequeue
1122 || first_dgram_len != dgram_len)
1125 offset += sizeof (hdr) + hdr.data_length;
1129 ctx->max_dequeue = len;
1132 ASSERT (ctx->max_dequeue > 0);
1134 /* Ensure we're not writing more than transport window allows */
1135 if (ctx->max_dequeue < ctx->sp.snd_space)
1137 /* Constrained by tx queue. Try to send only fully formed segments */
1138 ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
1139 (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
1145 /* Expectation is that snd_space0 is already a multiple of snd_mss */
1146 ctx->max_len_to_snd = ctx->sp.snd_space;
1149 /* Check if we're tx constrained by the node */
1150 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
1151 if (ctx->n_segs_per_evt > max_segs)
1153 ctx->n_segs_per_evt = max_segs;
1154 ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
1157 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
1158 if (ctx->n_segs_per_evt > 1)
1160 u32 n_bytes_last_seg, n_bufs_last_seg;
1162 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
1163 n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
1164 - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
1165 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1166 n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
1167 ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
1172 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
1173 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
1174 ctx->n_bufs_needed = ctx->n_bufs_per_seg;
1177 ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
1178 ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
1180 TRANSPORT_MAX_HDRS_LEN);
1184 session_tx_maybe_reschedule (session_worker_t * wrk,
1185 session_tx_context_t * ctx,
1186 session_evt_elt_t * elt)
1188 session_t *s = ctx->s;
1190 svm_fifo_unset_event (s->tx_fifo);
1191 if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
1192 if (svm_fifo_set_event (s->tx_fifo))
1193 session_evt_add_head_old (wrk, elt);
1197 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
1198 vlib_node_runtime_t * node,
1199 session_evt_elt_t * elt,
1200 int *n_tx_packets, u8 peek_data)
1202 u32 n_trace, n_left, pbi, next_index, max_burst;
1203 session_tx_context_t *ctx = &wrk->ctx;
1204 session_main_t *smm = &session_main;
1205 session_event_t *e = &elt->evt;
1206 vlib_main_t *vm = wrk->vm;
1207 transport_proto_t tp;
1211 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
1214 session_evt_add_old (wrk, elt);
1215 return SESSION_TX_NO_DATA;
1218 next_index = smm->session_type_to_next[ctx->s->session_type];
1219 max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
1221 tp = session_get_transport_proto (ctx->s);
1222 ctx->transport_vft = transport_protocol_get_vft (tp);
1223 ctx->tc = session_tx_get_transport (ctx, peek_data);
1225 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
1227 if (ctx->transport_vft->flush_data)
1228 ctx->transport_vft->flush_data (ctx->tc);
1229 e->event_type = SESSION_IO_EVT_TX;
1232 if (ctx->s->flags & SESSION_F_CUSTOM_TX)
1235 ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
1236 ctx->sp.max_burst_size = max_burst;
1237 n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
1238 *n_tx_packets += n_custom_tx;
1240 (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1241 return SESSION_TX_OK;
1242 max_burst -= n_custom_tx;
1243 if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
1245 session_evt_add_old (wrk, elt);
1246 return SESSION_TX_OK;
1250 transport_connection_snd_params (ctx->tc, &ctx->sp);
1252 if (!ctx->sp.snd_space)
1254 /* If the deschedule flag was set, remove session from scheduler.
1255 * Transport is responsible for rescheduling this session. */
1256 if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
1257 transport_connection_deschedule (ctx->tc);
1258 /* Request to postpone the session, e.g., zero-wnd and transport
1259 * is not currently probing */
1260 else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
1261 session_evt_add_old (wrk, elt);
1262 /* This flow queue is "empty" so it should be re-evaluated before
1263 * the ones that have data to send. */
1265 session_evt_add_head_old (wrk, elt);
1267 return SESSION_TX_NO_DATA;
1270 if (transport_connection_is_tx_paced (ctx->tc))
1272 u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1273 if (snd_space < TRANSPORT_PACER_MIN_BURST)
1275 session_evt_add_head_old (wrk, elt);
1276 return SESSION_TX_NO_DATA;
1278 snd_space = clib_min (ctx->sp.snd_space, snd_space);
1279 ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1280 snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1283 /* Check how much we can pull. */
1284 session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1286 if (PREDICT_FALSE (!ctx->max_len_to_snd))
1288 transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1289 session_tx_maybe_reschedule (wrk, ctx, elt);
1290 return SESSION_TX_NO_DATA;
1293 vec_validate_aligned (ctx->tx_buffers, ctx->n_bufs_needed - 1,
1294 CLIB_CACHE_LINE_BYTES);
1295 n_bufs = vlib_buffer_alloc (vm, ctx->tx_buffers, ctx->n_bufs_needed);
1296 if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1299 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1300 session_evt_add_head_old (wrk, elt);
1301 vlib_node_increment_counter (wrk->vm, node->node_index,
1302 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1303 return SESSION_TX_NO_BUFFERS;
1306 if (transport_connection_is_tx_paced (ctx->tc))
1307 transport_connection_tx_pacer_update_bytes (ctx->tc, ctx->max_len_to_snd);
1309 ctx->left_to_snd = ctx->max_len_to_snd;
1310 n_left = ctx->n_segs_per_evt;
1314 vlib_buffer_t *b0, *b1;
1317 pbi = ctx->tx_buffers[n_bufs - 3];
1318 pb = vlib_get_buffer (vm, pbi);
1319 vlib_prefetch_buffer_header (pb, STORE);
1320 pbi = ctx->tx_buffers[n_bufs - 4];
1321 pb = vlib_get_buffer (vm, pbi);
1322 vlib_prefetch_buffer_header (pb, STORE);
1324 bi0 = ctx->tx_buffers[--n_bufs];
1325 bi1 = ctx->tx_buffers[--n_bufs];
1327 b0 = vlib_get_buffer (vm, bi0);
1328 b1 = vlib_get_buffer (vm, bi1);
1330 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1331 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
1333 ctx->transport_vft->push_header (ctx->tc, b0);
1334 ctx->transport_vft->push_header (ctx->tc, b1);
1338 vec_add1 (wrk->pending_tx_buffers, bi0);
1339 vec_add1 (wrk->pending_tx_buffers, bi1);
1340 vec_add1 (wrk->pending_tx_nexts, next_index);
1341 vec_add1 (wrk->pending_tx_nexts, next_index);
1350 pbi = ctx->tx_buffers[n_bufs - 2];
1351 pb = vlib_get_buffer (vm, pbi);
1352 vlib_prefetch_buffer_header (pb, STORE);
1355 bi0 = ctx->tx_buffers[--n_bufs];
1356 b0 = vlib_get_buffer (vm, bi0);
1357 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1359 /* Ask transport to push header after current_length and
1360 * total_length_not_including_first_buffer are updated */
1361 ctx->transport_vft->push_header (ctx->tc, b0);
1365 vec_add1 (wrk->pending_tx_buffers, bi0);
1366 vec_add1 (wrk->pending_tx_nexts, next_index);
1369 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1370 session_tx_trace_frame (vm, node, next_index, wrk->pending_tx_buffers,
1371 ctx->n_segs_per_evt, ctx->s, n_trace);
1373 if (PREDICT_FALSE (n_bufs))
1374 vlib_buffer_free (vm, ctx->tx_buffers, n_bufs);
1376 *n_tx_packets += ctx->n_segs_per_evt;
1378 SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1379 ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
1381 ASSERT (ctx->left_to_snd == 0);
1383 /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1384 * check if application enqueued more data and reschedule accordingly */
1385 if (ctx->max_len_to_snd < ctx->max_dequeue)
1386 session_evt_add_old (wrk, elt);
1388 session_tx_maybe_reschedule (wrk, ctx, elt);
1392 u32 n_dequeued = ctx->max_len_to_snd;
1393 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1394 n_dequeued += ctx->n_segs_per_evt * SESSION_CONN_HDR_LEN;
1395 if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, n_dequeued))
1396 session_dequeue_notify (ctx->s);
1398 return SESSION_TX_OK;
1402 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1403 vlib_node_runtime_t * node,
1404 session_evt_elt_t * e, int *n_tx_packets)
1406 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1410 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1411 vlib_node_runtime_t * node,
1412 session_evt_elt_t * e, int *n_tx_packets)
1414 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1418 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1419 vlib_node_runtime_t * node,
1420 session_evt_elt_t * elt, int *n_tx_packets)
1422 transport_send_params_t *sp = &wrk->ctx.sp;
1423 session_t *s = wrk->ctx.s;
1426 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1429 /* Clear custom-tx flag used to request reschedule for tx */
1430 s->flags &= ~SESSION_F_CUSTOM_TX;
1432 sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1433 TRANSPORT_PACER_MAX_BURST_PKTS);
1435 n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1436 *n_tx_packets += n_packets;
1438 if (s->flags & SESSION_F_CUSTOM_TX)
1440 session_evt_add_old (wrk, elt);
1442 else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1444 svm_fifo_unset_event (s->tx_fifo);
1445 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1446 if (svm_fifo_set_event (s->tx_fifo))
1447 session_evt_add_head_old (wrk, elt);
1450 if (sp->max_burst_size &&
1451 svm_fifo_needs_deq_ntf (s->tx_fifo, sp->max_burst_size))
1452 session_dequeue_notify (s);
1457 always_inline session_t *
1458 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1460 if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1463 ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1464 return pool_elt_at_index (wrk->sessions, e->session_index);
1468 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1470 clib_llist_index_t ei;
1471 void (*fp) (void *);
1475 ei = clib_llist_entry_index (wrk->event_elts, elt);
1478 switch (e->event_type)
1480 case SESSION_CTRL_EVT_RPC:
1481 fp = e->rpc_args.fp;
1482 (*fp) (e->rpc_args.arg);
1484 case SESSION_CTRL_EVT_HALF_CLOSE:
1485 s = session_get_from_handle_if_valid (e->session_handle);
1486 if (PREDICT_FALSE (!s))
1488 session_transport_half_close (s);
1490 case SESSION_CTRL_EVT_CLOSE:
1491 s = session_get_from_handle_if_valid (e->session_handle);
1492 if (PREDICT_FALSE (!s))
1494 session_transport_close (s);
1496 case SESSION_CTRL_EVT_RESET:
1497 s = session_get_from_handle_if_valid (e->session_handle);
1498 if (PREDICT_FALSE (!s))
1500 session_transport_reset (s);
1502 case SESSION_CTRL_EVT_LISTEN:
1503 session_mq_listen_handler (session_evt_ctrl_data (wrk, elt));
1505 case SESSION_CTRL_EVT_LISTEN_URI:
1506 session_mq_listen_uri_handler (session_evt_ctrl_data (wrk, elt));
1508 case SESSION_CTRL_EVT_UNLISTEN:
1509 session_mq_unlisten_handler (wrk, elt);
1511 case SESSION_CTRL_EVT_CONNECT:
1512 session_mq_connect_handler (wrk, elt);
1514 case SESSION_CTRL_EVT_CONNECT_URI:
1515 session_mq_connect_uri_handler (session_evt_ctrl_data (wrk, elt));
1517 case SESSION_CTRL_EVT_SHUTDOWN:
1518 session_mq_shutdown_handler (session_evt_ctrl_data (wrk, elt));
1520 case SESSION_CTRL_EVT_DISCONNECT:
1521 session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1523 case SESSION_CTRL_EVT_DISCONNECTED:
1524 session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1526 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1527 session_mq_accepted_reply_handler (session_evt_ctrl_data (wrk, elt));
1529 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1530 session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1533 case SESSION_CTRL_EVT_RESET_REPLY:
1534 session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1536 case SESSION_CTRL_EVT_WORKER_UPDATE:
1537 session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1539 case SESSION_CTRL_EVT_APP_DETACH:
1540 app_mq_detach_handler (session_evt_ctrl_data (wrk, elt));
1542 case SESSION_CTRL_EVT_APP_WRK_RPC:
1543 session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1545 case SESSION_CTRL_EVT_TRANSPORT_ATTR:
1546 session_mq_transport_attr_handler (session_evt_ctrl_data (wrk, elt));
1549 clib_warning ("unhandled event type %d", e->event_type);
1552 /* Regrab elements in case pool moved */
1553 elt = clib_llist_elt (wrk->event_elts, ei);
1554 if (!clib_llist_elt_is_linked (elt, evt_list))
1557 if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1558 session_evt_ctrl_data_free (wrk, elt);
1559 clib_llist_put (wrk->event_elts, elt);
1561 SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1565 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1566 session_evt_elt_t * elt, int *n_tx_packets)
1568 session_main_t *smm = &session_main;
1569 app_worker_t *app_wrk;
1570 clib_llist_index_t ei;
1574 ei = clib_llist_entry_index (wrk->event_elts, elt);
1577 switch (e->event_type)
1579 case SESSION_IO_EVT_TX_FLUSH:
1580 case SESSION_IO_EVT_TX:
1581 s = session_event_get_session (wrk, e);
1582 if (PREDICT_FALSE (!s))
1584 CLIB_PREFETCH (s->tx_fifo, sizeof (*(s->tx_fifo)), LOAD);
1586 /* Spray packets in per session type frames, since they go to
1587 * different nodes */
1588 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1590 case SESSION_IO_EVT_RX:
1591 s = session_event_get_session (wrk, e);
1594 transport_app_rx_evt (session_get_transport_proto (s),
1595 s->connection_index, s->thread_index);
1597 case SESSION_IO_EVT_BUILTIN_RX:
1598 s = session_event_get_session (wrk, e);
1599 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1601 svm_fifo_unset_event (s->rx_fifo);
1602 app_wrk = app_worker_get (s->app_wrk_index);
1603 app_worker_builtin_rx (app_wrk, s);
1605 case SESSION_IO_EVT_BUILTIN_TX:
1606 s = session_get_from_handle_if_valid (e->session_handle);
1608 if (PREDICT_TRUE (s != 0))
1609 session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
1612 clib_warning ("unhandled event type %d", e->event_type);
1615 SESSION_EVT (SESSION_IO_EVT_COUNTS, e->event_type, 1, wrk);
1617 /* Regrab elements in case pool moved */
1618 elt = clib_llist_elt (wrk->event_elts, ei);
1619 if (!clib_llist_elt_is_linked (elt, evt_list))
1620 clib_llist_put (wrk->event_elts, elt);
1624 static const u32 session_evt_msg_sizes[] = {
1625 #define _(symc, sym) \
1626 [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1627 foreach_session_ctrl_evt
1633 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1635 session_evt_elt_t *elt;
1637 if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1639 elt = session_evt_alloc_ctrl (wrk);
1640 if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1642 elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1643 elt->evt.event_type = evt->event_type;
1644 clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1645 session_evt_msg_sizes[evt->event_type]);
1649 /* Internal control events fit into io events footprint */
1650 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1655 elt = session_evt_alloc_new (wrk);
1656 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1661 session_flush_pending_tx_buffers (session_worker_t * wrk,
1662 vlib_node_runtime_t * node)
1664 vlib_buffer_enqueue_to_next_vec (wrk->vm, node, &wrk->pending_tx_buffers,
1665 &wrk->pending_tx_nexts,
1666 vec_len (wrk->pending_tx_nexts));
1667 vec_reset_length (wrk->pending_tx_buffers);
1668 vec_reset_length (wrk->pending_tx_nexts);
1672 session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq)
1674 svm_msg_q_msg_t _msg, *msg = &_msg;
1675 u32 i, n_to_dequeue = 0;
1676 session_event_t *evt;
1678 n_to_dequeue = svm_msg_q_size (mq);
1679 for (i = 0; i < n_to_dequeue; i++)
1681 svm_msg_q_sub_raw (mq, msg);
1682 evt = svm_msg_q_msg_data (mq, msg);
1683 session_evt_add_to_list (wrk, evt);
1684 svm_msg_q_free_msg (mq, msg);
1687 return n_to_dequeue;
1691 session_wrk_update_state (session_worker_t *wrk)
1693 vlib_main_t *vm = wrk->vm;
1695 if (wrk->state == SESSION_WRK_POLLING)
1697 if (clib_llist_elts (wrk->event_elts) == 4 &&
1698 vlib_last_vectors_per_main_loop (vm) < 1)
1700 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1701 vlib_node_set_state (vm, session_queue_node.index,
1702 VLIB_NODE_STATE_INTERRUPT);
1705 else if (wrk->state == SESSION_WRK_INTERRUPT)
1707 if (clib_llist_elts (wrk->event_elts) > 4 ||
1708 vlib_last_vectors_per_main_loop (vm) > 1)
1710 session_wrk_set_state (wrk, SESSION_WRK_POLLING);
1711 vlib_node_set_state (vm, session_queue_node.index,
1712 VLIB_NODE_STATE_POLLING);
1714 else if (PREDICT_FALSE (!pool_elts (wrk->sessions)))
1716 session_wrk_set_state (wrk, SESSION_WRK_IDLE);
1721 if (clib_llist_elts (wrk->event_elts))
1723 session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1729 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1730 vlib_frame_t * frame)
1732 u32 thread_index = vm->thread_index, __clib_unused n_evts;
1733 session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1734 session_main_t *smm = vnet_get_session_main ();
1735 session_worker_t *wrk = &smm->wrk[thread_index];
1736 clib_llist_index_t ei, next_ei, old_ti;
1739 SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1741 session_wrk_update_time (wrk, vlib_time_now (vm));
1744 * Update transport time
1746 transport_update_time (wrk->last_vlib_time, thread_index);
1747 n_tx_packets = vec_len (wrk->pending_tx_buffers);
1748 SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1751 * Dequeue new internal mq events
1754 n_evts = session_wrk_handle_mq (wrk, wrk->vpp_event_queue);
1755 SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_evts);
1758 * Handle control events
1761 ei = wrk->ctrl_head;
1762 ctrl_he = clib_llist_elt (wrk->event_elts, ei);
1763 next_ei = clib_llist_next_index (ctrl_he, evt_list);
1764 old_ti = clib_llist_prev_index (ctrl_he, evt_list);
1765 while (ei != old_ti)
1768 elt = clib_llist_elt (wrk->event_elts, next_ei);
1769 next_ei = clib_llist_next_index (elt, evt_list);
1770 clib_llist_remove (wrk->event_elts, evt_list, elt);
1771 session_event_dispatch_ctrl (wrk, elt);
1774 SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1777 * Handle the new io events.
1780 new_he = clib_llist_elt (wrk->event_elts, wrk->new_head);
1781 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1782 old_ti = clib_llist_prev_index (old_he, evt_list);
1784 ei = clib_llist_next_index (new_he, evt_list);
1785 while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
1787 elt = clib_llist_elt (wrk->event_elts, ei);
1788 ei = clib_llist_next_index (elt, evt_list);
1789 clib_llist_remove (wrk->event_elts, evt_list, elt);
1790 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1793 SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1796 * Handle the old io events, if we had any prior to processing the new ones
1799 if (old_ti != wrk->old_head)
1801 old_he = clib_llist_elt (wrk->event_elts, wrk->old_head);
1802 ei = clib_llist_next_index (old_he, evt_list);
1804 while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
1806 elt = clib_llist_elt (wrk->event_elts, ei);
1807 next_ei = clib_llist_next_index (elt, evt_list);
1808 clib_llist_remove (wrk->event_elts, evt_list, elt);
1810 session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1819 SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
1821 if (vec_len (wrk->pending_tx_buffers))
1822 session_flush_pending_tx_buffers (wrk, node);
1824 vlib_node_increment_counter (vm, session_queue_node.index,
1825 SESSION_QUEUE_ERROR_TX, n_tx_packets);
1827 SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1829 if (wrk->flags & SESSION_WRK_F_ADAPTIVE)
1830 session_wrk_update_state (wrk);
1832 return n_tx_packets;
1836 VLIB_REGISTER_NODE (session_queue_node) = {
1837 .function = session_queue_node_fn,
1838 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1839 .name = "session-queue",
1840 .format_trace = format_session_queue_trace,
1841 .type = VLIB_NODE_TYPE_INPUT,
1842 .n_errors = SESSION_QUEUE_N_ERROR,
1843 .error_counters = session_error_counters,
1844 .state = VLIB_NODE_STATE_DISABLED,
1848 static clib_error_t *
1849 session_wrk_tfd_read_ready (clib_file_t *cf)
1851 session_worker_t *wrk = session_main_get_worker (cf->private_data);
1855 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
1856 rv = read (wrk->timerfd, &buf, sizeof (buf));
1857 if (rv < 0 && errno != EAGAIN)
1858 clib_unix_warning ("failed");
1862 static clib_error_t *
1863 session_wrk_tfd_write_ready (clib_file_t *cf)
1869 session_wrk_enable_adaptive_mode (session_worker_t *wrk)
1871 u32 thread_index = wrk->vm->thread_index;
1872 clib_file_t template = { 0 };
1874 if ((wrk->timerfd = timerfd_create (CLOCK_MONOTONIC, TFD_NONBLOCK)) < 0)
1875 clib_warning ("timerfd_create");
1877 template.read_function = session_wrk_tfd_read_ready;
1878 template.write_function = session_wrk_tfd_write_ready;
1879 template.file_descriptor = wrk->timerfd;
1880 template.private_data = thread_index;
1881 template.polling_thread_index = thread_index;
1882 template.description = format (0, "session-wrk-tfd-%u", thread_index);
1884 wrk->timerfd_file = clib_file_add (&file_main, &template);
1885 wrk->flags |= SESSION_WRK_F_ADAPTIVE;
1888 static clib_error_t *
1889 session_queue_exit (vlib_main_t * vm)
1891 if (vlib_get_n_threads () < 2)
1895 * Shut off (especially) worker-thread session nodes.
1896 * Otherwise, vpp can crash as the main thread unmaps the
1899 vlib_worker_thread_barrier_sync (vm);
1900 session_node_enable_disable (0 /* is_enable */ );
1901 vlib_worker_thread_barrier_release (vm);
1905 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1908 session_queue_run_on_main (vlib_main_t * vm)
1910 vlib_node_runtime_t *node;
1912 node = vlib_node_get_runtime (vm, session_queue_node.index);
1913 return session_queue_node_fn (vm, node, 0);
1917 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1920 uword *event_data = 0;
1926 vlib_process_wait_for_event_or_clock (vm, timeout);
1927 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1931 case SESSION_Q_PROCESS_RUN_ON_MAIN:
1932 /* Run session queue node on main thread */
1933 session_queue_run_on_main (vm);
1935 case SESSION_Q_PROCESS_STOP:
1936 vlib_node_set_state (vm, session_queue_process_node.index,
1937 VLIB_NODE_STATE_DISABLED);
1941 /* Timed out. Run on main to ensure all events are handled */
1942 session_queue_run_on_main (vm);
1945 vec_reset_length (event_data);
1951 VLIB_REGISTER_NODE (session_queue_process_node) =
1953 .function = session_queue_process,
1954 .type = VLIB_NODE_TYPE_PROCESS,
1955 .name = "session-queue-process",
1956 .state = VLIB_NODE_STATE_DISABLED,
1960 static_always_inline uword
1961 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1962 vlib_frame_t * frame)
1964 session_main_t *sm = &session_main;
1965 if (!sm->wrk[0].vpp_event_queue)
1967 node = vlib_node_get_runtime (vm, session_queue_node.index);
1968 return session_queue_node_fn (vm, node, frame);
1972 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1974 .function = session_queue_pre_input_inline,
1975 .type = VLIB_NODE_TYPE_PRE_INPUT,
1976 .name = "session-queue-main",
1977 .state = VLIB_NODE_STATE_DISABLED,
1982 * fd.io coding-style-patch-verification: ON
1985 * eval: (c-set-style "gnu")