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/application.h>
22 #include <vnet/session/session_debug.h>
23 #include <svm/queue.h>
25 vlib_node_registration_t session_queue_node;
30 u32 server_thread_index;
31 } session_queue_trace_t;
33 /* packet trace format function */
35 format_session_queue_trace (u8 * s, va_list * args)
37 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
38 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
39 session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
41 s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
42 t->session_index, t->server_thread_index);
46 vlib_node_registration_t session_queue_node;
48 #define foreach_session_queue_error \
49 _(TX, "Packets transmitted") \
50 _(TIMER, "Timer events") \
51 _(NO_BUFFER, "Out of buffers")
55 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
56 foreach_session_queue_error
58 SESSION_QUEUE_N_ERROR,
59 } session_queue_error_t;
61 static char *session_queue_error_strings[] = {
62 #define _(sym,string) string,
63 foreach_session_queue_error
68 session_tx_fifo_chain_tail (session_manager_main_t * smm, vlib_main_t * vm,
69 u8 thread_index, svm_fifo_t * fifo,
70 vlib_buffer_t * b0, u32 bi0, u8 n_bufs_per_seg,
71 u32 left_from_seg, u32 * left_to_snd0,
72 u16 * n_bufs, u32 * tx_offset, u16 deq_per_buf,
75 vlib_buffer_t *chain_b0, *prev_b0;
76 u32 chain_bi0, to_deq;
77 u16 len_to_deq0, n_bytes_read;
80 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
81 b0->total_length_not_including_first_buffer = 0;
85 to_deq = left_from_seg;
86 for (j = 1; j < n_bufs_per_seg; j++)
89 len_to_deq0 = clib_min (to_deq, deq_per_buf);
92 chain_bi0 = smm->tx_buffers[thread_index][*n_bufs];
93 _vec_len (smm->tx_buffers[thread_index]) = *n_bufs;
95 chain_b0 = vlib_get_buffer (vm, chain_bi0);
96 chain_b0->current_data = 0;
97 data0 = vlib_buffer_get_current (chain_b0);
100 n_bytes_read = svm_fifo_peek (fifo, *tx_offset, len_to_deq0, data0);
101 *tx_offset += n_bytes_read;
105 n_bytes_read = svm_fifo_dequeue_nowait (fifo, len_to_deq0, data0);
107 ASSERT (n_bytes_read == len_to_deq0);
108 chain_b0->current_length = n_bytes_read;
109 b0->total_length_not_including_first_buffer += chain_b0->current_length;
111 /* update previous buffer */
112 prev_b0->next_buffer = chain_bi0;
113 prev_b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
115 /* update current buffer */
116 chain_b0->next_buffer = 0;
118 to_deq -= n_bytes_read;
123 && b0->total_length_not_including_first_buffer == left_from_seg);
124 *left_to_snd0 -= left_from_seg;
128 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
129 session_manager_main_t * smm,
130 session_fifo_event_t * e0,
131 stream_session_t * s0, u32 thread_index,
132 int *n_tx_packets, u8 peek_data)
134 u32 n_trace = vlib_get_trace_count (vm, node);
135 u32 left_to_snd0, max_len_to_snd0, len_to_deq0, snd_space0;
136 u32 n_bufs_per_evt, n_frames_per_evt, n_bufs_per_frame;
137 transport_connection_t *tc0;
138 transport_proto_vft_t *transport_vft;
139 transport_proto_t tp;
140 u32 next_index, next0, *to_next, n_left_to_next, bi0;
142 u32 tx_offset = 0, max_dequeue0, n_bytes_per_seg, left_for_seg;
143 u16 snd_mss0, n_bufs_per_seg, n_bufs;
146 u32 n_bytes_per_buf, deq_per_buf, deq_per_first_buf;
147 u32 bufs_alloc, bufs_now;
149 next_index = next0 = smm->session_type_to_next[s0->session_type];
151 tp = session_get_transport_proto (s0);
152 transport_vft = transport_protocol_get_vft (tp);
153 tc0 = transport_vft->get_connection (s0->connection_index, thread_index);
155 /* Make sure we have space to send and there's something to dequeue */
156 snd_mss0 = transport_vft->send_mss (tc0);
157 snd_space0 = transport_vft->send_space (tc0);
159 /* Can't make any progress */
160 if (snd_space0 == 0 || snd_mss0 == 0)
162 vec_add1 (smm->pending_event_vector[thread_index], *e0);
166 /* Allow enqueuing of a new event */
167 svm_fifo_unset_event (s0->server_tx_fifo);
169 /* Check how much we can pull. */
170 max_dequeue0 = svm_fifo_max_dequeue (s0->server_tx_fifo);
174 /* Offset in rx fifo from where to peek data */
175 tx_offset = transport_vft->tx_fifo_offset (tc0);
176 if (PREDICT_FALSE (tx_offset >= max_dequeue0))
179 max_dequeue0 -= tx_offset;
182 /* Nothing to read return */
183 if (max_dequeue0 == 0)
186 /* Ensure we're not writing more than transport window allows */
187 if (max_dequeue0 < snd_space0)
189 /* Constrained by tx queue. Try to send only fully formed segments */
190 max_len_to_snd0 = (max_dequeue0 > snd_mss0) ?
191 max_dequeue0 - max_dequeue0 % snd_mss0 : max_dequeue0;
196 /* Expectation is that snd_space0 is already a multiple of snd_mss */
197 max_len_to_snd0 = snd_space0;
200 n_bytes_per_buf = vlib_buffer_free_list_buffer_size
201 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
202 ASSERT (n_bytes_per_buf > MAX_HDRS_LEN);
203 n_bytes_per_seg = MAX_HDRS_LEN + snd_mss0;
204 n_bufs_per_seg = ceil ((double) n_bytes_per_seg / n_bytes_per_buf);
205 n_bufs_per_evt = ceil ((double) max_len_to_snd0 / n_bytes_per_seg);
206 n_frames_per_evt = ceil ((double) n_bufs_per_evt / VLIB_FRAME_SIZE);
207 n_bufs_per_frame = n_bufs_per_seg * VLIB_FRAME_SIZE;
209 deq_per_buf = clib_min (snd_mss0, n_bytes_per_buf);
210 deq_per_first_buf = clib_min (snd_mss0, n_bytes_per_buf - MAX_HDRS_LEN);
212 n_bufs = vec_len (smm->tx_buffers[thread_index]);
213 left_to_snd0 = max_len_to_snd0;
214 for (i = 0; i < n_frames_per_evt; i++)
216 /* Make sure we have at least one full frame of buffers ready */
217 if (PREDICT_FALSE (n_bufs < n_bufs_per_frame))
219 vec_validate (smm->tx_buffers[thread_index],
220 n_bufs + n_bufs_per_frame - 1);
225 vlib_buffer_alloc (vm,
226 &smm->tx_buffers[thread_index][n_bufs +
228 n_bufs_per_frame - bufs_alloc);
229 bufs_alloc += bufs_now;
231 while (bufs_now > 0 && ((bufs_alloc + n_bufs < n_bufs_per_frame)));
233 n_bufs += bufs_alloc;
234 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
236 if (PREDICT_FALSE (n_bufs < n_bufs_per_frame))
238 vec_add1 (smm->pending_event_vector[thread_index], *e0);
241 ASSERT (n_bufs >= n_bufs_per_frame);
244 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
245 while (left_to_snd0 && n_left_to_next)
248 * Handle first buffer in chain separately
251 len_to_deq0 = clib_min (left_to_snd0, deq_per_first_buf);
252 if (left_to_snd0 > len_to_deq0 && n_left_to_next > 1)
255 u32 pbi = smm->tx_buffers[thread_index][n_bufs - 2];
256 pb = vlib_get_buffer (vm, pbi);
257 vlib_prefetch_buffer_header (pb, LOAD);
260 /* Get free buffer */
261 ASSERT (n_bufs >= 1);
262 bi0 = smm->tx_buffers[thread_index][--n_bufs];
263 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
265 /* usual speculation, or the enqueue_x1 macro will barf */
270 b0 = vlib_get_buffer (vm, bi0);
272 b0->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
273 b0->current_data = 0;
274 b0->total_length_not_including_first_buffer = 0;
276 data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
279 n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, tx_offset,
281 if (n_bytes_read <= 0)
283 /* Keep track of progress locally, transport is also supposed to
284 * increment it independently when pushing the header */
285 tx_offset += n_bytes_read;
289 n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
291 if (n_bytes_read <= 0)
295 b0->current_length = n_bytes_read;
297 left_to_snd0 -= n_bytes_read;
298 *n_tx_packets = *n_tx_packets + 1;
301 * Fill in the remaining buffers in the chain, if any
303 if (PREDICT_FALSE (n_bufs_per_seg > 1 && left_to_snd0))
305 left_for_seg = clib_min (snd_mss0 - n_bytes_read, left_to_snd0);
306 session_tx_fifo_chain_tail (smm, vm, thread_index,
307 s0->server_tx_fifo, b0, bi0,
308 n_bufs_per_seg, left_for_seg,
309 &left_to_snd0, &n_bufs, &tx_offset,
310 deq_per_buf, peek_data);
313 /* Ask transport to push header after current_length and
314 * total_length_not_including_first_buffer are updated */
315 transport_vft->push_header (tc0, b0);
318 SESSION_EVT_DBG(SESSION_EVT_DEQ, s0, ({
319 ed->data[0] = e0->event_type;
320 ed->data[1] = max_dequeue0;
321 ed->data[2] = len_to_deq0;
322 ed->data[3] = left_to_snd0;
326 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
328 if (PREDICT_FALSE (n_trace > 0))
330 session_queue_trace_t *t0;
331 vlib_trace_buffer (vm, node, next_index, b0,
332 1 /* follow_chain */ );
333 vlib_set_trace_count (vm, node, --n_trace);
334 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
335 t0->session_index = s0->session_index;
336 t0->server_thread_index = s0->thread_index;
339 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
340 to_next, n_left_to_next,
343 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
346 /* If we couldn't dequeue all bytes mark as partially read */
347 if (max_len_to_snd0 < max_dequeue0)
349 /* If we don't already have new event */
350 if (svm_fifo_set_event (s0->server_tx_fifo))
352 vec_add1 (smm->pending_event_vector[thread_index], *e0);
359 * Can't read from fifo. If we don't already have an event, save as partially
360 * read, return buff to free list and return
362 clib_warning ("dequeue fail");
364 if (svm_fifo_set_event (s0->server_tx_fifo))
366 vec_add1 (smm->pending_event_vector[thread_index], *e0);
368 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
369 _vec_len (smm->tx_buffers[thread_index]) += 1;
375 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
376 session_manager_main_t * smm,
377 session_fifo_event_t * e0,
378 stream_session_t * s0, u32 thread_index,
381 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
386 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
387 session_manager_main_t * smm,
388 session_fifo_event_t * e0,
389 stream_session_t * s0, u32 thread_index,
392 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
397 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
398 vlib_node_runtime_t * node,
399 session_manager_main_t * smm,
400 session_fifo_event_t * e0,
401 stream_session_t * s0, u32 thread_index,
405 app = application_get (s0->opaque);
406 svm_fifo_unset_event (s0->server_tx_fifo);
407 return app->cb_fns.builtin_app_tx_callback (s0);
410 always_inline stream_session_t *
411 session_event_get_session (session_fifo_event_t * e, u8 thread_index)
413 return session_get_if_valid (e->fifo->master_session_index, thread_index);
417 dump_thread_0_event_queue (void)
419 session_manager_main_t *smm = vnet_get_session_manager_main ();
420 vlib_main_t *vm = &vlib_global_main;
421 u32 my_thread_index = vm->thread_index;
422 session_fifo_event_t _e, *e = &_e;
423 stream_session_t *s0;
428 q = smm->vpp_event_queues[my_thread_index];
432 for (i = 0; i < q->cursize; i++)
434 headp = (i8 *) (&q->data[0] + q->elsize * index);
435 clib_memcpy (e, headp, q->elsize);
437 switch (e->event_type)
439 case FIFO_EVENT_APP_TX:
440 s0 = session_event_get_session (e, my_thread_index);
441 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
444 case FIFO_EVENT_DISCONNECT:
445 s0 = session_get_from_handle (e->session_handle);
446 fformat (stdout, "[%04d] disconnect session %d\n", i,
450 case FIFO_EVENT_BUILTIN_RX:
451 s0 = session_event_get_session (e, my_thread_index);
452 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
456 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
457 i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
461 fformat (stdout, "[%04d] unhandled event type %d\n",
468 if (index == q->maxsize)
474 session_node_cmp_event (session_fifo_event_t * e, svm_fifo_t * f)
477 switch (e->event_type)
479 case FIFO_EVENT_APP_RX:
480 case FIFO_EVENT_APP_TX:
481 case FIFO_EVENT_BUILTIN_RX:
485 case FIFO_EVENT_DISCONNECT:
488 s = session_get_from_handle (e->session_handle);
491 clib_warning ("session has event but doesn't exist!");
494 if (s->server_rx_fifo == f || s->server_tx_fifo == f)
504 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e)
506 session_manager_main_t *smm = vnet_get_session_manager_main ();
508 session_fifo_event_t *pending_event_vector, *evt;
509 int i, index, found = 0;
514 thread_index = f->master_thread_index;
518 q = smm->vpp_event_queues[thread_index];
520 for (i = 0; i < q->cursize; i++)
522 headp = (i8 *) (&q->data[0] + q->elsize * index);
523 clib_memcpy (e, headp, q->elsize);
524 found = session_node_cmp_event (e, f);
527 if (++index == q->maxsize)
531 * Search pending events vector
533 pending_event_vector = smm->pending_event_vector[thread_index];
534 vec_foreach (evt, pending_event_vector)
536 found = session_node_cmp_event (evt, f);
539 clib_memcpy (e, evt, sizeof (*evt));
547 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
548 vlib_frame_t * frame)
550 session_manager_main_t *smm = vnet_get_session_manager_main ();
551 session_fifo_event_t *my_pending_event_vector, *pending_disconnects, *e;
552 session_fifo_event_t *my_fifo_events;
553 u32 n_to_dequeue, n_events;
556 int n_tx_packets = 0;
557 u32 my_thread_index = vm->thread_index;
559 f64 now = vlib_time_now (vm);
562 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
565 * Update transport time
567 transport_update_time (now, my_thread_index);
570 * Get vpp queue events
572 q = smm->vpp_event_queues[my_thread_index];
573 if (PREDICT_FALSE (q == 0))
576 my_fifo_events = smm->free_event_vector[my_thread_index];
578 /* min number of events we can dequeue without blocking */
579 n_to_dequeue = q->cursize;
580 my_pending_event_vector = smm->pending_event_vector[my_thread_index];
581 pending_disconnects = smm->pending_disconnects[my_thread_index];
583 if (!n_to_dequeue && !vec_len (my_pending_event_vector)
584 && !vec_len (pending_disconnects))
587 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
590 * If we didn't manage to process previous events try going
591 * over them again without dequeuing new ones.
593 /* XXX: Block senders to sessions that can't keep up */
594 if (0 && vec_len (my_pending_event_vector) >= 100)
596 clib_warning ("too many fifo events unsolved");
600 /* See you in the next life, don't be late */
601 if (pthread_mutex_trylock (&q->mutex))
604 for (i = 0; i < n_to_dequeue; i++)
606 vec_add2 (my_fifo_events, e, 1);
607 svm_queue_sub_raw (q, (u8 *) e);
610 /* The other side of the connection is not polling */
611 if (q->cursize < (q->maxsize / 8))
612 (void) pthread_cond_broadcast (&q->condvar);
613 pthread_mutex_unlock (&q->mutex);
615 vec_append (my_fifo_events, my_pending_event_vector);
616 vec_append (my_fifo_events, smm->pending_disconnects[my_thread_index]);
618 _vec_len (my_pending_event_vector) = 0;
619 smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
620 _vec_len (smm->pending_disconnects[my_thread_index]) = 0;
623 n_events = vec_len (my_fifo_events);
624 for (i = 0; i < n_events; i++)
626 stream_session_t *s0; /* $$$ prefetch 1 ahead maybe */
627 session_fifo_event_t *e0;
629 e0 = &my_fifo_events[i];
631 switch (e0->event_type)
633 case FIFO_EVENT_APP_TX:
634 s0 = session_event_get_session (e0, my_thread_index);
636 if (PREDICT_FALSE (!s0))
638 clib_warning ("It's dead, Jim!");
641 /* Can retransmit for closed sessions but can't do anything if
642 * session is not ready or closed */
643 if (PREDICT_FALSE (s0->session_state < SESSION_STATE_READY))
645 vec_add1 (smm->pending_event_vector[my_thread_index], *e0);
648 /* Spray packets in per session type frames, since they go to
650 rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
654 if (PREDICT_FALSE (rv < 0))
656 vlib_node_increment_counter (vm, node->node_index,
657 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
661 case FIFO_EVENT_DISCONNECT:
662 /* Make sure disconnects run after the pending list is drained */
666 vec_add1 (smm->pending_disconnects[my_thread_index], *e0);
669 s0 = session_get_from_handle (e0->session_handle);
670 stream_session_disconnect_transport (s0);
672 case FIFO_EVENT_BUILTIN_RX:
673 s0 = session_event_get_session (e0, my_thread_index);
674 if (PREDICT_FALSE (!s0))
676 svm_fifo_unset_event (s0->server_rx_fifo);
677 app = application_get (s0->app_index);
678 app->cb_fns.builtin_app_rx_callback (s0);
681 fp = e0->rpc_args.fp;
682 (*fp) (e0->rpc_args.arg);
686 clib_warning ("unhandled event type %d", e0->event_type);
690 _vec_len (my_fifo_events) = 0;
691 smm->free_event_vector[my_thread_index] = my_fifo_events;
693 vlib_node_increment_counter (vm, session_queue_node.index,
694 SESSION_QUEUE_ERROR_TX, n_tx_packets);
696 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
702 VLIB_REGISTER_NODE (session_queue_node) =
704 .function = session_queue_node_fn,
705 .name = "session-queue",
706 .format_trace = format_session_queue_trace,
707 .type = VLIB_NODE_TYPE_INPUT,
708 .n_errors = ARRAY_LEN (session_queue_error_strings),
709 .error_strings = session_queue_error_strings,
710 .state = VLIB_NODE_STATE_DISABLED,
714 static clib_error_t *
715 session_queue_exit (vlib_main_t * vm)
717 if (vec_len (vlib_mains) < 2)
721 * Shut off (especially) worker-thread session nodes.
722 * Otherwise, vpp can crash as the main thread unmaps the
725 vlib_worker_thread_barrier_sync (vm);
726 session_node_enable_disable (0 /* is_enable */ );
727 vlib_worker_thread_barrier_release (vm);
731 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
734 * fd.io coding-style-patch-verification: ON
737 * eval: (c-set-style "gnu")