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 <vnet/tcp/tcp.h>
20 #include <vppinfra/elog.h>
21 #include <vnet/session/application.h>
22 #include <vnet/session/session_debug.h>
23 #include <vlibmemory/unix_shared_memory_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
67 static u32 session_type_to_next[] = {
68 SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT,
69 SESSION_QUEUE_NEXT_IP4_LOOKUP,
70 SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT,
71 SESSION_QUEUE_NEXT_IP6_LOOKUP,
75 session_tx_fifo_chain_tail (session_manager_main_t * smm, vlib_main_t * vm,
76 u8 thread_index, svm_fifo_t * fifo,
77 vlib_buffer_t * b0, u32 bi0, u8 n_bufs_per_seg,
78 u32 left_from_seg, u32 * left_to_snd0,
79 u16 * n_bufs, u32 * tx_offset, u16 deq_per_buf,
82 vlib_buffer_t *chain_b0, *prev_b0;
83 u32 chain_bi0, to_deq;
84 u16 len_to_deq0, n_bytes_read;
87 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
88 b0->total_length_not_including_first_buffer = 0;
92 to_deq = left_from_seg;
93 for (j = 1; j < n_bufs_per_seg; j++)
96 len_to_deq0 = clib_min (to_deq, deq_per_buf);
99 chain_bi0 = smm->tx_buffers[thread_index][*n_bufs];
100 _vec_len (smm->tx_buffers[thread_index]) = *n_bufs;
102 chain_b0 = vlib_get_buffer (vm, chain_bi0);
103 chain_b0->current_data = 0;
104 data0 = vlib_buffer_get_current (chain_b0);
107 n_bytes_read = svm_fifo_peek (fifo, *tx_offset, len_to_deq0, data0);
108 *tx_offset += n_bytes_read;
112 n_bytes_read = svm_fifo_dequeue_nowait (fifo, len_to_deq0, data0);
114 ASSERT (n_bytes_read == len_to_deq0);
115 chain_b0->current_length = n_bytes_read;
116 b0->total_length_not_including_first_buffer += chain_b0->current_length;
118 /* update previous buffer */
119 prev_b0->next_buffer = chain_bi0;
120 prev_b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
122 /* update current buffer */
123 chain_b0->next_buffer = 0;
125 to_deq -= n_bytes_read;
130 && b0->total_length_not_including_first_buffer == left_from_seg);
131 *left_to_snd0 -= left_from_seg;
135 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
136 session_manager_main_t * smm,
137 session_fifo_event_t * e0,
138 stream_session_t * s0, u32 thread_index,
139 int *n_tx_packets, u8 peek_data)
141 u32 n_trace = vlib_get_trace_count (vm, node);
142 u32 left_to_snd0, max_len_to_snd0, len_to_deq0, snd_space0;
143 u32 n_bufs_per_evt, n_frames_per_evt, n_bufs_per_frame;
144 transport_connection_t *tc0;
145 transport_proto_vft_t *transport_vft;
146 u32 next_index, next0, *to_next, n_left_to_next, bi0;
148 u32 tx_offset = 0, max_dequeue0, n_bytes_per_seg, left_for_seg;
149 u16 snd_mss0, n_bufs_per_seg, n_bufs;
152 u32 n_bytes_per_buf, deq_per_buf, deq_per_first_buf;
153 u32 buffers_allocated, buffers_allocated_this_call;
155 next_index = next0 = session_type_to_next[s0->session_type];
157 transport_vft = transport_protocol_get_vft (s0->session_type);
158 tc0 = transport_vft->get_connection (s0->connection_index, thread_index);
160 /* Make sure we have space to send and there's something to dequeue */
161 snd_mss0 = transport_vft->send_mss (tc0);
162 snd_space0 = transport_vft->send_space (tc0);
164 /* Can't make any progress */
165 if (snd_space0 == 0 || snd_mss0 == 0)
167 vec_add1 (smm->pending_event_vector[thread_index], *e0);
171 /* Allow enqueuing of a new event */
172 svm_fifo_unset_event (s0->server_tx_fifo);
174 /* Check how much we can pull. */
175 max_dequeue0 = svm_fifo_max_dequeue (s0->server_tx_fifo);
179 /* Offset in rx fifo from where to peek data */
180 tx_offset = transport_vft->tx_fifo_offset (tc0);
181 if (PREDICT_FALSE (tx_offset >= max_dequeue0))
184 max_dequeue0 -= tx_offset;
187 /* Nothing to read return */
188 if (max_dequeue0 == 0)
191 /* Ensure we're not writing more than transport window allows */
192 if (max_dequeue0 < snd_space0)
194 /* Constrained by tx queue. Try to send only fully formed segments */
195 max_len_to_snd0 = (max_dequeue0 > snd_mss0) ?
196 max_dequeue0 - max_dequeue0 % snd_mss0 : max_dequeue0;
201 /* Expectation is that snd_space0 is already a multiple of snd_mss */
202 max_len_to_snd0 = snd_space0;
205 n_bytes_per_buf = vlib_buffer_free_list_buffer_size
206 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
207 ASSERT (n_bytes_per_buf > MAX_HDRS_LEN);
208 n_bytes_per_seg = MAX_HDRS_LEN + snd_mss0;
209 n_bufs_per_seg = ceil ((double) n_bytes_per_seg / n_bytes_per_buf);
210 n_bufs_per_evt = ceil ((double) max_len_to_snd0 / n_bytes_per_seg);
211 n_frames_per_evt = ceil ((double) n_bufs_per_evt / VLIB_FRAME_SIZE);
212 n_bufs_per_frame = n_bufs_per_seg * VLIB_FRAME_SIZE;
214 deq_per_buf = clib_min (snd_mss0, n_bytes_per_buf);
215 deq_per_first_buf = clib_min (snd_mss0, n_bytes_per_buf - MAX_HDRS_LEN);
217 n_bufs = vec_len (smm->tx_buffers[thread_index]);
218 left_to_snd0 = max_len_to_snd0;
219 for (i = 0; i < n_frames_per_evt; i++)
221 /* Make sure we have at least one full frame of buffers ready */
222 if (PREDICT_FALSE (n_bufs < n_bufs_per_frame))
224 vec_validate (smm->tx_buffers[thread_index],
225 n_bufs + n_bufs_per_frame - 1);
226 buffers_allocated = 0;
229 buffers_allocated_this_call = vlib_buffer_alloc (vm,
237 buffers_allocated += buffers_allocated_this_call;
239 while (buffers_allocated_this_call > 0
240 && ((buffers_allocated + n_bufs < n_bufs_per_frame)));
242 n_bufs += buffers_allocated;
243 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
245 if (PREDICT_FALSE (n_bufs < n_bufs_per_frame))
247 vec_add1 (smm->pending_event_vector[thread_index], *e0);
250 ASSERT (n_bufs >= n_bufs_per_frame);
253 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
254 while (left_to_snd0 && n_left_to_next)
257 * Handle first buffer in chain separately
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 len_to_deq0 = clib_min (left_to_snd0, deq_per_first_buf);
277 data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
280 n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, tx_offset,
282 if (n_bytes_read <= 0)
284 /* Keep track of progress locally, transport is also supposed to
285 * increment it independently when pushing the header */
286 tx_offset += n_bytes_read;
290 n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
292 if (n_bytes_read <= 0)
296 b0->current_length = n_bytes_read;
298 left_to_snd0 -= n_bytes_read;
299 *n_tx_packets = *n_tx_packets + 1;
302 * Fill in the remaining buffers in the chain, if any
304 if (PREDICT_FALSE (n_bufs_per_seg > 1 && left_to_snd0))
306 left_for_seg = clib_min (snd_mss0 - n_bytes_read, left_to_snd0);
307 session_tx_fifo_chain_tail (smm, vm, thread_index,
308 s0->server_tx_fifo, b0, bi0,
309 n_bufs_per_seg, left_for_seg,
310 &left_to_snd0, &n_bufs, &tx_offset,
311 deq_per_buf, peek_data);
314 /* Ask transport to push header after current_length and
315 * total_length_not_including_first_buffer are updated */
316 transport_vft->push_header (tc0, b0);
319 SESSION_EVT_DBG(SESSION_EVT_DEQ, s0, ({
320 ed->data[0] = e0->event_type;
321 ed->data[1] = max_dequeue0;
322 ed->data[2] = len_to_deq0;
323 ed->data[3] = left_to_snd0;
327 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
328 tcp_trajectory_add_start (b0, 3);
330 if (PREDICT_FALSE (n_trace > 0))
332 session_queue_trace_t *t0;
333 vlib_trace_buffer (vm, node, next_index, b0,
334 1 /* follow_chain */ );
335 vlib_set_trace_count (vm, node, --n_trace);
336 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
337 t0->session_index = s0->session_index;
338 t0->server_thread_index = s0->thread_index;
341 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
342 to_next, n_left_to_next,
345 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
348 /* If we couldn't dequeue all bytes mark as partially read */
349 if (max_len_to_snd0 < max_dequeue0)
351 /* If we don't already have new event */
352 if (svm_fifo_set_event (s0->server_tx_fifo))
354 vec_add1 (smm->pending_event_vector[thread_index], *e0);
361 * Can't read from fifo. If we don't already have an event, save as partially
362 * read, return buff to free list and return
364 clib_warning ("dequeue fail");
366 if (svm_fifo_set_event (s0->server_tx_fifo))
368 vec_add1 (smm->pending_event_vector[thread_index], *e0);
370 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
371 _vec_len (smm->tx_buffers[thread_index]) += 1;
377 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
378 session_manager_main_t * smm,
379 session_fifo_event_t * e0,
380 stream_session_t * s0, u32 thread_index,
383 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
388 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
389 session_manager_main_t * smm,
390 session_fifo_event_t * e0,
391 stream_session_t * s0, u32 thread_index,
394 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
398 always_inline stream_session_t *
399 session_event_get_session (session_fifo_event_t * e, u8 thread_index)
401 return session_get_if_valid (e->fifo->master_session_index, thread_index);
405 dump_thread_0_event_queue (void)
407 session_manager_main_t *smm = vnet_get_session_manager_main ();
408 vlib_main_t *vm = &vlib_global_main;
409 u32 my_thread_index = vm->thread_index;
410 session_fifo_event_t _e, *e = &_e;
411 stream_session_t *s0;
415 unix_shared_memory_queue_t *q;
416 q = smm->vpp_event_queues[my_thread_index];
420 for (i = 0; i < q->cursize; i++)
422 headp = (i8 *) (&q->data[0] + q->elsize * index);
423 clib_memcpy (e, headp, q->elsize);
425 switch (e->event_type)
427 case FIFO_EVENT_APP_TX:
428 s0 = session_event_get_session (e, my_thread_index);
429 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
432 case FIFO_EVENT_DISCONNECT:
433 s0 = session_get_from_handle (e->session_handle);
434 fformat (stdout, "[%04d] disconnect session %d\n", i,
438 case FIFO_EVENT_BUILTIN_RX:
439 s0 = session_event_get_session (e, my_thread_index);
440 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
444 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
445 i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
449 fformat (stdout, "[%04d] unhandled event type %d\n",
456 if (index == q->maxsize)
462 session_node_cmp_event (session_fifo_event_t * e, svm_fifo_t * f)
465 switch (e->event_type)
467 case FIFO_EVENT_APP_RX:
468 case FIFO_EVENT_APP_TX:
469 case FIFO_EVENT_BUILTIN_RX:
473 case FIFO_EVENT_DISCONNECT:
476 s = session_get_from_handle (e->session_handle);
479 clib_warning ("session has event but doesn't exist!");
482 if (s->server_rx_fifo == f || s->server_tx_fifo == f)
492 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e)
494 session_manager_main_t *smm = vnet_get_session_manager_main ();
495 unix_shared_memory_queue_t *q;
496 session_fifo_event_t *pending_event_vector, *evt;
497 int i, index, found = 0;
502 thread_index = f->master_thread_index;
506 q = smm->vpp_event_queues[thread_index];
508 for (i = 0; i < q->cursize; i++)
510 headp = (i8 *) (&q->data[0] + q->elsize * index);
511 clib_memcpy (e, headp, q->elsize);
512 found = session_node_cmp_event (e, f);
515 if (++index == q->maxsize)
519 * Search pending events vector
521 pending_event_vector = smm->pending_event_vector[thread_index];
522 vec_foreach (evt, pending_event_vector)
524 found = session_node_cmp_event (evt, f);
527 clib_memcpy (e, evt, sizeof (*evt));
535 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
536 vlib_frame_t * frame)
538 session_manager_main_t *smm = vnet_get_session_manager_main ();
539 session_fifo_event_t *my_pending_event_vector, *pending_disconnects, *e;
540 session_fifo_event_t *my_fifo_events;
541 u32 n_to_dequeue, n_events;
542 unix_shared_memory_queue_t *q;
544 int n_tx_packets = 0;
545 u32 my_thread_index = vm->thread_index;
547 f64 now = vlib_time_now (vm);
550 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
555 tcp_update_time (now, my_thread_index);
558 * Get vpp queue events
560 q = smm->vpp_event_queues[my_thread_index];
561 if (PREDICT_FALSE (q == 0))
564 my_fifo_events = smm->free_event_vector[my_thread_index];
566 /* min number of events we can dequeue without blocking */
567 n_to_dequeue = q->cursize;
568 my_pending_event_vector = smm->pending_event_vector[my_thread_index];
569 pending_disconnects = smm->pending_disconnects[my_thread_index];
571 if (!n_to_dequeue && !vec_len (my_pending_event_vector)
572 && !vec_len (pending_disconnects))
575 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
578 * If we didn't manage to process previous events try going
579 * over them again without dequeuing new ones.
581 /* XXX: Block senders to sessions that can't keep up */
582 if (0 && vec_len (my_pending_event_vector) >= 100)
584 clib_warning ("too many fifo events unsolved");
588 /* See you in the next life, don't be late */
589 if (pthread_mutex_trylock (&q->mutex))
592 for (i = 0; i < n_to_dequeue; i++)
594 vec_add2 (my_fifo_events, e, 1);
595 unix_shared_memory_queue_sub_raw (q, (u8 *) e);
598 /* The other side of the connection is not polling */
599 if (q->cursize < (q->maxsize / 8))
600 (void) pthread_cond_broadcast (&q->condvar);
601 pthread_mutex_unlock (&q->mutex);
603 vec_append (my_fifo_events, my_pending_event_vector);
604 vec_append (my_fifo_events, smm->pending_disconnects[my_thread_index]);
606 _vec_len (my_pending_event_vector) = 0;
607 smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
608 _vec_len (smm->pending_disconnects[my_thread_index]) = 0;
611 n_events = vec_len (my_fifo_events);
612 for (i = 0; i < n_events; i++)
614 stream_session_t *s0; /* $$$ prefetch 1 ahead maybe */
615 session_fifo_event_t *e0;
617 e0 = &my_fifo_events[i];
619 switch (e0->event_type)
621 case FIFO_EVENT_APP_TX:
622 s0 = session_event_get_session (e0, my_thread_index);
624 if (PREDICT_FALSE (!s0))
626 clib_warning ("It's dead, Jim!");
629 /* Can retransmit for closed sessions but can't do anything if
630 * session is not ready or closed */
631 if (PREDICT_FALSE (s0->session_state < SESSION_STATE_READY))
633 /* Spray packets in per session type frames, since they go to
635 rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
639 if (PREDICT_FALSE (rv < 0))
641 vlib_node_increment_counter (vm, node->node_index,
642 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
646 case FIFO_EVENT_DISCONNECT:
647 /* Make sure disconnects run after the pending list is drained */
651 vec_add1 (smm->pending_disconnects[my_thread_index], *e0);
654 s0 = session_get_from_handle (e0->session_handle);
655 stream_session_disconnect (s0);
657 case FIFO_EVENT_BUILTIN_RX:
658 s0 = session_event_get_session (e0, my_thread_index);
659 if (PREDICT_FALSE (!s0))
661 svm_fifo_unset_event (s0->server_rx_fifo);
662 app = application_get (s0->app_index);
663 app->cb_fns.builtin_server_rx_callback (s0);
666 fp = e0->rpc_args.fp;
667 (*fp) (e0->rpc_args.arg);
671 clib_warning ("unhandled event type %d", e0->event_type);
675 _vec_len (my_fifo_events) = 0;
676 smm->free_event_vector[my_thread_index] = my_fifo_events;
678 vlib_node_increment_counter (vm, session_queue_node.index,
679 SESSION_QUEUE_ERROR_TX, n_tx_packets);
681 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
687 VLIB_REGISTER_NODE (session_queue_node) =
689 .function = session_queue_node_fn,
690 .name = "session-queue",
691 .format_trace = format_session_queue_trace,
692 .type = VLIB_NODE_TYPE_INPUT,
693 .n_errors = ARRAY_LEN (session_queue_error_strings),
694 .error_strings = session_queue_error_strings,
695 .n_next_nodes = SESSION_QUEUE_N_NEXT,
696 .state = VLIB_NODE_STATE_DISABLED,
699 [SESSION_QUEUE_NEXT_DROP] = "error-drop",
700 [SESSION_QUEUE_NEXT_IP4_LOOKUP] = "ip4-lookup",
701 [SESSION_QUEUE_NEXT_IP6_LOOKUP] = "ip6-lookup",
702 [SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT] = "tcp4-output",
703 [SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT] = "tcp6-output",
708 static clib_error_t *
709 session_queue_exit (vlib_main_t * vm)
711 if (vec_len (vlib_mains) < 2)
715 * Shut off (especially) worker-thread session nodes.
716 * Otherwise, vpp can crash as the main thread unmaps the
719 vlib_worker_thread_barrier_sync (vm);
720 session_node_enable_disable (0 /* is_enable */ );
721 vlib_worker_thread_barrier_release (vm);
725 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
728 * fd.io coding-style-patch-verification: ON
731 * eval: (c-set-style "gnu")