tcp: delivery rate estimator
[vpp.git] / src / vnet / tcp / tcp_output.c
1 /*
2  * Copyright (c) 2016-2019 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 <vnet/tcp/tcp.h>
17 #include <math.h>
18
19 typedef enum _tcp_output_next
20 {
21   TCP_OUTPUT_NEXT_DROP,
22   TCP_OUTPUT_NEXT_IP_LOOKUP,
23   TCP_OUTPUT_NEXT_IP_REWRITE,
24   TCP_OUTPUT_NEXT_IP_ARP,
25   TCP_OUTPUT_N_NEXT
26 } tcp_output_next_t;
27
28 #define foreach_tcp4_output_next                \
29   _ (DROP, "error-drop")                        \
30   _ (IP_LOOKUP, "ip4-lookup")                   \
31   _ (IP_REWRITE, "ip4-rewrite")                 \
32   _ (IP_ARP, "ip4-arp")
33
34 #define foreach_tcp6_output_next                \
35   _ (DROP, "error-drop")                        \
36   _ (IP_LOOKUP, "ip6-lookup")                   \
37   _ (IP_REWRITE, "ip6-rewrite")                 \
38   _ (IP_ARP, "ip6-discover-neighbor")
39
40 static char *tcp_error_strings[] = {
41 #define tcp_error(n,s) s,
42 #include <vnet/tcp/tcp_error.def>
43 #undef tcp_error
44 };
45
46 typedef struct
47 {
48   tcp_header_t tcp_header;
49   tcp_connection_t tcp_connection;
50 } tcp_tx_trace_t;
51
52 static u8 *
53 format_tcp_tx_trace (u8 * s, va_list * args)
54 {
55   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
56   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
57   tcp_tx_trace_t *t = va_arg (*args, tcp_tx_trace_t *);
58   u32 indent = format_get_indent (s);
59
60   s = format (s, "%U\n%U%U",
61               format_tcp_header, &t->tcp_header, 128,
62               format_white_space, indent,
63               format_tcp_connection, &t->tcp_connection, 1);
64
65   return s;
66 }
67
68 #ifndef CLIB_MARCH_VARIANT
69 static u8
70 tcp_window_compute_scale (u32 window)
71 {
72   u8 wnd_scale = 0;
73   while (wnd_scale < TCP_MAX_WND_SCALE && (window >> wnd_scale) > TCP_WND_MAX)
74     wnd_scale++;
75   return wnd_scale;
76 }
77
78 /**
79  * Update max segment size we're able to process.
80  *
81  * The value is constrained by our interface's MTU and IP options. It is
82  * also what we advertise to our peer.
83  */
84 void
85 tcp_update_rcv_mss (tcp_connection_t * tc)
86 {
87   /* TODO find our iface MTU */
88   tc->mss = tcp_main.default_mtu - sizeof (tcp_header_t);
89 }
90
91 /**
92  * TCP's initial window
93  */
94 always_inline u32
95 tcp_initial_wnd_unscaled (tcp_connection_t * tc)
96 {
97   /* RFC 6928 recommends the value lower. However at the time our connections
98    * are initialized, fifos may not be allocated. Therefore, advertise the
99    * smallest possible unscaled window size and update once fifos are
100    * assigned to the session.
101    */
102   /*
103      tcp_update_rcv_mss (tc);
104      TCP_IW_N_SEGMENTS * tc->mss;
105    */
106   return TCP_MIN_RX_FIFO_SIZE;
107 }
108
109 /**
110  * Compute initial window and scale factor. As per RFC1323, window field in
111  * SYN and SYN-ACK segments is never scaled.
112  */
113 u32
114 tcp_initial_window_to_advertise (tcp_connection_t * tc)
115 {
116   tcp_main_t *tm = &tcp_main;
117   u32 max_fifo;
118
119   /* Initial wnd for SYN. Fifos are not allocated yet.
120    * Use some predefined value. For SYN-ACK we still want the
121    * scale to be computed in the same way */
122   max_fifo = tm->max_rx_fifo ? tm->max_rx_fifo : TCP_MAX_RX_FIFO_SIZE;
123
124   /* Compute rcv wscale only if peer advertised support for it */
125   if (tc->state != TCP_STATE_SYN_RCVD || tcp_opts_wscale (&tc->rcv_opts))
126     tc->rcv_wscale = tcp_window_compute_scale (max_fifo);
127
128   tc->rcv_wnd = tcp_initial_wnd_unscaled (tc);
129
130   return clib_min (tc->rcv_wnd, TCP_WND_MAX);
131 }
132
133 static inline void
134 tcp_update_rcv_wnd (tcp_connection_t * tc)
135 {
136   u32 available_space, wnd;
137   i32 observed_wnd;
138
139   ASSERT (tc->rcv_opts.mss < transport_rx_fifo_size (&tc->connection));
140
141   /*
142    * Figure out how much space we have available
143    */
144   available_space = transport_max_rx_enqueue (&tc->connection);
145   if (PREDICT_FALSE (available_space < tc->rcv_opts.mss))
146     available_space = 0;
147
148   /*
149    * Use the above and what we know about what we've previously advertised
150    * to compute the new window
151    */
152   observed_wnd = (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
153
154   /* Bad. Thou shalt not shrink */
155   if (PREDICT_FALSE ((i32) available_space < observed_wnd))
156     {
157       wnd = clib_max (observed_wnd, 0);
158       TCP_EVT_DBG (TCP_EVT_RCV_WND_SHRUNK, tc, observed_wnd, available_space);
159     }
160   else
161     {
162       wnd = available_space;
163     }
164
165   /* Make sure we have a multiple of rcv_wscale */
166   if (wnd && tc->rcv_wscale)
167     {
168       wnd &= ~((1 << tc->rcv_wscale) - 1);
169       if (wnd == 0)
170         wnd = 1 << tc->rcv_wscale;
171     }
172
173   tc->rcv_wnd = clib_min (wnd, TCP_WND_MAX << tc->rcv_wscale);
174 }
175
176 /**
177  * Compute and return window to advertise, scaled as per RFC1323
178  */
179 static inline u32
180 tcp_window_to_advertise (tcp_connection_t * tc, tcp_state_t state)
181 {
182   if (state < TCP_STATE_ESTABLISHED)
183     return tcp_initial_window_to_advertise (tc);
184
185   tcp_update_rcv_wnd (tc);
186   return tc->rcv_wnd >> tc->rcv_wscale;
187 }
188
189 /**
190  * Write TCP options to segment.
191  */
192 static u32
193 tcp_options_write (u8 * data, tcp_options_t * opts)
194 {
195   u32 opts_len = 0;
196   u32 buf, seq_len = 4;
197
198   if (tcp_opts_mss (opts))
199     {
200       *data++ = TCP_OPTION_MSS;
201       *data++ = TCP_OPTION_LEN_MSS;
202       buf = clib_host_to_net_u16 (opts->mss);
203       clib_memcpy_fast (data, &buf, sizeof (opts->mss));
204       data += sizeof (opts->mss);
205       opts_len += TCP_OPTION_LEN_MSS;
206     }
207
208   if (tcp_opts_wscale (opts))
209     {
210       *data++ = TCP_OPTION_WINDOW_SCALE;
211       *data++ = TCP_OPTION_LEN_WINDOW_SCALE;
212       *data++ = opts->wscale;
213       opts_len += TCP_OPTION_LEN_WINDOW_SCALE;
214     }
215
216   if (tcp_opts_sack_permitted (opts))
217     {
218       *data++ = TCP_OPTION_SACK_PERMITTED;
219       *data++ = TCP_OPTION_LEN_SACK_PERMITTED;
220       opts_len += TCP_OPTION_LEN_SACK_PERMITTED;
221     }
222
223   if (tcp_opts_tstamp (opts))
224     {
225       *data++ = TCP_OPTION_TIMESTAMP;
226       *data++ = TCP_OPTION_LEN_TIMESTAMP;
227       buf = clib_host_to_net_u32 (opts->tsval);
228       clib_memcpy_fast (data, &buf, sizeof (opts->tsval));
229       data += sizeof (opts->tsval);
230       buf = clib_host_to_net_u32 (opts->tsecr);
231       clib_memcpy_fast (data, &buf, sizeof (opts->tsecr));
232       data += sizeof (opts->tsecr);
233       opts_len += TCP_OPTION_LEN_TIMESTAMP;
234     }
235
236   if (tcp_opts_sack (opts))
237     {
238       int i;
239
240       if (opts->n_sack_blocks != 0)
241         {
242           *data++ = TCP_OPTION_SACK_BLOCK;
243           *data++ = 2 + opts->n_sack_blocks * TCP_OPTION_LEN_SACK_BLOCK;
244           for (i = 0; i < opts->n_sack_blocks; i++)
245             {
246               buf = clib_host_to_net_u32 (opts->sacks[i].start);
247               clib_memcpy_fast (data, &buf, seq_len);
248               data += seq_len;
249               buf = clib_host_to_net_u32 (opts->sacks[i].end);
250               clib_memcpy_fast (data, &buf, seq_len);
251               data += seq_len;
252             }
253           opts_len += 2 + opts->n_sack_blocks * TCP_OPTION_LEN_SACK_BLOCK;
254         }
255     }
256
257   /* Terminate TCP options */
258   if (opts_len % 4)
259     {
260       *data++ = TCP_OPTION_EOL;
261       opts_len += TCP_OPTION_LEN_EOL;
262     }
263
264   /* Pad with zeroes to a u32 boundary */
265   while (opts_len % 4)
266     {
267       *data++ = TCP_OPTION_NOOP;
268       opts_len += TCP_OPTION_LEN_NOOP;
269     }
270   return opts_len;
271 }
272
273 static int
274 tcp_make_syn_options (tcp_options_t * opts, u8 wnd_scale)
275 {
276   u8 len = 0;
277
278   opts->flags |= TCP_OPTS_FLAG_MSS;
279   opts->mss = tcp_main.default_mtu;     /*XXX discover that */
280   len += TCP_OPTION_LEN_MSS;
281
282   opts->flags |= TCP_OPTS_FLAG_WSCALE;
283   opts->wscale = wnd_scale;
284   len += TCP_OPTION_LEN_WINDOW_SCALE;
285
286   opts->flags |= TCP_OPTS_FLAG_TSTAMP;
287   opts->tsval = tcp_time_now ();
288   opts->tsecr = 0;
289   len += TCP_OPTION_LEN_TIMESTAMP;
290
291   if (TCP_USE_SACKS)
292     {
293       opts->flags |= TCP_OPTS_FLAG_SACK_PERMITTED;
294       len += TCP_OPTION_LEN_SACK_PERMITTED;
295     }
296
297   /* Align to needed boundary */
298   len += (TCP_OPTS_ALIGN - len % TCP_OPTS_ALIGN) % TCP_OPTS_ALIGN;
299   return len;
300 }
301
302 static int
303 tcp_make_synack_options (tcp_connection_t * tc, tcp_options_t * opts)
304 {
305   u8 len = 0;
306
307   opts->flags |= TCP_OPTS_FLAG_MSS;
308   opts->mss = tc->mss;
309   len += TCP_OPTION_LEN_MSS;
310
311   if (tcp_opts_wscale (&tc->rcv_opts))
312     {
313       opts->flags |= TCP_OPTS_FLAG_WSCALE;
314       opts->wscale = tc->rcv_wscale;
315       len += TCP_OPTION_LEN_WINDOW_SCALE;
316     }
317
318   if (tcp_opts_tstamp (&tc->rcv_opts))
319     {
320       opts->flags |= TCP_OPTS_FLAG_TSTAMP;
321       opts->tsval = tcp_time_now ();
322       opts->tsecr = tc->tsval_recent;
323       len += TCP_OPTION_LEN_TIMESTAMP;
324     }
325
326   if (tcp_opts_sack_permitted (&tc->rcv_opts))
327     {
328       opts->flags |= TCP_OPTS_FLAG_SACK_PERMITTED;
329       len += TCP_OPTION_LEN_SACK_PERMITTED;
330     }
331
332   /* Align to needed boundary */
333   len += (TCP_OPTS_ALIGN - len % TCP_OPTS_ALIGN) % TCP_OPTS_ALIGN;
334   return len;
335 }
336
337 static int
338 tcp_make_established_options (tcp_connection_t * tc, tcp_options_t * opts)
339 {
340   u8 len = 0;
341
342   opts->flags = 0;
343
344   if (tcp_opts_tstamp (&tc->rcv_opts))
345     {
346       opts->flags |= TCP_OPTS_FLAG_TSTAMP;
347       opts->tsval = tcp_time_now_w_thread (tc->c_thread_index);
348       opts->tsecr = tc->tsval_recent;
349       len += TCP_OPTION_LEN_TIMESTAMP;
350     }
351   if (tcp_opts_sack_permitted (&tc->rcv_opts))
352     {
353       if (vec_len (tc->snd_sacks))
354         {
355           opts->flags |= TCP_OPTS_FLAG_SACK;
356           if (tc->snd_sack_pos >= vec_len (tc->snd_sacks))
357             tc->snd_sack_pos = 0;
358           opts->sacks = &tc->snd_sacks[tc->snd_sack_pos];
359           opts->n_sack_blocks = vec_len (tc->snd_sacks) - tc->snd_sack_pos;
360           opts->n_sack_blocks = clib_min (opts->n_sack_blocks,
361                                           TCP_OPTS_MAX_SACK_BLOCKS);
362           tc->snd_sack_pos += opts->n_sack_blocks;
363           len += 2 + TCP_OPTION_LEN_SACK_BLOCK * opts->n_sack_blocks;
364         }
365     }
366
367   /* Align to needed boundary */
368   len += (TCP_OPTS_ALIGN - len % TCP_OPTS_ALIGN) % TCP_OPTS_ALIGN;
369   return len;
370 }
371
372 always_inline int
373 tcp_make_options (tcp_connection_t * tc, tcp_options_t * opts,
374                   tcp_state_t state)
375 {
376   switch (state)
377     {
378     case TCP_STATE_ESTABLISHED:
379     case TCP_STATE_CLOSE_WAIT:
380     case TCP_STATE_FIN_WAIT_1:
381     case TCP_STATE_LAST_ACK:
382     case TCP_STATE_CLOSING:
383     case TCP_STATE_FIN_WAIT_2:
384     case TCP_STATE_TIME_WAIT:
385     case TCP_STATE_CLOSED:
386       return tcp_make_established_options (tc, opts);
387     case TCP_STATE_SYN_RCVD:
388       return tcp_make_synack_options (tc, opts);
389     case TCP_STATE_SYN_SENT:
390       return tcp_make_syn_options (opts, tc->rcv_wscale);
391     default:
392       clib_warning ("State not handled! %d", state);
393       return 0;
394     }
395 }
396
397 /**
398  * Update burst send vars
399  *
400  * - Updates snd_mss to reflect the effective segment size that we can send
401  * by taking into account all TCP options, including SACKs.
402  * - Cache 'on the wire' options for reuse
403  * - Updates receive window which can be reused for a burst.
404  *
405  * This should *only* be called when doing bursts
406  */
407 void
408 tcp_update_burst_snd_vars (tcp_connection_t * tc)
409 {
410   tcp_main_t *tm = &tcp_main;
411
412   /* Compute options to be used for connection. These may be reused when
413    * sending data or to compute the effective mss (snd_mss) */
414   tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts,
415                                        TCP_STATE_ESTABLISHED);
416
417   /* XXX check if MTU has been updated */
418   tc->snd_mss = clib_min (tc->mss, tc->rcv_opts.mss) - tc->snd_opts_len;
419   ASSERT (tc->snd_mss > 0);
420
421   tcp_options_write (tm->wrk_ctx[tc->c_thread_index].cached_opts,
422                      &tc->snd_opts);
423
424   tcp_update_rcv_wnd (tc);
425
426   if (tc->flags & TCP_CONN_RATE_SAMPLE)
427     tc->flags |= TCP_CONN_TRACK_BURST;
428 }
429
430 void
431 tcp_init_mss (tcp_connection_t * tc)
432 {
433   u16 default_min_mss = 536;
434   tcp_update_rcv_mss (tc);
435
436   /* TODO cache mss and consider PMTU discovery */
437   tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
438
439   if (tc->snd_mss < 45)
440     {
441       /* Assume that at least the min default mss works */
442       tc->snd_mss = default_min_mss;
443       tc->rcv_opts.mss = default_min_mss;
444     }
445
446   /* We should have enough space for 40 bytes of options */
447   ASSERT (tc->snd_mss > 45);
448
449   /* If we use timestamp option, account for it */
450   if (tcp_opts_tstamp (&tc->rcv_opts))
451     tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
452 }
453 #endif /* CLIB_MARCH_VARIANT */
454
455 static void *
456 tcp_reuse_buffer (vlib_main_t * vm, vlib_buffer_t * b)
457 {
458   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
459     vlib_buffer_free_one (vm, b->next_buffer);
460   /* Zero all flags but free list index and trace flag */
461   b->flags &= VLIB_BUFFER_NEXT_PRESENT - 1;
462   b->current_data = 0;
463   b->current_length = 0;
464   b->total_length_not_including_first_buffer = 0;
465   vnet_buffer (b)->tcp.flags = 0;
466
467   /* Leave enough space for headers */
468   return vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
469 }
470
471 #ifndef CLIB_MARCH_VARIANT
472 static void *
473 tcp_init_buffer (vlib_main_t * vm, vlib_buffer_t * b)
474 {
475   ASSERT ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
476   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
477   b->total_length_not_including_first_buffer = 0;
478   b->current_data = 0;
479   vnet_buffer (b)->tcp.flags = 0;
480   VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
481   /* Leave enough space for headers */
482   return vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
483 }
484
485 /**
486  * Prepare ACK
487  */
488 static inline void
489 tcp_make_ack_i (tcp_connection_t * tc, vlib_buffer_t * b, tcp_state_t state,
490                 u8 flags)
491 {
492   tcp_options_t _snd_opts, *snd_opts = &_snd_opts;
493   u8 tcp_opts_len, tcp_hdr_opts_len;
494   tcp_header_t *th;
495   u16 wnd;
496
497   wnd = tcp_window_to_advertise (tc, state);
498
499   /* Make and write options */
500   tcp_opts_len = tcp_make_established_options (tc, snd_opts);
501   tcp_hdr_opts_len = tcp_opts_len + sizeof (tcp_header_t);
502
503   th = vlib_buffer_push_tcp (b, tc->c_lcl_port, tc->c_rmt_port, tc->snd_nxt,
504                              tc->rcv_nxt, tcp_hdr_opts_len, flags, wnd);
505
506   tcp_options_write ((u8 *) (th + 1), snd_opts);
507   vnet_buffer (b)->tcp.connection_index = tc->c_c_index;
508 }
509
510 /**
511  * Convert buffer to ACK
512  */
513 static inline void
514 tcp_make_ack (tcp_connection_t * tc, vlib_buffer_t * b)
515 {
516   tcp_make_ack_i (tc, b, TCP_STATE_ESTABLISHED, TCP_FLAG_ACK);
517   TCP_EVT_DBG (TCP_EVT_ACK_SENT, tc);
518   tc->rcv_las = tc->rcv_nxt;
519 }
520
521 /**
522  * Convert buffer to FIN-ACK
523  */
524 void
525 tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b)
526 {
527   tcp_make_ack_i (tc, b, TCP_STATE_ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_ACK);
528 }
529
530 /**
531  * Convert buffer to SYN
532  */
533 void
534 tcp_make_syn (tcp_connection_t * tc, vlib_buffer_t * b)
535 {
536   u8 tcp_hdr_opts_len, tcp_opts_len;
537   tcp_header_t *th;
538   u16 initial_wnd;
539   tcp_options_t snd_opts;
540
541   initial_wnd = tcp_initial_window_to_advertise (tc);
542
543   /* Make and write options */
544   clib_memset (&snd_opts, 0, sizeof (snd_opts));
545   tcp_opts_len = tcp_make_syn_options (&snd_opts, tc->rcv_wscale);
546   tcp_hdr_opts_len = tcp_opts_len + sizeof (tcp_header_t);
547
548   th = vlib_buffer_push_tcp (b, tc->c_lcl_port, tc->c_rmt_port, tc->iss,
549                              tc->rcv_nxt, tcp_hdr_opts_len, TCP_FLAG_SYN,
550                              initial_wnd);
551   vnet_buffer (b)->tcp.connection_index = tc->c_c_index;
552   tcp_options_write ((u8 *) (th + 1), &snd_opts);
553 }
554
555 /**
556  * Convert buffer to SYN-ACK
557  */
558 void
559 tcp_make_synack (tcp_connection_t * tc, vlib_buffer_t * b)
560 {
561   tcp_options_t _snd_opts, *snd_opts = &_snd_opts;
562   u8 tcp_opts_len, tcp_hdr_opts_len;
563   tcp_header_t *th;
564   u16 initial_wnd;
565
566   clib_memset (snd_opts, 0, sizeof (*snd_opts));
567   initial_wnd = tcp_initial_window_to_advertise (tc);
568   tcp_opts_len = tcp_make_synack_options (tc, snd_opts);
569   tcp_hdr_opts_len = tcp_opts_len + sizeof (tcp_header_t);
570
571   th = vlib_buffer_push_tcp (b, tc->c_lcl_port, tc->c_rmt_port, tc->iss,
572                              tc->rcv_nxt, tcp_hdr_opts_len,
573                              TCP_FLAG_SYN | TCP_FLAG_ACK, initial_wnd);
574   tcp_options_write ((u8 *) (th + 1), snd_opts);
575
576   vnet_buffer (b)->tcp.connection_index = tc->c_c_index;
577 }
578
579 always_inline void
580 tcp_enqueue_to_ip_lookup_i (tcp_worker_ctx_t * wrk, vlib_buffer_t * b, u32 bi,
581                             u8 is_ip4, u32 fib_index, u8 flush)
582 {
583   vlib_main_t *vm = wrk->vm;
584   u32 *to_next, next_index;
585   vlib_frame_t *f;
586
587   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
588   b->error = 0;
589
590   vnet_buffer (b)->sw_if_index[VLIB_TX] = fib_index;
591   vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
592
593   /* Send to IP lookup */
594   next_index = is_ip4 ? ip4_lookup_node.index : ip6_lookup_node.index;
595   tcp_trajectory_add_start (b, 1);
596
597   f = wrk->ip_lookup_tx_frames[!is_ip4];
598   if (!f)
599     {
600       f = vlib_get_frame_to_node (vm, next_index);
601       ASSERT (f);
602       wrk->ip_lookup_tx_frames[!is_ip4] = f;
603     }
604
605   to_next = vlib_frame_vector_args (f);
606   to_next[f->n_vectors] = bi;
607   f->n_vectors += 1;
608   if (flush || f->n_vectors == VLIB_FRAME_SIZE)
609     {
610       vlib_put_frame_to_node (vm, next_index, f);
611       wrk->ip_lookup_tx_frames[!is_ip4] = 0;
612     }
613 }
614
615 static void
616 tcp_enqueue_to_ip_lookup_now (tcp_worker_ctx_t * wrk, vlib_buffer_t * b,
617                               u32 bi, u8 is_ip4, u32 fib_index)
618 {
619   tcp_enqueue_to_ip_lookup_i (wrk, b, bi, is_ip4, fib_index, 1);
620 }
621
622 static void
623 tcp_enqueue_to_ip_lookup (tcp_worker_ctx_t * wrk, vlib_buffer_t * b, u32 bi,
624                           u8 is_ip4, u32 fib_index)
625 {
626   tcp_enqueue_to_ip_lookup_i (wrk, b, bi, is_ip4, fib_index, 0);
627   if (wrk->vm->thread_index == 0 && vlib_num_workers ())
628     session_flush_frames_main_thread (wrk->vm);
629 }
630
631 always_inline void
632 tcp_enqueue_to_output_i (tcp_worker_ctx_t * wrk, vlib_buffer_t * b, u32 bi,
633                          u8 is_ip4, u8 flush)
634 {
635   u32 *to_next, next_index;
636   vlib_frame_t *f;
637
638   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
639   b->error = 0;
640
641   /* Decide where to send the packet */
642   next_index = is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
643   tcp_trajectory_add_start (b, 2);
644
645   /* Get frame to v4/6 output node */
646   f = wrk->tx_frames[!is_ip4];
647   if (!f)
648     {
649       f = vlib_get_frame_to_node (wrk->vm, next_index);
650       ASSERT (f);
651       wrk->tx_frames[!is_ip4] = f;
652     }
653   to_next = vlib_frame_vector_args (f);
654   to_next[f->n_vectors] = bi;
655   f->n_vectors += 1;
656   if (flush || f->n_vectors == VLIB_FRAME_SIZE)
657     {
658       vlib_put_frame_to_node (wrk->vm, next_index, f);
659       wrk->tx_frames[!is_ip4] = 0;
660     }
661 }
662
663 static void
664 tcp_enqueue_to_output (tcp_worker_ctx_t * wrk, vlib_buffer_t * b, u32 bi,
665                        u8 is_ip4)
666 {
667   tcp_enqueue_to_output_i (wrk, b, bi, is_ip4, 0);
668 }
669
670 static void
671 tcp_enqueue_to_output_now (tcp_worker_ctx_t * wrk, vlib_buffer_t * b, u32 bi,
672                            u8 is_ip4)
673 {
674   tcp_enqueue_to_output_i (wrk, b, bi, is_ip4, 1);
675 }
676 #endif /* CLIB_MARCH_VARIANT */
677
678 static int
679 tcp_make_reset_in_place (vlib_main_t * vm, vlib_buffer_t * b0,
680                          tcp_state_t state, u8 thread_index, u8 is_ip4)
681 {
682   ip4_header_t *ih4;
683   ip6_header_t *ih6;
684   tcp_header_t *th0;
685   ip4_address_t src_ip40, dst_ip40;
686   ip6_address_t src_ip60, dst_ip60;
687   u16 src_port, dst_port;
688   u32 tmp;
689   u32 seq, ack;
690   u8 flags;
691
692   /* Find IP and TCP headers */
693   th0 = tcp_buffer_hdr (b0);
694
695   /* Save src and dst ip */
696   if (is_ip4)
697     {
698       ih4 = vlib_buffer_get_current (b0);
699       ASSERT ((ih4->ip_version_and_header_length & 0xF0) == 0x40);
700       src_ip40.as_u32 = ih4->src_address.as_u32;
701       dst_ip40.as_u32 = ih4->dst_address.as_u32;
702     }
703   else
704     {
705       ih6 = vlib_buffer_get_current (b0);
706       ASSERT ((ih6->ip_version_traffic_class_and_flow_label & 0xF0) == 0x60);
707       clib_memcpy_fast (&src_ip60, &ih6->src_address, sizeof (ip6_address_t));
708       clib_memcpy_fast (&dst_ip60, &ih6->dst_address, sizeof (ip6_address_t));
709     }
710
711   src_port = th0->src_port;
712   dst_port = th0->dst_port;
713
714   /* Try to determine what/why we're actually resetting */
715   if (state == TCP_STATE_CLOSED)
716     {
717       if (!tcp_syn (th0))
718         return -1;
719
720       tmp = clib_net_to_host_u32 (th0->seq_number);
721
722       /* Got a SYN for no listener. */
723       flags = TCP_FLAG_RST | TCP_FLAG_ACK;
724       ack = clib_host_to_net_u32 (tmp + 1);
725       seq = 0;
726     }
727   else
728     {
729       flags = TCP_FLAG_RST;
730       seq = th0->ack_number;
731       ack = 0;
732     }
733
734   tcp_reuse_buffer (vm, b0);
735   tcp_trajectory_add_start (b0, 4);
736   th0 = vlib_buffer_push_tcp_net_order (b0, dst_port, src_port, seq, ack,
737                                         sizeof (tcp_header_t), flags, 0);
738
739   if (is_ip4)
740     {
741       ih4 = vlib_buffer_push_ip4 (vm, b0, &dst_ip40, &src_ip40,
742                                   IP_PROTOCOL_TCP, 1);
743       th0->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ih4);
744     }
745   else
746     {
747       int bogus = ~0;
748       ih6 = vlib_buffer_push_ip6 (vm, b0, &dst_ip60, &src_ip60,
749                                   IP_PROTOCOL_TCP);
750       th0->checksum = ip6_tcp_udp_icmp_compute_checksum (vm, b0, ih6, &bogus);
751       ASSERT (!bogus);
752     }
753
754   return 0;
755 }
756
757 #ifndef CLIB_MARCH_VARIANT
758 /**
759  *  Send reset without reusing existing buffer
760  *
761  *  It extracts connection info out of original packet
762  */
763 void
764 tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
765                       u32 thread_index, u8 is_ip4)
766 {
767   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
768   vlib_main_t *vm = wrk->vm;
769   vlib_buffer_t *b;
770   u32 bi, sw_if_index, fib_index;
771   u8 tcp_hdr_len, flags = 0;
772   tcp_header_t *th, *pkt_th;
773   u32 seq, ack;
774   ip4_header_t *ih4, *pkt_ih4;
775   ip6_header_t *ih6, *pkt_ih6;
776   fib_protocol_t fib_proto;
777
778   if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
779     return;
780
781   b = vlib_get_buffer (vm, bi);
782   sw_if_index = vnet_buffer (pkt)->sw_if_index[VLIB_RX];
783   fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
784   fib_index = fib_table_get_index_for_sw_if_index (fib_proto, sw_if_index);
785   tcp_init_buffer (vm, b);
786
787   /* Make and write options */
788   tcp_hdr_len = sizeof (tcp_header_t);
789
790   if (is_ip4)
791     {
792       pkt_ih4 = vlib_buffer_get_current (pkt);
793       pkt_th = ip4_next_header (pkt_ih4);
794     }
795   else
796     {
797       pkt_ih6 = vlib_buffer_get_current (pkt);
798       pkt_th = ip6_next_header (pkt_ih6);
799     }
800
801   if (tcp_ack (pkt_th))
802     {
803       flags = TCP_FLAG_RST;
804       seq = pkt_th->ack_number;
805       ack = (tc->state >= TCP_STATE_SYN_RCVD) ? tc->rcv_nxt : 0;
806     }
807   else
808     {
809       flags = TCP_FLAG_RST | TCP_FLAG_ACK;
810       seq = 0;
811       ack = clib_host_to_net_u32 (vnet_buffer (pkt)->tcp.seq_end);
812     }
813
814   th = vlib_buffer_push_tcp_net_order (b, pkt_th->dst_port, pkt_th->src_port,
815                                        seq, ack, tcp_hdr_len, flags, 0);
816
817   /* Swap src and dst ip */
818   if (is_ip4)
819     {
820       ASSERT ((pkt_ih4->ip_version_and_header_length & 0xF0) == 0x40);
821       ih4 = vlib_buffer_push_ip4 (vm, b, &pkt_ih4->dst_address,
822                                   &pkt_ih4->src_address, IP_PROTOCOL_TCP, 1);
823       th->checksum = ip4_tcp_udp_compute_checksum (vm, b, ih4);
824     }
825   else
826     {
827       int bogus = ~0;
828       ASSERT ((pkt_ih6->ip_version_traffic_class_and_flow_label & 0xF0) ==
829               0x60);
830       ih6 = vlib_buffer_push_ip6 (vm, b, &pkt_ih6->dst_address,
831                                   &pkt_ih6->src_address, IP_PROTOCOL_TCP);
832       th->checksum = ip6_tcp_udp_icmp_compute_checksum (vm, b, ih6, &bogus);
833       ASSERT (!bogus);
834     }
835
836   tcp_enqueue_to_ip_lookup_now (wrk, b, bi, is_ip4, fib_index);
837   TCP_EVT_DBG (TCP_EVT_RST_SENT, tc);
838 }
839
840 /**
841  * Build and set reset packet for connection
842  */
843 void
844 tcp_send_reset (tcp_connection_t * tc)
845 {
846   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
847   vlib_main_t *vm = wrk->vm;
848   vlib_buffer_t *b;
849   u32 bi;
850   tcp_header_t *th;
851   u16 tcp_hdr_opts_len, advertise_wnd, opts_write_len;
852   u8 flags;
853
854   if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
855     return;
856   b = vlib_get_buffer (vm, bi);
857   tcp_init_buffer (vm, b);
858
859   tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts, tc->state);
860   tcp_hdr_opts_len = tc->snd_opts_len + sizeof (tcp_header_t);
861   advertise_wnd = tcp_window_to_advertise (tc, TCP_STATE_ESTABLISHED);
862   flags = TCP_FLAG_RST;
863   th = vlib_buffer_push_tcp (b, tc->c_lcl_port, tc->c_rmt_port, tc->snd_nxt,
864                              tc->rcv_nxt, tcp_hdr_opts_len, flags,
865                              advertise_wnd);
866   opts_write_len = tcp_options_write ((u8 *) (th + 1), &tc->snd_opts);
867   ASSERT (opts_write_len == tc->snd_opts_len);
868   vnet_buffer (b)->tcp.connection_index = tc->c_c_index;
869   if (tc->c_is_ip4)
870     {
871       ip4_header_t *ih4;
872       ih4 = vlib_buffer_push_ip4 (vm, b, &tc->c_lcl_ip.ip4,
873                                   &tc->c_rmt_ip.ip4, IP_PROTOCOL_TCP, 0);
874       th->checksum = ip4_tcp_udp_compute_checksum (vm, b, ih4);
875     }
876   else
877     {
878       int bogus = ~0;
879       ip6_header_t *ih6;
880       ih6 = vlib_buffer_push_ip6 (vm, b, &tc->c_lcl_ip.ip6,
881                                   &tc->c_rmt_ip.ip6, IP_PROTOCOL_TCP);
882       th->checksum = ip6_tcp_udp_icmp_compute_checksum (vm, b, ih6, &bogus);
883       ASSERT (!bogus);
884     }
885   tcp_enqueue_to_ip_lookup_now (wrk, b, bi, tc->c_is_ip4, tc->c_fib_index);
886   TCP_EVT_DBG (TCP_EVT_RST_SENT, tc);
887 }
888
889 static void
890 tcp_push_ip_hdr (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
891                  vlib_buffer_t * b)
892 {
893   tcp_header_t *th = vlib_buffer_get_current (b);
894   vlib_main_t *vm = wrk->vm;
895   if (tc->c_is_ip4)
896     {
897       ip4_header_t *ih;
898       ih = vlib_buffer_push_ip4 (vm, b, &tc->c_lcl_ip4,
899                                  &tc->c_rmt_ip4, IP_PROTOCOL_TCP, 1);
900       th->checksum = ip4_tcp_udp_compute_checksum (vm, b, ih);
901     }
902   else
903     {
904       ip6_header_t *ih;
905       int bogus = ~0;
906
907       ih = vlib_buffer_push_ip6 (vm, b, &tc->c_lcl_ip6,
908                                  &tc->c_rmt_ip6, IP_PROTOCOL_TCP);
909       th->checksum = ip6_tcp_udp_icmp_compute_checksum (vm, b, ih, &bogus);
910       ASSERT (!bogus);
911     }
912 }
913
914 /**
915  *  Send SYN
916  *
917  *  Builds a SYN packet for a half-open connection and sends it to ipx_lookup.
918  *  The packet is not forwarded through tcpx_output to avoid doing lookups
919  *  in the half_open pool.
920  */
921 void
922 tcp_send_syn (tcp_connection_t * tc)
923 {
924   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
925   vlib_main_t *vm = wrk->vm;
926   vlib_buffer_t *b;
927   u32 bi;
928
929   /*
930    * Setup retransmit and establish timers before requesting buffer
931    * such that we can return if we've ran out.
932    */
933   tcp_timer_set (tc, TCP_TIMER_ESTABLISH_AO, TCP_ESTABLISH_TIME);
934   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT_SYN,
935                     tc->rto * TCP_TO_TIMER_TICK);
936
937   if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
938     {
939       tcp_timer_update (tc, TCP_TIMER_RETRANSMIT_SYN, 1);
940       return;
941     }
942
943   b = vlib_get_buffer (vm, bi);
944   tcp_init_buffer (vm, b);
945   tcp_make_syn (tc, b);
946
947   /* Measure RTT with this */
948   tc->rtt_ts = tcp_time_now_us (vlib_num_workers ()? 1 : 0);
949   tc->rtt_seq = tc->snd_nxt;
950   tc->rto_boff = 0;
951
952   tcp_push_ip_hdr (wrk, tc, b);
953   tcp_enqueue_to_ip_lookup (wrk, b, bi, tc->c_is_ip4, tc->c_fib_index);
954   TCP_EVT_DBG (TCP_EVT_SYN_SENT, tc);
955 }
956
957 void
958 tcp_send_synack (tcp_connection_t * tc)
959 {
960   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
961   vlib_main_t *vm = wrk->vm;
962   vlib_buffer_t *b;
963   u32 bi;
964
965   tcp_retransmit_timer_force_update (tc);
966
967   if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
968     {
969       tcp_timer_update (tc, TCP_TIMER_RETRANSMIT, 1);
970       return;
971     }
972
973   tc->rtt_ts = tcp_time_now_us (tc->c_thread_index);
974   b = vlib_get_buffer (vm, bi);
975   tcp_init_buffer (vm, b);
976   tcp_make_synack (tc, b);
977   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
978   TCP_EVT_DBG (TCP_EVT_SYNACK_SENT, tc);
979 }
980
981 /**
982  * Flush tx frame populated by retransmits and timer pops
983  */
984 void
985 tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4)
986 {
987   if (wrk->tx_frames[!is_ip4])
988     {
989       u32 next_index;
990       next_index = is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
991       vlib_put_frame_to_node (wrk->vm, next_index, wrk->tx_frames[!is_ip4]);
992       wrk->tx_frames[!is_ip4] = 0;
993     }
994 }
995
996 /**
997  * Flush ip lookup tx frames populated by timer pops
998  */
999 static void
1000 tcp_flush_frame_to_ip_lookup (tcp_worker_ctx_t * wrk, u8 is_ip4)
1001 {
1002   if (wrk->ip_lookup_tx_frames[!is_ip4])
1003     {
1004       u32 next_index;
1005       next_index = is_ip4 ? ip4_lookup_node.index : ip6_lookup_node.index;
1006       vlib_put_frame_to_node (wrk->vm, next_index,
1007                               wrk->ip_lookup_tx_frames[!is_ip4]);
1008       wrk->ip_lookup_tx_frames[!is_ip4] = 0;
1009     }
1010 }
1011
1012 /**
1013  * Flush v4 and v6 tcp and ip-lookup tx frames for thread index
1014  */
1015 void
1016 tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk)
1017 {
1018   tcp_flush_frame_to_output (wrk, 1);
1019   tcp_flush_frame_to_output (wrk, 0);
1020   tcp_flush_frame_to_ip_lookup (wrk, 1);
1021   tcp_flush_frame_to_ip_lookup (wrk, 0);
1022 }
1023
1024 /**
1025  *  Send FIN
1026  */
1027 void
1028 tcp_send_fin (tcp_connection_t * tc)
1029 {
1030   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1031   vlib_main_t *vm = wrk->vm;
1032   vlib_buffer_t *b;
1033   u32 bi;
1034   u8 fin_snt = 0;
1035
1036   fin_snt = tc->flags & TCP_CONN_FINSNT;
1037   if (fin_snt)
1038     tc->snd_nxt -= 1;
1039
1040   if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
1041     {
1042       /* Out of buffers so program fin retransmit ASAP */
1043       tcp_timer_update (tc, TCP_TIMER_RETRANSMIT, 1);
1044       if (fin_snt)
1045         tc->snd_nxt += 1;
1046       else
1047         /* Make sure retransmit retries a fin not data */
1048         tc->flags |= TCP_CONN_FINSNT;
1049       return;
1050     }
1051
1052   tcp_retransmit_timer_force_update (tc);
1053   b = vlib_get_buffer (vm, bi);
1054   tcp_init_buffer (vm, b);
1055   tcp_make_fin (tc, b);
1056   tcp_enqueue_to_output_now (wrk, b, bi, tc->c_is_ip4);
1057   TCP_EVT_DBG (TCP_EVT_FIN_SENT, tc);
1058   /* Account for the FIN */
1059   tc->snd_nxt += 1;
1060   if (!fin_snt)
1061     {
1062       tc->flags |= TCP_CONN_FINSNT;
1063       tc->flags &= ~TCP_CONN_FINPNDG;
1064       tc->snd_una_max = seq_max (tc->snd_una_max, tc->snd_nxt);
1065     }
1066 }
1067
1068 /**
1069  * Push TCP header and update connection variables. Should only be called
1070  * for segments with data, not for 'control' packets.
1071  */
1072 always_inline void
1073 tcp_push_hdr_i (tcp_connection_t * tc, vlib_buffer_t * b, u32 snd_nxt,
1074                 u8 compute_opts, u8 maybe_burst, u8 update_snd_nxt)
1075 {
1076   u8 tcp_hdr_opts_len, flags = TCP_FLAG_ACK;
1077   u32 advertise_wnd, data_len;
1078   tcp_main_t *tm = &tcp_main;
1079   tcp_header_t *th;
1080
1081   data_len = b->current_length;
1082   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
1083     data_len += b->total_length_not_including_first_buffer;
1084
1085   vnet_buffer (b)->tcp.flags = 0;
1086   vnet_buffer (b)->tcp.connection_index = tc->c_c_index;
1087
1088   if (compute_opts)
1089     tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts, tc->state);
1090
1091   tcp_hdr_opts_len = tc->snd_opts_len + sizeof (tcp_header_t);
1092
1093   if (maybe_burst)
1094     advertise_wnd = tc->rcv_wnd >> tc->rcv_wscale;
1095   else
1096     advertise_wnd = tcp_window_to_advertise (tc, TCP_STATE_ESTABLISHED);
1097
1098   if (PREDICT_FALSE (tc->flags & TCP_CONN_PSH_PENDING))
1099     {
1100       if (seq_geq (tc->psh_seq, snd_nxt)
1101           && seq_lt (tc->psh_seq, snd_nxt + data_len))
1102         flags |= TCP_FLAG_PSH;
1103     }
1104   th = vlib_buffer_push_tcp (b, tc->c_lcl_port, tc->c_rmt_port, snd_nxt,
1105                              tc->rcv_nxt, tcp_hdr_opts_len, flags,
1106                              advertise_wnd);
1107
1108   if (maybe_burst)
1109     {
1110       clib_memcpy_fast ((u8 *) (th + 1),
1111                         tm->wrk_ctx[tc->c_thread_index].cached_opts,
1112                         tc->snd_opts_len);
1113     }
1114   else
1115     {
1116       u8 len = tcp_options_write ((u8 *) (th + 1), &tc->snd_opts);
1117       ASSERT (len == tc->snd_opts_len);
1118     }
1119
1120   /*
1121    * Update connection variables
1122    */
1123
1124   if (update_snd_nxt)
1125     tc->snd_nxt += data_len;
1126   tc->rcv_las = tc->rcv_nxt;
1127
1128   TCP_EVT_DBG (TCP_EVT_PKTIZE, tc);
1129 }
1130
1131 u32
1132 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1133 {
1134   tcp_connection_t *tc = (tcp_connection_t *) tconn;
1135
1136   if (tc->flags & TCP_CONN_TRACK_BURST)
1137     {
1138       tcp_bt_check_app_limited (tc);
1139       tcp_bt_track_tx (tc);
1140       tc->flags &= ~TCP_CONN_TRACK_BURST;
1141     }
1142
1143   tcp_push_hdr_i (tc, b, tc->snd_nxt, /* compute opts */ 0, /* burst */ 1,
1144                   /* update_snd_nxt */ 1);
1145
1146   tc->snd_una_max = seq_max (tc->snd_nxt, tc->snd_una_max);
1147   tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
1148   /* If not tracking an ACK, start tracking */
1149   if (tc->rtt_ts == 0 && !tcp_in_cong_recovery (tc))
1150     {
1151       tc->rtt_ts = tcp_time_now_us (tc->c_thread_index);
1152       tc->rtt_seq = tc->snd_nxt;
1153     }
1154   if (PREDICT_FALSE (!tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT)))
1155     {
1156       tcp_retransmit_timer_set (tc);
1157       tc->rto_boff = 0;
1158     }
1159   tcp_trajectory_add_start (b, 3);
1160   return 0;
1161 }
1162
1163 void
1164 tcp_send_ack (tcp_connection_t * tc)
1165 {
1166   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1167   vlib_main_t *vm = wrk->vm;
1168   vlib_buffer_t *b;
1169   u32 bi;
1170
1171   if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
1172     {
1173       tcp_update_rcv_wnd (tc);
1174       return;
1175     }
1176   b = vlib_get_buffer (vm, bi);
1177   tcp_init_buffer (vm, b);
1178   tcp_make_ack (tc, b);
1179   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1180 }
1181
1182 void
1183 tcp_program_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1184 {
1185   if (!(tc->flags & TCP_CONN_SNDACK))
1186     {
1187       vec_add1 (wrk->pending_acks, tc->c_c_index);
1188       tc->flags |= TCP_CONN_SNDACK;
1189     }
1190 }
1191
1192 void
1193 tcp_program_dupack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1194 {
1195   if (!(tc->flags & TCP_CONN_SNDACK))
1196     {
1197       vec_add1 (wrk->pending_acks, tc->c_c_index);
1198       tc->flags |= TCP_CONN_SNDACK;
1199     }
1200   if (tc->pending_dupacks < 255)
1201     tc->pending_dupacks += 1;
1202 }
1203
1204 void
1205 tcp_send_acks (tcp_worker_ctx_t * wrk)
1206 {
1207   u32 thread_index, *pending_acks;
1208   tcp_connection_t *tc;
1209   int i, j, n_acks;
1210
1211   if (!vec_len (wrk->pending_acks))
1212     return;
1213
1214   thread_index = wrk->vm->thread_index;
1215   pending_acks = wrk->pending_acks;
1216   for (i = 0; i < vec_len (pending_acks); i++)
1217     {
1218       tc = tcp_connection_get (pending_acks[i], thread_index);
1219       tc->flags &= ~TCP_CONN_SNDACK;
1220       if (!tc->pending_dupacks)
1221         {
1222           tcp_send_ack (tc);
1223           continue;
1224         }
1225
1226       /* If we're supposed to send dupacks but have no ooo data
1227        * send only one ack */
1228       if (!vec_len (tc->snd_sacks))
1229         {
1230           tcp_send_ack (tc);
1231           continue;
1232         }
1233
1234       /* Start with first sack block */
1235       tc->snd_sack_pos = 0;
1236
1237       /* Generate enough dupacks to cover all sack blocks. Do not generate
1238        * more sacks than the number of packets received. But do generate at
1239        * least 3, i.e., the number needed to signal congestion, if needed. */
1240       n_acks = vec_len (tc->snd_sacks) / TCP_OPTS_MAX_SACK_BLOCKS;
1241       n_acks = clib_min (n_acks, tc->pending_dupacks);
1242       n_acks = clib_max (n_acks, clib_min (tc->pending_dupacks, 3));
1243       for (j = 0; j < n_acks; j++)
1244         tcp_send_ack (tc);
1245
1246       tc->pending_dupacks = 0;
1247       tc->snd_sack_pos = 0;
1248     }
1249   _vec_len (wrk->pending_acks) = 0;
1250 }
1251
1252 /**
1253  * Delayed ack timer handler
1254  *
1255  * Sends delayed ACK when timer expires
1256  */
1257 void
1258 tcp_timer_delack_handler (u32 index)
1259 {
1260   u32 thread_index = vlib_get_thread_index ();
1261   tcp_connection_t *tc;
1262
1263   tc = tcp_connection_get (index, thread_index);
1264   tc->timers[TCP_TIMER_DELACK] = TCP_TIMER_HANDLE_INVALID;
1265   tcp_send_ack (tc);
1266 }
1267
1268 /**
1269  * Allocate a new buffer and build a new tcp segment
1270  *
1271  * @param wrk           tcp worker
1272  * @param tc            connection for which the segment will be allocated
1273  * @param offset        offset of the first byte in the tx fifo
1274  * @param max_deq_byte  segment size
1275  * @param[out] b        pointer to buffer allocated
1276  *
1277  * @return      the number of bytes in the segment or 0 if buffer cannot be
1278  *              allocated or no data available
1279  */
1280 static int
1281 tcp_prepare_segment (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1282                      u32 offset, u32 max_deq_bytes, vlib_buffer_t ** b)
1283 {
1284   u32 bytes_per_buffer = vnet_get_tcp_main ()->bytes_per_buffer;
1285   vlib_main_t *vm = wrk->vm;
1286   u32 bi, seg_size;
1287   int n_bytes = 0;
1288   u8 *data;
1289
1290   seg_size = max_deq_bytes + TRANSPORT_MAX_HDRS_LEN;
1291
1292   /*
1293    * Prepare options
1294    */
1295   tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts, tc->state);
1296
1297   /*
1298    * Allocate and fill in buffer(s)
1299    */
1300
1301   /* Easy case, buffer size greater than mss */
1302   if (PREDICT_TRUE (seg_size <= bytes_per_buffer))
1303     {
1304       if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
1305         return 0;
1306       *b = vlib_get_buffer (vm, bi);
1307       data = tcp_init_buffer (vm, *b);
1308       n_bytes = session_tx_fifo_peek_bytes (&tc->connection, data, offset,
1309                                             max_deq_bytes);
1310       ASSERT (n_bytes == max_deq_bytes);
1311       b[0]->current_length = n_bytes;
1312       tcp_push_hdr_i (tc, *b, tc->snd_una + offset, /* compute opts */ 0,
1313                       /* burst */ 0, /* update_snd_nxt */ 0);
1314     }
1315   /* Split mss into multiple buffers */
1316   else
1317     {
1318       u32 chain_bi = ~0, n_bufs_per_seg, n_bufs;
1319       u16 n_peeked, len_to_deq;
1320       vlib_buffer_t *chain_b, *prev_b;
1321       int i;
1322
1323       /* Make sure we have enough buffers */
1324       n_bufs_per_seg = ceil ((double) seg_size / bytes_per_buffer);
1325       vec_validate_aligned (wrk->tx_buffers, n_bufs_per_seg - 1,
1326                             CLIB_CACHE_LINE_BYTES);
1327       n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_per_seg);
1328       if (PREDICT_FALSE (n_bufs != n_bufs_per_seg))
1329         {
1330           if (n_bufs)
1331             vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1332           return 0;
1333         }
1334
1335       *b = vlib_get_buffer (vm, wrk->tx_buffers[--n_bufs]);
1336       data = tcp_init_buffer (vm, *b);
1337       n_bytes = session_tx_fifo_peek_bytes (&tc->connection, data, offset,
1338                                             bytes_per_buffer -
1339                                             TRANSPORT_MAX_HDRS_LEN);
1340       b[0]->current_length = n_bytes;
1341       b[0]->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1342       b[0]->total_length_not_including_first_buffer = 0;
1343       max_deq_bytes -= n_bytes;
1344
1345       chain_b = *b;
1346       for (i = 1; i < n_bufs_per_seg; i++)
1347         {
1348           prev_b = chain_b;
1349           len_to_deq = clib_min (max_deq_bytes, bytes_per_buffer);
1350           chain_bi = wrk->tx_buffers[--n_bufs];
1351           chain_b = vlib_get_buffer (vm, chain_bi);
1352           chain_b->current_data = 0;
1353           data = vlib_buffer_get_current (chain_b);
1354           n_peeked = session_tx_fifo_peek_bytes (&tc->connection, data,
1355                                                  offset + n_bytes,
1356                                                  len_to_deq);
1357           ASSERT (n_peeked == len_to_deq);
1358           n_bytes += n_peeked;
1359           chain_b->current_length = n_peeked;
1360           chain_b->next_buffer = 0;
1361
1362           /* update previous buffer */
1363           prev_b->next_buffer = chain_bi;
1364           prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1365
1366           max_deq_bytes -= n_peeked;
1367           b[0]->total_length_not_including_first_buffer += n_peeked;
1368         }
1369
1370       tcp_push_hdr_i (tc, *b, tc->snd_una + offset, /* compute opts */ 0,
1371                       /* burst */ 0, /* update_snd_nxt */ 0);
1372
1373       if (PREDICT_FALSE (n_bufs))
1374         {
1375           clib_warning ("not all buffers consumed");
1376           vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1377         }
1378     }
1379
1380   ASSERT (n_bytes > 0);
1381   ASSERT (((*b)->current_data + (*b)->current_length) <= bytes_per_buffer);
1382
1383   return n_bytes;
1384 }
1385
1386 /**
1387  * Build a retransmit segment
1388  *
1389  * @return the number of bytes in the segment or 0 if there's nothing to
1390  *         retransmit
1391  */
1392 static u32
1393 tcp_prepare_retransmit_segment (tcp_worker_ctx_t * wrk,
1394                                 tcp_connection_t * tc, u32 offset,
1395                                 u32 max_deq_bytes, vlib_buffer_t ** b)
1396 {
1397   u32 start, available_bytes;
1398   int n_bytes = 0;
1399
1400   ASSERT (tc->state >= TCP_STATE_ESTABLISHED);
1401   ASSERT (max_deq_bytes != 0);
1402
1403   /*
1404    * Make sure we can retransmit something
1405    */
1406   available_bytes = transport_max_tx_dequeue (&tc->connection);
1407   ASSERT (available_bytes >= offset);
1408   available_bytes -= offset;
1409   if (!available_bytes)
1410     return 0;
1411
1412   max_deq_bytes = clib_min (tc->snd_mss, max_deq_bytes);
1413   max_deq_bytes = clib_min (available_bytes, max_deq_bytes);
1414
1415   /* Start is beyond snd_congestion */
1416   start = tc->snd_una + offset;
1417   if (seq_geq (start, tc->snd_congestion))
1418     goto done;
1419
1420   /* Don't overshoot snd_congestion */
1421   if (seq_gt (start + max_deq_bytes, tc->snd_congestion))
1422     {
1423       max_deq_bytes = tc->snd_congestion - start;
1424       if (max_deq_bytes == 0)
1425         goto done;
1426     }
1427
1428   n_bytes = tcp_prepare_segment (wrk, tc, offset, max_deq_bytes, b);
1429   if (!n_bytes)
1430     return 0;
1431
1432   if (tcp_in_fastrecovery (tc))
1433     {
1434       tc->snd_rxt_bytes += n_bytes;
1435       if (tc->flags & TCP_CONN_RATE_SAMPLE)
1436         tcp_bt_track_rxt (tc, start, start + n_bytes);
1437     }
1438
1439 done:
1440   TCP_EVT_DBG (TCP_EVT_CC_RTX, tc, offset, n_bytes);
1441   return n_bytes;
1442 }
1443
1444 /**
1445  * Reset congestion control, switch cwnd to loss window and try again.
1446  */
1447 static void
1448 tcp_rxt_timeout_cc (tcp_connection_t * tc)
1449 {
1450   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 6);
1451   tc->prev_ssthresh = tc->ssthresh;
1452   tc->prev_cwnd = tc->cwnd;
1453
1454   /* Cleanly recover cc (also clears up fast retransmit) */
1455   if (tcp_in_fastrecovery (tc))
1456     {
1457       /* TODO be less aggressive about this */
1458       scoreboard_clear (&tc->sack_sb);
1459       tcp_cc_fastrecovery_exit (tc);
1460     }
1461   else
1462     tc->rcv_dupacks = 0;
1463
1464   /* Start again from the beginning */
1465   tc->cc_algo->congestion (tc);
1466   tc->cwnd = tcp_loss_wnd (tc);
1467   tc->snd_congestion = tc->snd_nxt;
1468   tc->rtt_ts = 0;
1469   tc->cwnd_acc_bytes = 0;
1470   tcp_connection_tx_pacer_reset (tc, tc->cwnd, 2 * tc->snd_mss);
1471   tcp_recovery_on (tc);
1472 }
1473
1474 static inline void
1475 tcp_timer_retransmit_handler_i (u32 index, u8 is_syn)
1476 {
1477   u32 thread_index = vlib_get_thread_index ();
1478   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1479   vlib_main_t *vm = wrk->vm;
1480   tcp_connection_t *tc;
1481   vlib_buffer_t *b = 0;
1482   u32 bi, n_bytes;
1483
1484   if (is_syn)
1485     {
1486       tc = tcp_half_open_connection_get (index);
1487       /* Note: the connection may have transitioned to ESTABLISHED... */
1488       if (PREDICT_FALSE (tc == 0 || tc->state != TCP_STATE_SYN_SENT))
1489         return;
1490       tc->timers[TCP_TIMER_RETRANSMIT_SYN] = TCP_TIMER_HANDLE_INVALID;
1491     }
1492   else
1493     {
1494       tc = tcp_connection_get (index, thread_index);
1495       /* Note: the connection may have been closed and pool_put */
1496       if (PREDICT_FALSE (tc == 0 || tc->state == TCP_STATE_SYN_SENT))
1497         return;
1498       tc->timers[TCP_TIMER_RETRANSMIT] = TCP_TIMER_HANDLE_INVALID;
1499       /* Wait-close and retransmit could pop at the same time */
1500       if (tc->state == TCP_STATE_CLOSED)
1501         return;
1502     }
1503
1504   if (tc->state >= TCP_STATE_ESTABLISHED)
1505     {
1506       TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 2);
1507
1508       /* Lost FIN, retransmit and return */
1509       if (tc->flags & TCP_CONN_FINSNT)
1510         {
1511           tcp_send_fin (tc);
1512           tc->rto_boff += 1;
1513           tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1514           return;
1515         }
1516
1517       /* Shouldn't be here. This condition is tricky because it has to take
1518        * into account boff > 0 due to persist timeout. */
1519       if ((tc->rto_boff == 0 && tc->snd_una == tc->snd_nxt)
1520           || (tc->rto_boff > 0 && seq_geq (tc->snd_una, tc->snd_congestion)
1521               && !tcp_flight_size (tc)))
1522         {
1523           ASSERT (!tcp_in_recovery (tc));
1524           tc->rto_boff = 0;
1525           return;
1526         }
1527
1528       /* We're not in recovery so make sure rto_boff is 0. Can be non 0 due
1529        * to persist timer timeout */
1530       if (!tcp_in_recovery (tc) && tc->rto_boff > 0)
1531         {
1532           tc->rto_boff = 0;
1533           tcp_update_rto (tc);
1534         }
1535
1536       /* Peer is dead or network connectivity is lost. Close connection.
1537        * RFC 1122 section 4.2.3.5 recommends a value of at least 100s. For
1538        * a min rto of 0.2s we need to retry about 8 times. */
1539       if (tc->rto_boff >= TCP_RTO_BOFF_MAX)
1540         {
1541           tcp_send_reset (tc);
1542           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1543           session_transport_closing_notify (&tc->connection);
1544           tcp_connection_timers_reset (tc);
1545           tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
1546           return;
1547         }
1548
1549       /* Increment RTO backoff (also equal to number of retries) and go back
1550        * to first un-acked byte  */
1551       tc->rto_boff += 1;
1552
1553       /* First retransmit timeout */
1554       if (tc->rto_boff == 1)
1555         tcp_rxt_timeout_cc (tc);
1556       else
1557         scoreboard_clear (&tc->sack_sb);
1558
1559       if (tc->flags & TCP_CONN_RATE_SAMPLE)
1560         tcp_bt_flush_samples (tc);
1561
1562       /* If we've sent beyond snd_congestion, update it */
1563       tc->snd_congestion = seq_max (tc->snd_nxt, tc->snd_congestion);
1564
1565       tc->snd_nxt = tc->snd_una;
1566       tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1567
1568       /* Send one segment. Note that n_bytes may be zero due to buffer
1569        * shortfall */
1570       n_bytes = tcp_prepare_retransmit_segment (wrk, tc, 0, tc->snd_mss, &b);
1571       if (!n_bytes)
1572         {
1573           tcp_timer_update (tc, TCP_TIMER_RETRANSMIT, 1);
1574           return;
1575         }
1576
1577       bi = vlib_get_buffer_index (vm, b);
1578
1579       /* For first retransmit, record timestamp (Eifel detection RFC3522) */
1580       if (tc->rto_boff == 1)
1581         tc->snd_rxt_ts = tcp_time_now_w_thread (tc->c_thread_index);
1582
1583       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1584       tcp_retransmit_timer_force_update (tc);
1585     }
1586   /* Retransmit for SYN */
1587   else if (tc->state == TCP_STATE_SYN_SENT)
1588     {
1589       /* Half-open connection actually moved to established but we were
1590        * waiting for syn retransmit to pop to call cleanup from the right
1591        * thread. */
1592       if (tc->flags & TCP_CONN_HALF_OPEN_DONE)
1593         {
1594           if (tcp_half_open_connection_cleanup (tc))
1595             TCP_DBG ("could not remove half-open connection");
1596           return;
1597         }
1598
1599       TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 2);
1600
1601       /* Try without increasing RTO a number of times. If this fails,
1602        * start growing RTO exponentially */
1603       tc->rto_boff += 1;
1604       if (tc->rto_boff > TCP_RTO_SYN_RETRIES)
1605         tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1606
1607       tcp_timer_update (tc, TCP_TIMER_RETRANSMIT_SYN,
1608                         tc->rto * TCP_TO_TIMER_TICK);
1609
1610       if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
1611         {
1612           tcp_timer_update (tc, TCP_TIMER_RETRANSMIT_SYN, 1);
1613           return;
1614         }
1615
1616       b = vlib_get_buffer (vm, bi);
1617       tcp_init_buffer (vm, b);
1618       tcp_make_syn (tc, b);
1619
1620       tc->rtt_ts = 0;
1621       TCP_EVT_DBG (TCP_EVT_SYN_RXT, tc, 0);
1622
1623       /* This goes straight to ipx_lookup. Retransmit timer set already */
1624       tcp_push_ip_hdr (wrk, tc, b);
1625       tcp_enqueue_to_ip_lookup (wrk, b, bi, tc->c_is_ip4, tc->c_fib_index);
1626     }
1627   /* Retransmit SYN-ACK */
1628   else if (tc->state == TCP_STATE_SYN_RCVD)
1629     {
1630       TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 2);
1631
1632       tc->rto_boff += 1;
1633       if (tc->rto_boff > TCP_RTO_SYN_RETRIES)
1634         tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1635       tc->rtt_ts = 0;
1636
1637       tcp_retransmit_timer_force_update (tc);
1638
1639       if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
1640         {
1641           tcp_timer_update (tc, TCP_TIMER_RETRANSMIT, 1);
1642           return;
1643         }
1644
1645       b = vlib_get_buffer (vm, bi);
1646       tcp_init_buffer (vm, b);
1647       tcp_make_synack (tc, b);
1648       TCP_EVT_DBG (TCP_EVT_SYN_RXT, tc, 1);
1649
1650       /* Retransmit timer already updated, just enqueue to output */
1651       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1652     }
1653   else
1654     {
1655       ASSERT (tc->state == TCP_STATE_CLOSED);
1656       return;
1657     }
1658 }
1659
1660 void
1661 tcp_timer_retransmit_handler (u32 index)
1662 {
1663   tcp_timer_retransmit_handler_i (index, 0);
1664 }
1665
1666 void
1667 tcp_timer_retransmit_syn_handler (u32 index)
1668 {
1669   tcp_timer_retransmit_handler_i (index, 1);
1670 }
1671
1672 /**
1673  * Got 0 snd_wnd from peer, try to do something about it.
1674  *
1675  */
1676 void
1677 tcp_timer_persist_handler (u32 index)
1678 {
1679   u32 thread_index = vlib_get_thread_index ();
1680   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1681   u32 bi, max_snd_bytes, available_bytes, offset;
1682   tcp_main_t *tm = vnet_get_tcp_main ();
1683   vlib_main_t *vm = wrk->vm;
1684   tcp_connection_t *tc;
1685   vlib_buffer_t *b;
1686   int n_bytes = 0;
1687   u8 *data;
1688
1689   tc = tcp_connection_get_if_valid (index, thread_index);
1690   if (!tc)
1691     return;
1692
1693   /* Make sure timer handle is set to invalid */
1694   tc->timers[TCP_TIMER_PERSIST] = TCP_TIMER_HANDLE_INVALID;
1695
1696   /* Problem already solved or worse */
1697   if (tc->state == TCP_STATE_CLOSED || tc->snd_wnd > tc->snd_mss
1698       || (tc->flags & TCP_CONN_FINSNT))
1699     return;
1700
1701   available_bytes = transport_max_tx_dequeue (&tc->connection);
1702   offset = tc->snd_nxt - tc->snd_una;
1703
1704   /* Reprogram persist if no new bytes available to send. We may have data
1705    * next time */
1706   if (!available_bytes)
1707     {
1708       tcp_persist_timer_set (tc);
1709       return;
1710     }
1711
1712   if (available_bytes <= offset)
1713     {
1714       ASSERT (tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT));
1715       return;
1716     }
1717
1718   /* Increment RTO backoff */
1719   tc->rto_boff += 1;
1720   tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1721
1722   /*
1723    * Try to force the first unsent segment (or buffer)
1724    */
1725   if (PREDICT_FALSE (!vlib_buffer_alloc (vm, &bi, 1)))
1726     {
1727       tcp_persist_timer_set (tc);
1728       return;
1729     }
1730   b = vlib_get_buffer (vm, bi);
1731   data = tcp_init_buffer (vm, b);
1732
1733   tcp_validate_txf_size (tc, offset);
1734   tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts, tc->state);
1735   max_snd_bytes = clib_min (tc->snd_mss,
1736                             tm->bytes_per_buffer - TRANSPORT_MAX_HDRS_LEN);
1737   n_bytes = session_tx_fifo_peek_bytes (&tc->connection, data, offset,
1738                                         max_snd_bytes);
1739   b->current_length = n_bytes;
1740   ASSERT (n_bytes != 0 && (tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT)
1741                            || tc->snd_nxt == tc->snd_una_max
1742                            || tc->rto_boff > 1));
1743
1744   tcp_push_hdr_i (tc, b, tc->snd_nxt, /* compute opts */ 0,
1745                   /* burst */ 0, /* update_snd_nxt */ 1);
1746   tc->snd_una_max = seq_max (tc->snd_nxt, tc->snd_una_max);
1747   tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
1748   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1749
1750   /* Just sent new data, enable retransmit */
1751   tcp_retransmit_timer_update (tc);
1752 }
1753
1754 /**
1755  * Retransmit first unacked segment
1756  */
1757 int
1758 tcp_retransmit_first_unacked (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1759 {
1760   vlib_main_t *vm = wrk->vm;
1761   vlib_buffer_t *b;
1762   u32 bi, n_bytes;
1763
1764   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 1);
1765
1766   n_bytes = tcp_prepare_retransmit_segment (wrk, tc, 0, tc->snd_mss, &b);
1767   if (!n_bytes)
1768     return -1;
1769
1770   bi = vlib_get_buffer_index (vm, b);
1771   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1772
1773   return 0;
1774 }
1775
1776 static int
1777 tcp_fast_retransmit_unsent (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1778                             u32 burst_size)
1779 {
1780   u32 offset, n_segs = 0, n_written, bi;
1781   vlib_main_t *vm = wrk->vm;
1782   vlib_buffer_t *b = 0;
1783
1784   offset = tc->snd_nxt - tc->snd_una;
1785   while (n_segs < burst_size)
1786     {
1787       n_written = tcp_prepare_segment (wrk, tc, offset, tc->snd_mss, &b);
1788       if (!n_written)
1789         goto done;
1790
1791       bi = vlib_get_buffer_index (vm, b);
1792       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1793       offset += n_written;
1794       n_segs += 1;
1795
1796       tc->snd_nxt += n_written;
1797       tc->snd_una_max = seq_max (tc->snd_nxt, tc->snd_una_max);
1798     }
1799
1800 done:
1801   return n_segs;
1802 }
1803
1804 #define scoreboard_rescue_rxt_valid(_sb, _tc)                   \
1805     (seq_geq (_sb->rescue_rxt, _tc->snd_una)                    \
1806         && seq_leq (_sb->rescue_rxt, _tc->snd_congestion))
1807
1808 /**
1809  * Do fast retransmit with SACKs
1810  */
1811 int
1812 tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1813                           u32 burst_size)
1814 {
1815   u32 n_written = 0, offset, max_bytes, n_segs = 0, n_segs_now;
1816   sack_scoreboard_hole_t *hole;
1817   vlib_main_t *vm = wrk->vm;
1818   vlib_buffer_t *b = 0;
1819   sack_scoreboard_t *sb;
1820   u32 bi, max_deq;
1821   int snd_space;
1822   u8 snd_limited = 0, can_rescue = 0;
1823
1824   ASSERT (tcp_in_fastrecovery (tc));
1825
1826   snd_space = tcp_available_cc_snd_space (tc);
1827   if (snd_space < tc->snd_mss)
1828     {
1829       tcp_program_fastretransmit (wrk, tc);
1830       return 0;
1831     }
1832
1833   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 0);
1834   sb = &tc->sack_sb;
1835   hole = scoreboard_get_hole (sb, sb->cur_rxt_hole);
1836
1837   max_deq = transport_max_tx_dequeue (&tc->connection);
1838   max_deq -= tc->snd_nxt - tc->snd_una;
1839
1840   while (snd_space > 0 && n_segs < burst_size)
1841     {
1842       hole = scoreboard_next_rxt_hole (sb, hole, max_deq, &can_rescue,
1843                                        &snd_limited);
1844       if (!hole)
1845         {
1846           if (max_deq)
1847             {
1848               snd_space = clib_min (max_deq, snd_space);
1849               burst_size = clib_min (burst_size - n_segs,
1850                                      snd_space / tc->snd_mss);
1851               n_segs_now = tcp_fast_retransmit_unsent (wrk, tc, burst_size);
1852               if (max_deq > n_segs_now * tc->snd_mss)
1853                 tcp_program_fastretransmit (wrk, tc);
1854               n_segs += n_segs_now;
1855               goto done;
1856             }
1857
1858           if (!can_rescue || scoreboard_rescue_rxt_valid (sb, tc))
1859             break;
1860
1861           /* If rescue rxt undefined or less than snd_una then one segment of
1862            * up to SMSS octets that MUST include the highest outstanding
1863            * unSACKed sequence number SHOULD be returned, and RescueRxt set to
1864            * RecoveryPoint. HighRxt MUST NOT be updated.
1865            */
1866           max_bytes = clib_min (tc->snd_mss,
1867                                 tc->snd_congestion - tc->snd_una);
1868           max_bytes = clib_min (max_bytes, snd_space);
1869           offset = tc->snd_congestion - tc->snd_una - max_bytes;
1870           sb->rescue_rxt = tc->snd_congestion;
1871           n_written = tcp_prepare_retransmit_segment (wrk, tc, offset,
1872                                                       max_bytes, &b);
1873           if (!n_written)
1874             goto done;
1875
1876           bi = vlib_get_buffer_index (vm, b);
1877           tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1878           n_segs += 1;
1879           break;
1880         }
1881
1882       max_bytes = clib_min (hole->end - sb->high_rxt, snd_space);
1883       max_bytes = snd_limited ? clib_min (max_bytes, tc->snd_mss) : max_bytes;
1884       if (max_bytes == 0)
1885         break;
1886
1887       offset = sb->high_rxt - tc->snd_una;
1888       n_written = tcp_prepare_retransmit_segment (wrk, tc, offset, max_bytes,
1889                                                   &b);
1890       ASSERT (n_written <= snd_space);
1891
1892       /* Nothing left to retransmit */
1893       if (n_written == 0)
1894         break;
1895
1896       bi = vlib_get_buffer_index (vm, b);
1897       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1898
1899       sb->high_rxt += n_written;
1900       snd_space -= n_written;
1901       n_segs += 1;
1902     }
1903
1904   if (hole)
1905     tcp_program_fastretransmit (wrk, tc);
1906
1907 done:
1908   return n_segs;
1909 }
1910
1911 /**
1912  * Fast retransmit without SACK info
1913  */
1914 int
1915 tcp_fast_retransmit_no_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1916                              u32 burst_size)
1917 {
1918   u32 n_written = 0, offset = 0, bi, max_deq, n_segs_now;
1919   vlib_main_t *vm = wrk->vm;
1920   int snd_space, n_segs = 0;
1921   vlib_buffer_t *b;
1922
1923   ASSERT (tcp_in_fastrecovery (tc));
1924   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 0);
1925
1926   snd_space = tcp_available_cc_snd_space (tc);
1927
1928   if (!tcp_fastrecovery_first (tc))
1929     goto send_unsent;
1930
1931   /* RFC 6582: [If a partial ack], retransmit the first unacknowledged
1932    * segment. */
1933   while (snd_space > 0 && n_segs < burst_size)
1934     {
1935       n_written = tcp_prepare_retransmit_segment (wrk, tc, offset,
1936                                                   tc->snd_mss, &b);
1937
1938       /* Nothing left to retransmit */
1939       if (n_written == 0)
1940         break;
1941
1942       bi = vlib_get_buffer_index (vm, b);
1943       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1944       snd_space -= n_written;
1945       offset += n_written;
1946       n_segs += 1;
1947     }
1948
1949   if (n_segs == burst_size)
1950     goto done;
1951
1952 send_unsent:
1953
1954   /* RFC 6582: Send a new segment if permitted by the new value of cwnd. */
1955   if (snd_space < tc->snd_mss || tc->snd_mss == 0)
1956     goto done;
1957
1958   max_deq = transport_max_tx_dequeue (&tc->connection);
1959   max_deq -= tc->snd_nxt - tc->snd_una;
1960   if (max_deq)
1961     {
1962       snd_space = clib_min (max_deq, snd_space);
1963       burst_size = clib_min (burst_size - n_segs, snd_space / tc->snd_mss);
1964       n_segs_now = tcp_fast_retransmit_unsent (wrk, tc, burst_size);
1965       if (max_deq > n_segs_now * tc->snd_mss)
1966         tcp_program_fastretransmit (wrk, tc);
1967       n_segs += n_segs_now;
1968     }
1969
1970 done:
1971   tcp_fastrecovery_first_off (tc);
1972   return n_segs;
1973 }
1974
1975 /**
1976  * Do fast retransmit
1977  */
1978 int
1979 tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1980                      u32 burst_size)
1981 {
1982   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1983     return tcp_fast_retransmit_sack (wrk, tc, burst_size);
1984   else
1985     return tcp_fast_retransmit_no_sack (wrk, tc, burst_size);
1986 }
1987 #endif /* CLIB_MARCH_VARIANT */
1988
1989 static void
1990 tcp_output_handle_link_local (tcp_connection_t * tc0, vlib_buffer_t * b0,
1991                               u16 * next0, u32 * error0)
1992 {
1993   ip_adjacency_t *adj;
1994   adj_index_t ai;
1995
1996   /* Not thread safe but as long as the connection exists the adj should
1997    * not be removed */
1998   ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &tc0->c_rmt_ip,
1999                      tc0->sw_if_index);
2000   if (ai == ADJ_INDEX_INVALID)
2001     {
2002       vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
2003       *next0 = TCP_OUTPUT_NEXT_DROP;
2004       *error0 = TCP_ERROR_LINK_LOCAL_RW;
2005       return;
2006     }
2007
2008   adj = adj_get (ai);
2009   if (PREDICT_TRUE (adj->lookup_next_index == IP_LOOKUP_NEXT_REWRITE))
2010     *next0 = TCP_OUTPUT_NEXT_IP_REWRITE;
2011   else if (adj->lookup_next_index == IP_LOOKUP_NEXT_ARP)
2012     *next0 = TCP_OUTPUT_NEXT_IP_ARP;
2013   else
2014     {
2015       *next0 = TCP_OUTPUT_NEXT_DROP;
2016       *error0 = TCP_ERROR_LINK_LOCAL_RW;
2017     }
2018   vnet_buffer (b0)->ip.adj_index[VLIB_TX] = ai;
2019 }
2020
2021 static void
2022 tcp46_output_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
2023                           u32 * to_next, u32 n_bufs)
2024 {
2025   u32 n_trace = vlib_get_trace_count (vm, node);
2026   tcp_connection_t *tc;
2027   tcp_tx_trace_t *t;
2028   vlib_buffer_t *b;
2029   tcp_header_t *th;
2030   int i;
2031
2032   for (i = 0; i < clib_min (n_trace, n_bufs); i++)
2033     {
2034       b = vlib_get_buffer (vm, to_next[i]);
2035       th = vlib_buffer_get_current (b);
2036       tc = tcp_connection_get (vnet_buffer (b)->tcp.connection_index,
2037                                vm->thread_index);
2038       t = vlib_add_trace (vm, node, b, sizeof (*t));
2039       clib_memcpy_fast (&t->tcp_header, th, sizeof (t->tcp_header));
2040       clib_memcpy_fast (&t->tcp_connection, tc, sizeof (t->tcp_connection));
2041     }
2042 }
2043
2044 always_inline void
2045 tcp_output_push_ip (vlib_main_t * vm, vlib_buffer_t * b0,
2046                     tcp_connection_t * tc0, u8 is_ip4)
2047 {
2048   tcp_header_t *th0 = 0;
2049
2050   th0 = vlib_buffer_get_current (b0);
2051   TCP_EVT_DBG (TCP_EVT_OUTPUT, tc0, th0->flags, b0->current_length);
2052   if (is_ip4)
2053     {
2054       vlib_buffer_push_ip4 (vm, b0, &tc0->c_lcl_ip4, &tc0->c_rmt_ip4,
2055                             IP_PROTOCOL_TCP, 1);
2056       b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
2057       vnet_buffer (b0)->l4_hdr_offset = (u8 *) th0 - b0->data;
2058       th0->checksum = 0;
2059     }
2060   else
2061     {
2062       ip6_header_t *ih0;
2063       ih0 = vlib_buffer_push_ip6 (vm, b0, &tc0->c_lcl_ip6,
2064                                   &tc0->c_rmt_ip6, IP_PROTOCOL_TCP);
2065       b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
2066       vnet_buffer (b0)->l3_hdr_offset = (u8 *) ih0 - b0->data;
2067       vnet_buffer (b0)->l4_hdr_offset = (u8 *) th0 - b0->data;
2068       th0->checksum = 0;
2069     }
2070 }
2071
2072 always_inline void
2073 tcp_output_handle_packet (tcp_connection_t * tc0, vlib_buffer_t * b0,
2074                           u32 * error0, u16 * next0, u8 is_ip4)
2075 {
2076
2077   if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
2078     {
2079       *error0 = TCP_ERROR_INVALID_CONNECTION;
2080       *next0 = TCP_OUTPUT_NEXT_DROP;
2081       return;
2082     }
2083
2084   /* If next_index is not drop use it */
2085   if (tc0->next_node_index)
2086     {
2087       *next0 = tc0->next_node_index;
2088       vnet_buffer (b0)->tcp.next_node_opaque = tc0->next_node_opaque;
2089     }
2090
2091   vnet_buffer (b0)->sw_if_index[VLIB_TX] = tc0->c_fib_index;
2092   vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
2093
2094   if (!is_ip4)
2095     {
2096       if (PREDICT_FALSE (ip6_address_is_link_local_unicast (&tc0->c_rmt_ip6)))
2097         tcp_output_handle_link_local (tc0, b0, next0, error0);
2098     }
2099
2100   if (!TCP_ALWAYS_ACK)
2101     tcp_timer_reset (tc0, TCP_TIMER_DELACK);
2102 }
2103
2104 always_inline uword
2105 tcp46_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2106                      vlib_frame_t * frame, int is_ip4)
2107 {
2108   u32 n_left_from, *from, thread_index = vm->thread_index;
2109   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
2110   u16 nexts[VLIB_FRAME_SIZE], *next;
2111
2112   from = vlib_frame_vector_args (frame);
2113   n_left_from = frame->n_vectors;
2114   tcp_set_time_now (tcp_get_worker (thread_index));
2115
2116   if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
2117     tcp46_output_trace_frame (vm, node, from, n_left_from);
2118
2119   vlib_get_buffers (vm, from, bufs, n_left_from);
2120   b = bufs;
2121   next = nexts;
2122
2123   while (n_left_from >= 4)
2124     {
2125       u32 error0 = TCP_ERROR_PKTS_SENT, error1 = TCP_ERROR_PKTS_SENT;
2126       tcp_connection_t *tc0, *tc1;
2127
2128       {
2129         vlib_prefetch_buffer_header (b[2], STORE);
2130         CLIB_PREFETCH (b[2]->data, 2 * CLIB_CACHE_LINE_BYTES, STORE);
2131
2132         vlib_prefetch_buffer_header (b[3], STORE);
2133         CLIB_PREFETCH (b[3]->data, 2 * CLIB_CACHE_LINE_BYTES, STORE);
2134       }
2135
2136       next[0] = next[1] = TCP_OUTPUT_NEXT_IP_LOOKUP;
2137
2138       tc0 = tcp_connection_get (vnet_buffer (b[0])->tcp.connection_index,
2139                                 thread_index);
2140       tc1 = tcp_connection_get (vnet_buffer (b[1])->tcp.connection_index,
2141                                 thread_index);
2142
2143       tcp_output_push_ip (vm, b[0], tc0, is_ip4);
2144       tcp_output_push_ip (vm, b[1], tc1, is_ip4);
2145
2146       tcp_output_handle_packet (tc0, b[0], &error0, &next[0], is_ip4);
2147       tcp_output_handle_packet (tc1, b[1], &error1, &next[1], is_ip4);
2148
2149       b += 2;
2150       next += 2;
2151       n_left_from -= 2;
2152     }
2153   while (n_left_from > 0)
2154     {
2155       u32 error0 = TCP_ERROR_PKTS_SENT;
2156       tcp_connection_t *tc0;
2157
2158       if (n_left_from > 1)
2159         {
2160           vlib_prefetch_buffer_header (b[1], STORE);
2161           CLIB_PREFETCH (b[1]->data, 2 * CLIB_CACHE_LINE_BYTES, STORE);
2162         }
2163
2164       next[0] = TCP_OUTPUT_NEXT_IP_LOOKUP;
2165       tc0 = tcp_connection_get (vnet_buffer (b[0])->tcp.connection_index,
2166                                 thread_index);
2167
2168       tcp_output_push_ip (vm, b[0], tc0, is_ip4);
2169       tcp_output_handle_packet (tc0, b[0], &error0, &next[0], is_ip4);
2170
2171       b += 1;
2172       next += 1;
2173       n_left_from -= 1;
2174     }
2175
2176   vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
2177   return frame->n_vectors;
2178 }
2179
2180 VLIB_NODE_FN (tcp4_output_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
2181                                  vlib_frame_t * from_frame)
2182 {
2183   return tcp46_output_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2184 }
2185
2186 VLIB_NODE_FN (tcp6_output_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
2187                                  vlib_frame_t * from_frame)
2188 {
2189   return tcp46_output_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2190 }
2191
2192 /* *INDENT-OFF* */
2193 VLIB_REGISTER_NODE (tcp4_output_node) =
2194 {
2195   .name = "tcp4-output",
2196   /* Takes a vector of packets. */
2197   .vector_size = sizeof (u32),
2198   .n_errors = TCP_N_ERROR,
2199   .protocol_hint = VLIB_NODE_PROTO_HINT_TCP,
2200   .error_strings = tcp_error_strings,
2201   .n_next_nodes = TCP_OUTPUT_N_NEXT,
2202   .next_nodes = {
2203 #define _(s,n) [TCP_OUTPUT_NEXT_##s] = n,
2204     foreach_tcp4_output_next
2205 #undef _
2206   },
2207   .format_buffer = format_tcp_header,
2208   .format_trace = format_tcp_tx_trace,
2209 };
2210 /* *INDENT-ON* */
2211
2212 /* *INDENT-OFF* */
2213 VLIB_REGISTER_NODE (tcp6_output_node) =
2214 {
2215   .name = "tcp6-output",
2216     /* Takes a vector of packets. */
2217   .vector_size = sizeof (u32),
2218   .n_errors = TCP_N_ERROR,
2219   .protocol_hint = VLIB_NODE_PROTO_HINT_TCP,
2220   .error_strings = tcp_error_strings,
2221   .n_next_nodes = TCP_OUTPUT_N_NEXT,
2222   .next_nodes = {
2223 #define _(s,n) [TCP_OUTPUT_NEXT_##s] = n,
2224     foreach_tcp6_output_next
2225 #undef _
2226   },
2227   .format_buffer = format_tcp_header,
2228   .format_trace = format_tcp_tx_trace,
2229 };
2230 /* *INDENT-ON* */
2231
2232 typedef enum _tcp_reset_next
2233 {
2234   TCP_RESET_NEXT_DROP,
2235   TCP_RESET_NEXT_IP_LOOKUP,
2236   TCP_RESET_N_NEXT
2237 } tcp_reset_next_t;
2238
2239 #define foreach_tcp4_reset_next         \
2240   _(DROP, "error-drop")                 \
2241   _(IP_LOOKUP, "ip4-lookup")
2242
2243 #define foreach_tcp6_reset_next         \
2244   _(DROP, "error-drop")                 \
2245   _(IP_LOOKUP, "ip6-lookup")
2246
2247 static uword
2248 tcp46_send_reset_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2249                          vlib_frame_t * from_frame, u8 is_ip4)
2250 {
2251   u32 n_left_from, next_index, *from, *to_next;
2252   u32 my_thread_index = vm->thread_index;
2253
2254   from = vlib_frame_vector_args (from_frame);
2255   n_left_from = from_frame->n_vectors;
2256
2257   next_index = node->cached_next_index;
2258
2259   while (n_left_from > 0)
2260     {
2261       u32 n_left_to_next;
2262
2263       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2264
2265       while (n_left_from > 0 && n_left_to_next > 0)
2266         {
2267           u32 bi0;
2268           vlib_buffer_t *b0;
2269           tcp_tx_trace_t *t0;
2270           tcp_header_t *th0;
2271           u32 error0 = TCP_ERROR_RST_SENT, next0 = TCP_RESET_NEXT_IP_LOOKUP;
2272
2273           bi0 = from[0];
2274           to_next[0] = bi0;
2275           from += 1;
2276           to_next += 1;
2277           n_left_from -= 1;
2278           n_left_to_next -= 1;
2279
2280           b0 = vlib_get_buffer (vm, bi0);
2281
2282           if (tcp_make_reset_in_place (vm, b0, vnet_buffer (b0)->tcp.flags,
2283                                        my_thread_index, is_ip4))
2284             {
2285               error0 = TCP_ERROR_LOOKUP_DROPS;
2286               next0 = TCP_RESET_NEXT_DROP;
2287               goto done;
2288             }
2289
2290           /* Prepare to send to IP lookup */
2291           vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
2292           next0 = TCP_RESET_NEXT_IP_LOOKUP;
2293
2294         done:
2295           b0->error = node->errors[error0];
2296           b0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
2297           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2298             {
2299               th0 = vlib_buffer_get_current (b0);
2300               if (is_ip4)
2301                 th0 = ip4_next_header ((ip4_header_t *) th0);
2302               else
2303                 th0 = ip6_next_header ((ip6_header_t *) th0);
2304               t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2305               clib_memcpy_fast (&t0->tcp_header, th0,
2306                                 sizeof (t0->tcp_header));
2307             }
2308
2309           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2310                                            n_left_to_next, bi0, next0);
2311         }
2312       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2313     }
2314   return from_frame->n_vectors;
2315 }
2316
2317 VLIB_NODE_FN (tcp4_reset_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
2318                                 vlib_frame_t * from_frame)
2319 {
2320   return tcp46_send_reset_inline (vm, node, from_frame, 1);
2321 }
2322
2323 VLIB_NODE_FN (tcp6_reset_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
2324                                 vlib_frame_t * from_frame)
2325 {
2326   return tcp46_send_reset_inline (vm, node, from_frame, 0);
2327 }
2328
2329 /* *INDENT-OFF* */
2330 VLIB_REGISTER_NODE (tcp4_reset_node) = {
2331   .name = "tcp4-reset",
2332   .vector_size = sizeof (u32),
2333   .n_errors = TCP_N_ERROR,
2334   .error_strings = tcp_error_strings,
2335   .n_next_nodes = TCP_RESET_N_NEXT,
2336   .next_nodes = {
2337 #define _(s,n) [TCP_RESET_NEXT_##s] = n,
2338     foreach_tcp4_reset_next
2339 #undef _
2340   },
2341   .format_trace = format_tcp_tx_trace,
2342 };
2343 /* *INDENT-ON* */
2344
2345 /* *INDENT-OFF* */
2346 VLIB_REGISTER_NODE (tcp6_reset_node) = {
2347   .name = "tcp6-reset",
2348   .vector_size = sizeof (u32),
2349   .n_errors = TCP_N_ERROR,
2350   .error_strings = tcp_error_strings,
2351   .n_next_nodes = TCP_RESET_N_NEXT,
2352   .next_nodes = {
2353 #define _(s,n) [TCP_RESET_NEXT_##s] = n,
2354     foreach_tcp6_reset_next
2355 #undef _
2356   },
2357   .format_trace = format_tcp_tx_trace,
2358 };
2359 /* *INDENT-ON* */
2360
2361 /*
2362  * fd.io coding-style-patch-verification: ON
2363  *
2364  * Local Variables:
2365  * eval: (c-set-style "gnu")
2366  * End:
2367  */