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")
54 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
55 foreach_session_queue_error
57 SESSION_QUEUE_N_ERROR,
58 } session_queue_error_t;
60 static char *session_queue_error_strings[] = {
61 #define _(sym,string) string,
62 foreach_session_queue_error
66 static u32 session_type_to_next[] = {
67 SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT,
68 SESSION_QUEUE_NEXT_IP4_LOOKUP,
69 SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT,
70 SESSION_QUEUE_NEXT_IP6_LOOKUP,
74 session_tx_fifo_chain_tail (session_manager_main_t * smm, vlib_main_t * vm,
75 u8 thread_index, svm_fifo_t * fifo,
76 vlib_buffer_t * b0, u32 bi0, u8 n_bufs_per_seg,
77 u32 * left_to_snd0, u16 * n_bufs, u32 * rx_offset,
78 u16 deq_per_buf, u8 peek_data)
80 vlib_buffer_t *chain_b0, *prev_b0;
82 u16 len_to_deq0, n_bytes_read;
87 for (j = 1; j < n_bufs_per_seg; j++)
90 len_to_deq0 = clib_min (*left_to_snd0, deq_per_buf);
93 chain_bi0 = smm->tx_buffers[thread_index][*n_bufs];
94 _vec_len (smm->tx_buffers[thread_index]) = *n_bufs;
96 chain_b0 = vlib_get_buffer (vm, chain_bi0);
97 chain_b0->current_data = 0;
98 data0 = vlib_buffer_get_current (chain_b0);
101 n_bytes_read = svm_fifo_peek (fifo, *rx_offset, len_to_deq0, data0);
102 *rx_offset += n_bytes_read;
106 n_bytes_read = svm_fifo_dequeue_nowait (fifo, len_to_deq0, data0);
108 ASSERT (n_bytes_read == len_to_deq0);
109 chain_b0->current_length = n_bytes_read;
110 b0->total_length_not_including_first_buffer += chain_b0->current_length;
112 /* update previous buffer */
113 prev_b0->next_buffer = chain_bi0;
114 prev_b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
116 /* update current buffer */
117 chain_b0->next_buffer = 0;
119 *left_to_snd0 -= n_bytes_read;
120 if (*left_to_snd0 == 0)
126 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
127 session_manager_main_t * smm,
128 session_fifo_event_t * e0,
129 stream_session_t * s0, u32 thread_index,
130 int *n_tx_packets, u8 peek_data)
132 u32 n_trace = vlib_get_trace_count (vm, node);
133 u32 left_to_snd0, max_len_to_snd0, len_to_deq0, snd_space0;
134 u32 n_bufs_per_evt, n_frames_per_evt;
135 transport_connection_t *tc0;
136 transport_proto_vft_t *transport_vft;
137 u32 next_index, next0, *to_next, n_left_to_next, bi0;
139 u32 rx_offset = 0, max_dequeue0, n_bytes_per_seg;
140 u16 snd_mss0, n_bufs_per_seg, n_bufs;
143 u32 n_bytes_per_buf, deq_per_buf;
145 next_index = next0 = session_type_to_next[s0->session_type];
147 transport_vft = session_get_transport_vft (s0->session_type);
148 tc0 = transport_vft->get_connection (s0->connection_index, thread_index);
150 /* Make sure we have space to send and there's something to dequeue */
151 snd_mss0 = transport_vft->send_mss (tc0);
152 snd_space0 = transport_vft->send_space (tc0);
154 /* Can't make any progress */
155 if (snd_space0 == 0 || snd_mss0 == 0)
157 vec_add1 (smm->pending_event_vector[thread_index], *e0);
163 /* Offset in rx fifo from where to peek data */
164 rx_offset = transport_vft->tx_fifo_offset (tc0);
167 /* Check how much we can pull. If buffering, subtract the offset */
168 max_dequeue0 = svm_fifo_max_dequeue (s0->server_tx_fifo) - rx_offset;
170 /* Allow enqueuing of a new event */
171 svm_fifo_unset_event (s0->server_tx_fifo);
173 /* Nothing to read return */
174 if (max_dequeue0 == 0)
177 /* Ensure we're not writing more than transport window allows */
178 if (max_dequeue0 < snd_space0)
180 /* Constrained by tx queue. Try to send only fully formed segments */
181 max_len_to_snd0 = (max_dequeue0 > snd_mss0) ?
182 max_dequeue0 - max_dequeue0 % snd_mss0 : max_dequeue0;
187 max_len_to_snd0 = snd_space0;
190 n_bytes_per_buf = vlib_buffer_free_list_buffer_size (vm,
191 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
192 n_bytes_per_seg = MAX_HDRS_LEN + snd_mss0;
193 n_bufs_per_seg = ceil ((double) n_bytes_per_seg / n_bytes_per_buf);
194 n_bufs_per_evt = (ceil ((double) max_len_to_snd0 / n_bytes_per_seg))
196 n_frames_per_evt = ceil ((double) n_bufs_per_evt / VLIB_FRAME_SIZE);
198 deq_per_buf = clib_min (snd_mss0, n_bytes_per_buf);
200 n_bufs = vec_len (smm->tx_buffers[thread_index]);
201 left_to_snd0 = max_len_to_snd0;
202 for (i = 0; i < n_frames_per_evt; i++)
204 /* Make sure we have at least one full frame of buffers ready */
205 if (PREDICT_FALSE (n_bufs < VLIB_FRAME_SIZE))
207 vec_validate (smm->tx_buffers[thread_index],
208 n_bufs + VLIB_FRAME_SIZE - 1);
209 n_bufs += vlib_buffer_alloc (vm,
210 &smm->tx_buffers[thread_index][n_bufs],
214 * XXX 0.9 because when debugging we might not get a full frame */
215 if (PREDICT_FALSE (n_bufs < 0.9 * VLIB_FRAME_SIZE))
217 if (svm_fifo_set_event (s0->server_tx_fifo))
219 vec_add1 (smm->pending_event_vector[thread_index], *e0);
224 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
227 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
228 while (left_to_snd0 && n_left_to_next >= n_bufs_per_seg)
231 * Handle first buffer in chain separately
234 /* Get free buffer */
235 bi0 = smm->tx_buffers[thread_index][--n_bufs];
236 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
238 b0 = vlib_get_buffer (vm, bi0);
240 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID
241 | VNET_BUFFER_LOCALLY_ORIGINATED;
242 b0->current_data = 0;
243 b0->total_length_not_including_first_buffer = 0;
245 /* RX on the local interface. tx in default fib */
246 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
247 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
249 len_to_deq0 = clib_min (left_to_snd0, deq_per_buf);
251 data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
254 n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, rx_offset,
256 /* Keep track of progress locally, transport is also supposed to
257 * increment it independently when pushing the header */
258 rx_offset += n_bytes_read;
262 n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
266 if (n_bytes_read <= 0)
269 b0->current_length = n_bytes_read;
271 left_to_snd0 -= n_bytes_read;
272 *n_tx_packets = *n_tx_packets + 1;
275 * Fill in the remaining buffers in the chain, if any
277 if (PREDICT_FALSE (n_bufs_per_seg > 1))
278 session_tx_fifo_chain_tail (smm, vm, thread_index,
279 s0->server_tx_fifo, b0, bi0,
280 n_bufs_per_seg, &left_to_snd0,
281 &n_bufs, &rx_offset, deq_per_buf,
284 /* Ask transport to push header after current_length and
285 * total_length_not_including_first_buffer are updated */
286 transport_vft->push_header (tc0, b0);
289 SESSION_EVT_DBG(SESSION_EVT_DEQ, s0, ({
290 ed->data[0] = e0->event_id;
291 ed->data[1] = max_dequeue0;
292 ed->data[2] = len_to_deq0;
293 ed->data[3] = left_to_snd0;
297 /* usual speculation, or the enqueue_x1 macro will barf */
302 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
303 if (PREDICT_FALSE (n_trace > 0))
305 session_queue_trace_t *t0;
306 vlib_trace_buffer (vm, node, next_index, b0,
307 1 /* follow_chain */ );
308 vlib_set_trace_count (vm, node, --n_trace);
309 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
310 t0->session_index = s0->session_index;
311 t0->server_thread_index = s0->thread_index;
314 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
315 to_next, n_left_to_next,
318 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
321 /* If we couldn't dequeue all bytes mark as partially read */
322 if (max_len_to_snd0 < max_dequeue0)
324 /* If we don't already have new event */
325 if (svm_fifo_set_event (s0->server_tx_fifo))
327 vec_add1 (smm->pending_event_vector[thread_index], *e0);
334 * Can't read from fifo. If we don't already have an event, save as partially
335 * read, return buff to free list and return
337 clib_warning ("dequeue fail");
339 if (svm_fifo_set_event (s0->server_tx_fifo))
341 vec_add1 (smm->pending_event_vector[thread_index], *e0);
343 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
344 _vec_len (smm->tx_buffers[thread_index]) += 1;
350 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
351 session_manager_main_t * smm,
352 session_fifo_event_t * e0,
353 stream_session_t * s0, u32 thread_index,
356 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
361 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
362 session_manager_main_t * smm,
363 session_fifo_event_t * e0,
364 stream_session_t * s0, u32 thread_index,
367 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
372 session_event_get_session (session_fifo_event_t * e0, u8 thread_index)
375 stream_session_t *s0;
379 session_index0 = f0->master_session_index;
381 /* $$$ add multiple event queues, per vpp worker thread */
382 ASSERT (f0->master_thread_index == thread_index);
384 s0 = stream_session_get_if_valid (session_index0, thread_index);
386 ASSERT (s0->thread_index == thread_index);
392 dump_thread_0_event_queue (void)
394 session_manager_main_t *smm = vnet_get_session_manager_main ();
395 vlib_main_t *vm = &vlib_global_main;
396 u32 my_thread_index = vm->thread_index;
397 session_fifo_event_t _e, *e = &_e;
398 stream_session_t *s0;
402 unix_shared_memory_queue_t *q;
403 q = smm->vpp_event_queues[my_thread_index];
407 for (i = 0; i < q->cursize; i++)
409 headp = (i8 *) (&q->data[0] + q->elsize * index);
410 clib_memcpy (e, headp, q->elsize);
412 switch (e->event_type)
414 case FIFO_EVENT_APP_TX:
415 s0 = session_event_get_session (e, my_thread_index);
416 fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
419 case FIFO_EVENT_DISCONNECT:
420 s0 = stream_session_get_from_handle (e->session_handle);
421 fformat (stdout, "[%04d] disconnect session %d\n", i,
425 case FIFO_EVENT_BUILTIN_RX:
426 s0 = session_event_get_session (e, my_thread_index);
427 fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
431 fformat (stdout, "[%04d] RPC call %llx with %llx\n",
432 i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
436 fformat (stdout, "[%04d] unhandled event type %d\n",
443 if (index == q->maxsize)
449 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
450 vlib_frame_t * frame)
452 session_manager_main_t *smm = vnet_get_session_manager_main ();
453 session_fifo_event_t *my_pending_event_vector, *e;
454 session_fifo_event_t *my_fifo_events;
455 u32 n_to_dequeue, n_events;
456 unix_shared_memory_queue_t *q;
458 int n_tx_packets = 0;
459 u32 my_thread_index = vm->thread_index;
461 f64 now = vlib_time_now (vm);
464 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
469 tcp_update_time (now, my_thread_index);
472 * Get vpp queue events
474 q = smm->vpp_event_queues[my_thread_index];
475 if (PREDICT_FALSE (q == 0))
478 my_fifo_events = smm->free_event_vector[my_thread_index];
480 /* min number of events we can dequeue without blocking */
481 n_to_dequeue = q->cursize;
482 my_pending_event_vector = smm->pending_event_vector[my_thread_index];
484 if (n_to_dequeue == 0 && vec_len (my_pending_event_vector) == 0)
487 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
490 * If we didn't manage to process previous events try going
491 * over them again without dequeuing new ones.
493 /* XXX: Block senders to sessions that can't keep up */
494 if (0 && vec_len (my_pending_event_vector) >= 100)
496 clib_warning ("too many fifo events unsolved");
500 /* See you in the next life, don't be late */
501 if (pthread_mutex_trylock (&q->mutex))
504 for (i = 0; i < n_to_dequeue; i++)
506 vec_add2 (my_fifo_events, e, 1);
507 unix_shared_memory_queue_sub_raw (q, (u8 *) e);
510 /* The other side of the connection is not polling */
511 if (q->cursize < (q->maxsize / 8))
512 (void) pthread_cond_broadcast (&q->condvar);
513 pthread_mutex_unlock (&q->mutex);
515 vec_append (my_fifo_events, my_pending_event_vector);
517 _vec_len (my_pending_event_vector) = 0;
518 smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
521 n_events = vec_len (my_fifo_events);
522 for (i = 0; i < n_events; i++)
524 stream_session_t *s0; /* $$$ prefetch 1 ahead maybe */
525 session_fifo_event_t *e0;
527 e0 = &my_fifo_events[i];
529 switch (e0->event_type)
531 case FIFO_EVENT_APP_TX:
532 s0 = session_event_get_session (e0, my_thread_index);
534 if (CLIB_DEBUG && !s0)
536 clib_warning ("It's dead, Jim!");
540 if (PREDICT_FALSE (s0->session_state == SESSION_STATE_CLOSED))
542 /* Spray packets in per session type frames, since they go to
544 rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
550 vec_add1 (smm->pending_event_vector[my_thread_index], *e0);
554 case FIFO_EVENT_DISCONNECT:
555 s0 = stream_session_get_from_handle (e0->session_handle);
556 stream_session_disconnect (s0);
558 case FIFO_EVENT_BUILTIN_RX:
559 s0 = session_event_get_session (e0, my_thread_index);
560 svm_fifo_unset_event (s0->server_rx_fifo);
561 /* Get session's server */
562 app = application_get (s0->app_index);
563 app->cb_fns.builtin_server_rx_callback (s0);
566 fp = e0->rpc_args.fp;
567 (*fp) (e0->rpc_args.arg);
571 clib_warning ("unhandled event type %d", e0->event_type);
575 _vec_len (my_fifo_events) = 0;
576 smm->free_event_vector[my_thread_index] = my_fifo_events;
578 vlib_node_increment_counter (vm, session_queue_node.index,
579 SESSION_QUEUE_ERROR_TX, n_tx_packets);
581 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
587 VLIB_REGISTER_NODE (session_queue_node) =
589 .function = session_queue_node_fn,
590 .name = "session-queue",
591 .format_trace = format_session_queue_trace,
592 .type = VLIB_NODE_TYPE_INPUT,
593 .n_errors = ARRAY_LEN (session_queue_error_strings),
594 .error_strings = session_queue_error_strings,
595 .n_next_nodes = SESSION_QUEUE_N_NEXT,
596 .state = VLIB_NODE_STATE_DISABLED,
599 [SESSION_QUEUE_NEXT_DROP] = "error-drop",
600 [SESSION_QUEUE_NEXT_IP4_LOOKUP] = "ip4-lookup",
601 [SESSION_QUEUE_NEXT_IP6_LOOKUP] = "ip6-lookup",
602 [SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT] = "tcp4-output",
603 [SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT] = "tcp6-output",
609 * fd.io coding-style-patch-verification: ON
612 * eval: (c-set-style "gnu")