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/session_debug.h>
25 #include <svm/queue.h>
28 session_mq_accepted_reply_handler (void *data)
30 session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
31 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
32 session_state_t old_state;
33 app_worker_t *app_wrk;
37 /* Server isn't interested, kill the session */
40 a->app_index = mp->context;
41 a->handle = mp->handle;
42 vnet_disconnect_session (a);
46 if (session_handle_is_local (mp->handle))
48 ls = app_worker_get_local_session_from_handle (mp->handle);
51 clib_warning ("unknown local handle 0x%lx", mp->handle);
54 app_wrk = app_worker_get (ls->app_wrk_index);
55 if (app_wrk->app_index != mp->context)
57 clib_warning ("server %u doesn't own local handle 0x%lx",
58 mp->context, mp->handle);
61 if (app_worker_local_session_connect_notify (ls))
63 ls->session_state = SESSION_STATE_READY;
67 s = session_get_from_handle_if_valid (mp->handle);
71 app_wrk = app_worker_get (s->app_wrk_index);
72 if (app_wrk->app_index != mp->context)
74 clib_warning ("app doesn't own session");
78 old_state = s->session_state;
79 s->session_state = SESSION_STATE_READY;
80 if (!svm_fifo_is_empty (s->rx_fifo))
81 app_worker_lock_and_send_event (app_wrk, s, FIFO_EVENT_APP_RX);
83 /* Closed while waiting for app to reply. Resend disconnect */
84 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
86 application_t *app = application_get (app_wrk->app_index);
87 app->cb_fns.session_disconnect_callback (s);
88 s->session_state = old_state;
95 session_mq_reset_reply_handler (void *data)
97 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
98 session_reset_reply_msg_t *mp;
99 app_worker_t *app_wrk;
102 u32 index, thread_index;
104 mp = (session_reset_reply_msg_t *) data;
105 app = application_lookup (mp->context);
109 session_parse_handle (mp->handle, &index, &thread_index);
110 s = session_get_if_valid (index, thread_index);
112 /* Session was already closed or already cleaned up */
113 if (!s || s->session_state != SESSION_STATE_TRANSPORT_CLOSING)
116 app_wrk = app_worker_get (s->app_wrk_index);
117 if (!app_wrk || app_wrk->app_index != app->app_index)
119 clib_warning ("App % does not own handle 0x%lx!", app->app_index,
124 /* Client objected to resetting the session, log and continue */
127 clib_warning ("client retval %d", mp->retval);
131 /* This comes as a response to a reset, transport only waiting for
132 * confirmation to remove connection state, no need to disconnect */
133 a->handle = mp->handle;
134 a->app_index = app->app_index;
135 vnet_disconnect_session (a);
139 session_mq_disconnected_handler (void *data)
141 session_disconnected_reply_msg_t *rmp;
142 vnet_disconnect_args_t _a, *a = &_a;
143 svm_msg_q_msg_t _msg, *msg = &_msg;
144 session_disconnected_msg_t *mp;
145 app_worker_t *app_wrk;
146 session_event_t *evt;
151 mp = (session_disconnected_msg_t *) data;
152 if (!(s = session_get_from_handle_if_valid (mp->handle)))
154 clib_warning ("could not disconnect handle %llu", mp->handle);
157 app_wrk = app_worker_get (s->app_wrk_index);
158 app = application_lookup (mp->client_index);
159 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
161 clib_warning ("could not disconnect session: %llu app: %u",
162 mp->handle, mp->client_index);
166 a->handle = mp->handle;
167 a->app_index = app_wrk->wrk_index;
168 rv = vnet_disconnect_session (a);
170 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
171 SESSION_MQ_CTRL_EVT_RING,
173 svm_msg_q_unlock (app_wrk->event_queue);
174 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
175 clib_memset (evt, 0, sizeof (*evt));
176 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
177 rmp = (session_disconnected_reply_msg_t *) evt->data;
178 rmp->handle = mp->handle;
179 rmp->context = mp->context;
181 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
185 session_mq_disconnected_reply_handler (void *data)
187 session_disconnected_reply_msg_t *mp;
188 vnet_disconnect_args_t _a, *a = &_a;
191 mp = (session_disconnected_reply_msg_t *) data;
193 /* Client objected to disconnecting the session, log and continue */
196 clib_warning ("client retval %d", mp->retval);
200 /* Disconnect has been confirmed. Confirm close to transport */
201 app = application_lookup (mp->context);
204 a->handle = mp->handle;
205 a->app_index = app->app_index;
206 vnet_disconnect_session (a);
211 session_mq_worker_update_handler (void *data)
213 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
214 session_worker_update_reply_msg_t *rmp;
215 svm_msg_q_msg_t _msg, *msg = &_msg;
216 app_worker_t *app_wrk;
217 u32 owner_app_wrk_map;
218 session_event_t *evt;
222 app = application_lookup (mp->client_index);
225 if (!(s = session_get_from_handle_if_valid (mp->handle)))
227 clib_warning ("invalid handle %llu", mp->handle);
230 app_wrk = app_worker_get (s->app_wrk_index);
231 if (app_wrk->app_index != app->app_index)
233 clib_warning ("app %u does not own session %llu", app->app_index,
237 owner_app_wrk_map = app_wrk->wrk_map_index;
238 app_wrk = application_get_worker (app, mp->wrk_index);
240 /* This needs to come from the new owner */
241 if (mp->req_wrk_index == owner_app_wrk_map)
243 session_req_worker_update_msg_t *wump;
245 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
246 SESSION_MQ_CTRL_EVT_RING,
248 svm_msg_q_unlock (app_wrk->event_queue);
249 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
250 clib_memset (evt, 0, sizeof (*evt));
251 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
252 wump = (session_req_worker_update_msg_t *) evt->data;
253 wump->session_handle = mp->handle;
254 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
258 app_worker_own_session (app_wrk, s);
263 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
264 SESSION_MQ_CTRL_EVT_RING,
266 svm_msg_q_unlock (app_wrk->event_queue);
267 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
268 clib_memset (evt, 0, sizeof (*evt));
269 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
270 rmp = (session_worker_update_reply_msg_t *) evt->data;
271 rmp->handle = mp->handle;
272 rmp->rx_fifo = pointer_to_uword (s->rx_fifo);
273 rmp->tx_fifo = pointer_to_uword (s->tx_fifo);
274 rmp->segment_handle = session_segment_handle (s);
275 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
278 * Retransmit messages that may have been lost
280 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
281 session_send_io_evt_to_thread (s->tx_fifo, FIFO_EVENT_APP_TX);
283 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
284 app_worker_lock_and_send_event (app_wrk, s, FIFO_EVENT_APP_RX);
286 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
287 app->cb_fns.session_disconnect_callback (s);
290 vlib_node_registration_t session_queue_node;
295 u32 server_thread_index;
296 } session_queue_trace_t;
298 /* packet trace format function */
300 format_session_queue_trace (u8 * s, va_list * args)
302 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
303 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
304 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
306 s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
307 t->session_index, t->server_thread_index);
311 #define foreach_session_queue_error \
312 _(TX, "Packets transmitted") \
313 _(TIMER, "Timer events") \
314 _(NO_BUFFER, "Out of buffers")
318 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
319 foreach_session_queue_error
321 SESSION_QUEUE_N_ERROR,
322 } session_queue_error_t;
324 static char *session_queue_error_strings[] = {
325 #define _(sym,string) string,
326 foreach_session_queue_error
332 SESSION_TX_NO_BUFFERS = -2,
338 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
339 u32 next_index, u32 * to_next, u16 n_segs,
340 session_t * s, u32 n_trace)
342 session_queue_trace_t *t;
346 for (i = 0; i < clib_min (n_trace, n_segs); i++)
348 b = vlib_get_buffer (vm, to_next[i - n_segs]);
349 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
350 t = vlib_add_trace (vm, node, b, sizeof (*t));
351 t->session_index = s->session_index;
352 t->server_thread_index = s->thread_index;
354 vlib_set_trace_count (vm, node, n_trace - i);
358 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
359 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
361 vlib_buffer_t *chain_b, *prev_b;
362 u32 chain_bi0, to_deq, left_from_seg;
363 session_manager_worker_t *wrk;
364 u16 len_to_deq, n_bytes_read;
367 wrk = session_manager_get_worker (ctx->s->thread_index);
368 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
369 b->total_length_not_including_first_buffer = 0;
372 left_from_seg = clib_min (ctx->snd_mss - b->current_length,
374 to_deq = left_from_seg;
375 for (j = 1; j < ctx->n_bufs_per_seg; j++)
378 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
381 chain_bi0 = wrk->tx_buffers[*n_bufs];
382 chain_b = vlib_get_buffer (vm, chain_bi0);
383 chain_b->current_data = 0;
384 data = vlib_buffer_get_current (chain_b);
387 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
388 ctx->tx_offset, len_to_deq, data);
389 ctx->tx_offset += n_bytes_read;
393 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
395 svm_fifo_t *f = ctx->s->tx_fifo;
396 session_dgram_hdr_t *hdr = &ctx->hdr;
398 deq_now = clib_min (hdr->data_length - hdr->data_offset,
400 n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
402 ASSERT (n_bytes_read > 0);
404 hdr->data_offset += n_bytes_read;
405 if (hdr->data_offset == hdr->data_length)
407 u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
408 svm_fifo_dequeue_drop (f, offset);
412 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
415 ASSERT (n_bytes_read == len_to_deq);
416 chain_b->current_length = n_bytes_read;
417 b->total_length_not_including_first_buffer += chain_b->current_length;
419 /* update previous buffer */
420 prev_b->next_buffer = chain_bi0;
421 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
423 /* update current buffer */
424 chain_b->next_buffer = 0;
426 to_deq -= n_bytes_read;
431 && b->total_length_not_including_first_buffer == left_from_seg);
432 ctx->left_to_snd -= left_from_seg;
436 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
437 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
444 * Start with the first buffer in chain
447 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
450 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
451 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
455 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->tx_offset,
457 ASSERT (n_bytes_read > 0);
458 /* Keep track of progress locally, transport is also supposed to
459 * increment it independently when pushing the header */
460 ctx->tx_offset += n_bytes_read;
464 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
466 session_dgram_hdr_t *hdr = &ctx->hdr;
467 svm_fifo_t *f = ctx->s->tx_fifo;
471 ASSERT (hdr->data_length > hdr->data_offset);
472 deq_now = clib_min (hdr->data_length - hdr->data_offset,
474 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
475 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
476 ASSERT (n_bytes_read > 0);
478 if (ctx->s->session_state == SESSION_STATE_LISTENING)
480 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
481 ctx->tc->rmt_port = hdr->rmt_port;
483 hdr->data_offset += n_bytes_read;
484 if (hdr->data_offset == hdr->data_length)
486 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
487 svm_fifo_dequeue_drop (f, offset);
492 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
494 ASSERT (n_bytes_read > 0);
497 b->current_length = n_bytes_read;
498 ctx->left_to_snd -= n_bytes_read;
501 * Fill in the remaining buffers in the chain, if any
503 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
504 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
507 SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
508 ed->data[0] = FIFO_EVENT_APP_TX;
509 ed->data[1] = ctx->max_dequeue;
510 ed->data[2] = len_to_deq;
511 ed->data[3] = ctx->left_to_snd;
517 session_tx_not_ready (session_t * s, u8 peek_data)
521 /* Can retransmit for closed sessions but can't send new data if
522 * session is not ready or closed */
523 if (s->session_state < SESSION_STATE_READY)
525 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
531 always_inline transport_connection_t *
532 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
536 return ctx->transport_vft->get_connection (ctx->s->connection_index,
537 ctx->s->thread_index);
541 if (ctx->s->session_state == SESSION_STATE_LISTENING)
542 return ctx->transport_vft->get_listener (ctx->s->connection_index);
545 return ctx->transport_vft->get_connection (ctx->s->connection_index,
546 ctx->s->thread_index);
552 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
553 u32 max_segs, u8 peek_data)
555 u32 n_bytes_per_buf, n_bytes_per_seg;
556 ctx->max_dequeue = svm_fifo_max_dequeue (ctx->s->tx_fifo);
559 /* Offset in rx fifo from where to peek data */
560 ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
561 if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
563 ctx->max_len_to_snd = 0;
566 ctx->max_dequeue -= ctx->tx_offset;
570 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
572 if (ctx->max_dequeue <= sizeof (ctx->hdr))
574 ctx->max_len_to_snd = 0;
577 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
579 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
580 ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
583 ASSERT (ctx->max_dequeue > 0);
585 /* Ensure we're not writing more than transport window allows */
586 if (ctx->max_dequeue < ctx->snd_space)
588 /* Constrained by tx queue. Try to send only fully formed segments */
589 ctx->max_len_to_snd =
590 (ctx->max_dequeue > ctx->snd_mss) ?
591 ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
596 /* Expectation is that snd_space0 is already a multiple of snd_mss */
597 ctx->max_len_to_snd = ctx->snd_space;
600 /* Check if we're tx constrained by the node */
601 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
602 if (ctx->n_segs_per_evt > max_segs)
604 ctx->n_segs_per_evt = max_segs;
605 ctx->max_len_to_snd = max_segs * ctx->snd_mss;
608 n_bytes_per_buf = vlib_bufer_get_default_size (vm);
609 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
610 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
611 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
612 ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
613 ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
615 TRANSPORT_MAX_HDRS_LEN);
619 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
620 session_manager_worker_t * wrk,
621 session_event_t * e, int *n_tx_packets,
624 u32 next_index, next0, next1, *to_next, n_left_to_next, n_left, pbi;
625 u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
626 session_manager_main_t *smm = &session_manager_main;
627 session_tx_context_t *ctx = &wrk->ctx;
628 transport_proto_t tp;
632 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
635 vec_add1 (wrk->pending_event_vector, *e);
636 return SESSION_TX_NO_DATA;
639 next_index = smm->session_type_to_next[ctx->s->session_type];
640 next0 = next1 = next_index;
642 tp = session_get_transport_proto (ctx->s);
643 ctx->transport_vft = transport_protocol_get_vft (tp);
644 ctx->tc = session_tx_get_transport (ctx, peek_data);
645 ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
647 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
649 if (ctx->transport_vft->flush_data)
650 ctx->transport_vft->flush_data (ctx->tc);
653 ctx->snd_space = transport_connection_snd_space (ctx->tc,
657 if (ctx->snd_space == 0 || ctx->snd_mss == 0)
659 vec_add1 (wrk->pending_event_vector, *e);
660 return SESSION_TX_NO_DATA;
663 /* Allow enqueuing of a new event */
664 svm_fifo_unset_event (ctx->s->tx_fifo);
666 /* Check how much we can pull. */
667 session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
670 if (PREDICT_FALSE (!ctx->max_len_to_snd))
671 return SESSION_TX_NO_DATA;
673 n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
674 vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
675 CLIB_CACHE_LINE_BYTES);
676 n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
677 if (PREDICT_FALSE (n_bufs < n_bufs_needed))
680 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
681 vec_add1 (wrk->pending_event_vector, *e);
682 return SESSION_TX_NO_BUFFERS;
686 * Write until we fill up a frame
688 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
689 if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
691 ctx->n_segs_per_evt = n_left_to_next;
692 ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
694 ctx->left_to_snd = ctx->max_len_to_snd;
695 n_left = ctx->n_segs_per_evt;
699 vlib_buffer_t *b0, *b1;
702 pbi = wrk->tx_buffers[n_bufs - 3];
703 pb = vlib_get_buffer (vm, pbi);
704 vlib_prefetch_buffer_header (pb, STORE);
705 pbi = wrk->tx_buffers[n_bufs - 4];
706 pb = vlib_get_buffer (vm, pbi);
707 vlib_prefetch_buffer_header (pb, STORE);
709 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
710 to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
712 b0 = vlib_get_buffer (vm, bi0);
713 b1 = vlib_get_buffer (vm, bi1);
715 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
716 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
718 ctx->transport_vft->push_header (ctx->tc, b0);
719 ctx->transport_vft->push_header (ctx->tc, b1);
725 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
726 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
728 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
729 n_left_to_next, bi0, bi1, next0,
739 pbi = wrk->tx_buffers[n_bufs - 2];
740 pb = vlib_get_buffer (vm, pbi);
741 vlib_prefetch_buffer_header (pb, STORE);
744 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
745 b0 = vlib_get_buffer (vm, bi0);
746 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
748 /* Ask transport to push header after current_length and
749 * total_length_not_including_first_buffer are updated */
750 ctx->transport_vft->push_header (ctx->tc, b0);
756 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
758 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
759 n_left_to_next, bi0, next0);
762 if (PREDICT_FALSE (n_trace > 0))
763 session_tx_trace_frame (vm, node, next_index, to_next,
764 ctx->n_segs_per_evt, ctx->s, n_trace);
765 if (PREDICT_FALSE (n_bufs))
767 clib_warning ("not all buffers consumed");
768 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
770 *n_tx_packets += ctx->n_segs_per_evt;
771 transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
772 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
774 /* If we couldn't dequeue all bytes mark as partially read */
775 ASSERT (ctx->left_to_snd == 0);
776 if (ctx->max_len_to_snd < ctx->max_dequeue)
777 if (svm_fifo_set_event (ctx->s->tx_fifo))
778 vec_add1 (wrk->pending_event_vector, *e);
780 if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
782 /* Fix dgram pre header */
783 if (ctx->max_len_to_snd < ctx->max_dequeue)
784 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
785 sizeof (session_dgram_pre_hdr_t));
786 /* More data needs to be read */
787 else if (svm_fifo_max_dequeue (ctx->s->tx_fifo) > 0)
788 if (svm_fifo_set_event (ctx->s->tx_fifo))
789 vec_add1 (wrk->pending_event_vector, *e);
791 return SESSION_TX_OK;
795 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
796 session_manager_worker_t * wrk,
797 session_event_t * e, int *n_tx_pkts)
799 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 1);
803 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
804 session_manager_worker_t * wrk,
805 session_event_t * e, int *n_tx_pkts)
807 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 0);
811 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
812 vlib_node_runtime_t * node,
813 session_manager_worker_t * wrk,
814 session_event_t * e, int *n_tx_pkts)
816 session_t *s = wrk->ctx.s;
819 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
821 app = application_get (s->t_app_index);
822 svm_fifo_unset_event (s->tx_fifo);
823 return app->cb_fns.builtin_app_tx_callback (s);
826 always_inline session_t *
827 session_event_get_session (session_event_t * e, u8 thread_index)
829 return session_get_if_valid (e->fifo->master_session_index, thread_index);
833 session_update_dispatch_period (session_manager_worker_t * wrk, f64 now,
836 if (wrk->last_tx_packets)
838 f64 sample = now - wrk->last_vlib_time;
839 wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
841 wrk->last_vlib_time = now;
845 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
846 vlib_frame_t * frame)
848 session_manager_main_t *smm = vnet_get_session_manager_main ();
849 u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
850 session_manager_worker_t *wrk = &smm->wrk[thread_index];
851 session_event_t *e, *fifo_events;
852 svm_msg_q_msg_t _msg, *msg = &_msg;
853 f64 now = vlib_time_now (vm);
854 int n_tx_packets = 0, i, rv;
855 app_worker_t *app_wrk;
860 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, thread_index);
863 * Update transport time
865 session_update_dispatch_period (wrk, now, thread_index);
866 transport_update_time (now, thread_index);
868 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
870 /* Make sure postponed events are handled first */
871 fifo_events = wrk->free_event_vector;
872 vec_append (fifo_events, wrk->postponed_event_vector);
873 _vec_len (wrk->postponed_event_vector) = 0;
875 /* Try to dequeue what is available. Don't wait for lock.
876 * XXX: we may need priorities here */
877 mq = wrk->vpp_event_queue;
878 n_to_dequeue = svm_msg_q_size (mq);
879 if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
881 for (i = 0; i < n_to_dequeue; i++)
883 vec_add2 (fifo_events, e, 1);
884 svm_msg_q_sub_w_lock (mq, msg);
885 /* Works because reply messages are smaller than a session evt.
886 * If we ever need to support bigger messages this needs to be
888 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), sizeof (*e));
889 svm_msg_q_free_msg (mq, msg);
891 svm_msg_q_unlock (mq);
894 vec_append (fifo_events, wrk->pending_event_vector);
895 vec_append (fifo_events, wrk->pending_disconnects);
897 _vec_len (wrk->pending_event_vector) = 0;
898 _vec_len (wrk->pending_disconnects) = 0;
900 n_events = vec_len (fifo_events);
901 if (PREDICT_FALSE (!n_events))
904 for (i = 0; i < n_events; i++)
906 session_t *s; /* $$$ prefetch 1 ahead maybe */
911 switch (e->event_type)
913 case SESSION_IO_EVT_TX_FLUSH:
914 case FIFO_EVENT_APP_TX:
915 /* Don't try to send more that one frame per dispatch cycle */
916 if (n_tx_packets == VLIB_FRAME_SIZE)
918 vec_add1 (wrk->postponed_event_vector, *e);
922 s = session_event_get_session (e, thread_index);
923 if (PREDICT_FALSE (!s))
925 clib_warning ("session was freed!");
929 /* Spray packets in per session type frames, since they go to
931 rv = (smm->session_tx_fns[s->session_type]) (vm, node, wrk, e,
933 if (PREDICT_TRUE (rv == SESSION_TX_OK))
935 need_tx_ntf = svm_fifo_needs_tx_ntf (s->tx_fifo,
936 wrk->ctx.max_len_to_snd);
937 if (PREDICT_FALSE (need_tx_ntf))
938 session_dequeue_notify (s);
940 else if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
942 vlib_node_increment_counter (vm, node->node_index,
943 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
947 case FIFO_EVENT_DISCONNECT:
948 s = session_get_from_handle_if_valid (e->session_handle);
949 if (PREDICT_FALSE (!s))
952 /* Make sure session disconnects run after the pending list is
953 * drained, i.e., postpone if the first time. If not the first
954 * and the tx queue is still not empty, try to wait for some
957 || (e->postponed < 200 && svm_fifo_max_dequeue (s->tx_fifo)))
960 vec_add1 (wrk->pending_disconnects, *e);
964 session_transport_close (s);
966 case FIFO_EVENT_BUILTIN_RX:
967 s = session_event_get_session (e, thread_index);
968 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
970 svm_fifo_unset_event (s->rx_fifo);
971 app_wrk = app_worker_get (s->app_wrk_index);
972 app = application_get (app_wrk->app_index);
973 app->cb_fns.builtin_app_rx_callback (s);
975 case FIFO_EVENT_BUILTIN_TX:
976 s = session_get_from_handle_if_valid (e->session_handle);
978 if (PREDICT_TRUE (s != 0))
979 session_tx_fifo_dequeue_internal (vm, node, wrk, e,
984 (*fp) (e->rpc_args.arg);
986 case SESSION_CTRL_EVT_DISCONNECTED:
987 session_mq_disconnected_handler (e->data);
989 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
990 session_mq_accepted_reply_handler (e->data);
992 case SESSION_CTRL_EVT_CONNECTED_REPLY:
994 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
995 session_mq_disconnected_reply_handler (e->data);
997 case SESSION_CTRL_EVT_RESET_REPLY:
998 session_mq_reset_reply_handler (e->data);
1000 case SESSION_CTRL_EVT_WORKER_UPDATE:
1001 session_mq_worker_update_handler (e->data);
1004 clib_warning ("unhandled event type %d", e->event_type);
1008 _vec_len (fifo_events) = 0;
1009 wrk->free_event_vector = fifo_events;
1010 wrk->last_tx_packets = n_tx_packets;
1012 vlib_node_increment_counter (vm, session_queue_node.index,
1013 SESSION_QUEUE_ERROR_TX, n_tx_packets);
1015 SESSION_EVT_DBG (SESSION_EVT_DISPATCH_END, smm, thread_index);
1017 return n_tx_packets;
1021 VLIB_REGISTER_NODE (session_queue_node) =
1023 .function = session_queue_node_fn,
1024 .name = "session-queue",
1025 .format_trace = format_session_queue_trace,
1026 .type = VLIB_NODE_TYPE_INPUT,
1027 .n_errors = ARRAY_LEN (session_queue_error_strings),
1028 .error_strings = session_queue_error_strings,
1029 .state = VLIB_NODE_STATE_DISABLED,
1034 dump_thread_0_event_queue (void)
1036 session_manager_main_t *smm = vnet_get_session_manager_main ();
1037 vlib_main_t *vm = &vlib_global_main;
1038 u32 my_thread_index = vm->thread_index;
1039 session_event_t _e, *e = &_e;
1040 svm_msg_q_ring_t *ring;
1042 svm_msg_q_msg_t *msg;
1046 mq = smm->wrk[my_thread_index].vpp_event_queue;
1047 index = mq->q->head;
1049 for (i = 0; i < mq->q->cursize; i++)
1051 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1052 ring = svm_msg_q_ring (mq, msg->ring_index);
1053 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1055 switch (e->event_type)
1057 case FIFO_EVENT_APP_TX:
1058 s0 = session_event_get_session (e, my_thread_index);
1059 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
1062 case FIFO_EVENT_DISCONNECT:
1063 s0 = session_get_from_handle (e->session_handle);
1064 fformat (stdout, "[%04d] disconnect session %d\n", i,
1068 case FIFO_EVENT_BUILTIN_RX:
1069 s0 = session_event_get_session (e, my_thread_index);
1070 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1073 case FIFO_EVENT_RPC:
1074 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1075 i, (u64) (uword) (e->rpc_args.fp),
1076 (u64) (uword) (e->rpc_args.arg));
1080 fformat (stdout, "[%04d] unhandled event type %d\n",
1087 if (index == mq->q->maxsize)
1093 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1096 switch (e->event_type)
1098 case FIFO_EVENT_APP_RX:
1099 case FIFO_EVENT_APP_TX:
1100 case FIFO_EVENT_BUILTIN_RX:
1104 case FIFO_EVENT_DISCONNECT:
1106 case FIFO_EVENT_RPC:
1107 s = session_get_from_handle (e->session_handle);
1110 clib_warning ("session has event but doesn't exist!");
1113 if (s->rx_fifo == f || s->tx_fifo == f)
1123 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1125 session_event_t *pending_event_vector, *evt;
1126 session_manager_worker_t *wrk;
1127 int i, index, found = 0;
1128 svm_msg_q_msg_t *msg;
1129 svm_msg_q_ring_t *ring;
1134 thread_index = f->master_thread_index;
1135 wrk = session_manager_get_worker (thread_index);
1140 mq = wrk->vpp_event_queue;
1141 index = mq->q->head;
1142 for (i = 0; i < mq->q->cursize; i++)
1144 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1145 ring = svm_msg_q_ring (mq, msg->ring_index);
1146 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1147 found = session_node_cmp_event (e, f);
1150 if (++index == mq->q->maxsize)
1154 * Search pending events vector
1156 pending_event_vector = wrk->pending_event_vector;
1157 vec_foreach (evt, pending_event_vector)
1159 found = session_node_cmp_event (evt, f);
1162 clib_memcpy_fast (e, evt, sizeof (*evt));
1169 static clib_error_t *
1170 session_queue_exit (vlib_main_t * vm)
1172 if (vec_len (vlib_mains) < 2)
1176 * Shut off (especially) worker-thread session nodes.
1177 * Otherwise, vpp can crash as the main thread unmaps the
1180 vlib_worker_thread_barrier_sync (vm);
1181 session_node_enable_disable (0 /* is_enable */ );
1182 vlib_worker_thread_barrier_release (vm);
1186 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1189 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1192 f64 now, timeout = 1.0;
1193 uword *event_data = 0;
1198 vlib_process_wait_for_event_or_clock (vm, timeout);
1199 now = vlib_time_now (vm);
1200 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1204 case SESSION_Q_PROCESS_FLUSH_FRAMES:
1205 /* Flush the frames by updating all transports times */
1206 transport_update_time (now, 0);
1208 case SESSION_Q_PROCESS_STOP:
1212 /* Timed out. Update time for all transports to trigger all
1213 * outstanding retransmits. */
1214 transport_update_time (now, 0);
1217 vec_reset_length (event_data);
1223 VLIB_REGISTER_NODE (session_queue_process_node) =
1225 .function = session_queue_process,
1226 .type = VLIB_NODE_TYPE_PROCESS,
1227 .name = "session-queue-process",
1228 .state = VLIB_NODE_STATE_DISABLED,
1233 * fd.io coding-style-patch-verification: ON
1236 * eval: (c-set-style "gnu")