2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 #include <vlib/vlib.h>
18 #include <vnet/vnet.h>
19 #include <vppinfra/elog.h>
20 #include <vnet/session/transport.h>
21 #include <vnet/session/session.h>
22 #include <vnet/session/application.h>
23 #include <vnet/session/application_interface.h>
24 #include <vnet/session/session_debug.h>
25 #include <svm/queue.h>
28 session_mq_accepted_reply_handler (void *data)
30 session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
31 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
32 stream_session_state_t old_state;
33 app_worker_t *app_wrk;
37 /* Server isn't interested, kill the session */
40 a->app_index = mp->context;
41 a->handle = mp->handle;
42 vnet_disconnect_session (a);
46 if (session_handle_is_local (mp->handle))
48 ls = application_get_local_session_from_handle (mp->handle);
51 clib_warning ("unknown local handle 0x%lx", mp->handle);
54 app_wrk = app_worker_get (ls->app_wrk_index);
55 if (app_wrk->app_index != mp->context)
57 clib_warning ("server %u doesn't own local handle 0x%lx",
58 mp->context, mp->handle);
61 if (application_local_session_connect_notify (ls))
63 ls->session_state = SESSION_STATE_READY;
67 s = session_get_from_handle_if_valid (mp->handle);
71 app_wrk = app_worker_get (s->app_wrk_index);
72 if (app_wrk->app_index != mp->context)
74 clib_warning ("app doesn't own session");
78 old_state = s->session_state;
79 s->session_state = SESSION_STATE_READY;
80 if (!svm_fifo_is_empty (s->server_rx_fifo))
81 app_worker_lock_and_send_event (app_wrk, s, FIFO_EVENT_APP_RX);
83 /* Closed while waiting for app to reply. Resend disconnect */
84 if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
86 application_t *app = application_get (app_wrk->app_index);
87 app->cb_fns.session_disconnect_callback (s);
88 s->session_state = old_state;
95 session_mq_reset_reply_handler (void *data)
97 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
98 session_reset_reply_msg_t *mp;
99 app_worker_t *app_wrk;
102 u32 index, thread_index;
104 mp = (session_reset_reply_msg_t *) data;
105 app = application_lookup (mp->context);
109 session_parse_handle (mp->handle, &index, &thread_index);
110 s = session_get_if_valid (index, thread_index);
112 /* Session was already closed or already cleaned up */
113 if (!s || s->session_state != SESSION_STATE_TRANSPORT_CLOSING)
116 app_wrk = app_worker_get (s->app_wrk_index);
117 if (!app_wrk || app_wrk->app_index != app->app_index)
119 clib_warning ("App % does not own handle 0x%lx!", app->app_index,
124 /* Client objected to resetting the session, log and continue */
127 clib_warning ("client retval %d", mp->retval);
131 /* This comes as a response to a reset, transport only waiting for
132 * confirmation to remove connection state, no need to disconnect */
133 a->handle = mp->handle;
134 a->app_index = app->app_index;
135 vnet_disconnect_session (a);
139 session_mq_disconnected_handler (void *data)
141 session_disconnected_reply_msg_t *rmp;
142 vnet_disconnect_args_t _a, *a = &_a;
143 svm_msg_q_msg_t _msg, *msg = &_msg;
144 session_disconnected_msg_t *mp;
145 app_worker_t *app_wrk;
146 session_event_t *evt;
151 mp = (session_disconnected_msg_t *) data;
152 if (!(s = session_get_from_handle_if_valid (mp->handle)))
154 clib_warning ("could not disconnect handle %llu", mp->handle);
157 app_wrk = app_worker_get (s->app_wrk_index);
158 app = application_lookup (mp->client_index);
159 if (!(app_wrk && app && app->app_index == app_wrk->app_index))
161 clib_warning ("could not disconnect session: %llu app: %u",
162 mp->handle, mp->client_index);
166 a->handle = mp->handle;
167 a->app_index = app_wrk->wrk_index;
168 rv = vnet_disconnect_session (a);
170 svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
171 SESSION_MQ_CTRL_EVT_RING,
173 svm_msg_q_unlock (app_wrk->event_queue);
174 evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
175 clib_memset (evt, 0, sizeof (*evt));
176 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED;
177 rmp = (session_disconnected_reply_msg_t *) evt->data;
178 rmp->handle = mp->handle;
179 rmp->context = mp->context;
181 svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
185 session_mq_disconnected_reply_handler (void *data)
187 session_disconnected_reply_msg_t *mp;
188 vnet_disconnect_args_t _a, *a = &_a;
191 mp = (session_disconnected_reply_msg_t *) data;
193 /* Client objected to disconnecting the session, log and continue */
196 clib_warning ("client retval %d", mp->retval);
200 /* Disconnect has been confirmed. Confirm close to transport */
201 app = application_lookup (mp->context);
204 a->handle = mp->handle;
205 a->app_index = app->app_index;
206 vnet_disconnect_session (a);
210 vlib_node_registration_t session_queue_node;
215 u32 server_thread_index;
216 } session_queue_trace_t;
218 /* packet trace format function */
220 format_session_queue_trace (u8 * s, va_list * args)
222 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
223 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
224 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
226 s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
227 t->session_index, t->server_thread_index);
231 #define foreach_session_queue_error \
232 _(TX, "Packets transmitted") \
233 _(TIMER, "Timer events") \
234 _(NO_BUFFER, "Out of buffers")
238 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
239 foreach_session_queue_error
241 SESSION_QUEUE_N_ERROR,
242 } session_queue_error_t;
244 static char *session_queue_error_strings[] = {
245 #define _(sym,string) string,
246 foreach_session_queue_error
252 SESSION_TX_NO_BUFFERS = -2,
258 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
259 u32 next_index, u32 * to_next, u16 n_segs,
260 stream_session_t * s, u32 n_trace)
262 session_queue_trace_t *t;
266 for (i = 0; i < clib_min (n_trace, n_segs); i++)
268 b = vlib_get_buffer (vm, to_next[i - n_segs]);
269 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
270 t = vlib_add_trace (vm, node, b, sizeof (*t));
271 t->session_index = s->session_index;
272 t->server_thread_index = s->thread_index;
274 vlib_set_trace_count (vm, node, n_trace - i);
278 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
279 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
281 vlib_buffer_t *chain_b, *prev_b;
282 u32 chain_bi0, to_deq, left_from_seg;
283 session_manager_worker_t *wrk;
284 u16 len_to_deq, n_bytes_read;
287 wrk = session_manager_get_worker (ctx->s->thread_index);
288 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
289 b->total_length_not_including_first_buffer = 0;
292 left_from_seg = clib_min (ctx->snd_mss - b->current_length,
294 to_deq = left_from_seg;
295 for (j = 1; j < ctx->n_bufs_per_seg; j++)
298 len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
301 chain_bi0 = wrk->tx_buffers[*n_bufs];
302 _vec_len (wrk->tx_buffers) = *n_bufs;
304 chain_b = vlib_get_buffer (vm, chain_bi0);
305 chain_b->current_data = 0;
306 data = vlib_buffer_get_current (chain_b);
309 n_bytes_read = svm_fifo_peek (ctx->s->server_tx_fifo,
310 ctx->tx_offset, len_to_deq, data);
311 ctx->tx_offset += n_bytes_read;
315 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
317 svm_fifo_t *f = ctx->s->server_tx_fifo;
318 session_dgram_hdr_t *hdr = &ctx->hdr;
320 deq_now = clib_min (hdr->data_length - hdr->data_offset,
322 n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
324 ASSERT (n_bytes_read > 0);
326 hdr->data_offset += n_bytes_read;
327 if (hdr->data_offset == hdr->data_length)
329 u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
330 svm_fifo_dequeue_drop (f, offset);
334 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->server_tx_fifo,
337 ASSERT (n_bytes_read == len_to_deq);
338 chain_b->current_length = n_bytes_read;
339 b->total_length_not_including_first_buffer += chain_b->current_length;
341 /* update previous buffer */
342 prev_b->next_buffer = chain_bi0;
343 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
345 /* update current buffer */
346 chain_b->next_buffer = 0;
348 to_deq -= n_bytes_read;
353 && b->total_length_not_including_first_buffer == left_from_seg);
354 ctx->left_to_snd -= left_from_seg;
358 session_output_try_get_buffers (vlib_main_t * vm,
359 session_manager_worker_t * wrk,
360 u32 thread_index, u16 * n_bufs, u32 wanted)
363 vec_validate_aligned (wrk->tx_buffers, wanted - 1, CLIB_CACHE_LINE_BYTES);
364 n_alloc = vlib_buffer_alloc (vm, &wrk->tx_buffers[*n_bufs],
367 _vec_len (wrk->tx_buffers) = *n_bufs;
372 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
373 vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
380 * Start with the first buffer in chain
383 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
386 data0 = vlib_buffer_make_headroom (b, MAX_HDRS_LEN);
387 len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
391 n_bytes_read = svm_fifo_peek (ctx->s->server_tx_fifo, ctx->tx_offset,
393 ASSERT (n_bytes_read > 0);
394 /* Keep track of progress locally, transport is also supposed to
395 * increment it independently when pushing the header */
396 ctx->tx_offset += n_bytes_read;
400 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
402 session_dgram_hdr_t *hdr = &ctx->hdr;
403 svm_fifo_t *f = ctx->s->server_tx_fifo;
407 ASSERT (hdr->data_length > hdr->data_offset);
408 deq_now = clib_min (hdr->data_length - hdr->data_offset,
410 offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
411 n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
412 ASSERT (n_bytes_read > 0);
414 if (ctx->s->session_state == SESSION_STATE_LISTENING)
416 ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
417 ctx->tc->rmt_port = hdr->rmt_port;
419 hdr->data_offset += n_bytes_read;
420 if (hdr->data_offset == hdr->data_length)
422 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
423 svm_fifo_dequeue_drop (f, offset);
428 n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->server_tx_fifo,
430 ASSERT (n_bytes_read > 0);
433 b->current_length = n_bytes_read;
434 ctx->left_to_snd -= n_bytes_read;
437 * Fill in the remaining buffers in the chain, if any
439 if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
440 session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
443 SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
444 ed->data[0] = FIFO_EVENT_APP_TX;
445 ed->data[1] = ctx->max_dequeue;
446 ed->data[2] = len_to_deq;
447 ed->data[3] = ctx->left_to_snd;
453 session_tx_not_ready (stream_session_t * s, u8 peek_data)
457 /* Can retransmit for closed sessions but can't send new data if
458 * session is not ready or closed */
459 if (s->session_state < SESSION_STATE_READY)
461 if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
467 always_inline transport_connection_t *
468 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
472 return ctx->transport_vft->get_connection (ctx->s->connection_index,
473 ctx->s->thread_index);
477 if (ctx->s->session_state == SESSION_STATE_LISTENING)
478 return ctx->transport_vft->get_listener (ctx->s->connection_index);
481 return ctx->transport_vft->get_connection (ctx->s->connection_index,
482 ctx->s->thread_index);
488 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
489 u32 max_segs, u8 peek_data)
491 u32 n_bytes_per_buf, n_bytes_per_seg;
492 ctx->max_dequeue = svm_fifo_max_dequeue (ctx->s->server_tx_fifo);
495 /* Offset in rx fifo from where to peek data */
496 ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
497 if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
499 ctx->max_len_to_snd = 0;
502 ctx->max_dequeue -= ctx->tx_offset;
506 if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
508 if (ctx->max_dequeue <= sizeof (ctx->hdr))
510 ctx->max_len_to_snd = 0;
513 svm_fifo_peek (ctx->s->server_tx_fifo, 0, sizeof (ctx->hdr),
515 ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
516 ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
519 ASSERT (ctx->max_dequeue > 0);
521 /* Ensure we're not writing more than transport window allows */
522 if (ctx->max_dequeue < ctx->snd_space)
524 /* Constrained by tx queue. Try to send only fully formed segments */
525 ctx->max_len_to_snd =
526 (ctx->max_dequeue > ctx->snd_mss) ?
527 ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
532 /* Expectation is that snd_space0 is already a multiple of snd_mss */
533 ctx->max_len_to_snd = ctx->snd_space;
536 /* Check if we're tx constrained by the node */
537 ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
538 if (ctx->n_segs_per_evt > max_segs)
540 ctx->n_segs_per_evt = max_segs;
541 ctx->max_len_to_snd = max_segs * ctx->snd_mss;
544 n_bytes_per_buf = VLIB_BUFFER_DATA_SIZE;
545 ASSERT (n_bytes_per_buf > MAX_HDRS_LEN);
546 n_bytes_per_seg = MAX_HDRS_LEN + ctx->snd_mss;
547 ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
548 ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
549 ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
550 n_bytes_per_buf - MAX_HDRS_LEN);
554 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
556 stream_session_t * s, int *n_tx_packets,
559 u32 next_index, next0, next1, *to_next, n_left_to_next;
560 u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
561 u32 thread_index = s->thread_index, n_left, pbi;
562 session_manager_main_t *smm = &session_manager_main;
563 session_manager_worker_t *wrk = &smm->wrk[thread_index];
564 session_tx_context_t *ctx = &wrk->ctx;
565 transport_proto_t tp;
569 if (PREDICT_FALSE ((rv = session_tx_not_ready (s, peek_data))))
572 vec_add1 (wrk->pending_event_vector, *e);
573 return SESSION_TX_NO_DATA;
576 next_index = smm->session_type_to_next[s->session_type];
577 next0 = next1 = next_index;
579 tp = session_get_transport_proto (s);
581 ctx->transport_vft = transport_protocol_get_vft (tp);
582 ctx->tc = session_tx_get_transport (ctx, peek_data);
583 ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
585 if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
587 if (ctx->transport_vft->flush_data)
588 ctx->transport_vft->flush_data (ctx->tc);
591 ctx->snd_space = transport_connection_snd_space (ctx->tc,
593 clib_time.last_cpu_time,
595 if (ctx->snd_space == 0 || ctx->snd_mss == 0)
597 vec_add1 (wrk->pending_event_vector, *e);
598 return SESSION_TX_NO_DATA;
601 /* Allow enqueuing of a new event */
602 svm_fifo_unset_event (s->server_tx_fifo);
604 /* Check how much we can pull. */
605 session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
608 if (PREDICT_FALSE (!ctx->max_len_to_snd))
609 return SESSION_TX_NO_DATA;
611 n_bufs = vec_len (wrk->tx_buffers);
612 n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
615 * Make sure we have at least one full frame of buffers ready
617 if (n_bufs < n_bufs_needed)
619 session_output_try_get_buffers (vm, wrk, thread_index, &n_bufs,
620 ctx->n_bufs_per_seg * VLIB_FRAME_SIZE);
621 if (PREDICT_FALSE (n_bufs < n_bufs_needed))
623 vec_add1 (wrk->pending_event_vector, *e);
624 return SESSION_TX_NO_BUFFERS;
629 * Write until we fill up a frame
631 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
632 if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
634 ctx->n_segs_per_evt = n_left_to_next;
635 ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
637 ctx->left_to_snd = ctx->max_len_to_snd;
638 n_left = ctx->n_segs_per_evt;
642 vlib_buffer_t *b0, *b1;
645 pbi = wrk->tx_buffers[n_bufs - 3];
646 pb = vlib_get_buffer (vm, pbi);
647 vlib_prefetch_buffer_header (pb, STORE);
648 pbi = wrk->tx_buffers[n_bufs - 4];
649 pb = vlib_get_buffer (vm, pbi);
650 vlib_prefetch_buffer_header (pb, STORE);
652 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
653 to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
655 b0 = vlib_get_buffer (vm, bi0);
656 b1 = vlib_get_buffer (vm, bi1);
658 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
659 session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
661 ctx->transport_vft->push_header (ctx->tc, b0);
662 ctx->transport_vft->push_header (ctx->tc, b1);
668 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
669 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
671 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
672 n_left_to_next, bi0, bi1, next0,
682 pbi = wrk->tx_buffers[n_bufs - 2];
683 pb = vlib_get_buffer (vm, pbi);
684 vlib_prefetch_buffer_header (pb, STORE);
687 to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
688 b0 = vlib_get_buffer (vm, bi0);
689 session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
691 /* Ask transport to push header after current_length and
692 * total_length_not_including_first_buffer are updated */
693 ctx->transport_vft->push_header (ctx->tc, b0);
699 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
701 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
702 n_left_to_next, bi0, next0);
705 if (PREDICT_FALSE (n_trace > 0))
706 session_tx_trace_frame (vm, node, next_index, to_next,
707 ctx->n_segs_per_evt, s, n_trace);
709 _vec_len (wrk->tx_buffers) = n_bufs;
710 *n_tx_packets += ctx->n_segs_per_evt;
711 transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
712 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
714 /* If we couldn't dequeue all bytes mark as partially read */
715 ASSERT (ctx->left_to_snd == 0);
716 if (ctx->max_len_to_snd < ctx->max_dequeue)
717 if (svm_fifo_set_event (s->server_tx_fifo))
718 vec_add1 (wrk->pending_event_vector, *e);
720 if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
722 /* Fix dgram pre header */
723 if (ctx->max_len_to_snd < ctx->max_dequeue)
724 svm_fifo_overwrite_head (s->server_tx_fifo, (u8 *) & ctx->hdr,
725 sizeof (session_dgram_pre_hdr_t));
726 /* More data needs to be read */
727 else if (svm_fifo_max_dequeue (s->server_tx_fifo) > 0)
728 if (svm_fifo_set_event (s->server_tx_fifo))
729 vec_add1 (wrk->pending_event_vector, *e);
731 return SESSION_TX_OK;
735 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
737 stream_session_t * s, int *n_tx_pkts)
739 return session_tx_fifo_read_and_snd_i (vm, node, e, s, n_tx_pkts, 1);
743 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
745 stream_session_t * s, int *n_tx_pkts)
747 return session_tx_fifo_read_and_snd_i (vm, node, e, s, n_tx_pkts, 0);
751 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
752 vlib_node_runtime_t * node,
754 stream_session_t * s, int *n_tx_pkts)
757 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
759 app = application_get (s->t_app_index);
760 svm_fifo_unset_event (s->server_tx_fifo);
761 return app->cb_fns.builtin_app_tx_callback (s);
764 always_inline stream_session_t *
765 session_event_get_session (session_event_t * e, u8 thread_index)
767 return session_get_if_valid (e->fifo->master_session_index, thread_index);
771 session_update_dispatch_period (session_manager_worker_t * wrk, f64 now,
774 if (wrk->last_tx_packets)
776 f64 sample = now - wrk->last_vlib_time;
777 wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
779 wrk->last_vlib_time = now;
783 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
784 vlib_frame_t * frame)
786 session_manager_main_t *smm = vnet_get_session_manager_main ();
787 u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
788 session_manager_worker_t *wrk = &smm->wrk[thread_index];
789 session_event_t *e, *fifo_events;
790 svm_msg_q_msg_t _msg, *msg = &_msg;
791 f64 now = vlib_time_now (vm);
792 int n_tx_packets = 0, i, rv;
793 app_worker_t *app_wrk;
798 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, thread_index);
801 * Update transport time
803 session_update_dispatch_period (wrk, now, thread_index);
804 transport_update_time (now, thread_index);
806 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
808 /* Make sure postponed events are handled first */
809 fifo_events = wrk->free_event_vector;
810 vec_append (fifo_events, wrk->postponed_event_vector);
811 _vec_len (wrk->postponed_event_vector) = 0;
813 /* Try to dequeue what is available. Don't wait for lock.
814 * XXX: we may need priorities here */
815 mq = wrk->vpp_event_queue;
816 n_to_dequeue = svm_msg_q_size (mq);
817 if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
819 for (i = 0; i < n_to_dequeue; i++)
821 vec_add2 (fifo_events, e, 1);
822 svm_msg_q_sub_w_lock (mq, msg);
823 /* Works because reply messages are smaller than a session evt.
824 * If we ever need to support bigger messages this needs to be
826 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), sizeof (*e));
827 svm_msg_q_free_msg (mq, msg);
829 svm_msg_q_unlock (mq);
832 vec_append (fifo_events, wrk->pending_event_vector);
833 vec_append (fifo_events, wrk->pending_disconnects);
835 _vec_len (wrk->pending_event_vector) = 0;
836 _vec_len (wrk->pending_disconnects) = 0;
838 n_events = vec_len (fifo_events);
839 if (PREDICT_FALSE (!n_events))
842 for (i = 0; i < n_events; i++)
844 stream_session_t *s; /* $$$ prefetch 1 ahead maybe */
849 switch (e->event_type)
851 case SESSION_IO_EVT_TX_FLUSH:
852 case FIFO_EVENT_APP_TX:
853 /* Don't try to send more that one frame per dispatch cycle */
854 if (n_tx_packets == VLIB_FRAME_SIZE)
856 vec_add1 (wrk->postponed_event_vector, *e);
860 s = session_event_get_session (e, thread_index);
861 if (PREDICT_FALSE (!s))
863 clib_warning ("session was freed!");
867 want_tx_evt = svm_fifo_want_tx_evt (s->server_tx_fifo);
868 /* Spray packets in per session type frames, since they go to
870 rv = (smm->session_tx_fns[s->session_type]) (vm, node, e, s,
872 if (PREDICT_TRUE (rv == SESSION_TX_OK))
874 if (PREDICT_FALSE (want_tx_evt))
876 svm_fifo_set_want_tx_evt (s->server_tx_fifo, 0);
877 session_dequeue_notify (s);
880 else if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
882 vlib_node_increment_counter (vm, node->node_index,
883 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
887 case FIFO_EVENT_DISCONNECT:
888 s = session_get_from_handle_if_valid (e->session_handle);
889 if (PREDICT_FALSE (!s))
892 /* Make sure session disconnects run after the pending list is
893 * drained, i.e., postpone if the first time. If not the first
894 * and the tx queue is still not empty, try to wait for some
897 || (e->postponed < 200
898 && svm_fifo_max_dequeue (s->server_tx_fifo)))
901 vec_add1 (wrk->pending_disconnects, *e);
905 session_transport_close (s);
907 case FIFO_EVENT_BUILTIN_RX:
908 s = session_event_get_session (e, thread_index);
909 if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
911 svm_fifo_unset_event (s->server_rx_fifo);
912 app_wrk = app_worker_get (s->app_wrk_index);
913 app = application_get (app_wrk->app_index);
914 app->cb_fns.builtin_app_rx_callback (s);
916 case FIFO_EVENT_BUILTIN_TX:
917 s = session_get_from_handle_if_valid (e->session_handle);
918 if (PREDICT_TRUE (s != 0))
919 session_tx_fifo_dequeue_internal (vm, node, e, s, &n_tx_packets);
923 (*fp) (e->rpc_args.arg);
925 case SESSION_CTRL_EVT_DISCONNECTED:
926 session_mq_disconnected_handler (e->data);
928 case SESSION_CTRL_EVT_ACCEPTED_REPLY:
929 session_mq_accepted_reply_handler (e->data);
931 case SESSION_CTRL_EVT_CONNECTED_REPLY:
933 case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
934 session_mq_disconnected_reply_handler (e->data);
936 case SESSION_CTRL_EVT_RESET_REPLY:
937 session_mq_reset_reply_handler (e->data);
940 clib_warning ("unhandled event type %d", e->event_type);
944 _vec_len (fifo_events) = 0;
945 wrk->free_event_vector = fifo_events;
946 wrk->last_tx_packets = n_tx_packets;
948 vlib_node_increment_counter (vm, session_queue_node.index,
949 SESSION_QUEUE_ERROR_TX, n_tx_packets);
951 SESSION_EVT_DBG (SESSION_EVT_DISPATCH_END, smm, thread_index);
957 VLIB_REGISTER_NODE (session_queue_node) =
959 .function = session_queue_node_fn,
960 .name = "session-queue",
961 .format_trace = format_session_queue_trace,
962 .type = VLIB_NODE_TYPE_INPUT,
963 .n_errors = ARRAY_LEN (session_queue_error_strings),
964 .error_strings = session_queue_error_strings,
965 .state = VLIB_NODE_STATE_DISABLED,
970 dump_thread_0_event_queue (void)
972 session_manager_main_t *smm = vnet_get_session_manager_main ();
973 vlib_main_t *vm = &vlib_global_main;
974 u32 my_thread_index = vm->thread_index;
975 session_event_t _e, *e = &_e;
976 svm_msg_q_ring_t *ring;
977 stream_session_t *s0;
978 svm_msg_q_msg_t *msg;
982 mq = smm->wrk[my_thread_index].vpp_event_queue;
985 for (i = 0; i < mq->q->cursize; i++)
987 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
988 ring = svm_msg_q_ring (mq, msg->ring_index);
989 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
991 switch (e->event_type)
993 case FIFO_EVENT_APP_TX:
994 s0 = session_event_get_session (e, my_thread_index);
995 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
998 case FIFO_EVENT_DISCONNECT:
999 s0 = session_get_from_handle (e->session_handle);
1000 fformat (stdout, "[%04d] disconnect session %d\n", i,
1004 case FIFO_EVENT_BUILTIN_RX:
1005 s0 = session_event_get_session (e, my_thread_index);
1006 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1009 case FIFO_EVENT_RPC:
1010 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1011 i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
1015 fformat (stdout, "[%04d] unhandled event type %d\n",
1022 if (index == mq->q->maxsize)
1028 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1030 stream_session_t *s;
1031 switch (e->event_type)
1033 case FIFO_EVENT_APP_RX:
1034 case FIFO_EVENT_APP_TX:
1035 case FIFO_EVENT_BUILTIN_RX:
1039 case FIFO_EVENT_DISCONNECT:
1041 case FIFO_EVENT_RPC:
1042 s = session_get_from_handle (e->session_handle);
1045 clib_warning ("session has event but doesn't exist!");
1048 if (s->server_rx_fifo == f || s->server_tx_fifo == f)
1058 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1060 session_event_t *pending_event_vector, *evt;
1061 session_manager_worker_t *wrk;
1062 int i, index, found = 0;
1063 svm_msg_q_msg_t *msg;
1064 svm_msg_q_ring_t *ring;
1069 thread_index = f->master_thread_index;
1070 wrk = session_manager_get_worker (thread_index);
1075 mq = wrk->vpp_event_queue;
1076 index = mq->q->head;
1077 for (i = 0; i < mq->q->cursize; i++)
1079 msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1080 ring = svm_msg_q_ring (mq, msg->ring_index);
1081 clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1082 found = session_node_cmp_event (e, f);
1085 if (++index == mq->q->maxsize)
1089 * Search pending events vector
1091 pending_event_vector = wrk->pending_event_vector;
1092 vec_foreach (evt, pending_event_vector)
1094 found = session_node_cmp_event (evt, f);
1097 clib_memcpy_fast (e, evt, sizeof (*evt));
1104 static clib_error_t *
1105 session_queue_exit (vlib_main_t * vm)
1107 if (vec_len (vlib_mains) < 2)
1111 * Shut off (especially) worker-thread session nodes.
1112 * Otherwise, vpp can crash as the main thread unmaps the
1115 vlib_worker_thread_barrier_sync (vm);
1116 session_node_enable_disable (0 /* is_enable */ );
1117 vlib_worker_thread_barrier_release (vm);
1121 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1124 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1127 f64 now, timeout = 1.0;
1128 uword *event_data = 0;
1133 vlib_process_wait_for_event_or_clock (vm, timeout);
1134 now = vlib_time_now (vm);
1135 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1139 case SESSION_Q_PROCESS_FLUSH_FRAMES:
1140 /* Flush the frames by updating all transports times */
1141 transport_update_time (now, 0);
1143 case SESSION_Q_PROCESS_STOP:
1147 /* Timed out. Update time for all transports to trigger all
1148 * outstanding retransmits. */
1149 transport_update_time (now, 0);
1152 vec_reset_length (event_data);
1158 VLIB_REGISTER_NODE (session_queue_process_node) =
1160 .function = session_queue_process,
1161 .type = VLIB_NODE_TYPE_PROCESS,
1162 .name = "session-queue-process",
1163 .state = VLIB_NODE_STATE_DISABLED,
1169 * fd.io coding-style-patch-verification: ON
1172 * eval: (c-set-style "gnu")