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 application_t *app = application_get (app_wrk->app_index);
92 app->cb_fns.session_disconnect_callback (s);
93 s->session_state = old_state;
100 session_mq_reset_reply_handler (void *data)
102 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
103 session_reset_reply_msg_t *mp;
104 app_worker_t *app_wrk;
107 u32 index, thread_index;
109 mp = (session_reset_reply_msg_t *) data;
110 app = application_lookup (mp->context);
114 session_parse_handle (mp->handle, &index, &thread_index);
115 s = session_get_if_valid (index, thread_index);
117 /* Session was already closed or already cleaned up */
118 if (!s || s->session_state != SESSION_STATE_TRANSPORT_CLOSING)
121 app_wrk = app_worker_get (s->app_wrk_index);
122 if (!app_wrk || app_wrk->app_index != app->app_index)
124 clib_warning ("App % does not own handle 0x%lx!", app->app_index,
129 /* Client objected to resetting the session, log and continue */
132 clib_warning ("client retval %d", mp->retval);
136 /* This comes as a response to a reset, transport only waiting for
137 * confirmation to remove connection state, no need to disconnect */
138 a->handle = mp->handle;
139 a->app_index = app->app_index;
140 vnet_disconnect_session (a);
144 session_mq_disconnected_handler (void *data)
146 session_disconnected_reply_msg_t *rmp;
147 vnet_disconnect_args_t _a, *a = &_a;
148 svm_msg_q_msg_t _msg, *msg = &_msg;
149 session_disconnected_msg_t *mp;
150 app_worker_t *app_wrk;
151 session_event_t *evt;
156 mp = (session_disconnected_msg_t *) data;
157 if (!(s = session_get_from_handle_if_valid (mp->handle)))
159 clib_warning ("could not disconnect handle %llu", mp->handle);
162 app_wrk = app_worker_get (s->app_wrk_index);
163 app = application_lookup (mp->client_index);
164 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
166 clib_warning ("could not disconnect session: %llu app: %u",
167 mp->handle, mp->client_index);
171 a->handle = mp->handle;
172 a->app_index = app_wrk->wrk_index;
173 rv = vnet_disconnect_session (a);
175 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
176 SESSION_MQ_CTRL_EVT_RING,
178 svm_msg_q_unlock (app_wrk->event_queue);
179 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
180 clib_memset (evt, 0, sizeof (*evt));
181 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
182 rmp = (session_disconnected_reply_msg_t *) evt->data;
183 rmp->handle = mp->handle;
184 rmp->context = mp->context;
186 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
190 session_mq_disconnected_reply_handler (void *data)
192 session_disconnected_reply_msg_t *mp;
193 vnet_disconnect_args_t _a, *a = &_a;
196 mp = (session_disconnected_reply_msg_t *) data;
198 /* Client objected to disconnecting the session, log and continue */
201 clib_warning ("client retval %d", mp->retval);
205 /* Disconnect has been confirmed. Confirm close to transport */
206 app = application_lookup (mp->context);
209 a->handle = mp->handle;
210 a->app_index = app->app_index;
211 vnet_disconnect_session (a);
216 session_mq_worker_update_handler (void *data)
218 session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
219 session_worker_update_reply_msg_t *rmp;
220 svm_msg_q_msg_t _msg, *msg = &_msg;
221 app_worker_t *app_wrk;
222 u32 owner_app_wrk_map;
223 session_event_t *evt;
227 app = application_lookup (mp->client_index);
230 if (!(s = session_get_from_handle_if_valid (mp->handle)))
232 clib_warning ("invalid handle %llu", mp->handle);
235 app_wrk = app_worker_get (s->app_wrk_index);
236 if (app_wrk->app_index != app->app_index)
238 clib_warning ("app %u does not own session %llu", app->app_index,
242 owner_app_wrk_map = app_wrk->wrk_map_index;
243 app_wrk = application_get_worker (app, mp->wrk_index);
245 /* This needs to come from the new owner */
246 if (mp->req_wrk_index == owner_app_wrk_map)
248 session_req_worker_update_msg_t *wump;
250 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
251 SESSION_MQ_CTRL_EVT_RING,
253 svm_msg_q_unlock (app_wrk->event_queue);
254 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
255 clib_memset (evt, 0, sizeof (*evt));
256 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
257 wump = (session_req_worker_update_msg_t *) evt->data;
258 wump->session_handle = mp->handle;
259 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
263 app_worker_own_session (app_wrk, s);
268 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
269 SESSION_MQ_CTRL_EVT_RING,
271 svm_msg_q_unlock (app_wrk->event_queue);
272 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
273 clib_memset (evt, 0, sizeof (*evt));
274 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
275 rmp = (session_worker_update_reply_msg_t *) evt->data;
276 rmp->handle = mp->handle;
277 rmp->rx_fifo = pointer_to_uword (s->rx_fifo);
278 rmp->tx_fifo = pointer_to_uword (s->tx_fifo);
279 rmp->segment_handle = session_segment_handle (s);
280 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
283 * Retransmit messages that may have been lost
285 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
286 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
288 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
289 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
291 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
292 app->cb_fns.session_disconnect_callback (s);
295 vlib_node_registration_t session_queue_node;
300 u32 server_thread_index;
301 } session_queue_trace_t;
303 /* packet trace format function */
305 format_session_queue_trace (u8 * s, va_list * args)
307 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
308 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
309 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
311 s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
312 t->session_index, t->server_thread_index);
316 #define foreach_session_queue_error \
317 _(TX, "Packets transmitted") \
318 _(TIMER, "Timer events") \
319 _(NO_BUFFER, "Out of buffers")
323 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
324 foreach_session_queue_error
326 SESSION_QUEUE_N_ERROR,
327 } session_queue_error_t;
329 static char *session_queue_error_strings[] = {
330 #define _(sym,string) string,
331 foreach_session_queue_error
337 SESSION_TX_NO_BUFFERS = -2,
343 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
344 u32 next_index, u32 * to_next, u16 n_segs,
345 session_t * s, u32 n_trace)
347 session_queue_trace_t *t;
351 for (i = 0; i < clib_min (n_trace, n_segs); i++)
353 b = vlib_get_buffer (vm, to_next[i - n_segs]);
354 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
355 t = vlib_add_trace (vm, node, b, sizeof (*t));
356 t->session_index = s->session_index;
357 t->server_thread_index = s->thread_index;
359 vlib_set_trace_count (vm, node, n_trace - i);
363 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
364 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
366 vlib_buffer_t *chain_b, *prev_b;
367 u32 chain_bi0, to_deq, left_from_seg;
368 session_worker_t *wrk;
369 u16 len_to_deq, n_bytes_read;
372 wrk = session_main_get_worker (ctx->s->thread_index);
373 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
374 b->total_length_not_including_first_buffer = 0;
377 left_from_seg = clib_min (ctx->snd_mss - b->current_length,
379 to_deq = left_from_seg;
380 for (j = 1; j < ctx->n_bufs_per_seg; j++)
383 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
386 chain_bi0 = wrk->tx_buffers[*n_bufs];
387 chain_b = vlib_get_buffer (vm, chain_bi0);
388 chain_b->current_data = 0;
389 data = vlib_buffer_get_current (chain_b);
392 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
393 ctx->tx_offset, len_to_deq, data);
394 ctx->tx_offset += n_bytes_read;
398 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
400 svm_fifo_t *f = ctx->s->tx_fifo;
401 session_dgram_hdr_t *hdr = &ctx->hdr;
403 deq_now = clib_min (hdr->data_length - hdr->data_offset,
405 n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
407 ASSERT (n_bytes_read > 0);
409 hdr->data_offset += n_bytes_read;
410 if (hdr->data_offset == hdr->data_length)
412 u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
413 svm_fifo_dequeue_drop (f, offset);
417 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
420 ASSERT (n_bytes_read == len_to_deq);
421 chain_b->current_length = n_bytes_read;
422 b->total_length_not_including_first_buffer += chain_b->current_length;
424 /* update previous buffer */
425 prev_b->next_buffer = chain_bi0;
426 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
428 /* update current buffer */
429 chain_b->next_buffer = 0;
431 to_deq -= n_bytes_read;
436 && b->total_length_not_including_first_buffer == left_from_seg);
437 ctx->left_to_snd -= left_from_seg;
441 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
442 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
449 * Start with the first buffer in chain
452 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
455 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
456 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
460 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->tx_offset,
462 ASSERT (n_bytes_read > 0);
463 /* Keep track of progress locally, transport is also supposed to
464 * increment it independently when pushing the header */
465 ctx->tx_offset += n_bytes_read;
469 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
471 session_dgram_hdr_t *hdr = &ctx->hdr;
472 svm_fifo_t *f = ctx->s->tx_fifo;
476 ASSERT (hdr->data_length > hdr->data_offset);
477 deq_now = clib_min (hdr->data_length - hdr->data_offset,
479 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
480 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
481 ASSERT (n_bytes_read > 0);
483 if (ctx->s->session_state == SESSION_STATE_LISTENING)
485 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
486 ctx->tc->rmt_port = hdr->rmt_port;
488 hdr->data_offset += n_bytes_read;
489 if (hdr->data_offset == hdr->data_length)
491 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
492 svm_fifo_dequeue_drop (f, offset);
497 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
499 ASSERT (n_bytes_read > 0);
502 b->current_length = n_bytes_read;
503 ctx->left_to_snd -= n_bytes_read;
506 * Fill in the remaining buffers in the chain, if any
508 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
509 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
512 SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
513 ed->data[0] = SESSION_IO_EVT_TX;
514 ed->data[1] = ctx->max_dequeue;
515 ed->data[2] = len_to_deq;
516 ed->data[3] = ctx->left_to_snd;
522 session_tx_not_ready (session_t * s, u8 peek_data)
526 /* Can retransmit for closed sessions but can't send new data if
527 * session is not ready or closed */
528 if (s->session_state < SESSION_STATE_READY)
530 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
536 always_inline transport_connection_t *
537 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
541 return ctx->transport_vft->get_connection (ctx->s->connection_index,
542 ctx->s->thread_index);
546 if (ctx->s->session_state == SESSION_STATE_LISTENING)
547 return ctx->transport_vft->get_listener (ctx->s->connection_index);
550 return ctx->transport_vft->get_connection (ctx->s->connection_index,
551 ctx->s->thread_index);
557 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
558 u32 max_segs, u8 peek_data)
560 u32 n_bytes_per_buf, n_bytes_per_seg;
561 ctx->max_dequeue = svm_fifo_max_dequeue (ctx->s->tx_fifo);
564 /* Offset in rx fifo from where to peek data */
565 ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
566 if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
568 ctx->max_len_to_snd = 0;
571 ctx->max_dequeue -= ctx->tx_offset;
575 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
577 if (ctx->max_dequeue <= sizeof (ctx->hdr))
579 ctx->max_len_to_snd = 0;
582 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
584 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
585 ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
588 ASSERT (ctx->max_dequeue > 0);
590 /* Ensure we're not writing more than transport window allows */
591 if (ctx->max_dequeue < ctx->snd_space)
593 /* Constrained by tx queue. Try to send only fully formed segments */
594 ctx->max_len_to_snd =
595 (ctx->max_dequeue > ctx->snd_mss) ?
596 ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
601 /* Expectation is that snd_space0 is already a multiple of snd_mss */
602 ctx->max_len_to_snd = ctx->snd_space;
605 /* Check if we're tx constrained by the node */
606 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
607 if (ctx->n_segs_per_evt > max_segs)
609 ctx->n_segs_per_evt = max_segs;
610 ctx->max_len_to_snd = max_segs * ctx->snd_mss;
613 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
614 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
615 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
616 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
617 ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
618 ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
620 TRANSPORT_MAX_HDRS_LEN);
624 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
625 session_worker_t * wrk,
626 session_event_t * e, int *n_tx_packets,
629 u32 next_index, next0, next1, *to_next, n_left_to_next, n_left, pbi;
630 u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
631 session_main_t *smm = &session_main;
632 session_tx_context_t *ctx = &wrk->ctx;
633 transport_proto_t tp;
637 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
640 vec_add1 (wrk->pending_event_vector, *e);
641 return SESSION_TX_NO_DATA;
644 next_index = smm->session_type_to_next[ctx->s->session_type];
645 next0 = next1 = next_index;
647 tp = session_get_transport_proto (ctx->s);
648 ctx->transport_vft = transport_protocol_get_vft (tp);
649 ctx->tc = session_tx_get_transport (ctx, peek_data);
650 ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
652 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
654 if (ctx->transport_vft->flush_data)
655 ctx->transport_vft->flush_data (ctx->tc);
658 ctx->snd_space = transport_connection_snd_space (ctx->tc,
662 if (ctx->snd_space == 0 || ctx->snd_mss == 0)
664 vec_add1 (wrk->pending_event_vector, *e);
665 return SESSION_TX_NO_DATA;
668 /* Allow enqueuing of a new event */
669 svm_fifo_unset_event (ctx->s->tx_fifo);
671 /* Check how much we can pull. */
672 session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
675 if (PREDICT_FALSE (!ctx->max_len_to_snd))
676 return SESSION_TX_NO_DATA;
678 n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
679 vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
680 CLIB_CACHE_LINE_BYTES);
681 n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
682 if (PREDICT_FALSE (n_bufs < n_bufs_needed))
685 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
686 vec_add1 (wrk->pending_event_vector, *e);
687 return SESSION_TX_NO_BUFFERS;
691 * Write until we fill up a frame
693 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
694 if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
696 ctx->n_segs_per_evt = n_left_to_next;
697 ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
699 ctx->left_to_snd = ctx->max_len_to_snd;
700 n_left = ctx->n_segs_per_evt;
704 vlib_buffer_t *b0, *b1;
707 pbi = wrk->tx_buffers[n_bufs - 3];
708 pb = vlib_get_buffer (vm, pbi);
709 vlib_prefetch_buffer_header (pb, STORE);
710 pbi = wrk->tx_buffers[n_bufs - 4];
711 pb = vlib_get_buffer (vm, pbi);
712 vlib_prefetch_buffer_header (pb, STORE);
714 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
715 to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
717 b0 = vlib_get_buffer (vm, bi0);
718 b1 = vlib_get_buffer (vm, bi1);
720 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
721 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
723 ctx->transport_vft->push_header (ctx->tc, b0);
724 ctx->transport_vft->push_header (ctx->tc, b1);
730 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
731 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
733 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
734 n_left_to_next, bi0, bi1, next0,
744 pbi = wrk->tx_buffers[n_bufs - 2];
745 pb = vlib_get_buffer (vm, pbi);
746 vlib_prefetch_buffer_header (pb, STORE);
749 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
750 b0 = vlib_get_buffer (vm, bi0);
751 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
753 /* Ask transport to push header after current_length and
754 * total_length_not_including_first_buffer are updated */
755 ctx->transport_vft->push_header (ctx->tc, b0);
761 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
763 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
764 n_left_to_next, bi0, next0);
767 if (PREDICT_FALSE (n_trace > 0))
768 session_tx_trace_frame (vm, node, next_index, to_next,
769 ctx->n_segs_per_evt, ctx->s, n_trace);
770 if (PREDICT_FALSE (n_bufs))
772 clib_warning ("not all buffers consumed");
773 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
775 *n_tx_packets += ctx->n_segs_per_evt;
776 transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
777 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
779 /* If we couldn't dequeue all bytes mark as partially read */
780 ASSERT (ctx->left_to_snd == 0);
781 if (ctx->max_len_to_snd < ctx->max_dequeue)
782 if (svm_fifo_set_event (ctx->s->tx_fifo))
783 vec_add1 (wrk->pending_event_vector, *e);
785 if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
787 /* Fix dgram pre header */
788 if (ctx->max_len_to_snd < ctx->max_dequeue)
789 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
790 sizeof (session_dgram_pre_hdr_t));
791 /* More data needs to be read */
792 else if (svm_fifo_max_dequeue (ctx->s->tx_fifo) > 0)
793 if (svm_fifo_set_event (ctx->s->tx_fifo))
794 vec_add1 (wrk->pending_event_vector, *e);
796 return SESSION_TX_OK;
800 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
801 session_worker_t * wrk,
802 session_event_t * e, int *n_tx_pkts)
804 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 1);
808 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
809 session_worker_t * wrk,
810 session_event_t * e, int *n_tx_pkts)
812 return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 0);
816 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
817 vlib_node_runtime_t * node,
818 session_worker_t * wrk,
819 session_event_t * e, int *n_tx_pkts)
821 session_t *s = wrk->ctx.s;
824 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
826 app = application_get (s->t_app_index);
827 svm_fifo_unset_event (s->tx_fifo);
828 return app->cb_fns.builtin_app_tx_callback (s);
831 always_inline session_t *
832 session_event_get_session (session_event_t * e, u8 thread_index)
834 return session_get_if_valid (e->fifo->master_session_index, thread_index);
838 session_update_dispatch_period (session_worker_t * wrk, f64 now,
841 if (wrk->last_tx_packets)
843 f64 sample = now - wrk->last_vlib_time;
844 wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
846 wrk->last_vlib_time = now;
850 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
851 vlib_frame_t * frame)
853 session_main_t *smm = vnet_get_session_main ();
854 u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
855 session_worker_t *wrk = &smm->wrk[thread_index];
856 session_event_t *e, *fifo_events;
857 svm_msg_q_msg_t _msg, *msg = &_msg;
858 f64 now = vlib_time_now (vm);
859 int n_tx_packets = 0, i, rv;
860 app_worker_t *app_wrk;
865 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, thread_index);
868 * Update transport time
870 session_update_dispatch_period (wrk, now, thread_index);
871 transport_update_time (now, thread_index);
873 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
875 /* Make sure postponed events are handled first */
876 fifo_events = wrk->free_event_vector;
877 vec_append (fifo_events, wrk->postponed_event_vector);
878 _vec_len (wrk->postponed_event_vector) = 0;
880 /* Try to dequeue what is available. Don't wait for lock.
881 * XXX: we may need priorities here */
882 mq = wrk->vpp_event_queue;
883 n_to_dequeue = svm_msg_q_size (mq);
884 if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
886 for (i = 0; i < n_to_dequeue; i++)
888 vec_add2 (fifo_events, e, 1);
889 svm_msg_q_sub_w_lock (mq, msg);
890 /* Works because reply messages are smaller than a session evt.
891 * If we ever need to support bigger messages this needs to be
893 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), sizeof (*e));
894 svm_msg_q_free_msg (mq, msg);
896 svm_msg_q_unlock (mq);
899 vec_append (fifo_events, wrk->pending_event_vector);
900 vec_append (fifo_events, wrk->pending_disconnects);
902 _vec_len (wrk->pending_event_vector) = 0;
903 _vec_len (wrk->pending_disconnects) = 0;
905 n_events = vec_len (fifo_events);
906 if (PREDICT_FALSE (!n_events))
909 for (i = 0; i < n_events; i++)
911 session_t *s; /* $$$ prefetch 1 ahead maybe */
916 switch (e->event_type)
918 case SESSION_IO_EVT_TX_FLUSH:
919 case SESSION_IO_EVT_TX:
920 /* Don't try to send more that one frame per dispatch cycle */
921 if (n_tx_packets == VLIB_FRAME_SIZE)
923 vec_add1 (wrk->postponed_event_vector, *e);
927 s = session_event_get_session (e, thread_index);
928 if (PREDICT_FALSE (!s))
930 clib_warning ("session was freed!");
934 /* Spray packets in per session type frames, since they go to
936 rv = (smm->session_tx_fns[s->session_type]) (vm, node, wrk, e,
938 if (PREDICT_TRUE (rv == SESSION_TX_OK))
940 need_tx_ntf = svm_fifo_needs_tx_ntf (s->tx_fifo,
941 wrk->ctx.max_len_to_snd);
942 if (PREDICT_FALSE (need_tx_ntf))
943 session_dequeue_notify (s);
945 else if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
947 vlib_node_increment_counter (vm, node->node_index,
948 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
952 case SESSION_CTRL_EVT_CLOSE:
953 s = session_get_from_handle_if_valid (e->session_handle);
954 if (PREDICT_FALSE (!s))
957 /* Make sure session disconnects run after the pending list is
958 * drained, i.e., postpone if the first time. If not the first
959 * and the tx queue is still not empty, try to wait for some
962 || (e->postponed < 200 && svm_fifo_max_dequeue (s->tx_fifo)))
965 vec_add1 (wrk->pending_disconnects, *e);
969 session_transport_close (s);
971 case SESSION_IO_EVT_BUILTIN_RX:
972 s = session_event_get_session (e, thread_index);
973 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
975 svm_fifo_unset_event (s->rx_fifo);
976 app_wrk = app_worker_get (s->app_wrk_index);
977 app = application_get (app_wrk->app_index);
978 app->cb_fns.builtin_app_rx_callback (s);
980 case SESSION_IO_EVT_BUILTIN_TX:
981 s = session_get_from_handle_if_valid (e->session_handle);
983 if (PREDICT_TRUE (s != 0))
984 session_tx_fifo_dequeue_internal (vm, node, wrk, e,
987 case SESSION_CTRL_EVT_RPC:
989 (*fp) (e->rpc_args.arg);
991 case SESSION_CTRL_EVT_DISCONNECTED:
992 session_mq_disconnected_handler (e->data);
994 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
995 session_mq_accepted_reply_handler (e->data);
997 case SESSION_CTRL_EVT_CONNECTED_REPLY:
999 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1000 session_mq_disconnected_reply_handler (e->data);
1002 case SESSION_CTRL_EVT_RESET_REPLY:
1003 session_mq_reset_reply_handler (e->data);
1005 case SESSION_CTRL_EVT_WORKER_UPDATE:
1006 session_mq_worker_update_handler (e->data);
1009 clib_warning ("unhandled event type %d", e->event_type);
1013 _vec_len (fifo_events) = 0;
1014 wrk->free_event_vector = fifo_events;
1015 wrk->last_tx_packets = n_tx_packets;
1017 vlib_node_increment_counter (vm, session_queue_node.index,
1018 SESSION_QUEUE_ERROR_TX, n_tx_packets);
1020 SESSION_EVT_DBG (SESSION_EVT_DISPATCH_END, smm, thread_index);
1022 return n_tx_packets;
1026 VLIB_REGISTER_NODE (session_queue_node) =
1028 .function = session_queue_node_fn,
1029 .name = "session-queue",
1030 .format_trace = format_session_queue_trace,
1031 .type = VLIB_NODE_TYPE_INPUT,
1032 .n_errors = ARRAY_LEN (session_queue_error_strings),
1033 .error_strings = session_queue_error_strings,
1034 .state = VLIB_NODE_STATE_DISABLED,
1039 dump_thread_0_event_queue (void)
1041 session_main_t *smm = vnet_get_session_main ();
1042 vlib_main_t *vm = &vlib_global_main;
1043 u32 my_thread_index = vm->thread_index;
1044 session_event_t _e, *e = &_e;
1045 svm_msg_q_ring_t *ring;
1047 svm_msg_q_msg_t *msg;
1051 mq = smm->wrk[my_thread_index].vpp_event_queue;
1052 index = mq->q->head;
1054 for (i = 0; i < mq->q->cursize; i++)
1056 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1057 ring = svm_msg_q_ring (mq, msg->ring_index);
1058 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1060 switch (e->event_type)
1062 case SESSION_IO_EVT_TX:
1063 s0 = session_event_get_session (e, my_thread_index);
1064 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
1067 case SESSION_CTRL_EVT_CLOSE:
1068 s0 = session_get_from_handle (e->session_handle);
1069 fformat (stdout, "[%04d] disconnect session %d\n", i,
1073 case SESSION_IO_EVT_BUILTIN_RX:
1074 s0 = session_event_get_session (e, my_thread_index);
1075 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1078 case SESSION_CTRL_EVT_RPC:
1079 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1080 i, (u64) (uword) (e->rpc_args.fp),
1081 (u64) (uword) (e->rpc_args.arg));
1085 fformat (stdout, "[%04d] unhandled event type %d\n",
1092 if (index == mq->q->maxsize)
1098 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1101 switch (e->event_type)
1103 case SESSION_IO_EVT_RX:
1104 case SESSION_IO_EVT_TX:
1105 case SESSION_IO_EVT_BUILTIN_RX:
1109 case SESSION_CTRL_EVT_CLOSE:
1111 case SESSION_CTRL_EVT_RPC:
1112 s = session_get_from_handle (e->session_handle);
1115 clib_warning ("session has event but doesn't exist!");
1118 if (s->rx_fifo == f || s->tx_fifo == f)
1128 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1130 session_event_t *pending_event_vector, *evt;
1131 session_worker_t *wrk;
1132 int i, index, found = 0;
1133 svm_msg_q_msg_t *msg;
1134 svm_msg_q_ring_t *ring;
1139 thread_index = f->master_thread_index;
1140 wrk = session_main_get_worker (thread_index);
1145 mq = wrk->vpp_event_queue;
1146 index = mq->q->head;
1147 for (i = 0; i < mq->q->cursize; i++)
1149 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1150 ring = svm_msg_q_ring (mq, msg->ring_index);
1151 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1152 found = session_node_cmp_event (e, f);
1155 if (++index == mq->q->maxsize)
1159 * Search pending events vector
1161 pending_event_vector = wrk->pending_event_vector;
1162 vec_foreach (evt, pending_event_vector)
1164 found = session_node_cmp_event (evt, f);
1167 clib_memcpy_fast (e, evt, sizeof (*evt));
1174 static clib_error_t *
1175 session_queue_exit (vlib_main_t * vm)
1177 if (vec_len (vlib_mains) < 2)
1181 * Shut off (especially) worker-thread session nodes.
1182 * Otherwise, vpp can crash as the main thread unmaps the
1185 vlib_worker_thread_barrier_sync (vm);
1186 session_node_enable_disable (0 /* is_enable */ );
1187 vlib_worker_thread_barrier_release (vm);
1191 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1194 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1197 f64 now, timeout = 1.0;
1198 uword *event_data = 0;
1203 vlib_process_wait_for_event_or_clock (vm, timeout);
1204 now = vlib_time_now (vm);
1205 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1209 case SESSION_Q_PROCESS_FLUSH_FRAMES:
1210 /* Flush the frames by updating all transports times */
1211 transport_update_time (now, 0);
1213 case SESSION_Q_PROCESS_STOP:
1217 /* Timed out. Update time for all transports to trigger all
1218 * outstanding retransmits. */
1219 transport_update_time (now, 0);
1222 vec_reset_length (event_data);
1228 VLIB_REGISTER_NODE (session_queue_process_node) =
1230 .function = session_queue_process,
1231 .type = VLIB_NODE_TYPE_PROCESS,
1232 .name = "session-queue-process",
1233 .state = VLIB_NODE_STATE_DISABLED,
1237 static_always_inline uword
1238 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1239 vlib_frame_t * frame)
1241 session_main_t *sm = &session_main;
1242 if (!sm->wrk[0].vpp_event_queue)
1244 return session_queue_node_fn (vm, node, frame);
1248 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1250 .function = session_queue_pre_input_inline,
1251 .type = VLIB_NODE_TYPE_PRE_INPUT,
1252 .name = "session-queue-main",
1253 .state = VLIB_NODE_STATE_DISABLED,
1258 * fd.io coding-style-patch-verification: ON
1261 * eval: (c-set-style "gnu")