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 buffers_allocated, buffers_allocated_this_call;
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);
221 buffers_allocated = 0;
224 buffers_allocated_this_call = vlib_buffer_alloc (vm,
232 buffers_allocated += buffers_allocated_this_call;
234 while (buffers_allocated_this_call > 0
235 && ((buffers_allocated + n_bufs < n_bufs_per_frame)));
237 n_bufs += buffers_allocated;
238 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
240 if (PREDICT_FALSE (n_bufs < n_bufs_per_frame))
242 vec_add1 (smm->pending_event_vector[thread_index], *e0);
245 ASSERT (n_bufs >= n_bufs_per_frame);
248 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
249 while (left_to_snd0 && n_left_to_next)
252 * Handle first buffer in chain separately
255 /* Get free buffer */
256 ASSERT (n_bufs >= 1);
257 bi0 = smm->tx_buffers[thread_index][--n_bufs];
258 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
260 /* usual speculation, or the enqueue_x1 macro will barf */
265 b0 = vlib_get_buffer (vm, bi0);
267 b0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
268 b0->current_data = 0;
269 b0->total_length_not_including_first_buffer = 0;
271 len_to_deq0 = clib_min (left_to_snd0, deq_per_first_buf);
272 data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
275 n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, tx_offset,
277 if (n_bytes_read <= 0)
279 /* Keep track of progress locally, transport is also supposed to
280 * increment it independently when pushing the header */
281 tx_offset += n_bytes_read;
285 n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
287 if (n_bytes_read <= 0)
291 b0->current_length = n_bytes_read;
293 left_to_snd0 -= n_bytes_read;
294 *n_tx_packets = *n_tx_packets + 1;
297 * Fill in the remaining buffers in the chain, if any
299 if (PREDICT_FALSE (n_bufs_per_seg > 1 && left_to_snd0))
301 left_for_seg = clib_min (snd_mss0 - n_bytes_read, left_to_snd0);
302 session_tx_fifo_chain_tail (smm, vm, thread_index,
303 s0->server_tx_fifo, b0, bi0,
304 n_bufs_per_seg, left_for_seg,
305 &left_to_snd0, &n_bufs, &tx_offset,
306 deq_per_buf, peek_data);
309 /* Ask transport to push header after current_length and
310 * total_length_not_including_first_buffer are updated */
311 transport_vft->push_header (tc0, b0);
314 SESSION_EVT_DBG(SESSION_EVT_DEQ, s0, ({
315 ed->data[0] = e0->event_type;
316 ed->data[1] = max_dequeue0;
317 ed->data[2] = len_to_deq0;
318 ed->data[3] = left_to_snd0;
322 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
324 if (PREDICT_FALSE (n_trace > 0))
326 session_queue_trace_t *t0;
327 vlib_trace_buffer (vm, node, next_index, b0,
328 1 /* follow_chain */ );
329 vlib_set_trace_count (vm, node, --n_trace);
330 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
331 t0->session_index = s0->session_index;
332 t0->server_thread_index = s0->thread_index;
335 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
336 to_next, n_left_to_next,
339 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
342 /* If we couldn't dequeue all bytes mark as partially read */
343 if (max_len_to_snd0 < max_dequeue0)
345 /* If we don't already have new event */
346 if (svm_fifo_set_event (s0->server_tx_fifo))
348 vec_add1 (smm->pending_event_vector[thread_index], *e0);
355 * Can't read from fifo. If we don't already have an event, save as partially
356 * read, return buff to free list and return
358 clib_warning ("dequeue fail");
360 if (svm_fifo_set_event (s0->server_tx_fifo))
362 vec_add1 (smm->pending_event_vector[thread_index], *e0);
364 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
365 _vec_len (smm->tx_buffers[thread_index]) += 1;
371 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
372 session_manager_main_t * smm,
373 session_fifo_event_t * e0,
374 stream_session_t * s0, u32 thread_index,
377 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
382 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
383 session_manager_main_t * smm,
384 session_fifo_event_t * e0,
385 stream_session_t * s0, u32 thread_index,
388 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
392 always_inline stream_session_t *
393 session_event_get_session (session_fifo_event_t * e, u8 thread_index)
395 return session_get_if_valid (e->fifo->master_session_index, thread_index);
399 dump_thread_0_event_queue (void)
401 session_manager_main_t *smm = vnet_get_session_manager_main ();
402 vlib_main_t *vm = &vlib_global_main;
403 u32 my_thread_index = vm->thread_index;
404 session_fifo_event_t _e, *e = &_e;
405 stream_session_t *s0;
410 q = smm->vpp_event_queues[my_thread_index];
414 for (i = 0; i < q->cursize; i++)
416 headp = (i8 *) (&q->data[0] + q->elsize * index);
417 clib_memcpy (e, headp, q->elsize);
419 switch (e->event_type)
421 case FIFO_EVENT_APP_TX:
422 s0 = session_event_get_session (e, my_thread_index);
423 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
426 case FIFO_EVENT_DISCONNECT:
427 s0 = session_get_from_handle (e->session_handle);
428 fformat (stdout, "[%04d] disconnect session %d\n", i,
432 case FIFO_EVENT_BUILTIN_RX:
433 s0 = session_event_get_session (e, my_thread_index);
434 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
438 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
439 i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
443 fformat (stdout, "[%04d] unhandled event type %d\n",
450 if (index == q->maxsize)
456 session_node_cmp_event (session_fifo_event_t * e, svm_fifo_t * f)
459 switch (e->event_type)
461 case FIFO_EVENT_APP_RX:
462 case FIFO_EVENT_APP_TX:
463 case FIFO_EVENT_BUILTIN_RX:
467 case FIFO_EVENT_DISCONNECT:
470 s = session_get_from_handle (e->session_handle);
473 clib_warning ("session has event but doesn't exist!");
476 if (s->server_rx_fifo == f || s->server_tx_fifo == f)
486 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e)
488 session_manager_main_t *smm = vnet_get_session_manager_main ();
490 session_fifo_event_t *pending_event_vector, *evt;
491 int i, index, found = 0;
496 thread_index = f->master_thread_index;
500 q = smm->vpp_event_queues[thread_index];
502 for (i = 0; i < q->cursize; i++)
504 headp = (i8 *) (&q->data[0] + q->elsize * index);
505 clib_memcpy (e, headp, q->elsize);
506 found = session_node_cmp_event (e, f);
509 if (++index == q->maxsize)
513 * Search pending events vector
515 pending_event_vector = smm->pending_event_vector[thread_index];
516 vec_foreach (evt, pending_event_vector)
518 found = session_node_cmp_event (evt, f);
521 clib_memcpy (e, evt, sizeof (*evt));
529 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
530 vlib_frame_t * frame)
532 session_manager_main_t *smm = vnet_get_session_manager_main ();
533 session_fifo_event_t *my_pending_event_vector, *pending_disconnects, *e;
534 session_fifo_event_t *my_fifo_events;
535 u32 n_to_dequeue, n_events;
538 int n_tx_packets = 0;
539 u32 my_thread_index = vm->thread_index;
541 f64 now = vlib_time_now (vm);
544 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
547 * Update transport time
549 transport_update_time (now, my_thread_index);
552 * Get vpp queue events
554 q = smm->vpp_event_queues[my_thread_index];
555 if (PREDICT_FALSE (q == 0))
558 my_fifo_events = smm->free_event_vector[my_thread_index];
560 /* min number of events we can dequeue without blocking */
561 n_to_dequeue = q->cursize;
562 my_pending_event_vector = smm->pending_event_vector[my_thread_index];
563 pending_disconnects = smm->pending_disconnects[my_thread_index];
565 if (!n_to_dequeue && !vec_len (my_pending_event_vector)
566 && !vec_len (pending_disconnects))
569 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
572 * If we didn't manage to process previous events try going
573 * over them again without dequeuing new ones.
575 /* XXX: Block senders to sessions that can't keep up */
576 if (0 && vec_len (my_pending_event_vector) >= 100)
578 clib_warning ("too many fifo events unsolved");
582 /* See you in the next life, don't be late */
583 if (pthread_mutex_trylock (&q->mutex))
586 for (i = 0; i < n_to_dequeue; i++)
588 vec_add2 (my_fifo_events, e, 1);
589 svm_queue_sub_raw (q, (u8 *) e);
592 /* The other side of the connection is not polling */
593 if (q->cursize < (q->maxsize / 8))
594 (void) pthread_cond_broadcast (&q->condvar);
595 pthread_mutex_unlock (&q->mutex);
597 vec_append (my_fifo_events, my_pending_event_vector);
598 vec_append (my_fifo_events, smm->pending_disconnects[my_thread_index]);
600 _vec_len (my_pending_event_vector) = 0;
601 smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
602 _vec_len (smm->pending_disconnects[my_thread_index]) = 0;
605 n_events = vec_len (my_fifo_events);
606 for (i = 0; i < n_events; i++)
608 stream_session_t *s0; /* $$$ prefetch 1 ahead maybe */
609 session_fifo_event_t *e0;
611 e0 = &my_fifo_events[i];
613 switch (e0->event_type)
615 case FIFO_EVENT_APP_TX:
616 s0 = session_event_get_session (e0, my_thread_index);
618 if (PREDICT_FALSE (!s0))
620 clib_warning ("It's dead, Jim!");
623 /* Can retransmit for closed sessions but can't do anything if
624 * session is not ready or closed */
625 if (PREDICT_FALSE (s0->session_state < SESSION_STATE_READY))
627 vec_add1 (smm->pending_event_vector[my_thread_index], *e0);
630 /* Spray packets in per session type frames, since they go to
632 rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
636 if (PREDICT_FALSE (rv < 0))
638 vlib_node_increment_counter (vm, node->node_index,
639 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
643 case FIFO_EVENT_DISCONNECT:
644 /* Make sure disconnects run after the pending list is drained */
648 vec_add1 (smm->pending_disconnects[my_thread_index], *e0);
651 s0 = session_get_from_handle (e0->session_handle);
652 stream_session_disconnect_transport (s0);
654 case FIFO_EVENT_BUILTIN_RX:
655 s0 = session_event_get_session (e0, my_thread_index);
656 if (PREDICT_FALSE (!s0))
658 svm_fifo_unset_event (s0->server_rx_fifo);
659 app = application_get (s0->app_index);
660 app->cb_fns.builtin_server_rx_callback (s0);
663 fp = e0->rpc_args.fp;
664 (*fp) (e0->rpc_args.arg);
668 clib_warning ("unhandled event type %d", e0->event_type);
672 _vec_len (my_fifo_events) = 0;
673 smm->free_event_vector[my_thread_index] = my_fifo_events;
675 vlib_node_increment_counter (vm, session_queue_node.index,
676 SESSION_QUEUE_ERROR_TX, n_tx_packets);
678 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
684 VLIB_REGISTER_NODE (session_queue_node) =
686 .function = session_queue_node_fn,
687 .name = "session-queue",
688 .format_trace = format_session_queue_trace,
689 .type = VLIB_NODE_TYPE_INPUT,
690 .n_errors = ARRAY_LEN (session_queue_error_strings),
691 .error_strings = session_queue_error_strings,
692 .state = VLIB_NODE_STATE_DISABLED,
696 static clib_error_t *
697 session_queue_exit (vlib_main_t * vm)
699 if (vec_len (vlib_mains) < 2)
703 * Shut off (especially) worker-thread session nodes.
704 * Otherwise, vpp can crash as the main thread unmaps the
707 vlib_worker_thread_barrier_sync (vm);
708 session_node_enable_disable (0 /* is_enable */ );
709 vlib_worker_thread_barrier_release (vm);
713 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
716 * fd.io coding-style-patch-verification: ON
719 * eval: (c-set-style "gnu")