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_to_snd0, u16 * n_bufs, u32 * rx_offset,
79 u16 deq_per_buf, u8 peek_data)
81 vlib_buffer_t *chain_b0, *prev_b0;
83 u16 len_to_deq0, n_bytes_read;
88 for (j = 1; j < n_bufs_per_seg; j++)
91 len_to_deq0 = clib_min (*left_to_snd0, deq_per_buf);
94 chain_bi0 = smm->tx_buffers[thread_index][*n_bufs];
95 _vec_len (smm->tx_buffers[thread_index]) = *n_bufs;
97 chain_b0 = vlib_get_buffer (vm, chain_bi0);
98 chain_b0->current_data = 0;
99 data0 = vlib_buffer_get_current (chain_b0);
102 n_bytes_read = svm_fifo_peek (fifo, *rx_offset, len_to_deq0, data0);
103 *rx_offset += n_bytes_read;
107 n_bytes_read = svm_fifo_dequeue_nowait (fifo, len_to_deq0, data0);
109 ASSERT (n_bytes_read == len_to_deq0);
110 chain_b0->current_length = n_bytes_read;
111 b0->total_length_not_including_first_buffer += chain_b0->current_length;
113 /* update previous buffer */
114 prev_b0->next_buffer = chain_bi0;
115 prev_b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
117 /* update current buffer */
118 chain_b0->next_buffer = 0;
120 *left_to_snd0 -= n_bytes_read;
121 if (*left_to_snd0 == 0)
127 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
128 session_manager_main_t * smm,
129 session_fifo_event_t * e0,
130 stream_session_t * s0, u32 thread_index,
131 int *n_tx_packets, u8 peek_data)
133 u32 n_trace = vlib_get_trace_count (vm, node);
134 u32 left_to_snd0, max_len_to_snd0, len_to_deq0, snd_space0;
135 u32 n_bufs_per_evt, n_frames_per_evt;
136 transport_connection_t *tc0;
137 transport_proto_vft_t *transport_vft;
138 u32 next_index, next0, *to_next, n_left_to_next, bi0;
140 u32 rx_offset = 0, max_dequeue0, n_bytes_per_seg;
141 u16 snd_mss0, n_bufs_per_seg, n_bufs;
144 u32 n_bytes_per_buf, deq_per_buf;
145 u32 buffers_allocated, buffers_allocated_this_call;
147 next_index = next0 = session_type_to_next[s0->session_type];
149 transport_vft = session_get_transport_vft (s0->session_type);
150 tc0 = transport_vft->get_connection (s0->connection_index, thread_index);
152 /* Make sure we have space to send and there's something to dequeue */
153 snd_mss0 = transport_vft->send_mss (tc0);
154 snd_space0 = transport_vft->send_space (tc0);
156 /* Can't make any progress */
157 if (snd_space0 == 0 || snd_mss0 == 0)
159 vec_add1 (smm->pending_event_vector[thread_index], *e0);
165 /* Offset in rx fifo from where to peek data */
166 rx_offset = transport_vft->tx_fifo_offset (tc0);
169 /* Check how much we can pull. If buffering, subtract the offset */
170 max_dequeue0 = svm_fifo_max_dequeue (s0->server_tx_fifo) - rx_offset;
172 /* Nothing to read return */
173 if (max_dequeue0 == 0)
175 svm_fifo_unset_event (s0->server_tx_fifo);
179 /* Ensure we're not writing more than transport window allows */
180 if (max_dequeue0 < snd_space0)
182 /* Constrained by tx queue. Try to send only fully formed segments */
183 max_len_to_snd0 = (max_dequeue0 > snd_mss0) ?
184 max_dequeue0 - max_dequeue0 % snd_mss0 : max_dequeue0;
189 max_len_to_snd0 = snd_space0;
192 n_bytes_per_buf = vlib_buffer_free_list_buffer_size
193 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
194 n_bytes_per_seg = MAX_HDRS_LEN + snd_mss0;
195 n_bufs_per_seg = ceil ((double) n_bytes_per_seg / n_bytes_per_buf);
196 n_bufs_per_evt = (ceil ((double) max_len_to_snd0 / n_bytes_per_seg))
198 n_frames_per_evt = ceil ((double) n_bufs_per_evt / VLIB_FRAME_SIZE);
200 deq_per_buf = clib_min (snd_mss0, n_bytes_per_buf);
202 n_bufs = vec_len (smm->tx_buffers[thread_index]);
203 left_to_snd0 = max_len_to_snd0;
204 for (i = 0; i < n_frames_per_evt; i++)
206 /* Make sure we have at least one full frame of buffers ready */
207 if (PREDICT_FALSE (n_bufs < VLIB_FRAME_SIZE))
209 vec_validate (smm->tx_buffers[thread_index],
210 n_bufs + 2 * VLIB_FRAME_SIZE - 1);
212 buffers_allocated = 0;
215 buffers_allocated_this_call =
218 &smm->tx_buffers[thread_index][n_bufs + buffers_allocated],
219 2 * VLIB_FRAME_SIZE - buffers_allocated);
220 buffers_allocated += buffers_allocated_this_call;
222 while (buffers_allocated_this_call > 0
223 && ((buffers_allocated + n_bufs < VLIB_FRAME_SIZE)));
225 n_bufs += buffers_allocated;
227 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
229 if (PREDICT_FALSE (n_bufs < VLIB_FRAME_SIZE))
231 vec_add1 (smm->pending_event_vector[thread_index], *e0);
235 /* Allow enqueuing of a new event */
236 svm_fifo_unset_event (s0->server_tx_fifo);
238 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
239 while (left_to_snd0 && n_left_to_next >= n_bufs_per_seg)
242 * Handle first buffer in chain separately
245 /* Get free buffer */
246 ASSERT (n_bufs >= 1);
247 bi0 = smm->tx_buffers[thread_index][--n_bufs];
249 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
251 /* usual speculation, or the enqueue_x1 macro will barf */
256 b0 = vlib_get_buffer (vm, bi0);
258 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID
259 | VNET_BUFFER_F_LOCALLY_ORIGINATED;
260 b0->current_data = 0;
261 b0->total_length_not_including_first_buffer = 0;
263 len_to_deq0 = clib_min (left_to_snd0, deq_per_buf);
265 data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
268 n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, rx_offset,
270 /* Keep track of progress locally, transport is also supposed to
271 * increment it independently when pushing the header */
272 rx_offset += n_bytes_read;
276 n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
280 if (n_bytes_read <= 0)
283 b0->current_length = n_bytes_read;
285 left_to_snd0 -= n_bytes_read;
286 *n_tx_packets = *n_tx_packets + 1;
289 * Fill in the remaining buffers in the chain, if any
291 if (PREDICT_FALSE (n_bufs_per_seg > 1))
292 session_tx_fifo_chain_tail (smm, vm, thread_index,
293 s0->server_tx_fifo, b0, bi0,
294 n_bufs_per_seg, &left_to_snd0,
295 &n_bufs, &rx_offset, deq_per_buf,
298 /* Ask transport to push header after current_length and
299 * total_length_not_including_first_buffer are updated */
300 transport_vft->push_header (tc0, b0);
303 SESSION_EVT_DBG(SESSION_EVT_DEQ, s0, ({
304 ed->data[0] = e0->event_id;
305 ed->data[1] = max_dequeue0;
306 ed->data[2] = len_to_deq0;
307 ed->data[3] = left_to_snd0;
312 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
313 if (PREDICT_FALSE (n_trace > 0))
315 session_queue_trace_t *t0;
316 vlib_trace_buffer (vm, node, next_index, b0,
317 1 /* follow_chain */ );
318 vlib_set_trace_count (vm, node, --n_trace);
319 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
320 t0->session_index = s0->session_index;
321 t0->server_thread_index = s0->thread_index;
324 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
325 to_next, n_left_to_next,
328 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
331 /* If we couldn't dequeue all bytes mark as partially read */
332 if (max_len_to_snd0 < max_dequeue0)
334 /* If we don't already have new event */
335 if (svm_fifo_set_event (s0->server_tx_fifo))
337 vec_add1 (smm->pending_event_vector[thread_index], *e0);
344 * Can't read from fifo. If we don't already have an event, save as partially
345 * read, return buff to free list and return
347 clib_warning ("dequeue fail");
349 if (svm_fifo_set_event (s0->server_tx_fifo))
351 vec_add1 (smm->pending_event_vector[thread_index], *e0);
353 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
354 _vec_len (smm->tx_buffers[thread_index]) += 1;
360 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
361 session_manager_main_t * smm,
362 session_fifo_event_t * e0,
363 stream_session_t * s0, u32 thread_index,
366 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
371 session_tx_fifo_dequeue_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,
381 always_inline stream_session_t *
382 session_event_get_session (session_fifo_event_t * e, u8 thread_index)
384 ASSERT (e->fifo->master_thread_index == thread_index);
385 return stream_session_get_if_valid (e->fifo->master_session_index,
390 dump_thread_0_event_queue (void)
392 session_manager_main_t *smm = vnet_get_session_manager_main ();
393 vlib_main_t *vm = &vlib_global_main;
394 u32 my_thread_index = vm->thread_index;
395 session_fifo_event_t _e, *e = &_e;
396 stream_session_t *s0;
400 unix_shared_memory_queue_t *q;
401 q = smm->vpp_event_queues[my_thread_index];
405 for (i = 0; i < q->cursize; i++)
407 headp = (i8 *) (&q->data[0] + q->elsize * index);
408 clib_memcpy (e, headp, q->elsize);
410 switch (e->event_type)
412 case FIFO_EVENT_APP_TX:
413 s0 = session_event_get_session (e, my_thread_index);
414 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
417 case FIFO_EVENT_DISCONNECT:
418 s0 = stream_session_get_from_handle (e->session_handle);
419 fformat (stdout, "[%04d] disconnect session %d\n", i,
423 case FIFO_EVENT_BUILTIN_RX:
424 s0 = session_event_get_session (e, my_thread_index);
425 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
429 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
430 i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
434 fformat (stdout, "[%04d] unhandled event type %d\n",
441 if (index == q->maxsize)
447 session_node_cmp_event (session_fifo_event_t * e, svm_fifo_t * f)
450 switch (e->event_type)
452 case FIFO_EVENT_APP_RX:
453 case FIFO_EVENT_APP_TX:
454 case FIFO_EVENT_BUILTIN_RX:
458 case FIFO_EVENT_DISCONNECT:
461 s = stream_session_get_from_handle (e->session_handle);
464 clib_warning ("session has event but doesn't exist!");
467 if (s->server_rx_fifo == f || s->server_tx_fifo == f)
477 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e)
479 session_manager_main_t *smm = vnet_get_session_manager_main ();
480 unix_shared_memory_queue_t *q;
481 session_fifo_event_t *pending_event_vector, *evt;
482 int i, index, found = 0;
487 thread_index = f->master_thread_index;
491 q = smm->vpp_event_queues[thread_index];
493 for (i = 0; i < q->cursize; i++)
495 headp = (i8 *) (&q->data[0] + q->elsize * index);
496 clib_memcpy (e, headp, q->elsize);
497 found = session_node_cmp_event (e, f);
500 if (++index == q->maxsize)
504 * Search pending events vector
506 pending_event_vector = smm->pending_event_vector[thread_index];
507 vec_foreach (evt, pending_event_vector)
509 found = session_node_cmp_event (evt, f);
512 clib_memcpy (e, evt, sizeof (*evt));
520 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
521 vlib_frame_t * frame)
523 session_manager_main_t *smm = vnet_get_session_manager_main ();
524 session_fifo_event_t *my_pending_event_vector, *e;
525 session_fifo_event_t *my_fifo_events;
526 u32 n_to_dequeue, n_events;
527 unix_shared_memory_queue_t *q;
529 int n_tx_packets = 0;
530 u32 my_thread_index = vm->thread_index;
532 f64 now = vlib_time_now (vm);
535 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
540 tcp_update_time (now, my_thread_index);
543 * Get vpp queue events
545 q = smm->vpp_event_queues[my_thread_index];
546 if (PREDICT_FALSE (q == 0))
549 my_fifo_events = smm->free_event_vector[my_thread_index];
551 /* min number of events we can dequeue without blocking */
552 n_to_dequeue = q->cursize;
553 my_pending_event_vector = smm->pending_event_vector[my_thread_index];
555 if (n_to_dequeue == 0 && vec_len (my_pending_event_vector) == 0)
558 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
561 * If we didn't manage to process previous events try going
562 * over them again without dequeuing new ones.
564 /* XXX: Block senders to sessions that can't keep up */
565 if (0 && vec_len (my_pending_event_vector) >= 100)
567 clib_warning ("too many fifo events unsolved");
571 /* See you in the next life, don't be late */
572 if (pthread_mutex_trylock (&q->mutex))
575 for (i = 0; i < n_to_dequeue; i++)
577 vec_add2 (my_fifo_events, e, 1);
578 unix_shared_memory_queue_sub_raw (q, (u8 *) e);
581 /* The other side of the connection is not polling */
582 if (q->cursize < (q->maxsize / 8))
583 (void) pthread_cond_broadcast (&q->condvar);
584 pthread_mutex_unlock (&q->mutex);
586 vec_append (my_fifo_events, my_pending_event_vector);
588 _vec_len (my_pending_event_vector) = 0;
589 smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
592 n_events = vec_len (my_fifo_events);
593 for (i = 0; i < n_events; i++)
595 stream_session_t *s0; /* $$$ prefetch 1 ahead maybe */
596 session_fifo_event_t *e0;
598 e0 = &my_fifo_events[i];
600 switch (e0->event_type)
602 case FIFO_EVENT_APP_TX:
603 s0 = session_event_get_session (e0, my_thread_index);
605 if (CLIB_DEBUG && !s0)
607 clib_warning ("It's dead, Jim!");
611 if (PREDICT_FALSE (s0->session_state == SESSION_STATE_CLOSED))
613 /* Spray packets in per session type frames, since they go to
615 rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
619 if (PREDICT_FALSE (rv < 0))
621 vlib_node_increment_counter (vm, node->node_index,
622 SESSION_QUEUE_ERROR_NO_BUFFER, 1);
626 case FIFO_EVENT_DISCONNECT:
627 s0 = stream_session_get_from_handle (e0->session_handle);
628 stream_session_disconnect (s0);
630 case FIFO_EVENT_BUILTIN_RX:
631 s0 = session_event_get_session (e0, my_thread_index);
632 svm_fifo_unset_event (s0->server_rx_fifo);
633 app = application_get (s0->app_index);
634 app->cb_fns.builtin_server_rx_callback (s0);
637 fp = e0->rpc_args.fp;
638 (*fp) (e0->rpc_args.arg);
642 clib_warning ("unhandled event type %d", e0->event_type);
646 _vec_len (my_fifo_events) = 0;
647 smm->free_event_vector[my_thread_index] = my_fifo_events;
649 vlib_node_increment_counter (vm, session_queue_node.index,
650 SESSION_QUEUE_ERROR_TX, n_tx_packets);
652 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
658 VLIB_REGISTER_NODE (session_queue_node) =
660 .function = session_queue_node_fn,
661 .name = "session-queue",
662 .format_trace = format_session_queue_trace,
663 .type = VLIB_NODE_TYPE_INPUT,
664 .n_errors = ARRAY_LEN (session_queue_error_strings),
665 .error_strings = session_queue_error_strings,
666 .n_next_nodes = SESSION_QUEUE_N_NEXT,
667 .state = VLIB_NODE_STATE_DISABLED,
670 [SESSION_QUEUE_NEXT_DROP] = "error-drop",
671 [SESSION_QUEUE_NEXT_IP4_LOOKUP] = "ip4-lookup",
672 [SESSION_QUEUE_NEXT_IP6_LOOKUP] = "ip6-lookup",
673 [SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT] = "tcp4-output",
674 [SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT] = "tcp6-output",
680 * fd.io coding-style-patch-verification: ON
683 * eval: (c-set-style "gnu")