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 * rx_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, *rx_offset, len_to_deq0, data0);
108 *rx_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;
129 ASSERT (to_deq == 0);
130 *left_to_snd0 -= left_from_seg;
134 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
135 session_manager_main_t * smm,
136 session_fifo_event_t * e0,
137 stream_session_t * s0, u32 thread_index,
138 int *n_tx_packets, u8 peek_data)
140 u32 n_trace = vlib_get_trace_count (vm, node);
141 u32 left_to_snd0, max_len_to_snd0, len_to_deq0, snd_space0;
142 u32 n_bufs_per_evt, n_frames_per_evt;
143 transport_connection_t *tc0;
144 transport_proto_vft_t *transport_vft;
145 u32 next_index, next0, *to_next, n_left_to_next, bi0;
147 u32 rx_offset = 0, max_dequeue0, n_bytes_per_seg;
148 u16 snd_mss0, n_bufs_per_seg, n_bufs;
151 u32 n_bytes_per_buf, deq_per_buf;
152 u32 buffers_allocated, buffers_allocated_this_call;
154 next_index = next0 = session_type_to_next[s0->session_type];
156 transport_vft = session_get_transport_vft (s0->session_type);
157 tc0 = transport_vft->get_connection (s0->connection_index, thread_index);
159 /* Make sure we have space to send and there's something to dequeue */
160 snd_mss0 = transport_vft->send_mss (tc0);
161 snd_space0 = transport_vft->send_space (tc0);
163 /* Can't make any progress */
164 if (snd_space0 == 0 || snd_mss0 == 0)
166 vec_add1 (smm->pending_event_vector[thread_index], *e0);
172 /* Offset in rx fifo from where to peek data */
173 rx_offset = transport_vft->tx_fifo_offset (tc0);
176 /* Check how much we can pull. If buffering, subtract the offset */
177 max_dequeue0 = svm_fifo_max_dequeue (s0->server_tx_fifo) - rx_offset;
179 /* Nothing to read return */
180 if (max_dequeue0 == 0)
182 svm_fifo_unset_event (s0->server_tx_fifo);
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 max_len_to_snd0 = snd_space0;
199 n_bytes_per_buf = vlib_buffer_free_list_buffer_size
200 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
201 n_bytes_per_seg = MAX_HDRS_LEN + snd_mss0;
202 n_bufs_per_seg = ceil ((double) n_bytes_per_seg / n_bytes_per_buf);
203 n_bufs_per_evt = (ceil ((double) max_len_to_snd0 / n_bytes_per_seg))
205 n_frames_per_evt = ceil ((double) n_bufs_per_evt / VLIB_FRAME_SIZE);
207 deq_per_buf = clib_min (snd_mss0, n_bytes_per_buf);
209 n_bufs = vec_len (smm->tx_buffers[thread_index]);
210 left_to_snd0 = max_len_to_snd0;
211 for (i = 0; i < n_frames_per_evt; i++)
213 /* Make sure we have at least one full frame of buffers ready */
214 if (PREDICT_FALSE (n_bufs < VLIB_FRAME_SIZE))
216 vec_validate (smm->tx_buffers[thread_index],
217 n_bufs + 2 * VLIB_FRAME_SIZE - 1);
219 buffers_allocated = 0;
222 buffers_allocated_this_call =
225 &smm->tx_buffers[thread_index][n_bufs + buffers_allocated],
226 2 * VLIB_FRAME_SIZE - buffers_allocated);
227 buffers_allocated += buffers_allocated_this_call;
229 while (buffers_allocated_this_call > 0
230 && ((buffers_allocated + n_bufs < VLIB_FRAME_SIZE)));
232 n_bufs += buffers_allocated;
233 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
235 if (PREDICT_FALSE (n_bufs < VLIB_FRAME_SIZE))
237 vec_add1 (smm->pending_event_vector[thread_index], *e0);
241 /* Allow enqueuing of a new event */
242 svm_fifo_unset_event (s0->server_tx_fifo);
244 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
245 while (left_to_snd0 && n_left_to_next >= n_bufs_per_seg)
248 * Handle first buffer in chain separately
251 /* Get free buffer */
252 ASSERT (n_bufs >= 1);
253 bi0 = smm->tx_buffers[thread_index][--n_bufs];
255 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
257 /* usual speculation, or the enqueue_x1 macro will barf */
262 b0 = vlib_get_buffer (vm, bi0);
264 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID
265 | VNET_BUFFER_F_LOCALLY_ORIGINATED;
266 b0->current_data = 0;
267 b0->total_length_not_including_first_buffer = 0;
269 len_to_deq0 = clib_min (left_to_snd0, deq_per_buf);
271 data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
274 n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, rx_offset,
276 /* Keep track of progress locally, transport is also supposed to
277 * increment it independently when pushing the header */
278 rx_offset += n_bytes_read;
282 n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
286 if (n_bytes_read <= 0)
289 b0->current_length = n_bytes_read;
291 left_to_snd0 -= n_bytes_read;
292 *n_tx_packets = *n_tx_packets + 1;
295 * Fill in the remaining buffers in the chain, if any
297 if (PREDICT_FALSE (n_bufs_per_seg > 1))
300 left_for_seg = clib_min (snd_mss0 - n_bytes_read, left_to_snd0);
301 session_tx_fifo_chain_tail (smm, vm, thread_index,
302 s0->server_tx_fifo, b0, bi0,
303 n_bufs_per_seg, left_for_seg,
304 &left_to_snd0, &n_bufs, &rx_offset,
305 deq_per_buf, peek_data);
308 /* Ask transport to push header after current_length and
309 * total_length_not_including_first_buffer are updated */
310 transport_vft->push_header (tc0, b0);
313 SESSION_EVT_DBG(SESSION_EVT_DEQ, s0, ({
314 ed->data[0] = e0->event_id;
315 ed->data[1] = max_dequeue0;
316 ed->data[2] = len_to_deq0;
317 ed->data[3] = left_to_snd0;
322 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
323 if (PREDICT_FALSE (n_trace > 0))
325 session_queue_trace_t *t0;
326 vlib_trace_buffer (vm, node, next_index, b0,
327 1 /* follow_chain */ );
328 vlib_set_trace_count (vm, node, --n_trace);
329 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
330 t0->session_index = s0->session_index;
331 t0->server_thread_index = s0->thread_index;
334 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
335 to_next, n_left_to_next,
338 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
341 /* If we couldn't dequeue all bytes mark as partially read */
342 if (max_len_to_snd0 < max_dequeue0)
344 /* If we don't already have new event */
345 if (svm_fifo_set_event (s0->server_tx_fifo))
347 vec_add1 (smm->pending_event_vector[thread_index], *e0);
354 * Can't read from fifo. If we don't already have an event, save as partially
355 * read, return buff to free list and return
357 clib_warning ("dequeue fail");
359 if (svm_fifo_set_event (s0->server_tx_fifo))
361 vec_add1 (smm->pending_event_vector[thread_index], *e0);
363 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
364 _vec_len (smm->tx_buffers[thread_index]) += 1;
370 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
371 session_manager_main_t * smm,
372 session_fifo_event_t * e0,
373 stream_session_t * s0, u32 thread_index,
376 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
381 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
382 session_manager_main_t * smm,
383 session_fifo_event_t * e0,
384 stream_session_t * s0, u32 thread_index,
387 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
391 always_inline stream_session_t *
392 session_event_get_session (session_fifo_event_t * e, u8 thread_index)
394 ASSERT (e->fifo->master_thread_index == thread_index);
395 return stream_session_get_if_valid (e->fifo->master_session_index,
400 dump_thread_0_event_queue (void)
402 session_manager_main_t *smm = vnet_get_session_manager_main ();
403 vlib_main_t *vm = &vlib_global_main;
404 u32 my_thread_index = vm->thread_index;
405 session_fifo_event_t _e, *e = &_e;
406 stream_session_t *s0;
410 unix_shared_memory_queue_t *q;
411 q = smm->vpp_event_queues[my_thread_index];
415 for (i = 0; i < q->cursize; i++)
417 headp = (i8 *) (&q->data[0] + q->elsize * index);
418 clib_memcpy (e, headp, q->elsize);
420 switch (e->event_type)
422 case FIFO_EVENT_APP_TX:
423 s0 = session_event_get_session (e, my_thread_index);
424 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
427 case FIFO_EVENT_DISCONNECT:
428 s0 = stream_session_get_from_handle (e->session_handle);
429 fformat (stdout, "[%04d] disconnect session %d\n", i,
433 case FIFO_EVENT_BUILTIN_RX:
434 s0 = session_event_get_session (e, my_thread_index);
435 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
439 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
440 i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
444 fformat (stdout, "[%04d] unhandled event type %d\n",
451 if (index == q->maxsize)
457 session_node_cmp_event (session_fifo_event_t * e, svm_fifo_t * f)
460 switch (e->event_type)
462 case FIFO_EVENT_APP_RX:
463 case FIFO_EVENT_APP_TX:
464 case FIFO_EVENT_BUILTIN_RX:
468 case FIFO_EVENT_DISCONNECT:
471 s = stream_session_get_from_handle (e->session_handle);
474 clib_warning ("session has event but doesn't exist!");
477 if (s->server_rx_fifo == f || s->server_tx_fifo == f)
487 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e)
489 session_manager_main_t *smm = vnet_get_session_manager_main ();
490 unix_shared_memory_queue_t *q;
491 session_fifo_event_t *pending_event_vector, *evt;
492 int i, index, found = 0;
497 thread_index = f->master_thread_index;
501 q = smm->vpp_event_queues[thread_index];
503 for (i = 0; i < q->cursize; i++)
505 headp = (i8 *) (&q->data[0] + q->elsize * index);
506 clib_memcpy (e, headp, q->elsize);
507 found = session_node_cmp_event (e, f);
510 if (++index == q->maxsize)
514 * Search pending events vector
516 pending_event_vector = smm->pending_event_vector[thread_index];
517 vec_foreach (evt, pending_event_vector)
519 found = session_node_cmp_event (evt, f);
522 clib_memcpy (e, evt, sizeof (*evt));
530 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
531 vlib_frame_t * frame)
533 session_manager_main_t *smm = vnet_get_session_manager_main ();
534 session_fifo_event_t *my_pending_event_vector, *e;
535 session_fifo_event_t *my_fifo_events;
536 u32 n_to_dequeue, n_events;
537 unix_shared_memory_queue_t *q;
539 int n_tx_packets = 0;
540 u32 my_thread_index = vm->thread_index;
542 f64 now = vlib_time_now (vm);
545 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
550 tcp_update_time (now, my_thread_index);
553 * Get vpp queue events
555 q = smm->vpp_event_queues[my_thread_index];
556 if (PREDICT_FALSE (q == 0))
559 my_fifo_events = smm->free_event_vector[my_thread_index];
561 /* min number of events we can dequeue without blocking */
562 n_to_dequeue = q->cursize;
563 my_pending_event_vector = smm->pending_event_vector[my_thread_index];
565 if (n_to_dequeue == 0 && vec_len (my_pending_event_vector) == 0)
568 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
571 * If we didn't manage to process previous events try going
572 * over them again without dequeuing new ones.
574 /* XXX: Block senders to sessions that can't keep up */
575 if (0 && vec_len (my_pending_event_vector) >= 100)
577 clib_warning ("too many fifo events unsolved");
581 /* See you in the next life, don't be late */
582 if (pthread_mutex_trylock (&q->mutex))
585 for (i = 0; i < n_to_dequeue; i++)
587 vec_add2 (my_fifo_events, e, 1);
588 unix_shared_memory_queue_sub_raw (q, (u8 *) e);
591 /* The other side of the connection is not polling */
592 if (q->cursize < (q->maxsize / 8))
593 (void) pthread_cond_broadcast (&q->condvar);
594 pthread_mutex_unlock (&q->mutex);
596 vec_append (my_fifo_events, my_pending_event_vector);
598 _vec_len (my_pending_event_vector) = 0;
599 smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
602 n_events = vec_len (my_fifo_events);
603 for (i = 0; i < n_events; i++)
605 stream_session_t *s0; /* $$$ prefetch 1 ahead maybe */
606 session_fifo_event_t *e0;
608 e0 = &my_fifo_events[i];
610 switch (e0->event_type)
612 case FIFO_EVENT_APP_TX:
613 s0 = session_event_get_session (e0, my_thread_index);
615 if (CLIB_DEBUG && !s0)
617 clib_warning ("It's dead, Jim!");
620 /* Can retransmit for closed sessions but can't do anything if
621 * session is not ready or closed */
622 if (PREDICT_FALSE (s0->session_state < SESSION_STATE_READY))
624 /* Spray packets in per session type frames, since they go to
626 rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
630 if (PREDICT_FALSE (rv < 0))
632 vlib_node_increment_counter (vm, node->node_index,
633 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
637 case FIFO_EVENT_DISCONNECT:
638 s0 = stream_session_get_from_handle (e0->session_handle);
639 stream_session_disconnect (s0);
641 case FIFO_EVENT_BUILTIN_RX:
642 s0 = session_event_get_session (e0, my_thread_index);
643 svm_fifo_unset_event (s0->server_rx_fifo);
644 app = application_get (s0->app_index);
645 app->cb_fns.builtin_server_rx_callback (s0);
648 fp = e0->rpc_args.fp;
649 (*fp) (e0->rpc_args.arg);
653 clib_warning ("unhandled event type %d", e0->event_type);
657 _vec_len (my_fifo_events) = 0;
658 smm->free_event_vector[my_thread_index] = my_fifo_events;
660 vlib_node_increment_counter (vm, session_queue_node.index,
661 SESSION_QUEUE_ERROR_TX, n_tx_packets);
663 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
669 VLIB_REGISTER_NODE (session_queue_node) =
671 .function = session_queue_node_fn,
672 .name = "session-queue",
673 .format_trace = format_session_queue_trace,
674 .type = VLIB_NODE_TYPE_INPUT,
675 .n_errors = ARRAY_LEN (session_queue_error_strings),
676 .error_strings = session_queue_error_strings,
677 .n_next_nodes = SESSION_QUEUE_N_NEXT,
678 .state = VLIB_NODE_STATE_DISABLED,
681 [SESSION_QUEUE_NEXT_DROP] = "error-drop",
682 [SESSION_QUEUE_NEXT_IP4_LOOKUP] = "ip4-lookup",
683 [SESSION_QUEUE_NEXT_IP6_LOOKUP] = "ip6-lookup",
684 [SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT] = "tcp4-output",
685 [SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT] = "tcp6-output",
691 * fd.io coding-style-patch-verification: ON
694 * eval: (c-set-style "gnu")