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>
28 static void session_mq_accepted_reply_handler (void *data);
31 accepted_notify_cb (void *data, u32 data_len)
33 session_mq_accepted_reply_handler (data);
37 session_mq_accepted_reply_handler (void *data)
39 session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
40 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
41 session_state_t old_state;
42 app_worker_t *app_wrk;
45 /* Server isn't interested, kill the session */
48 a->app_index = mp->context;
49 a->handle = mp->handle;
50 vnet_disconnect_session (a);
54 /* Mail this back from the main thread. We're not polling in main
55 * thread so we're using other workers for notifications. */
56 if (vlib_num_workers () && vlib_get_thread_index () != 0
57 && session_thread_from_handle (mp->handle) == 0)
59 vl_api_rpc_call_main_thread (accepted_notify_cb, data,
60 sizeof (session_accepted_reply_msg_t));
64 s = session_get_from_handle_if_valid (mp->handle);
68 app_wrk = app_worker_get (s->app_wrk_index);
69 if (app_wrk->app_index != mp->context)
71 clib_warning ("app doesn't own session");
75 if (!session_has_transport (s))
77 s->session_state = SESSION_STATE_READY;
78 if (ct_session_connect_notify (s))
83 old_state = s->session_state;
84 s->session_state = SESSION_STATE_READY;
85 if (!svm_fifo_is_empty (s->rx_fifo))
86 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
88 /* Closed while waiting for app to reply. Resend disconnect */
89 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
91 app_worker_close_notify (app_wrk, s);
92 s->session_state = old_state;
99 session_mq_reset_reply_handler (void *data)
101 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
102 session_reset_reply_msg_t *mp;
103 app_worker_t *app_wrk;
106 u32 index, thread_index;
108 mp = (session_reset_reply_msg_t *) data;
109 app = application_lookup (mp->context);
113 session_parse_handle (mp->handle, &index, &thread_index);
114 s = session_get_if_valid (index, thread_index);
116 /* Session was already closed or already cleaned up */
117 if (!s || s->session_state != SESSION_STATE_TRANSPORT_CLOSING)
120 app_wrk = app_worker_get (s->app_wrk_index);
121 if (!app_wrk || app_wrk->app_index != app->app_index)
123 clib_warning ("App % does not own handle 0x%lx!", app->app_index,
128 /* Client objected to resetting the session, log and continue */
131 clib_warning ("client retval %d", mp->retval);
135 /* This comes as a response to a reset, transport only waiting for
136 * confirmation to remove connection state, no need to disconnect */
137 a->handle = mp->handle;
138 a->app_index = app->app_index;
139 vnet_disconnect_session (a);
143 session_mq_disconnected_handler (void *data)
145 session_disconnected_reply_msg_t *rmp;
146 vnet_disconnect_args_t _a, *a = &_a;
147 svm_msg_q_msg_t _msg, *msg = &_msg;
148 session_disconnected_msg_t *mp;
149 app_worker_t *app_wrk;
150 session_event_t *evt;
155 mp = (session_disconnected_msg_t *) data;
156 if (!(s = session_get_from_handle_if_valid (mp->handle)))
158 clib_warning ("could not disconnect handle %llu", mp->handle);
161 app_wrk = app_worker_get (s->app_wrk_index);
162 app = application_lookup (mp->client_index);
163 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
165 clib_warning ("could not disconnect session: %llu app: %u",
166 mp->handle, mp->client_index);
170 a->handle = mp->handle;
171 a->app_index = app_wrk->wrk_index;
172 rv = vnet_disconnect_session (a);
174 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
175 SESSION_MQ_CTRL_EVT_RING,
177 svm_msg_q_unlock (app_wrk->event_queue);
178 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
179 clib_memset (evt, 0, sizeof (*evt));
180 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
181 rmp = (session_disconnected_reply_msg_t *) evt->data;
182 rmp->handle = mp->handle;
183 rmp->context = mp->context;
185 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
189 session_mq_disconnected_reply_handler (void *data)
191 session_disconnected_reply_msg_t *mp;
192 vnet_disconnect_args_t _a, *a = &_a;
195 mp = (session_disconnected_reply_msg_t *) data;
197 /* Client objected to disconnecting the session, log and continue */
200 clib_warning ("client retval %d", mp->retval);
204 /* Disconnect has been confirmed. Confirm close to transport */
205 app = application_lookup (mp->context);
208 a->handle = mp->handle;
209 a->app_index = app->app_index;
210 vnet_disconnect_session (a);
215 session_mq_worker_update_handler (void *data)
217 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
218 session_worker_update_reply_msg_t *rmp;
219 svm_msg_q_msg_t _msg, *msg = &_msg;
220 app_worker_t *app_wrk;
221 u32 owner_app_wrk_map;
222 session_event_t *evt;
226 app = application_lookup (mp->client_index);
229 if (!(s = session_get_from_handle_if_valid (mp->handle)))
231 clib_warning ("invalid handle %llu", mp->handle);
234 app_wrk = app_worker_get (s->app_wrk_index);
235 if (app_wrk->app_index != app->app_index)
237 clib_warning ("app %u does not own session %llu", app->app_index,
241 owner_app_wrk_map = app_wrk->wrk_map_index;
242 app_wrk = application_get_worker (app, mp->wrk_index);
244 /* This needs to come from the new owner */
245 if (mp->req_wrk_index == owner_app_wrk_map)
247 session_req_worker_update_msg_t *wump;
249 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
250 SESSION_MQ_CTRL_EVT_RING,
252 svm_msg_q_unlock (app_wrk->event_queue);
253 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
254 clib_memset (evt, 0, sizeof (*evt));
255 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
256 wump = (session_req_worker_update_msg_t *) evt->data;
257 wump->session_handle = mp->handle;
258 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
262 app_worker_own_session (app_wrk, s);
267 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
268 SESSION_MQ_CTRL_EVT_RING,
270 svm_msg_q_unlock (app_wrk->event_queue);
271 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
272 clib_memset (evt, 0, sizeof (*evt));
273 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
274 rmp = (session_worker_update_reply_msg_t *) evt->data;
275 rmp->handle = mp->handle;
276 rmp->rx_fifo = pointer_to_uword (s->rx_fifo);
277 rmp->tx_fifo = pointer_to_uword (s->tx_fifo);
278 rmp->segment_handle = session_segment_handle (s);
279 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
282 * Retransmit messages that may have been lost
284 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
285 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
287 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
288 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
290 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
291 app_worker_close_notify (app_wrk, s);
294 vlib_node_registration_t session_queue_node;
299 u32 server_thread_index;
300 } session_queue_trace_t;
302 /* packet trace format function */
304 format_session_queue_trace (u8 * s, va_list * args)
306 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
307 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
308 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
310 s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
311 t->session_index, t->server_thread_index);
315 #define foreach_session_queue_error \
316 _(TX, "Packets transmitted") \
317 _(TIMER, "Timer events") \
318 _(NO_BUFFER, "Out of buffers")
322 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
323 foreach_session_queue_error
325 SESSION_QUEUE_N_ERROR,
326 } session_queue_error_t;
328 static char *session_queue_error_strings[] = {
329 #define _(sym,string) string,
330 foreach_session_queue_error
336 SESSION_TX_NO_BUFFERS = -2,
342 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
343 u32 next_index, u32 * to_next, u16 n_segs,
344 session_t * s, u32 n_trace)
346 session_queue_trace_t *t;
350 for (i = 0; i < clib_min (n_trace, n_segs); i++)
352 b = vlib_get_buffer (vm, to_next[i - n_segs]);
353 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
354 t = vlib_add_trace (vm, node, b, sizeof (*t));
355 t->session_index = s->session_index;
356 t->server_thread_index = s->thread_index;
358 vlib_set_trace_count (vm, node, n_trace - i);
362 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
363 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
365 vlib_buffer_t *chain_b, *prev_b;
366 u32 chain_bi0, to_deq, left_from_seg;
367 session_worker_t *wrk;
368 u16 len_to_deq, n_bytes_read;
371 wrk = session_main_get_worker (ctx->s->thread_index);
372 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
373 b->total_length_not_including_first_buffer = 0;
376 left_from_seg = clib_min (ctx->snd_mss - b->current_length,
378 to_deq = left_from_seg;
379 for (j = 1; j < ctx->n_bufs_per_seg; j++)
382 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
385 chain_bi0 = wrk->tx_buffers[*n_bufs];
386 chain_b = vlib_get_buffer (vm, chain_bi0);
387 chain_b->current_data = 0;
388 data = vlib_buffer_get_current (chain_b);
391 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
392 ctx->tx_offset, len_to_deq, data);
393 ctx->tx_offset += n_bytes_read;
397 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
399 svm_fifo_t *f = ctx->s->tx_fifo;
400 session_dgram_hdr_t *hdr = &ctx->hdr;
402 deq_now = clib_min (hdr->data_length - hdr->data_offset,
404 n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
406 ASSERT (n_bytes_read > 0);
408 hdr->data_offset += n_bytes_read;
409 if (hdr->data_offset == hdr->data_length)
411 u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
412 svm_fifo_dequeue_drop (f, offset);
416 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
419 ASSERT (n_bytes_read == len_to_deq);
420 chain_b->current_length = n_bytes_read;
421 b->total_length_not_including_first_buffer += chain_b->current_length;
423 /* update previous buffer */
424 prev_b->next_buffer = chain_bi0;
425 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
427 /* update current buffer */
428 chain_b->next_buffer = 0;
430 to_deq -= n_bytes_read;
435 && b->total_length_not_including_first_buffer == left_from_seg);
436 ctx->left_to_snd -= left_from_seg;
440 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
441 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
448 * Start with the first buffer in chain
451 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
454 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
455 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
459 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->tx_offset,
461 ASSERT (n_bytes_read > 0);
462 /* Keep track of progress locally, transport is also supposed to
463 * increment it independently when pushing the header */
464 ctx->tx_offset += n_bytes_read;
468 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
470 session_dgram_hdr_t *hdr = &ctx->hdr;
471 svm_fifo_t *f = ctx->s->tx_fifo;
475 ASSERT (hdr->data_length > hdr->data_offset);
476 deq_now = clib_min (hdr->data_length - hdr->data_offset,
478 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
479 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
480 ASSERT (n_bytes_read > 0);
482 if (ctx->s->session_state == SESSION_STATE_LISTENING)
484 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
485 ctx->tc->rmt_port = hdr->rmt_port;
487 hdr->data_offset += n_bytes_read;
488 if (hdr->data_offset == hdr->data_length)
490 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
491 svm_fifo_dequeue_drop (f, offset);
496 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
498 ASSERT (n_bytes_read > 0);
501 b->current_length = n_bytes_read;
502 ctx->left_to_snd -= n_bytes_read;
505 * Fill in the remaining buffers in the chain, if any
507 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
508 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
511 SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
512 ed->data[0] = SESSION_IO_EVT_TX;
513 ed->data[1] = ctx->max_dequeue;
514 ed->data[2] = len_to_deq;
515 ed->data[3] = ctx->left_to_snd;
521 session_tx_not_ready (session_t * s, u8 peek_data)
525 /* Can retransmit for closed sessions but can't send new data if
526 * session is not ready or closed */
527 if (s->session_state < SESSION_STATE_READY)
529 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
535 always_inline transport_connection_t *
536 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
540 return ctx->transport_vft->get_connection (ctx->s->connection_index,
541 ctx->s->thread_index);
545 if (ctx->s->session_state == SESSION_STATE_LISTENING)
546 return ctx->transport_vft->get_listener (ctx->s->connection_index);
549 return ctx->transport_vft->get_connection (ctx->s->connection_index,
550 ctx->s->thread_index);
556 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
557 u32 max_segs, u8 peek_data)
559 u32 n_bytes_per_buf, n_bytes_per_seg;
560 ctx->max_dequeue = svm_fifo_max_dequeue (ctx->s->tx_fifo);
563 /* Offset in rx fifo from where to peek data */
564 ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
565 if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
567 ctx->max_len_to_snd = 0;
570 ctx->max_dequeue -= ctx->tx_offset;
574 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
576 if (ctx->max_dequeue <= sizeof (ctx->hdr))
578 ctx->max_len_to_snd = 0;
581 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
583 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
584 ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
587 ASSERT (ctx->max_dequeue > 0);
589 /* Ensure we're not writing more than transport window allows */
590 if (ctx->max_dequeue < ctx->snd_space)
592 /* Constrained by tx queue. Try to send only fully formed segments */
593 ctx->max_len_to_snd =
594 (ctx->max_dequeue > ctx->snd_mss) ?
595 ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
600 /* Expectation is that snd_space0 is already a multiple of snd_mss */
601 ctx->max_len_to_snd = ctx->snd_space;
604 /* Check if we're tx constrained by the node */
605 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
606 if (ctx->n_segs_per_evt > max_segs)
608 ctx->n_segs_per_evt = max_segs;
609 ctx->max_len_to_snd = max_segs * ctx->snd_mss;
612 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
613 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
614 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
615 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
616 ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
617 ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
619 TRANSPORT_MAX_HDRS_LEN);
623 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
624 session_worker_t * wrk,
625 session_event_t * e, int *n_tx_packets,
628 u32 next_index, next0, next1, *to_next, n_left_to_next, n_left, pbi;
629 u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
630 session_main_t *smm = &session_main;
631 session_tx_context_t *ctx = &wrk->ctx;
632 transport_proto_t tp;
636 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
639 vec_add1 (wrk->pending_event_vector, *e);
640 return SESSION_TX_NO_DATA;
643 next_index = smm->session_type_to_next[ctx->s->session_type];
644 next0 = next1 = next_index;
646 tp = session_get_transport_proto (ctx->s);
647 ctx->transport_vft = transport_protocol_get_vft (tp);
648 ctx->tc = session_tx_get_transport (ctx, peek_data);
649 ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
651 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
653 if (ctx->transport_vft->flush_data)
654 ctx->transport_vft->flush_data (ctx->tc);
657 ctx->snd_space = transport_connection_snd_space (ctx->tc,
661 if (ctx->snd_space == 0 || ctx->snd_mss == 0)
663 vec_add1 (wrk->pending_event_vector, *e);
664 return SESSION_TX_NO_DATA;
667 /* Allow enqueuing of a new event */
668 svm_fifo_unset_event (ctx->s->tx_fifo);
670 /* Check how much we can pull. */
671 session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
674 if (PREDICT_FALSE (!ctx->max_len_to_snd))
675 return SESSION_TX_NO_DATA;
677 n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
678 vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
679 CLIB_CACHE_LINE_BYTES);
680 n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
681 if (PREDICT_FALSE (n_bufs < n_bufs_needed))
684 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
685 vec_add1 (wrk->pending_event_vector, *e);
686 return SESSION_TX_NO_BUFFERS;
690 * Write until we fill up a frame
692 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
693 if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
695 ctx->n_segs_per_evt = n_left_to_next;
696 ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
698 ctx->left_to_snd = ctx->max_len_to_snd;
699 n_left = ctx->n_segs_per_evt;
703 vlib_buffer_t *b0, *b1;
706 pbi = wrk->tx_buffers[n_bufs - 3];
707 pb = vlib_get_buffer (vm, pbi);
708 vlib_prefetch_buffer_header (pb, STORE);
709 pbi = wrk->tx_buffers[n_bufs - 4];
710 pb = vlib_get_buffer (vm, pbi);
711 vlib_prefetch_buffer_header (pb, STORE);
713 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
714 to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
716 b0 = vlib_get_buffer (vm, bi0);
717 b1 = vlib_get_buffer (vm, bi1);
719 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
720 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
722 ctx->transport_vft->push_header (ctx->tc, b0);
723 ctx->transport_vft->push_header (ctx->tc, b1);
729 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
730 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
732 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
733 n_left_to_next, bi0, bi1, next0,
743 pbi = wrk->tx_buffers[n_bufs - 2];
744 pb = vlib_get_buffer (vm, pbi);
745 vlib_prefetch_buffer_header (pb, STORE);
748 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
749 b0 = vlib_get_buffer (vm, bi0);
750 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
752 /* Ask transport to push header after current_length and
753 * total_length_not_including_first_buffer are updated */
754 ctx->transport_vft->push_header (ctx->tc, b0);
760 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
762 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
763 n_left_to_next, bi0, next0);
766 if (PREDICT_FALSE (n_trace > 0))
767 session_tx_trace_frame (vm, node, next_index, to_next,
768 ctx->n_segs_per_evt, ctx->s, n_trace);
769 if (PREDICT_FALSE (n_bufs))
771 clib_warning ("not all buffers consumed");
772 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
774 *n_tx_packets += ctx->n_segs_per_evt;
775 transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
776 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
778 /* If we couldn't dequeue all bytes mark as partially read */
779 ASSERT (ctx->left_to_snd == 0);
780 if (ctx->max_len_to_snd < ctx->max_dequeue)
781 if (svm_fifo_set_event (ctx->s->tx_fifo))
782 vec_add1 (wrk->pending_event_vector, *e);
784 if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
786 /* Fix dgram pre header */
787 if (ctx->max_len_to_snd < ctx->max_dequeue)
788 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
789 sizeof (session_dgram_pre_hdr_t));
790 /* More data needs to be read */
791 else if (svm_fifo_max_dequeue (ctx->s->tx_fifo) > 0)
792 if (svm_fifo_set_event (ctx->s->tx_fifo))
793 vec_add1 (wrk->pending_event_vector, *e);
795 return SESSION_TX_OK;
799 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
800 session_worker_t * wrk,
801 session_event_t * e, int *n_tx_pkts)
803 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 1);
807 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
808 session_worker_t * wrk,
809 session_event_t * e, int *n_tx_pkts)
811 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 0);
815 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
816 vlib_node_runtime_t * node,
817 session_worker_t * wrk,
818 session_event_t * e, int *n_tx_pkts)
820 session_t *s = wrk->ctx.s;
822 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
824 svm_fifo_unset_event (s->tx_fifo);
825 return transport_custom_tx (session_get_transport_proto (s), s);
828 always_inline session_t *
829 session_event_get_session (session_event_t * e, u8 thread_index)
831 return session_get_if_valid (e->session_index, thread_index);
835 session_update_dispatch_period (session_worker_t * wrk, f64 now,
838 if (wrk->last_tx_packets)
840 f64 sample = now - wrk->last_vlib_time;
841 wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
843 wrk->last_vlib_time = now;
847 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
848 vlib_frame_t * frame)
850 session_main_t *smm = vnet_get_session_main ();
851 u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
852 session_worker_t *wrk = &smm->wrk[thread_index];
853 session_event_t *e, *fifo_events;
854 svm_msg_q_msg_t _msg, *msg = &_msg;
855 f64 now = vlib_time_now (vm);
856 int n_tx_packets = 0, i, rv;
857 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 SESSION_IO_EVT_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!");
929 CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
931 /* Spray packets in per session type frames, since they go to
933 rv = (smm->session_tx_fns[s->session_type]) (vm, node, wrk, e,
935 if (PREDICT_TRUE (rv == SESSION_TX_OK))
937 need_tx_ntf = svm_fifo_needs_tx_ntf (s->tx_fifo,
938 wrk->ctx.max_len_to_snd);
939 if (PREDICT_FALSE (need_tx_ntf))
940 session_dequeue_notify (s);
942 else if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
944 vlib_node_increment_counter (vm, node->node_index,
945 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
949 case SESSION_CTRL_EVT_CLOSE:
950 s = session_get_from_handle_if_valid (e->session_handle);
951 if (PREDICT_FALSE (!s))
954 /* Make sure session disconnects run after the pending list is
955 * drained, i.e., postpone if the first time. If not the first
956 * and the tx queue is still not empty, try to wait for some
959 || (e->postponed < 200 && svm_fifo_max_dequeue (s->tx_fifo)))
962 vec_add1 (wrk->pending_disconnects, *e);
966 session_transport_close (s);
968 case SESSION_IO_EVT_BUILTIN_RX:
969 s = session_event_get_session (e, thread_index);
970 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
972 svm_fifo_unset_event (s->rx_fifo);
973 app_wrk = app_worker_get (s->app_wrk_index);
974 app_worker_builtin_rx (app_wrk, s);
976 case SESSION_IO_EVT_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,
983 case SESSION_CTRL_EVT_RPC:
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_main_t *smm = vnet_get_session_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 SESSION_IO_EVT_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 SESSION_CTRL_EVT_CLOSE:
1064 s0 = session_get_from_handle (e->session_handle);
1065 fformat (stdout, "[%04d] disconnect session %d\n", i,
1069 case SESSION_IO_EVT_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 SESSION_CTRL_EVT_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 SESSION_IO_EVT_RX:
1100 case SESSION_IO_EVT_TX:
1101 case SESSION_IO_EVT_BUILTIN_RX:
1102 if (e->session_index == f->master_session_index)
1105 case SESSION_CTRL_EVT_CLOSE:
1107 case SESSION_CTRL_EVT_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_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_main_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,
1233 static_always_inline uword
1234 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1235 vlib_frame_t * frame)
1237 session_main_t *sm = &session_main;
1238 if (!sm->wrk[0].vpp_event_queue)
1240 return session_queue_node_fn (vm, node, frame);
1244 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1246 .function = session_queue_pre_input_inline,
1247 .type = VLIB_NODE_TYPE_PRE_INPUT,
1248 .name = "session-queue-main",
1249 .state = VLIB_NODE_STATE_DISABLED,
1254 * fd.io coding-style-patch-verification: ON
1257 * eval: (c-set-style "gnu")