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_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
75 session_manager_main_t * smm,
76 session_fifo_event_t * e0,
77 stream_session_t * s0, u32 thread_index,
78 int *n_tx_packets, u8 peek_data)
80 u32 n_trace = vlib_get_trace_count (vm, node);
81 u32 left_to_snd0, max_len_to_snd0, len_to_deq0, n_bufs, snd_space0;
82 u32 n_frame_bytes, n_frames_per_evt;
83 transport_connection_t *tc0;
84 transport_proto_vft_t *transport_vft;
85 u32 next_index, next0, *to_next, n_left_to_next, bi0;
87 u32 rx_offset = 0, max_dequeue0;
92 next_index = next0 = session_type_to_next[s0->session_type];
94 transport_vft = session_get_transport_vft (s0->session_type);
95 tc0 = transport_vft->get_connection (s0->connection_index, thread_index);
97 /* Make sure we have space to send and there's something to dequeue */
98 snd_space0 = transport_vft->send_space (tc0);
99 snd_mss0 = transport_vft->send_mss (tc0);
101 /* Can't make any progress */
102 if (snd_space0 == 0 || snd_mss0 == 0)
104 vec_add1 (smm->evts_partially_read[thread_index], *e0);
110 /* Offset in rx fifo from where to peek data */
111 rx_offset = transport_vft->tx_fifo_offset (tc0);
114 /* Check how much we can pull. If buffering, subtract the offset */
115 max_dequeue0 = svm_fifo_max_dequeue (s0->server_tx_fifo) - rx_offset;
117 /* Allow enqueuing of a new event */
118 svm_fifo_unset_event (s0->server_tx_fifo);
120 /* Nothing to read return */
121 if (max_dequeue0 == 0)
124 /* Ensure we're not writing more than transport window allows */
125 if (max_dequeue0 < snd_space0)
127 /* Constrained by tx queue. Try to send only fully formed segments */
128 max_len_to_snd0 = (max_dequeue0 > snd_mss0) ?
129 max_dequeue0 - max_dequeue0 % snd_mss0 : max_dequeue0;
134 max_len_to_snd0 = snd_space0;
137 n_frame_bytes = snd_mss0 * VLIB_FRAME_SIZE;
138 n_frames_per_evt = ceil ((double) max_len_to_snd0 / n_frame_bytes);
140 n_bufs = vec_len (smm->tx_buffers[thread_index]);
141 left_to_snd0 = max_len_to_snd0;
142 for (i = 0; i < n_frames_per_evt; i++)
144 /* Make sure we have at least one full frame of buffers ready */
145 if (PREDICT_FALSE (n_bufs < VLIB_FRAME_SIZE))
147 vec_validate (smm->tx_buffers[thread_index],
148 n_bufs + VLIB_FRAME_SIZE - 1);
150 vlib_buffer_alloc (vm, &smm->tx_buffers[thread_index][n_bufs],
154 * XXX 0.9 because when debugging we might not get a full frame */
155 if (PREDICT_FALSE (n_bufs < 0.9 * VLIB_FRAME_SIZE))
157 if (svm_fifo_set_event (s0->server_tx_fifo))
159 vec_add1 (smm->evts_partially_read[thread_index], *e0);
164 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
167 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
168 while (left_to_snd0 && n_left_to_next)
170 /* Get free buffer */
172 bi0 = smm->tx_buffers[thread_index][n_bufs];
173 _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
175 b0 = vlib_get_buffer (vm, bi0);
177 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID
178 | VNET_BUFFER_LOCALLY_ORIGINATED;
179 b0->current_data = 0;
181 /* RX on the local interface. tx in default fib */
182 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
183 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
185 /* usual speculation, or the enqueue_x1 macro will barf */
190 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
191 if (PREDICT_FALSE (n_trace > 0))
193 session_queue_trace_t *t0;
194 vlib_trace_buffer (vm, node, next_index, b0,
195 1 /* follow_chain */ );
196 vlib_set_trace_count (vm, node, --n_trace);
197 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
198 t0->session_index = s0->session_index;
199 t0->server_thread_index = s0->thread_index;
202 len_to_deq0 = (left_to_snd0 < snd_mss0) ? left_to_snd0 : snd_mss0;
205 SESSION_EVT_DBG(SESSION_EVT_DEQ, s0, ({
206 ed->data[0] = e0->event_id;
207 ed->data[1] = max_dequeue0;
208 ed->data[2] = len_to_deq0;
209 ed->data[3] = left_to_snd0;
213 /* Make room for headers */
214 data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
217 * TODO 1) peek instead of dequeue
218 * 2) buffer chains */
221 n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, s0->pid,
222 rx_offset, len_to_deq0, data0);
223 if (n_bytes_read <= 0)
226 /* Keep track of progress locally, transport is also supposed to
227 * increment it independently when pushing the header */
228 rx_offset += n_bytes_read;
232 n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
233 s0->pid, len_to_deq0,
235 if (n_bytes_read <= 0)
239 b0->current_length = n_bytes_read;
241 /* Ask transport to push header */
242 transport_vft->push_header (tc0, b0);
244 left_to_snd0 -= n_bytes_read;
245 *n_tx_packets = *n_tx_packets + 1;
247 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
248 to_next, n_left_to_next,
251 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
254 /* If we couldn't dequeue all bytes mark as partially read */
255 if (max_len_to_snd0 < max_dequeue0)
257 /* If we don't already have new event */
258 if (svm_fifo_set_event (s0->server_tx_fifo))
260 vec_add1 (smm->evts_partially_read[thread_index], *e0);
267 * Can't read from fifo. If we don't already have an event, save as partially
268 * read, return buff to free list and return
270 clib_warning ("dequeue fail");
272 if (svm_fifo_set_event (s0->server_tx_fifo))
274 vec_add1 (smm->evts_partially_read[thread_index], *e0);
276 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
277 _vec_len (smm->tx_buffers[thread_index]) += 1;
283 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
284 session_manager_main_t * smm,
285 session_fifo_event_t * e0,
286 stream_session_t * s0, u32 thread_index,
289 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
294 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
295 session_manager_main_t * smm,
296 session_fifo_event_t * e0,
297 stream_session_t * s0, u32 thread_index,
300 return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
305 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
306 vlib_frame_t * frame)
308 session_manager_main_t *smm = vnet_get_session_manager_main ();
309 session_fifo_event_t *my_fifo_events, *e;
310 u32 n_to_dequeue, n_events;
311 unix_shared_memory_queue_t *q;
313 int n_tx_packets = 0;
314 u32 my_thread_index = vm->thread_index;
316 f64 now = vlib_time_now (vm);
318 SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
323 tcp_update_time (now, my_thread_index);
326 * Get vpp queue events
328 q = smm->vpp_event_queues[my_thread_index];
329 if (PREDICT_FALSE (q == 0))
332 /* min number of events we can dequeue without blocking */
333 n_to_dequeue = q->cursize;
334 my_fifo_events = smm->fifo_events[my_thread_index];
336 if (n_to_dequeue == 0 && vec_len (my_fifo_events) == 0)
339 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
342 * If we didn't manage to process previous events try going
343 * over them again without dequeuing new ones.
345 /* XXX: Block senders to sessions that can't keep up */
346 if (vec_len (my_fifo_events) >= 100)
348 clib_warning ("too many fifo events unsolved");
352 /* See you in the next life, don't be late */
353 if (pthread_mutex_trylock (&q->mutex))
356 for (i = 0; i < n_to_dequeue; i++)
358 vec_add2 (my_fifo_events, e, 1);
359 unix_shared_memory_queue_sub_raw (q, (u8 *) e);
362 /* The other side of the connection is not polling */
363 if (q->cursize < (q->maxsize / 8))
364 (void) pthread_cond_broadcast (&q->condvar);
365 pthread_mutex_unlock (&q->mutex);
367 smm->fifo_events[my_thread_index] = my_fifo_events;
370 n_events = vec_len (my_fifo_events);
371 for (i = 0; i < n_events; i++)
373 svm_fifo_t *f0; /* $$$ prefetch 1 ahead maybe */
374 stream_session_t *s0;
376 session_fifo_event_t *e0;
378 e0 = &my_fifo_events[i];
380 session_index0 = f0->server_session_index;
382 /* $$$ add multiple event queues, per vpp worker thread */
383 ASSERT (f0->server_thread_index == my_thread_index);
385 s0 = stream_session_get_if_valid (session_index0, my_thread_index);
387 if (CLIB_DEBUG && !s0)
389 clib_warning ("It's dead, Jim!");
393 if (PREDICT_FALSE (s0->session_state == SESSION_STATE_CLOSED))
396 ASSERT (s0->thread_index == my_thread_index);
398 switch (e0->event_type)
400 case FIFO_EVENT_SERVER_TX:
401 /* Spray packets in per session type frames, since they go to
403 rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
411 case FIFO_EVENT_SERVER_EXIT:
412 stream_session_disconnect (s0);
414 case FIFO_EVENT_BUILTIN_RX:
415 svm_fifo_unset_event (s0->server_rx_fifo);
416 /* Get session's server */
417 app = application_get (s0->app_index);
418 app->cb_fns.builtin_server_rx_callback (s0);
421 clib_warning ("unhandled event type %d", e0->event_type);
427 /* Couldn't process all events. Probably out of buffers */
428 if (PREDICT_FALSE (i < n_events))
430 session_fifo_event_t *partially_read =
431 smm->evts_partially_read[my_thread_index];
432 vec_add (partially_read, &my_fifo_events[i], n_events - i);
433 vec_free (my_fifo_events);
434 smm->fifo_events[my_thread_index] = partially_read;
435 smm->evts_partially_read[my_thread_index] = 0;
439 vec_free (smm->fifo_events[my_thread_index]);
440 smm->fifo_events[my_thread_index] =
441 smm->evts_partially_read[my_thread_index];
442 smm->evts_partially_read[my_thread_index] = 0;
445 vlib_node_increment_counter (vm, session_queue_node.index,
446 SESSION_QUEUE_ERROR_TX, n_tx_packets);
448 SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
454 VLIB_REGISTER_NODE (session_queue_node) =
456 .function = session_queue_node_fn,
457 .name = "session-queue",
458 .format_trace = format_session_queue_trace,
459 .type = VLIB_NODE_TYPE_INPUT,
460 .n_errors = ARRAY_LEN (session_queue_error_strings),
461 .error_strings = session_queue_error_strings,
462 .n_next_nodes = SESSION_QUEUE_N_NEXT,
463 .state = VLIB_NODE_STATE_DISABLED,
466 [SESSION_QUEUE_NEXT_DROP] = "error-drop",
467 [SESSION_QUEUE_NEXT_IP4_LOOKUP] = "ip4-lookup",
468 [SESSION_QUEUE_NEXT_IP6_LOOKUP] = "ip6-lookup",
469 [SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT] = "tcp4-output",
470 [SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT] = "tcp6-output",
476 * fd.io coding-style-patch-verification: ON
479 * eval: (c-set-style "gnu")