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