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