VPP-846: tcp perf / scale / hardening
[vpp.git] / src / vnet / session / node.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #include <math.h>
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>
24
25 vlib_node_registration_t session_queue_node;
26
27 typedef struct
28 {
29   u32 session_index;
30   u32 server_thread_index;
31 } session_queue_trace_t;
32
33 /* packet trace format function */
34 static u8 *
35 format_session_queue_trace (u8 * s, va_list * args)
36 {
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 *);
40
41   s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
42               t->session_index, t->server_thread_index);
43   return s;
44 }
45
46 vlib_node_registration_t session_queue_node;
47
48 #define foreach_session_queue_error             \
49 _(TX, "Packets transmitted")                    \
50 _(TIMER, "Timer events")
51
52 typedef enum
53 {
54 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
55   foreach_session_queue_error
56 #undef _
57     SESSION_QUEUE_N_ERROR,
58 } session_queue_error_t;
59
60 static char *session_queue_error_strings[] = {
61 #define _(sym,string) string,
62   foreach_session_queue_error
63 #undef _
64 };
65
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,
71 };
72
73 always_inline void
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)
79 {
80   vlib_buffer_t *chain_b0, *prev_b0;
81   u32 chain_bi0;
82   u16 len_to_deq0, n_bytes_read;
83   u8 *data0, j;
84
85   chain_bi0 = bi0;
86   chain_b0 = b0;
87   for (j = 1; j < n_bufs_per_seg; j++)
88     {
89       prev_b0 = chain_b0;
90       len_to_deq0 = clib_min (*left_to_snd0, deq_per_buf);
91
92       *n_bufs -= 1;
93       chain_bi0 = smm->tx_buffers[thread_index][*n_bufs];
94       _vec_len (smm->tx_buffers[thread_index]) = *n_bufs;
95
96       chain_b0 = vlib_get_buffer (vm, chain_bi0);
97       chain_b0->current_data = 0;
98       data0 = vlib_buffer_get_current (chain_b0);
99       if (peek_data)
100         {
101           n_bytes_read = svm_fifo_peek (fifo, *rx_offset, len_to_deq0, data0);
102           *rx_offset += n_bytes_read;
103         }
104       else
105         {
106           n_bytes_read = svm_fifo_dequeue_nowait (fifo, len_to_deq0, data0);
107         }
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;
111
112       /* update previous buffer */
113       prev_b0->next_buffer = chain_bi0;
114       prev_b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
115
116       /* update current buffer */
117       chain_b0->next_buffer = 0;
118
119       *left_to_snd0 -= n_bytes_read;
120       if (*left_to_snd0 == 0)
121         break;
122     }
123 }
124
125 always_inline int
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)
131 {
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;
138   vlib_buffer_t *b0;
139   u32 rx_offset = 0, max_dequeue0, n_bytes_per_seg;
140   u16 snd_mss0, n_bufs_per_seg, n_bufs;
141   u8 *data0;
142   int i, n_bytes_read;
143   u32 n_bytes_per_buf, deq_per_buf;
144
145   next_index = next0 = session_type_to_next[s0->session_type];
146
147   transport_vft = session_get_transport_vft (s0->session_type);
148   tc0 = transport_vft->get_connection (s0->connection_index, thread_index);
149
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);
153
154   /* Can't make any progress */
155   if (snd_space0 == 0 || snd_mss0 == 0)
156     {
157       vec_add1 (smm->pending_event_vector[thread_index], *e0);
158       return 0;
159     }
160
161   if (peek_data)
162     {
163       /* Offset in rx fifo from where to peek data  */
164       rx_offset = transport_vft->tx_fifo_offset (tc0);
165     }
166
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;
169
170   /* Allow enqueuing of a new event */
171   svm_fifo_unset_event (s0->server_tx_fifo);
172
173   /* Nothing to read return */
174   if (max_dequeue0 == 0)
175     return 0;
176
177   /* Ensure we're not writing more than transport window allows */
178   if (max_dequeue0 < snd_space0)
179     {
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;
183       /* TODO Nagle ? */
184     }
185   else
186     {
187       max_len_to_snd0 = snd_space0;
188     }
189
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))
195     * n_bufs_per_seg;
196   n_frames_per_evt = ceil ((double) n_bufs_per_evt / VLIB_FRAME_SIZE);
197
198   deq_per_buf = clib_min (snd_mss0, n_bytes_per_buf);
199
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++)
203     {
204       /* Make sure we have at least one full frame of buffers ready */
205       if (PREDICT_FALSE (n_bufs < VLIB_FRAME_SIZE))
206         {
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],
211                                        VLIB_FRAME_SIZE);
212
213           /* buffer shortage
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))
216             {
217               if (svm_fifo_set_event (s0->server_tx_fifo))
218                 {
219                   vec_add1 (smm->pending_event_vector[thread_index], *e0);
220                 }
221               return -1;
222             }
223
224           _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
225         }
226
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)
229         {
230           /*
231            * Handle first buffer in chain separately
232            */
233
234           /* Get free buffer */
235           bi0 = smm->tx_buffers[thread_index][--n_bufs];
236           _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
237
238           b0 = vlib_get_buffer (vm, bi0);
239           b0->error = 0;
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;
244
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;
248
249           len_to_deq0 = clib_min (left_to_snd0, deq_per_buf);
250
251           data0 = vlib_buffer_make_headroom (b0, MAX_HDRS_LEN);
252           if (peek_data)
253             {
254               n_bytes_read = svm_fifo_peek (s0->server_tx_fifo, rx_offset,
255                                             len_to_deq0, data0);
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;
259             }
260           else
261             {
262               n_bytes_read = svm_fifo_dequeue_nowait (s0->server_tx_fifo,
263                                                       len_to_deq0, data0);
264             }
265
266           if (n_bytes_read <= 0)
267             goto dequeue_fail;
268
269           b0->current_length = n_bytes_read;
270
271           left_to_snd0 -= n_bytes_read;
272           *n_tx_packets = *n_tx_packets + 1;
273
274           /*
275            * Fill in the remaining buffers in the chain, if any
276            */
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,
282                                         peek_data);
283
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);
287
288           /* *INDENT-OFF* */
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;
294           }));
295           /* *INDENT-ON* */
296
297           /* usual speculation, or the enqueue_x1 macro will barf */
298           to_next[0] = bi0;
299           to_next += 1;
300           n_left_to_next -= 1;
301
302           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
303           if (PREDICT_FALSE (n_trace > 0))
304             {
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;
312             }
313
314           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
315                                            to_next, n_left_to_next,
316                                            bi0, next0);
317         }
318       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
319     }
320
321   /* If we couldn't dequeue all bytes mark as partially read */
322   if (max_len_to_snd0 < max_dequeue0)
323     {
324       /* If we don't already have new event */
325       if (svm_fifo_set_event (s0->server_tx_fifo))
326         {
327           vec_add1 (smm->pending_event_vector[thread_index], *e0);
328         }
329     }
330   return 0;
331
332 dequeue_fail:
333   /*
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
336    */
337   clib_warning ("dequeue fail");
338
339   if (svm_fifo_set_event (s0->server_tx_fifo))
340     {
341       vec_add1 (smm->pending_event_vector[thread_index], *e0);
342     }
343   vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
344   _vec_len (smm->tx_buffers[thread_index]) += 1;
345
346   return 0;
347 }
348
349 int
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,
354                               int *n_tx_pkts)
355 {
356   return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
357                                          n_tx_pkts, 1);
358 }
359
360 int
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,
365                                  int *n_tx_pkts)
366 {
367   return session_tx_fifo_read_and_snd_i (vm, node, smm, e0, s0, thread_index,
368                                          n_tx_pkts, 0);
369 }
370
371 stream_session_t *
372 session_event_get_session (session_fifo_event_t * e0, u8 thread_index)
373 {
374   svm_fifo_t *f0;
375   stream_session_t *s0;
376   u32 session_index0;
377
378   f0 = e0->fifo;
379   session_index0 = f0->master_session_index;
380
381   /* $$$ add multiple event queues, per vpp worker thread */
382   ASSERT (f0->master_thread_index == thread_index);
383
384   s0 = stream_session_get_if_valid (session_index0, thread_index);
385
386   ASSERT (s0->thread_index == thread_index);
387
388   return s0;
389 }
390
391 void
392 dump_thread_0_event_queue (void)
393 {
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;
399   int i, index;
400   i8 *headp;
401
402   unix_shared_memory_queue_t *q;
403   q = smm->vpp_event_queues[my_thread_index];
404
405   index = q->head;
406
407   for (i = 0; i < q->cursize; i++)
408     {
409       headp = (i8 *) (&q->data[0] + q->elsize * index);
410       clib_memcpy (e, headp, q->elsize);
411
412       switch (e->event_type)
413         {
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);
417           break;
418
419         case FIFO_EVENT_DISCONNECT:
420           s0 = stream_session_get_from_handle (e->session_handle);
421           fformat (stdout, "[%04d] disconnect session %d\n", i,
422                    s0->session_index);
423           break;
424
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);
428           break;
429
430         case FIFO_EVENT_RPC:
431           fformat (stdout, "[%04d] RPC call %llx with %llx\n",
432                    i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
433           break;
434
435         default:
436           fformat (stdout, "[%04d] unhandled event type %d\n",
437                    i, e->event_type);
438           break;
439         }
440
441       index++;
442
443       if (index == q->maxsize)
444         index = 0;
445     }
446 }
447
448 static uword
449 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
450                        vlib_frame_t * frame)
451 {
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;
457   application_t *app;
458   int n_tx_packets = 0;
459   u32 my_thread_index = vm->thread_index;
460   int i, rv;
461   f64 now = vlib_time_now (vm);
462   void (*fp) (void *);
463
464   SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
465
466   /*
467    *  Update TCP time
468    */
469   tcp_update_time (now, my_thread_index);
470
471   /*
472    * Get vpp queue events
473    */
474   q = smm->vpp_event_queues[my_thread_index];
475   if (PREDICT_FALSE (q == 0))
476     return 0;
477
478   my_fifo_events = smm->free_event_vector[my_thread_index];
479
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];
483
484   if (n_to_dequeue == 0 && vec_len (my_pending_event_vector) == 0)
485     return 0;
486
487   SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
488
489   /*
490    * If we didn't manage to process previous events try going
491    * over them again without dequeuing new ones.
492    */
493   /* XXX: Block senders to sessions that can't keep up */
494   if (0 && vec_len (my_pending_event_vector) >= 100)
495     {
496       clib_warning ("too many fifo events unsolved");
497       goto skip_dequeue;
498     }
499
500   /* See you in the next life, don't be late */
501   if (pthread_mutex_trylock (&q->mutex))
502     return 0;
503
504   for (i = 0; i < n_to_dequeue; i++)
505     {
506       vec_add2 (my_fifo_events, e, 1);
507       unix_shared_memory_queue_sub_raw (q, (u8 *) e);
508     }
509
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);
514
515   vec_append (my_fifo_events, my_pending_event_vector);
516
517   _vec_len (my_pending_event_vector) = 0;
518   smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
519
520 skip_dequeue:
521   n_events = vec_len (my_fifo_events);
522   for (i = 0; i < n_events; i++)
523     {
524       stream_session_t *s0;     /* $$$ prefetch 1 ahead maybe */
525       session_fifo_event_t *e0;
526
527       e0 = &my_fifo_events[i];
528
529       switch (e0->event_type)
530         {
531         case FIFO_EVENT_APP_TX:
532           s0 = session_event_get_session (e0, my_thread_index);
533
534           if (CLIB_DEBUG && !s0)
535             {
536               clib_warning ("It's dead, Jim!");
537               continue;
538             }
539
540           if (PREDICT_FALSE (s0->session_state == SESSION_STATE_CLOSED))
541             continue;
542           /* Spray packets in per session type frames, since they go to
543            * different nodes */
544           rv = (smm->session_tx_fns[s0->session_type]) (vm, node, smm, e0, s0,
545                                                         my_thread_index,
546                                                         &n_tx_packets);
547           /* Out of buffers */
548           if (rv < 0)
549             {
550               vec_add1 (smm->pending_event_vector[my_thread_index], *e0);
551               continue;
552             }
553           break;
554         case FIFO_EVENT_DISCONNECT:
555           s0 = stream_session_get_from_handle (e0->session_handle);
556           stream_session_disconnect (s0);
557           break;
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);
564           break;
565         case FIFO_EVENT_RPC:
566           fp = e0->rpc_args.fp;
567           (*fp) (e0->rpc_args.arg);
568           break;
569
570         default:
571           clib_warning ("unhandled event type %d", e0->event_type);
572         }
573     }
574
575   _vec_len (my_fifo_events) = 0;
576   smm->free_event_vector[my_thread_index] = my_fifo_events;
577
578   vlib_node_increment_counter (vm, session_queue_node.index,
579                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
580
581   SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
582
583   return n_tx_packets;
584 }
585
586 /* *INDENT-OFF* */
587 VLIB_REGISTER_NODE (session_queue_node) =
588 {
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,
597   .next_nodes =
598   {
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",
604   },
605 };
606 /* *INDENT-ON* */
607
608 /*
609  * fd.io coding-style-patch-verification: ON
610  *
611  * Local Variables:
612  * eval: (c-set-style "gnu")
613  * End:
614  */