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>
29 session_mq_accepted_reply_handler (void *data)
31 session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
32 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
33 session_state_t old_state;
34 app_worker_t *app_wrk;
38 /* Server isn't interested, kill the session */
41 a->app_index = mp->context;
42 a->handle = mp->handle;
43 vnet_disconnect_session (a);
47 if (session_handle_is_local (mp->handle))
49 ls = app_worker_get_local_session_from_handle (mp->handle);
52 clib_warning ("unknown local handle 0x%lx", mp->handle);
55 app_wrk = app_worker_get (ls->app_wrk_index);
56 if (app_wrk->app_index != mp->context)
58 clib_warning ("server %u doesn't own local handle 0x%lx",
59 mp->context, mp->handle);
62 if (app_worker_local_session_connect_notify (ls))
64 ls->session_state = SESSION_STATE_READY;
68 s = session_get_from_handle_if_valid (mp->handle);
72 app_wrk = app_worker_get (s->app_wrk_index);
73 if (app_wrk->app_index != mp->context)
75 clib_warning ("app doesn't own session");
79 old_state = s->session_state;
80 s->session_state = SESSION_STATE_READY;
81 if (!svm_fifo_is_empty (s->rx_fifo))
82 app_worker_lock_and_send_event (app_wrk, s, FIFO_EVENT_APP_RX);
84 /* Closed while waiting for app to reply. Resend disconnect */
85 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
87 application_t *app = application_get (app_wrk->app_index);
88 app->cb_fns.session_disconnect_callback (s);
89 s->session_state = old_state;
96 session_mq_reset_reply_handler (void *data)
98 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
99 session_reset_reply_msg_t *mp;
100 app_worker_t *app_wrk;
103 u32 index, thread_index;
105 mp = (session_reset_reply_msg_t *) data;
106 app = application_lookup (mp->context);
110 session_parse_handle (mp->handle, &index, &thread_index);
111 s = session_get_if_valid (index, thread_index);
113 /* Session was already closed or already cleaned up */
114 if (!s || s->session_state != SESSION_STATE_TRANSPORT_CLOSING)
117 app_wrk = app_worker_get (s->app_wrk_index);
118 if (!app_wrk || app_wrk->app_index != app->app_index)
120 clib_warning ("App % does not own handle 0x%lx!", app->app_index,
125 /* Client objected to resetting the session, log and continue */
128 clib_warning ("client retval %d", mp->retval);
132 /* This comes as a response to a reset, transport only waiting for
133 * confirmation to remove connection state, no need to disconnect */
134 a->handle = mp->handle;
135 a->app_index = app->app_index;
136 vnet_disconnect_session (a);
140 session_mq_disconnected_handler (void *data)
142 session_disconnected_reply_msg_t *rmp;
143 vnet_disconnect_args_t _a, *a = &_a;
144 svm_msg_q_msg_t _msg, *msg = &_msg;
145 session_disconnected_msg_t *mp;
146 app_worker_t *app_wrk;
147 session_event_t *evt;
152 mp = (session_disconnected_msg_t *) data;
153 if (!(s = session_get_from_handle_if_valid (mp->handle)))
155 clib_warning ("could not disconnect handle %llu", mp->handle);
158 app_wrk = app_worker_get (s->app_wrk_index);
159 app = application_lookup (mp->client_index);
160 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
162 clib_warning ("could not disconnect session: %llu app: %u",
163 mp->handle, mp->client_index);
167 a->handle = mp->handle;
168 a->app_index = app_wrk->wrk_index;
169 rv = vnet_disconnect_session (a);
171 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
172 SESSION_MQ_CTRL_EVT_RING,
174 svm_msg_q_unlock (app_wrk->event_queue);
175 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
176 clib_memset (evt, 0, sizeof (*evt));
177 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
178 rmp = (session_disconnected_reply_msg_t *) evt->data;
179 rmp->handle = mp->handle;
180 rmp->context = mp->context;
182 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
186 session_mq_disconnected_reply_handler (void *data)
188 session_disconnected_reply_msg_t *mp;
189 vnet_disconnect_args_t _a, *a = &_a;
192 mp = (session_disconnected_reply_msg_t *) data;
194 /* Client objected to disconnecting the session, log and continue */
197 clib_warning ("client retval %d", mp->retval);
201 /* Disconnect has been confirmed. Confirm close to transport */
202 app = application_lookup (mp->context);
205 a->handle = mp->handle;
206 a->app_index = app->app_index;
207 vnet_disconnect_session (a);
212 session_mq_worker_update_handler (void *data)
214 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
215 session_worker_update_reply_msg_t *rmp;
216 svm_msg_q_msg_t _msg, *msg = &_msg;
217 app_worker_t *app_wrk;
218 u32 owner_app_wrk_map;
219 session_event_t *evt;
223 app = application_lookup (mp->client_index);
226 if (!(s = session_get_from_handle_if_valid (mp->handle)))
228 clib_warning ("invalid handle %llu", mp->handle);
231 app_wrk = app_worker_get (s->app_wrk_index);
232 if (app_wrk->app_index != app->app_index)
234 clib_warning ("app %u does not own session %llu", app->app_index,
238 owner_app_wrk_map = app_wrk->wrk_map_index;
239 app_wrk = application_get_worker (app, mp->wrk_index);
241 /* This needs to come from the new owner */
242 if (mp->req_wrk_index == owner_app_wrk_map)
244 session_req_worker_update_msg_t *wump;
246 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
247 SESSION_MQ_CTRL_EVT_RING,
249 svm_msg_q_unlock (app_wrk->event_queue);
250 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
251 clib_memset (evt, 0, sizeof (*evt));
252 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
253 wump = (session_req_worker_update_msg_t *) evt->data;
254 wump->session_handle = mp->handle;
255 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
259 app_worker_own_session (app_wrk, s);
264 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
265 SESSION_MQ_CTRL_EVT_RING,
267 svm_msg_q_unlock (app_wrk->event_queue);
268 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
269 clib_memset (evt, 0, sizeof (*evt));
270 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
271 rmp = (session_worker_update_reply_msg_t *) evt->data;
272 rmp->handle = mp->handle;
273 rmp->rx_fifo = pointer_to_uword (s->rx_fifo);
274 rmp->tx_fifo = pointer_to_uword (s->tx_fifo);
275 rmp->segment_handle = session_segment_handle (s);
276 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
279 * Retransmit messages that may have been lost
281 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
282 session_send_io_evt_to_thread (s->tx_fifo, FIFO_EVENT_APP_TX);
284 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
285 app_worker_lock_and_send_event (app_wrk, s, FIFO_EVENT_APP_RX);
287 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
288 app->cb_fns.session_disconnect_callback (s);
291 vlib_node_registration_t session_queue_node;
296 u32 server_thread_index;
297 } session_queue_trace_t;
299 /* packet trace format function */
301 format_session_queue_trace (u8 * s, va_list * args)
303 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
304 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
305 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
307 s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
308 t->session_index, t->server_thread_index);
312 #define foreach_session_queue_error \
313 _(TX, "Packets transmitted") \
314 _(TIMER, "Timer events") \
315 _(NO_BUFFER, "Out of buffers")
319 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
320 foreach_session_queue_error
322 SESSION_QUEUE_N_ERROR,
323 } session_queue_error_t;
325 static char *session_queue_error_strings[] = {
326 #define _(sym,string) string,
327 foreach_session_queue_error
333 SESSION_TX_NO_BUFFERS = -2,
339 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
340 u32 next_index, u32 * to_next, u16 n_segs,
341 session_t * s, u32 n_trace)
343 session_queue_trace_t *t;
347 for (i = 0; i < clib_min (n_trace, n_segs); i++)
349 b = vlib_get_buffer (vm, to_next[i - n_segs]);
350 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
351 t = vlib_add_trace (vm, node, b, sizeof (*t));
352 t->session_index = s->session_index;
353 t->server_thread_index = s->thread_index;
355 vlib_set_trace_count (vm, node, n_trace - i);
359 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
360 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
362 vlib_buffer_t *chain_b, *prev_b;
363 u32 chain_bi0, to_deq, left_from_seg;
364 session_manager_worker_t *wrk;
365 u16 len_to_deq, n_bytes_read;
368 wrk = session_manager_get_worker (ctx->s->thread_index);
369 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
370 b->total_length_not_including_first_buffer = 0;
373 left_from_seg = clib_min (ctx->snd_mss - b->current_length,
375 to_deq = left_from_seg;
376 for (j = 1; j < ctx->n_bufs_per_seg; j++)
379 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
382 chain_bi0 = wrk->tx_buffers[*n_bufs];
383 chain_b = vlib_get_buffer (vm, chain_bi0);
384 chain_b->current_data = 0;
385 data = vlib_buffer_get_current (chain_b);
388 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
389 ctx->tx_offset, len_to_deq, data);
390 ctx->tx_offset += n_bytes_read;
394 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
396 svm_fifo_t *f = ctx->s->tx_fifo;
397 session_dgram_hdr_t *hdr = &ctx->hdr;
399 deq_now = clib_min (hdr->data_length - hdr->data_offset,
401 n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
403 ASSERT (n_bytes_read > 0);
405 hdr->data_offset += n_bytes_read;
406 if (hdr->data_offset == hdr->data_length)
408 u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
409 svm_fifo_dequeue_drop (f, offset);
413 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
416 ASSERT (n_bytes_read == len_to_deq);
417 chain_b->current_length = n_bytes_read;
418 b->total_length_not_including_first_buffer += chain_b->current_length;
420 /* update previous buffer */
421 prev_b->next_buffer = chain_bi0;
422 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
424 /* update current buffer */
425 chain_b->next_buffer = 0;
427 to_deq -= n_bytes_read;
432 && b->total_length_not_including_first_buffer == left_from_seg);
433 ctx->left_to_snd -= left_from_seg;
437 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
438 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
445 * Start with the first buffer in chain
448 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
451 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
452 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
456 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->tx_offset,
458 ASSERT (n_bytes_read > 0);
459 /* Keep track of progress locally, transport is also supposed to
460 * increment it independently when pushing the header */
461 ctx->tx_offset += n_bytes_read;
465 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
467 session_dgram_hdr_t *hdr = &ctx->hdr;
468 svm_fifo_t *f = ctx->s->tx_fifo;
472 ASSERT (hdr->data_length > hdr->data_offset);
473 deq_now = clib_min (hdr->data_length - hdr->data_offset,
475 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
476 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
477 ASSERT (n_bytes_read > 0);
479 if (ctx->s->session_state == SESSION_STATE_LISTENING)
481 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
482 ctx->tc->rmt_port = hdr->rmt_port;
484 hdr->data_offset += n_bytes_read;
485 if (hdr->data_offset == hdr->data_length)
487 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
488 svm_fifo_dequeue_drop (f, offset);
493 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
495 ASSERT (n_bytes_read > 0);
498 b->current_length = n_bytes_read;
499 ctx->left_to_snd -= n_bytes_read;
502 * Fill in the remaining buffers in the chain, if any
504 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
505 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
508 SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
509 ed->data[0] = FIFO_EVENT_APP_TX;
510 ed->data[1] = ctx->max_dequeue;
511 ed->data[2] = len_to_deq;
512 ed->data[3] = ctx->left_to_snd;
518 session_tx_not_ready (session_t * s, u8 peek_data)
522 /* Can retransmit for closed sessions but can't send new data if
523 * session is not ready or closed */
524 if (s->session_state < SESSION_STATE_READY)
526 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
532 always_inline transport_connection_t *
533 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
537 return ctx->transport_vft->get_connection (ctx->s->connection_index,
538 ctx->s->thread_index);
542 if (ctx->s->session_state == SESSION_STATE_LISTENING)
543 return ctx->transport_vft->get_listener (ctx->s->connection_index);
546 return ctx->transport_vft->get_connection (ctx->s->connection_index,
547 ctx->s->thread_index);
553 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
554 u32 max_segs, u8 peek_data)
556 u32 n_bytes_per_buf, n_bytes_per_seg;
557 ctx->max_dequeue = svm_fifo_max_dequeue (ctx->s->tx_fifo);
560 /* Offset in rx fifo from where to peek data */
561 ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
562 if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
564 ctx->max_len_to_snd = 0;
567 ctx->max_dequeue -= ctx->tx_offset;
571 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
573 if (ctx->max_dequeue <= sizeof (ctx->hdr))
575 ctx->max_len_to_snd = 0;
578 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
580 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
581 ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
584 ASSERT (ctx->max_dequeue > 0);
586 /* Ensure we're not writing more than transport window allows */
587 if (ctx->max_dequeue < ctx->snd_space)
589 /* Constrained by tx queue. Try to send only fully formed segments */
590 ctx->max_len_to_snd =
591 (ctx->max_dequeue > ctx->snd_mss) ?
592 ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
597 /* Expectation is that snd_space0 is already a multiple of snd_mss */
598 ctx->max_len_to_snd = ctx->snd_space;
601 /* Check if we're tx constrained by the node */
602 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
603 if (ctx->n_segs_per_evt > max_segs)
605 ctx->n_segs_per_evt = max_segs;
606 ctx->max_len_to_snd = max_segs * ctx->snd_mss;
609 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
610 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
611 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
612 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
613 ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
614 ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
616 TRANSPORT_MAX_HDRS_LEN);
620 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
621 session_manager_worker_t * wrk,
622 session_event_t * e, int *n_tx_packets,
625 u32 next_index, next0, next1, *to_next, n_left_to_next, n_left, pbi;
626 u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
627 session_manager_main_t *smm = &session_manager_main;
628 session_tx_context_t *ctx = &wrk->ctx;
629 transport_proto_t tp;
633 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
636 vec_add1 (wrk->pending_event_vector, *e);
637 return SESSION_TX_NO_DATA;
640 next_index = smm->session_type_to_next[ctx->s->session_type];
641 next0 = next1 = next_index;
643 tp = session_get_transport_proto (ctx->s);
644 ctx->transport_vft = transport_protocol_get_vft (tp);
645 ctx->tc = session_tx_get_transport (ctx, peek_data);
646 ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
648 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
650 if (ctx->transport_vft->flush_data)
651 ctx->transport_vft->flush_data (ctx->tc);
654 ctx->snd_space = transport_connection_snd_space (ctx->tc,
658 if (ctx->snd_space == 0 || ctx->snd_mss == 0)
660 vec_add1 (wrk->pending_event_vector, *e);
661 return SESSION_TX_NO_DATA;
664 /* Allow enqueuing of a new event */
665 svm_fifo_unset_event (ctx->s->tx_fifo);
667 /* Check how much we can pull. */
668 session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
671 if (PREDICT_FALSE (!ctx->max_len_to_snd))
672 return SESSION_TX_NO_DATA;
674 n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
675 vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
676 CLIB_CACHE_LINE_BYTES);
677 n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
678 if (PREDICT_FALSE (n_bufs < n_bufs_needed))
681 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
682 vec_add1 (wrk->pending_event_vector, *e);
683 return SESSION_TX_NO_BUFFERS;
687 * Write until we fill up a frame
689 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
690 if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
692 ctx->n_segs_per_evt = n_left_to_next;
693 ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
695 ctx->left_to_snd = ctx->max_len_to_snd;
696 n_left = ctx->n_segs_per_evt;
700 vlib_buffer_t *b0, *b1;
703 pbi = wrk->tx_buffers[n_bufs - 3];
704 pb = vlib_get_buffer (vm, pbi);
705 vlib_prefetch_buffer_header (pb, STORE);
706 pbi = wrk->tx_buffers[n_bufs - 4];
707 pb = vlib_get_buffer (vm, pbi);
708 vlib_prefetch_buffer_header (pb, STORE);
710 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
711 to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
713 b0 = vlib_get_buffer (vm, bi0);
714 b1 = vlib_get_buffer (vm, bi1);
716 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
717 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
719 ctx->transport_vft->push_header (ctx->tc, b0);
720 ctx->transport_vft->push_header (ctx->tc, b1);
726 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
727 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
729 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
730 n_left_to_next, bi0, bi1, next0,
740 pbi = wrk->tx_buffers[n_bufs - 2];
741 pb = vlib_get_buffer (vm, pbi);
742 vlib_prefetch_buffer_header (pb, STORE);
745 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
746 b0 = vlib_get_buffer (vm, bi0);
747 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
749 /* Ask transport to push header after current_length and
750 * total_length_not_including_first_buffer are updated */
751 ctx->transport_vft->push_header (ctx->tc, b0);
757 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
759 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
760 n_left_to_next, bi0, next0);
763 if (PREDICT_FALSE (n_trace > 0))
764 session_tx_trace_frame (vm, node, next_index, to_next,
765 ctx->n_segs_per_evt, ctx->s, n_trace);
766 if (PREDICT_FALSE (n_bufs))
768 clib_warning ("not all buffers consumed");
769 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
771 *n_tx_packets += ctx->n_segs_per_evt;
772 transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
773 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
775 /* If we couldn't dequeue all bytes mark as partially read */
776 ASSERT (ctx->left_to_snd == 0);
777 if (ctx->max_len_to_snd < ctx->max_dequeue)
778 if (svm_fifo_set_event (ctx->s->tx_fifo))
779 vec_add1 (wrk->pending_event_vector, *e);
781 if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
783 /* Fix dgram pre header */
784 if (ctx->max_len_to_snd < ctx->max_dequeue)
785 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
786 sizeof (session_dgram_pre_hdr_t));
787 /* More data needs to be read */
788 else if (svm_fifo_max_dequeue (ctx->s->tx_fifo) > 0)
789 if (svm_fifo_set_event (ctx->s->tx_fifo))
790 vec_add1 (wrk->pending_event_vector, *e);
792 return SESSION_TX_OK;
796 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
797 session_manager_worker_t * wrk,
798 session_event_t * e, int *n_tx_pkts)
800 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 1);
804 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
805 session_manager_worker_t * wrk,
806 session_event_t * e, int *n_tx_pkts)
808 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 0);
812 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
813 vlib_node_runtime_t * node,
814 session_manager_worker_t * wrk,
815 session_event_t * e, int *n_tx_pkts)
817 session_t *s = wrk->ctx.s;
820 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
822 app = application_get (s->t_app_index);
823 svm_fifo_unset_event (s->tx_fifo);
824 return app->cb_fns.builtin_app_tx_callback (s);
827 always_inline session_t *
828 session_event_get_session (session_event_t * e, u8 thread_index)
830 return session_get_if_valid (e->fifo->master_session_index, thread_index);
834 session_update_dispatch_period (session_manager_worker_t * wrk, f64 now,
837 if (wrk->last_tx_packets)
839 f64 sample = now - wrk->last_vlib_time;
840 wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
842 wrk->last_vlib_time = now;
846 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
847 vlib_frame_t * frame)
849 session_manager_main_t *smm = vnet_get_session_manager_main ();
850 u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
851 session_manager_worker_t *wrk = &smm->wrk[thread_index];
852 session_event_t *e, *fifo_events;
853 svm_msg_q_msg_t _msg, *msg = &_msg;
854 f64 now = vlib_time_now (vm);
855 int n_tx_packets = 0, i, rv;
856 app_worker_t *app_wrk;
861 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, thread_index);
864 * Update transport time
866 session_update_dispatch_period (wrk, now, thread_index);
867 transport_update_time (now, thread_index);
869 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
871 /* Make sure postponed events are handled first */
872 fifo_events = wrk->free_event_vector;
873 vec_append (fifo_events, wrk->postponed_event_vector);
874 _vec_len (wrk->postponed_event_vector) = 0;
876 /* Try to dequeue what is available. Don't wait for lock.
877 * XXX: we may need priorities here */
878 mq = wrk->vpp_event_queue;
879 n_to_dequeue = svm_msg_q_size (mq);
880 if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
882 for (i = 0; i < n_to_dequeue; i++)
884 vec_add2 (fifo_events, e, 1);
885 svm_msg_q_sub_w_lock (mq, msg);
886 /* Works because reply messages are smaller than a session evt.
887 * If we ever need to support bigger messages this needs to be
889 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), sizeof (*e));
890 svm_msg_q_free_msg (mq, msg);
892 svm_msg_q_unlock (mq);
895 vec_append (fifo_events, wrk->pending_event_vector);
896 vec_append (fifo_events, wrk->pending_disconnects);
898 _vec_len (wrk->pending_event_vector) = 0;
899 _vec_len (wrk->pending_disconnects) = 0;
901 n_events = vec_len (fifo_events);
902 if (PREDICT_FALSE (!n_events))
905 for (i = 0; i < n_events; i++)
907 session_t *s; /* $$$ prefetch 1 ahead maybe */
912 switch (e->event_type)
914 case SESSION_IO_EVT_TX_FLUSH:
915 case FIFO_EVENT_APP_TX:
916 /* Don't try to send more that one frame per dispatch cycle */
917 if (n_tx_packets == VLIB_FRAME_SIZE)
919 vec_add1 (wrk->postponed_event_vector, *e);
923 s = session_event_get_session (e, thread_index);
924 if (PREDICT_FALSE (!s))
926 clib_warning ("session was freed!");
930 /* Spray packets in per session type frames, since they go to
932 rv = (smm->session_tx_fns[s->session_type]) (vm, node, wrk, e,
934 if (PREDICT_TRUE (rv == SESSION_TX_OK))
936 need_tx_ntf = svm_fifo_needs_tx_ntf (s->tx_fifo,
937 wrk->ctx.max_len_to_snd);
938 if (PREDICT_FALSE (need_tx_ntf))
939 session_dequeue_notify (s);
941 else if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
943 vlib_node_increment_counter (vm, node->node_index,
944 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
948 case FIFO_EVENT_DISCONNECT:
949 s = session_get_from_handle_if_valid (e->session_handle);
950 if (PREDICT_FALSE (!s))
953 /* Make sure session disconnects run after the pending list is
954 * drained, i.e., postpone if the first time. If not the first
955 * and the tx queue is still not empty, try to wait for some
958 || (e->postponed < 200 && svm_fifo_max_dequeue (s->tx_fifo)))
961 vec_add1 (wrk->pending_disconnects, *e);
965 session_transport_close (s);
967 case FIFO_EVENT_BUILTIN_RX:
968 s = session_event_get_session (e, thread_index);
969 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
971 svm_fifo_unset_event (s->rx_fifo);
972 app_wrk = app_worker_get (s->app_wrk_index);
973 app = application_get (app_wrk->app_index);
974 app->cb_fns.builtin_app_rx_callback (s);
976 case FIFO_EVENT_BUILTIN_TX:
977 s = session_get_from_handle_if_valid (e->session_handle);
979 if (PREDICT_TRUE (s != 0))
980 session_tx_fifo_dequeue_internal (vm, node, wrk, e,
985 (*fp) (e->rpc_args.arg);
987 case SESSION_CTRL_EVT_DISCONNECTED:
988 session_mq_disconnected_handler (e->data);
990 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
991 session_mq_accepted_reply_handler (e->data);
993 case SESSION_CTRL_EVT_CONNECTED_REPLY:
995 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
996 session_mq_disconnected_reply_handler (e->data);
998 case SESSION_CTRL_EVT_RESET_REPLY:
999 session_mq_reset_reply_handler (e->data);
1001 case SESSION_CTRL_EVT_WORKER_UPDATE:
1002 session_mq_worker_update_handler (e->data);
1005 clib_warning ("unhandled event type %d", e->event_type);
1009 _vec_len (fifo_events) = 0;
1010 wrk->free_event_vector = fifo_events;
1011 wrk->last_tx_packets = n_tx_packets;
1013 vlib_node_increment_counter (vm, session_queue_node.index,
1014 SESSION_QUEUE_ERROR_TX, n_tx_packets);
1016 SESSION_EVT_DBG (SESSION_EVT_DISPATCH_END, smm, thread_index);
1018 return n_tx_packets;
1022 VLIB_REGISTER_NODE (session_queue_node) =
1024 .function = session_queue_node_fn,
1025 .name = "session-queue",
1026 .format_trace = format_session_queue_trace,
1027 .type = VLIB_NODE_TYPE_INPUT,
1028 .n_errors = ARRAY_LEN (session_queue_error_strings),
1029 .error_strings = session_queue_error_strings,
1030 .state = VLIB_NODE_STATE_DISABLED,
1035 dump_thread_0_event_queue (void)
1037 session_manager_main_t *smm = vnet_get_session_manager_main ();
1038 vlib_main_t *vm = &vlib_global_main;
1039 u32 my_thread_index = vm->thread_index;
1040 session_event_t _e, *e = &_e;
1041 svm_msg_q_ring_t *ring;
1043 svm_msg_q_msg_t *msg;
1047 mq = smm->wrk[my_thread_index].vpp_event_queue;
1048 index = mq->q->head;
1050 for (i = 0; i < mq->q->cursize; i++)
1052 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1053 ring = svm_msg_q_ring (mq, msg->ring_index);
1054 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1056 switch (e->event_type)
1058 case FIFO_EVENT_APP_TX:
1059 s0 = session_event_get_session (e, my_thread_index);
1060 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
1063 case FIFO_EVENT_DISCONNECT:
1064 s0 = session_get_from_handle (e->session_handle);
1065 fformat (stdout, "[%04d] disconnect session %d\n", i,
1069 case FIFO_EVENT_BUILTIN_RX:
1070 s0 = session_event_get_session (e, my_thread_index);
1071 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1074 case FIFO_EVENT_RPC:
1075 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1076 i, (u64) (uword) (e->rpc_args.fp),
1077 (u64) (uword) (e->rpc_args.arg));
1081 fformat (stdout, "[%04d] unhandled event type %d\n",
1088 if (index == mq->q->maxsize)
1094 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1097 switch (e->event_type)
1099 case FIFO_EVENT_APP_RX:
1100 case FIFO_EVENT_APP_TX:
1101 case FIFO_EVENT_BUILTIN_RX:
1105 case FIFO_EVENT_DISCONNECT:
1107 case FIFO_EVENT_RPC:
1108 s = session_get_from_handle (e->session_handle);
1111 clib_warning ("session has event but doesn't exist!");
1114 if (s->rx_fifo == f || s->tx_fifo == f)
1124 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1126 session_event_t *pending_event_vector, *evt;
1127 session_manager_worker_t *wrk;
1128 int i, index, found = 0;
1129 svm_msg_q_msg_t *msg;
1130 svm_msg_q_ring_t *ring;
1135 thread_index = f->master_thread_index;
1136 wrk = session_manager_get_worker (thread_index);
1141 mq = wrk->vpp_event_queue;
1142 index = mq->q->head;
1143 for (i = 0; i < mq->q->cursize; i++)
1145 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1146 ring = svm_msg_q_ring (mq, msg->ring_index);
1147 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1148 found = session_node_cmp_event (e, f);
1151 if (++index == mq->q->maxsize)
1155 * Search pending events vector
1157 pending_event_vector = wrk->pending_event_vector;
1158 vec_foreach (evt, pending_event_vector)
1160 found = session_node_cmp_event (evt, f);
1163 clib_memcpy_fast (e, evt, sizeof (*evt));
1170 static clib_error_t *
1171 session_queue_exit (vlib_main_t * vm)
1173 if (vec_len (vlib_mains) < 2)
1177 * Shut off (especially) worker-thread session nodes.
1178 * Otherwise, vpp can crash as the main thread unmaps the
1181 vlib_worker_thread_barrier_sync (vm);
1182 session_node_enable_disable (0 /* is_enable */ );
1183 vlib_worker_thread_barrier_release (vm);
1187 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1190 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1193 f64 now, timeout = 1.0;
1194 uword *event_data = 0;
1199 vlib_process_wait_for_event_or_clock (vm, timeout);
1200 now = vlib_time_now (vm);
1201 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1205 case SESSION_Q_PROCESS_FLUSH_FRAMES:
1206 /* Flush the frames by updating all transports times */
1207 transport_update_time (now, 0);
1209 case SESSION_Q_PROCESS_STOP:
1213 /* Timed out. Update time for all transports to trigger all
1214 * outstanding retransmits. */
1215 transport_update_time (now, 0);
1218 vec_reset_length (event_data);
1224 VLIB_REGISTER_NODE (session_queue_process_node) =
1226 .function = session_queue_process,
1227 .type = VLIB_NODE_TYPE_PROCESS,
1228 .name = "session-queue-process",
1229 .state = VLIB_NODE_STATE_DISABLED,
1234 * fd.io coding-style-patch-verification: ON
1237 * eval: (c-set-style "gnu")