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;
86 if (!svm_fifo_is_empty_prod (s->rx_fifo))
87 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
89 /* Closed while waiting for app to reply. Resend disconnect */
90 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
92 app_worker_close_notify (app_wrk, 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 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_and_unlock (app_wrk->event_queue, msg);
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 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
253 clib_memset (evt, 0, sizeof (*evt));
254 evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
255 wump = (session_req_worker_update_msg_t *) evt->data;
256 wump->session_handle = mp->handle;
257 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
261 app_worker_own_session (app_wrk, s);
266 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
267 SESSION_MQ_CTRL_EVT_RING,
269 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
270 clib_memset (evt, 0, sizeof (*evt));
271 evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
272 rmp = (session_worker_update_reply_msg_t *) evt->data;
273 rmp->handle = mp->handle;
274 rmp->rx_fifo = pointer_to_uword (s->rx_fifo);
275 rmp->tx_fifo = pointer_to_uword (s->tx_fifo);
276 rmp->segment_handle = session_segment_handle (s);
277 svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
280 * Retransmit messages that may have been lost
282 if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
283 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
285 if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
286 app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
288 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
289 app_worker_close_notify (app_wrk, s);
292 vlib_node_registration_t session_queue_node;
297 u32 server_thread_index;
298 } session_queue_trace_t;
300 /* packet trace format function */
302 format_session_queue_trace (u8 * s, va_list * args)
304 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
305 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
306 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
308 s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
309 t->session_index, t->server_thread_index);
313 #define foreach_session_queue_error \
314 _(TX, "Packets transmitted") \
315 _(TIMER, "Timer events") \
316 _(NO_BUFFER, "Out of buffers")
320 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
321 foreach_session_queue_error
323 SESSION_QUEUE_N_ERROR,
324 } session_queue_error_t;
326 static char *session_queue_error_strings[] = {
327 #define _(sym,string) string,
328 foreach_session_queue_error
334 SESSION_TX_NO_BUFFERS = -2,
340 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
341 u32 next_index, u32 * to_next, u16 n_segs,
342 session_t * s, u32 n_trace)
344 session_queue_trace_t *t;
348 for (i = 0; i < clib_min (n_trace, n_segs); i++)
350 b = vlib_get_buffer (vm, to_next[i - n_segs]);
351 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
352 t = vlib_add_trace (vm, node, b, sizeof (*t));
353 t->session_index = s->session_index;
354 t->server_thread_index = s->thread_index;
356 vlib_set_trace_count (vm, node, n_trace - i);
360 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
361 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
363 vlib_buffer_t *chain_b, *prev_b;
364 u32 chain_bi0, to_deq, left_from_seg;
365 session_worker_t *wrk;
366 u16 len_to_deq, n_bytes_read;
369 wrk = session_main_get_worker (ctx->s->thread_index);
370 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
371 b->total_length_not_including_first_buffer = 0;
374 left_from_seg = clib_min (ctx->snd_mss - b->current_length,
376 to_deq = left_from_seg;
377 for (j = 1; j < ctx->n_bufs_per_seg; j++)
380 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
383 chain_bi0 = wrk->tx_buffers[*n_bufs];
384 chain_b = vlib_get_buffer (vm, chain_bi0);
385 chain_b->current_data = 0;
386 data = vlib_buffer_get_current (chain_b);
389 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
390 ctx->tx_offset, len_to_deq, data);
391 ctx->tx_offset += n_bytes_read;
395 if (ctx->transport_vft->transport_options.tx_type ==
398 svm_fifo_t *f = ctx->s->tx_fifo;
399 session_dgram_hdr_t *hdr = &ctx->hdr;
401 deq_now = clib_min (hdr->data_length - hdr->data_offset,
403 n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
405 ASSERT (n_bytes_read > 0);
407 hdr->data_offset += n_bytes_read;
408 if (hdr->data_offset == hdr->data_length)
410 u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
411 svm_fifo_dequeue_drop (f, offset);
415 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
418 ASSERT (n_bytes_read == len_to_deq);
419 chain_b->current_length = n_bytes_read;
420 b->total_length_not_including_first_buffer += chain_b->current_length;
422 /* update previous buffer */
423 prev_b->next_buffer = chain_bi0;
424 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
426 /* update current buffer */
427 chain_b->next_buffer = 0;
429 to_deq -= n_bytes_read;
434 && b->total_length_not_including_first_buffer == left_from_seg);
435 ctx->left_to_snd -= left_from_seg;
439 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
440 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
447 * Start with the first buffer in chain
450 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
453 data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
454 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
458 n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->tx_offset,
460 ASSERT (n_bytes_read > 0);
461 /* Keep track of progress locally, transport is also supposed to
462 * increment it independently when pushing the header */
463 ctx->tx_offset += n_bytes_read;
467 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
469 session_dgram_hdr_t *hdr = &ctx->hdr;
470 svm_fifo_t *f = ctx->s->tx_fifo;
474 ASSERT (hdr->data_length > hdr->data_offset);
475 deq_now = clib_min (hdr->data_length - hdr->data_offset,
477 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
478 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
479 ASSERT (n_bytes_read > 0);
481 if (ctx->s->session_state == SESSION_STATE_LISTENING)
483 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
484 ctx->tc->rmt_port = hdr->rmt_port;
486 hdr->data_offset += n_bytes_read;
487 if (hdr->data_offset == hdr->data_length)
489 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
490 svm_fifo_dequeue_drop (f, offset);
495 n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
497 ASSERT (n_bytes_read > 0);
500 b->current_length = n_bytes_read;
501 ctx->left_to_snd -= n_bytes_read;
504 * Fill in the remaining buffers in the chain, if any
506 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
507 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
511 session_tx_not_ready (session_t * s, u8 peek_data)
515 if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
517 /* Can retransmit for closed sessions but can't send new data if
518 * session is not ready or closed */
519 else if (s->session_state < SESSION_STATE_READY)
521 else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
523 /* Allow closed transports to still send custom packets.
524 * For instance, tcp may want to send acks in time-wait. */
525 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
526 && (s->flags & SESSION_F_CUSTOM_TX))
534 always_inline transport_connection_t *
535 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
539 return ctx->transport_vft->get_connection (ctx->s->connection_index,
540 ctx->s->thread_index);
544 if (ctx->s->session_state == SESSION_STATE_LISTENING)
545 return ctx->transport_vft->get_listener (ctx->s->connection_index);
548 return ctx->transport_vft->get_connection (ctx->s->connection_index,
549 ctx->s->thread_index);
555 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
556 u32 max_segs, u8 peek_data)
558 u32 n_bytes_per_buf, n_bytes_per_seg;
559 ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
562 /* Offset in rx fifo from where to peek data */
563 ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
564 if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
566 ctx->max_len_to_snd = 0;
569 ctx->max_dequeue -= ctx->tx_offset;
573 if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
575 if (ctx->max_dequeue <= sizeof (ctx->hdr))
577 ctx->max_len_to_snd = 0;
580 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
582 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
583 ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
586 ASSERT (ctx->max_dequeue > 0);
588 /* Ensure we're not writing more than transport window allows */
589 if (ctx->max_dequeue < ctx->snd_space)
591 /* Constrained by tx queue. Try to send only fully formed segments */
592 ctx->max_len_to_snd =
593 (ctx->max_dequeue > ctx->snd_mss) ?
594 ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
599 /* Expectation is that snd_space0 is already a multiple of snd_mss */
600 ctx->max_len_to_snd = ctx->snd_space;
603 /* Check if we're tx constrained by the node */
604 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
605 if (ctx->n_segs_per_evt > max_segs)
607 ctx->n_segs_per_evt = max_segs;
608 ctx->max_len_to_snd = max_segs * ctx->snd_mss;
611 n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
612 ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
613 n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
614 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
615 ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
616 ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
618 TRANSPORT_MAX_HDRS_LEN);
622 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
623 vlib_node_runtime_t * node,
624 session_evt_elt_t * elt,
625 int *n_tx_packets, u8 peek_data)
627 u32 next_index, next0, next1, *to_next, n_left_to_next, max_burst;
628 u32 n_trace, n_bufs_needed = 0, n_left, pbi;
629 session_tx_context_t *ctx = &wrk->ctx;
630 session_main_t *smm = &session_main;
631 session_event_t *e = &elt->evt;
632 vlib_main_t *vm = wrk->vm;
633 transport_proto_t tp;
637 if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
640 session_evt_add_old (wrk, elt);
641 return SESSION_TX_NO_DATA;
644 next_index = smm->session_type_to_next[ctx->s->session_type];
645 next0 = next1 = next_index;
646 max_burst = VLIB_FRAME_SIZE - *n_tx_packets;
648 tp = session_get_transport_proto (ctx->s);
649 ctx->transport_vft = transport_protocol_get_vft (tp);
650 ctx->tc = session_tx_get_transport (ctx, peek_data);
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 if (ctx->s->flags & SESSION_F_CUSTOM_TX)
661 ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
662 n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, max_burst);
663 *n_tx_packets += n_custom_tx;
665 (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
666 return SESSION_TX_OK;
667 max_burst -= n_custom_tx;
670 session_evt_add_old (wrk, elt);
671 return SESSION_TX_OK;
675 ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
676 ctx->snd_space = transport_connection_snd_space (ctx->tc,
681 if (ctx->snd_space == 0 || ctx->snd_mss == 0)
683 session_evt_add_old (wrk, elt);
684 return SESSION_TX_NO_DATA;
687 /* Allow enqueuing of a new event */
688 svm_fifo_unset_event (ctx->s->tx_fifo);
690 /* Check how much we can pull. */
691 session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
693 if (PREDICT_FALSE (!ctx->max_len_to_snd))
694 return SESSION_TX_NO_DATA;
696 n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
697 vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
698 CLIB_CACHE_LINE_BYTES);
699 n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
700 if (PREDICT_FALSE (n_bufs < n_bufs_needed))
703 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
704 session_evt_add_old (wrk, elt);
705 vlib_node_increment_counter (wrk->vm, node->node_index,
706 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
707 return SESSION_TX_NO_BUFFERS;
711 * Write until we fill up a frame
713 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
714 if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
716 ctx->n_segs_per_evt = n_left_to_next;
717 ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
719 ctx->left_to_snd = ctx->max_len_to_snd;
720 n_left = ctx->n_segs_per_evt;
724 vlib_buffer_t *b0, *b1;
727 pbi = wrk->tx_buffers[n_bufs - 3];
728 pb = vlib_get_buffer (vm, pbi);
729 vlib_prefetch_buffer_header (pb, STORE);
730 pbi = wrk->tx_buffers[n_bufs - 4];
731 pb = vlib_get_buffer (vm, pbi);
732 vlib_prefetch_buffer_header (pb, STORE);
734 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
735 to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
737 b0 = vlib_get_buffer (vm, bi0);
738 b1 = vlib_get_buffer (vm, bi1);
740 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
741 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
743 ctx->transport_vft->push_header (ctx->tc, b0);
744 ctx->transport_vft->push_header (ctx->tc, b1);
750 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
751 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
753 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
754 n_left_to_next, bi0, bi1, next0,
764 pbi = wrk->tx_buffers[n_bufs - 2];
765 pb = vlib_get_buffer (vm, pbi);
766 vlib_prefetch_buffer_header (pb, STORE);
769 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
770 b0 = vlib_get_buffer (vm, bi0);
771 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
773 /* Ask transport to push header after current_length and
774 * total_length_not_including_first_buffer are updated */
775 ctx->transport_vft->push_header (ctx->tc, b0);
781 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
783 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
784 n_left_to_next, bi0, next0);
787 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
788 session_tx_trace_frame (vm, node, next_index, to_next,
789 ctx->n_segs_per_evt, ctx->s, n_trace);
791 if (PREDICT_FALSE (n_bufs))
792 vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
794 *n_tx_packets += ctx->n_segs_per_evt;
795 transport_connection_update_tx_bytes (ctx->tc, ctx->max_len_to_snd);
796 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
798 SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
799 ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
801 /* If we couldn't dequeue all bytes mark as partially read */
802 ASSERT (ctx->left_to_snd == 0);
803 if (ctx->max_len_to_snd < ctx->max_dequeue)
804 if (svm_fifo_set_event (ctx->s->tx_fifo))
805 session_evt_add_old (wrk, elt);
808 && ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
810 /* Fix dgram pre header */
811 if (ctx->max_len_to_snd < ctx->max_dequeue)
812 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
813 sizeof (session_dgram_pre_hdr_t));
814 /* More data needs to be read */
815 else if (svm_fifo_max_dequeue_cons (ctx->s->tx_fifo) > 0)
816 if (svm_fifo_set_event (ctx->s->tx_fifo))
817 session_evt_add_old (wrk, elt);
819 if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, ctx->max_len_to_snd))
820 session_dequeue_notify (ctx->s);
822 return SESSION_TX_OK;
826 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
827 vlib_node_runtime_t * node,
828 session_evt_elt_t * e, int *n_tx_packets)
830 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
834 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
835 vlib_node_runtime_t * node,
836 session_evt_elt_t * e, int *n_tx_packets)
838 return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
842 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
843 vlib_node_runtime_t * node,
844 session_evt_elt_t * e, int *n_tx_packets)
846 session_t *s = wrk->ctx.s;
848 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
850 svm_fifo_unset_event (s->tx_fifo);
851 return transport_custom_tx (session_get_transport_proto (s), s,
852 VLIB_FRAME_SIZE - *n_tx_packets);
855 always_inline session_t *
856 session_event_get_session (session_event_t * e, u8 thread_index)
858 return session_get_if_valid (e->session_index, thread_index);
862 session_event_dispatch (session_worker_t * wrk, vlib_node_runtime_t * node,
863 session_evt_elt_t * elt, u32 thread_index,
866 session_main_t *smm = &session_main;
867 app_worker_t *app_wrk;
868 clib_llist_index_t ei;
873 ei = clib_llist_entry_index (wrk->event_elts, elt);
876 switch (e->event_type)
878 case SESSION_IO_EVT_TX_FLUSH:
879 case SESSION_IO_EVT_TX:
880 s = session_event_get_session (e, thread_index);
881 if (PREDICT_FALSE (!s))
883 clib_warning ("session %u was freed!", e->session_index);
886 CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
888 /* Spray packets in per session type frames, since they go to
890 (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
892 case SESSION_IO_EVT_RX:
893 s = session_event_get_session (e, thread_index);
896 transport_app_rx_evt (session_get_transport_proto (s),
897 s->connection_index, s->thread_index);
899 case SESSION_CTRL_EVT_CLOSE:
900 s = session_get_from_handle_if_valid (e->session_handle);
901 if (PREDICT_FALSE (!s))
903 session_transport_close (s);
905 case SESSION_CTRL_EVT_RESET:
906 s = session_get_from_handle_if_valid (e->session_handle);
907 if (PREDICT_FALSE (!s))
909 session_transport_reset (s);
911 case SESSION_IO_EVT_BUILTIN_RX:
912 s = session_event_get_session (e, thread_index);
913 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
915 svm_fifo_unset_event (s->rx_fifo);
916 app_wrk = app_worker_get (s->app_wrk_index);
917 app_worker_builtin_rx (app_wrk, s);
919 case SESSION_IO_EVT_BUILTIN_TX:
920 s = session_get_from_handle_if_valid (e->session_handle);
922 if (PREDICT_TRUE (s != 0))
923 session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
925 case SESSION_CTRL_EVT_RPC:
927 (*fp) (e->rpc_args.arg);
929 case SESSION_CTRL_EVT_DISCONNECTED:
930 session_mq_disconnected_handler (e->data);
932 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
933 session_mq_accepted_reply_handler (e->data);
935 case SESSION_CTRL_EVT_CONNECTED_REPLY:
937 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
938 session_mq_disconnected_reply_handler (e->data);
940 case SESSION_CTRL_EVT_RESET_REPLY:
941 session_mq_reset_reply_handler (e->data);
943 case SESSION_CTRL_EVT_WORKER_UPDATE:
944 session_mq_worker_update_handler (e->data);
947 clib_warning ("unhandled event type %d", e->event_type);
950 /* Regrab elements in case pool moved */
951 elt = pool_elt_at_index (wrk->event_elts, ei);
952 if (!clib_llist_elt_is_linked (elt, evt_list))
953 session_evt_elt_free (wrk, elt);
957 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
958 vlib_frame_t * frame)
960 session_main_t *smm = vnet_get_session_main ();
961 u32 thread_index = vm->thread_index, n_to_dequeue;
962 session_worker_t *wrk = &smm->wrk[thread_index];
963 session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
964 svm_msg_q_msg_t _msg, *msg = &_msg;
965 clib_llist_index_t old_ti;
966 int i, n_tx_packets = 0;
967 session_event_t *evt;
970 SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
972 wrk->last_vlib_time = vlib_time_now (vm);
975 * Update transport time
977 transport_update_time (wrk->last_vlib_time, thread_index);
980 * Dequeue and handle new events
983 /* Try to dequeue what is available. Don't wait for lock.
984 * XXX: we may need priorities here */
985 mq = wrk->vpp_event_queue;
986 n_to_dequeue = svm_msg_q_size (mq);
987 if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
989 for (i = 0; i < n_to_dequeue; i++)
991 svm_msg_q_sub_w_lock (mq, msg);
992 evt = svm_msg_q_msg_data (mq, msg);
993 if (evt->event_type > SESSION_IO_EVT_BUILTIN_TX)
994 elt = session_evt_alloc_ctrl (wrk);
996 elt = session_evt_alloc_new (wrk);
997 /* Works because reply messages are smaller than a session evt.
998 * If we ever need to support bigger messages this needs to be
1000 clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1001 svm_msg_q_free_msg (mq, msg);
1003 svm_msg_q_unlock (mq);
1007 * Handle control events
1010 ctrl_he = pool_elt_at_index (wrk->event_elts, wrk->ctrl_head);
1013 clib_llist_foreach_safe (wrk->event_elts, evt_list, ctrl_he, elt, ({
1014 clib_llist_remove (wrk->event_elts, evt_list, elt);
1015 session_event_dispatch (wrk, node, elt, thread_index, &n_tx_packets);
1020 * Handle the new io events.
1023 new_he = pool_elt_at_index (wrk->event_elts, wrk->new_head);
1026 clib_llist_foreach_safe (wrk->event_elts, evt_list, new_he, elt, ({
1027 session_evt_type_t et;
1029 et = elt->evt.event_type;
1030 clib_llist_remove (wrk->event_elts, evt_list, elt);
1032 /* Postpone tx events if we can't handle them this dispatch cycle */
1033 if (n_tx_packets >= VLIB_FRAME_SIZE
1034 && (et == SESSION_IO_EVT_TX || et == SESSION_IO_EVT_TX_FLUSH))
1036 clib_llist_add (wrk->event_elts, evt_list, elt, new_he);
1040 session_event_dispatch (wrk, node, elt, thread_index, &n_tx_packets);
1045 * Handle the old io events
1048 old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1049 old_ti = clib_llist_prev_index (old_he, evt_list);
1051 while (!clib_llist_is_empty (wrk->event_elts, evt_list, old_he))
1053 clib_llist_index_t ei;
1055 clib_llist_pop_first (wrk->event_elts, evt_list, elt, old_he);
1056 ei = clib_llist_entry_index (wrk->event_elts, elt);
1057 session_event_dispatch (wrk, node, elt, thread_index, &n_tx_packets);
1059 old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1060 if (n_tx_packets >= VLIB_FRAME_SIZE || ei == old_ti)
1064 vlib_node_increment_counter (vm, session_queue_node.index,
1065 SESSION_QUEUE_ERROR_TX, n_tx_packets);
1067 SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1069 return n_tx_packets;
1073 VLIB_REGISTER_NODE (session_queue_node) =
1075 .function = session_queue_node_fn,
1076 .name = "session-queue",
1077 .format_trace = format_session_queue_trace,
1078 .type = VLIB_NODE_TYPE_INPUT,
1079 .n_errors = ARRAY_LEN (session_queue_error_strings),
1080 .error_strings = session_queue_error_strings,
1081 .state = VLIB_NODE_STATE_DISABLED,
1086 dump_thread_0_event_queue (void)
1088 session_main_t *smm = vnet_get_session_main ();
1089 vlib_main_t *vm = &vlib_global_main;
1090 u32 my_thread_index = vm->thread_index;
1091 session_event_t _e, *e = &_e;
1092 svm_msg_q_ring_t *ring;
1094 svm_msg_q_msg_t *msg;
1098 mq = smm->wrk[my_thread_index].vpp_event_queue;
1099 index = mq->q->head;
1101 for (i = 0; i < mq->q->cursize; i++)
1103 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1104 ring = svm_msg_q_ring (mq, msg->ring_index);
1105 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1107 switch (e->event_type)
1109 case SESSION_IO_EVT_TX:
1110 s0 = session_event_get_session (e, my_thread_index);
1111 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
1114 case SESSION_CTRL_EVT_CLOSE:
1115 s0 = session_get_from_handle (e->session_handle);
1116 fformat (stdout, "[%04d] disconnect session %d\n", i,
1120 case SESSION_IO_EVT_BUILTIN_RX:
1121 s0 = session_event_get_session (e, my_thread_index);
1122 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1125 case SESSION_CTRL_EVT_RPC:
1126 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1127 i, (u64) (uword) (e->rpc_args.fp),
1128 (u64) (uword) (e->rpc_args.arg));
1132 fformat (stdout, "[%04d] unhandled event type %d\n",
1139 if (index == mq->q->maxsize)
1145 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1148 switch (e->event_type)
1150 case SESSION_IO_EVT_RX:
1151 case SESSION_IO_EVT_TX:
1152 case SESSION_IO_EVT_BUILTIN_RX:
1153 if (e->session_index == f->master_session_index)
1156 case SESSION_CTRL_EVT_CLOSE:
1158 case SESSION_CTRL_EVT_RPC:
1159 s = session_get_from_handle (e->session_handle);
1162 clib_warning ("session has event but doesn't exist!");
1165 if (s->rx_fifo == f || s->tx_fifo == f)
1175 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1177 session_evt_elt_t *elt;
1178 session_worker_t *wrk;
1179 int i, index, found = 0;
1180 svm_msg_q_msg_t *msg;
1181 svm_msg_q_ring_t *ring;
1186 thread_index = f->master_thread_index;
1187 wrk = session_main_get_worker (thread_index);
1192 mq = wrk->vpp_event_queue;
1193 index = mq->q->head;
1194 for (i = 0; i < mq->q->cursize; i++)
1196 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1197 ring = svm_msg_q_ring (mq, msg->ring_index);
1198 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1199 found = session_node_cmp_event (e, f);
1202 if (++index == mq->q->maxsize)
1206 * Search pending events vector
1210 clib_llist_foreach (wrk->event_elts, evt_list,
1211 pool_elt_at_index (wrk->event_elts, wrk->old_head),
1213 found = session_node_cmp_event (&elt->evt, f);
1216 clib_memcpy_fast (e, &elt->evt, sizeof (*e));
1226 static clib_error_t *
1227 session_queue_exit (vlib_main_t * vm)
1229 if (vec_len (vlib_mains) < 2)
1233 * Shut off (especially) worker-thread session nodes.
1234 * Otherwise, vpp can crash as the main thread unmaps the
1237 vlib_worker_thread_barrier_sync (vm);
1238 session_node_enable_disable (0 /* is_enable */ );
1239 vlib_worker_thread_barrier_release (vm);
1243 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1246 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1249 f64 now, timeout = 1.0;
1250 uword *event_data = 0;
1255 vlib_process_wait_for_event_or_clock (vm, timeout);
1256 now = vlib_time_now (vm);
1257 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1261 case SESSION_Q_PROCESS_FLUSH_FRAMES:
1262 /* Flush the frames by updating all transports times */
1263 transport_update_time (now, 0);
1265 case SESSION_Q_PROCESS_STOP:
1269 /* Timed out. Update time for all transports to trigger all
1270 * outstanding retransmits. */
1271 transport_update_time (now, 0);
1274 vec_reset_length (event_data);
1280 VLIB_REGISTER_NODE (session_queue_process_node) =
1282 .function = session_queue_process,
1283 .type = VLIB_NODE_TYPE_PROCESS,
1284 .name = "session-queue-process",
1285 .state = VLIB_NODE_STATE_DISABLED,
1289 static_always_inline uword
1290 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1291 vlib_frame_t * frame)
1293 session_main_t *sm = &session_main;
1294 if (!sm->wrk[0].vpp_event_queue)
1296 return session_queue_node_fn (vm, node, frame);
1300 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1302 .function = session_queue_pre_input_inline,
1303 .type = VLIB_NODE_TYPE_PRE_INPUT,
1304 .name = "session-queue-main",
1305 .state = VLIB_NODE_STATE_DISABLED,
1310 * fd.io coding-style-patch-verification: ON
1313 * eval: (c-set-style "gnu")