session/tcp: support tx flush mark
[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   tc->rtt_ts = tcp_time_now_us (tc->c_thread_index);
1025   b = vlib_get_buffer (vm, bi);
1026   tcp_make_synack (tc, b);
1027   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1028 }
1029
1030 /**
1031  * Flush tx frame populated by retransmits and timer pops
1032  */
1033 void
1034 tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4)
1035 {
1036   if (wrk->tx_frames[!is_ip4])
1037     {
1038       u32 next_index;
1039       next_index = is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
1040       vlib_put_frame_to_node (wrk->vm, next_index, wrk->tx_frames[!is_ip4]);
1041       wrk->tx_frames[!is_ip4] = 0;
1042     }
1043 }
1044
1045 /**
1046  * Flush ip lookup tx frames populated by timer pops
1047  */
1048 static void
1049 tcp_flush_frame_to_ip_lookup (tcp_worker_ctx_t * wrk, u8 is_ip4)
1050 {
1051   if (wrk->ip_lookup_tx_frames[!is_ip4])
1052     {
1053       u32 next_index;
1054       next_index = is_ip4 ? ip4_lookup_node.index : ip6_lookup_node.index;
1055       vlib_put_frame_to_node (wrk->vm, next_index,
1056                               wrk->ip_lookup_tx_frames[!is_ip4]);
1057       wrk->ip_lookup_tx_frames[!is_ip4] = 0;
1058     }
1059 }
1060
1061 /**
1062  * Flush v4 and v6 tcp and ip-lookup tx frames for thread index
1063  */
1064 void
1065 tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk)
1066 {
1067   tcp_flush_frame_to_output (wrk, 1);
1068   tcp_flush_frame_to_output (wrk, 0);
1069   tcp_flush_frame_to_ip_lookup (wrk, 1);
1070   tcp_flush_frame_to_ip_lookup (wrk, 0);
1071 }
1072
1073 /**
1074  *  Send FIN
1075  */
1076 void
1077 tcp_send_fin (tcp_connection_t * tc)
1078 {
1079   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1080   vlib_main_t *vm = wrk->vm;
1081   vlib_buffer_t *b;
1082   u32 bi;
1083   u8 fin_snt = 0;
1084
1085   fin_snt = tc->flags & TCP_CONN_FINSNT;
1086   if (fin_snt)
1087     tc->snd_nxt = tc->snd_una;
1088
1089   if (PREDICT_FALSE (tcp_get_free_buffer_index (wrk, &bi)))
1090     {
1091       /* Out of buffers so program fin retransmit ASAP */
1092       tcp_timer_update (tc, TCP_TIMER_RETRANSMIT, 1);
1093       goto post_enqueue;
1094     }
1095
1096   tcp_retransmit_timer_force_update (tc);
1097   b = vlib_get_buffer (vm, bi);
1098   tcp_init_buffer (vm, b);
1099   tcp_make_fin (tc, b);
1100   tcp_enqueue_to_output_now (wrk, b, bi, tc->c_is_ip4);
1101   TCP_EVT_DBG (TCP_EVT_FIN_SENT, tc);
1102
1103 post_enqueue:
1104   if (!fin_snt)
1105     {
1106       tc->flags |= TCP_CONN_FINSNT;
1107       tc->flags &= ~TCP_CONN_FINPNDG;
1108       /* Account for the FIN */
1109       tc->snd_una_max += 1;
1110       tc->snd_nxt = tc->snd_una_max;
1111     }
1112   else
1113     {
1114       tc->snd_nxt = tc->snd_una_max;
1115     }
1116 }
1117
1118 always_inline u8
1119 tcp_make_state_flags (tcp_connection_t * tc, tcp_state_t next_state)
1120 {
1121   switch (next_state)
1122     {
1123     case TCP_STATE_ESTABLISHED:
1124     case TCP_STATE_CLOSE_WAIT:
1125       return TCP_FLAG_ACK;
1126     case TCP_STATE_SYN_RCVD:
1127       return TCP_FLAG_SYN | TCP_FLAG_ACK;
1128     case TCP_STATE_SYN_SENT:
1129       return TCP_FLAG_SYN;
1130     case TCP_STATE_LAST_ACK:
1131     case TCP_STATE_FIN_WAIT_1:
1132       if (tc->snd_nxt + 1 < tc->snd_una_max)
1133         return TCP_FLAG_ACK;
1134       else
1135         return TCP_FLAG_FIN;
1136     default:
1137       clib_warning ("Shouldn't be here!");
1138     }
1139   return 0;
1140 }
1141
1142 /**
1143  * Push TCP header and update connection variables
1144  */
1145 always_inline void
1146 tcp_push_hdr_i (tcp_connection_t * tc, vlib_buffer_t * b,
1147                 tcp_state_t next_state, u8 compute_opts, u8 maybe_burst)
1148 {
1149   u32 advertise_wnd, data_len;
1150   u8 tcp_hdr_opts_len, flags;
1151   tcp_main_t *tm = &tcp_main;
1152   tcp_header_t *th;
1153
1154   data_len = b->current_length;
1155   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
1156     data_len += b->total_length_not_including_first_buffer;
1157
1158   vnet_buffer (b)->tcp.flags = 0;
1159   vnet_buffer (b)->tcp.connection_index = tc->c_c_index;
1160
1161   if (compute_opts)
1162     tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts, tc->state);
1163
1164   tcp_hdr_opts_len = tc->snd_opts_len + sizeof (tcp_header_t);
1165
1166   if (maybe_burst)
1167     advertise_wnd = tc->rcv_wnd >> tc->rcv_wscale;
1168   else
1169     advertise_wnd = tcp_window_to_advertise (tc, next_state);
1170
1171   flags = tcp_make_state_flags (tc, next_state);
1172   if (PREDICT_FALSE (tc->flags & TCP_CONN_PSH_PENDING))
1173     {
1174       if (seq_geq (tc->psh_seq, tc->snd_nxt)
1175           && seq_lt (tc->psh_seq, tc->snd_nxt + data_len))
1176         flags |= TCP_FLAG_PSH;
1177     }
1178   th = vlib_buffer_push_tcp (b, tc->c_lcl_port, tc->c_rmt_port, tc->snd_nxt,
1179                              tc->rcv_nxt, tcp_hdr_opts_len, flags,
1180                              advertise_wnd);
1181
1182   if (maybe_burst)
1183     {
1184       clib_memcpy_fast ((u8 *) (th + 1),
1185                         tm->wrk_ctx[tc->c_thread_index].cached_opts,
1186                         tc->snd_opts_len);
1187     }
1188   else
1189     {
1190       u8 len = tcp_options_write ((u8 *) (th + 1), &tc->snd_opts);
1191       ASSERT (len == tc->snd_opts_len);
1192     }
1193
1194   /*
1195    * Update connection variables
1196    */
1197
1198   tc->snd_nxt += data_len;
1199   tc->rcv_las = tc->rcv_nxt;
1200
1201   TCP_EVT_DBG (TCP_EVT_PKTIZE, tc);
1202 }
1203
1204 u32
1205 tcp_push_header (tcp_connection_t * tc, vlib_buffer_t * b)
1206 {
1207   tcp_push_hdr_i (tc, b, TCP_STATE_ESTABLISHED, /* compute opts */ 0,
1208                   /* burst */ 1);
1209   tc->snd_una_max = tc->snd_nxt;
1210   ASSERT (seq_leq (tc->snd_una_max, tc->snd_una + tc->snd_wnd));
1211   tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
1212   /* If not tracking an ACK, start tracking */
1213   if (tc->rtt_ts == 0 && !tcp_in_cong_recovery (tc))
1214     {
1215       tc->rtt_ts = tcp_time_now_us (tc->c_thread_index);
1216       tc->rtt_seq = tc->snd_nxt;
1217     }
1218   if (PREDICT_FALSE (!tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT)))
1219     {
1220       tcp_retransmit_timer_set (tc);
1221       tc->rto_boff = 0;
1222     }
1223   tcp_trajectory_add_start (b, 3);
1224   return 0;
1225 }
1226
1227 void
1228 tcp_send_ack (tcp_connection_t * tc)
1229 {
1230   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1231   vlib_main_t *vm = wrk->vm;
1232   vlib_buffer_t *b;
1233   u32 bi;
1234
1235   /* Get buffer */
1236   if (PREDICT_FALSE (tcp_get_free_buffer_index (wrk, &bi)))
1237     return;
1238   b = vlib_get_buffer (vm, bi);
1239   tcp_init_buffer (vm, b);
1240
1241   /* Fill in the ACK */
1242   tcp_make_ack (tc, b);
1243   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1244 }
1245
1246 void
1247 tcp_program_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1248 {
1249   if (!(tc->flags & TCP_CONN_SNDACK))
1250     {
1251       vec_add1 (wrk->pending_acks, tc->c_c_index);
1252       tc->flags |= TCP_CONN_SNDACK;
1253     }
1254 }
1255
1256 void
1257 tcp_program_dupack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1258 {
1259   if (!(tc->flags & TCP_CONN_SNDACK))
1260     {
1261       vec_add1 (wrk->pending_acks, tc->c_c_index);
1262       tc->flags |= TCP_CONN_SNDACK;
1263     }
1264   if (tc->pending_dupacks < 255)
1265     tc->pending_dupacks += 1;
1266 }
1267
1268 void
1269 tcp_send_acks (tcp_worker_ctx_t * wrk)
1270 {
1271   u32 thread_index, *pending_acks;
1272   tcp_connection_t *tc;
1273   int i, j, n_acks;
1274
1275   if (!vec_len (wrk->pending_acks))
1276     return;
1277
1278   thread_index = wrk->vm->thread_index;
1279   pending_acks = wrk->pending_acks;
1280   for (i = 0; i < vec_len (pending_acks); i++)
1281     {
1282       tc = tcp_connection_get (pending_acks[i], thread_index);
1283       tc->flags &= ~TCP_CONN_SNDACK;
1284       n_acks = clib_max (1, tc->pending_dupacks);
1285       /* If we're supposed to send dupacks but have no ooo data
1286        * send only one ack */
1287       if (tc->pending_dupacks && !vec_len (tc->snd_sacks))
1288         n_acks = 1;
1289       for (j = 0; j < n_acks; j++)
1290         tcp_send_ack (tc);
1291       tc->pending_dupacks = 0;
1292     }
1293   _vec_len (wrk->pending_acks) = 0;
1294 }
1295
1296 /**
1297  * Delayed ack timer handler
1298  *
1299  * Sends delayed ACK when timer expires
1300  */
1301 void
1302 tcp_timer_delack_handler (u32 index)
1303 {
1304   u32 thread_index = vlib_get_thread_index ();
1305   tcp_connection_t *tc;
1306
1307   tc = tcp_connection_get (index, thread_index);
1308   tc->timers[TCP_TIMER_DELACK] = TCP_TIMER_HANDLE_INVALID;
1309   tcp_send_ack (tc);
1310 }
1311
1312 /**
1313  * Allocate a new buffer and build a new tcp segment
1314  *
1315  * @param wrk           tcp worker
1316  * @param tc            connection for which the segment will be allocated
1317  * @param offset        offset of the first byte in the tx fifo
1318  * @param max_deq_byte  segment size
1319  * @param[out] b        pointer to buffer allocated
1320  *
1321  * @return      the number of bytes in the segment or 0 if buffer cannot be
1322  *              allocated or no data available
1323  */
1324 static int
1325 tcp_prepare_segment (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1326                      u32 offset, u32 max_deq_bytes, vlib_buffer_t ** b)
1327 {
1328   u32 bytes_per_buffer = vnet_get_tcp_main ()->bytes_per_buffer;
1329   u32 bi, seg_size;
1330   vlib_main_t *vm = wrk->vm;
1331   int n_bytes = 0;
1332   u8 *data;
1333
1334   seg_size = max_deq_bytes + MAX_HDRS_LEN;
1335
1336   /*
1337    * Prepare options
1338    */
1339   tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts, tc->state);
1340
1341   /*
1342    * Allocate and fill in buffer(s)
1343    */
1344
1345   /* Easy case, buffer size greater than mss */
1346   if (PREDICT_TRUE (seg_size <= bytes_per_buffer))
1347     {
1348       if (PREDICT_FALSE (tcp_get_free_buffer_index (wrk, &bi)))
1349         return 0;
1350       *b = vlib_get_buffer (vm, bi);
1351       data = tcp_init_buffer (vm, *b);
1352       n_bytes = stream_session_peek_bytes (&tc->connection, data, offset,
1353                                            max_deq_bytes);
1354       ASSERT (n_bytes == max_deq_bytes);
1355       b[0]->current_length = n_bytes;
1356       tcp_push_hdr_i (tc, *b, tc->state, /* compute opts */ 0, /* burst */ 0);
1357       if (seq_gt (tc->snd_nxt, tc->snd_una_max))
1358         tc->snd_una_max = tc->snd_nxt;
1359     }
1360   /* Split mss into multiple buffers */
1361   else
1362     {
1363       u32 chain_bi = ~0, n_bufs_per_seg;
1364       u16 n_peeked, len_to_deq, available_bufs;
1365       vlib_buffer_t *chain_b, *prev_b;
1366       int i;
1367
1368       /* Make sure we have enough buffers */
1369       n_bufs_per_seg = ceil ((double) seg_size / bytes_per_buffer);
1370       available_bufs = vec_len (wrk->tx_buffers);
1371       if (n_bufs_per_seg > available_bufs)
1372         {
1373           tcp_alloc_tx_buffers (wrk, &available_bufs, VLIB_FRAME_SIZE);
1374           if (n_bufs_per_seg > available_bufs)
1375             {
1376               *b = 0;
1377               return 0;
1378             }
1379         }
1380
1381       (void) tcp_get_free_buffer_index (wrk, &bi);
1382       ASSERT (bi != (u32) ~ 0);
1383       *b = vlib_get_buffer (vm, bi);
1384       data = tcp_init_buffer (vm, *b);
1385       n_bytes = stream_session_peek_bytes (&tc->connection, data, offset,
1386                                            bytes_per_buffer - MAX_HDRS_LEN);
1387       b[0]->current_length = n_bytes;
1388       b[0]->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1389       b[0]->total_length_not_including_first_buffer = 0;
1390       max_deq_bytes -= n_bytes;
1391
1392       chain_b = *b;
1393       for (i = 1; i < n_bufs_per_seg; i++)
1394         {
1395           prev_b = chain_b;
1396           len_to_deq = clib_min (max_deq_bytes, bytes_per_buffer);
1397           tcp_get_free_buffer_index (wrk, &chain_bi);
1398           ASSERT (chain_bi != (u32) ~ 0);
1399           chain_b = vlib_get_buffer (vm, chain_bi);
1400           chain_b->current_data = 0;
1401           data = vlib_buffer_get_current (chain_b);
1402           n_peeked = stream_session_peek_bytes (&tc->connection, data,
1403                                                 offset + n_bytes, len_to_deq);
1404           ASSERT (n_peeked == len_to_deq);
1405           n_bytes += n_peeked;
1406           chain_b->current_length = n_peeked;
1407           chain_b->next_buffer = 0;
1408
1409           /* update previous buffer */
1410           prev_b->next_buffer = chain_bi;
1411           prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
1412
1413           max_deq_bytes -= n_peeked;
1414           b[0]->total_length_not_including_first_buffer += n_peeked;
1415         }
1416
1417       tcp_push_hdr_i (tc, *b, tc->state, /* compute opts */ 0, /* burst */ 0);
1418       if (seq_gt (tc->snd_nxt, tc->snd_una_max))
1419         tc->snd_una_max = tc->snd_nxt;
1420     }
1421
1422   ASSERT (n_bytes > 0);
1423   ASSERT (((*b)->current_data + (*b)->current_length) <= bytes_per_buffer);
1424
1425   return n_bytes;
1426 }
1427
1428 /**
1429  * Build a retransmit segment
1430  *
1431  * @return the number of bytes in the segment or 0 if there's nothing to
1432  *         retransmit
1433  */
1434 static u32
1435 tcp_prepare_retransmit_segment (tcp_worker_ctx_t * wrk,
1436                                 tcp_connection_t * tc, u32 offset,
1437                                 u32 max_deq_bytes, vlib_buffer_t ** b)
1438 {
1439   u32 start, available_bytes;
1440   int n_bytes = 0;
1441
1442   ASSERT (tc->state >= TCP_STATE_ESTABLISHED);
1443   ASSERT (max_deq_bytes != 0);
1444
1445   /*
1446    * Make sure we can retransmit something
1447    */
1448   available_bytes = session_tx_fifo_max_dequeue (&tc->connection);
1449   ASSERT (available_bytes >= offset);
1450   available_bytes -= offset;
1451   if (!available_bytes)
1452     return 0;
1453
1454   max_deq_bytes = clib_min (tc->snd_mss, max_deq_bytes);
1455   max_deq_bytes = clib_min (available_bytes, max_deq_bytes);
1456
1457   /* Start is beyond snd_congestion */
1458   start = tc->snd_una + offset;
1459   if (seq_geq (start, tc->snd_congestion))
1460     goto done;
1461
1462   /* Don't overshoot snd_congestion */
1463   if (seq_gt (start + max_deq_bytes, tc->snd_congestion))
1464     {
1465       max_deq_bytes = tc->snd_congestion - start;
1466       if (max_deq_bytes == 0)
1467         goto done;
1468     }
1469
1470   n_bytes = tcp_prepare_segment (wrk, tc, offset, max_deq_bytes, b);
1471   if (!n_bytes)
1472     return 0;
1473
1474   if (tcp_in_fastrecovery (tc))
1475     tc->snd_rxt_bytes += n_bytes;
1476
1477 done:
1478   TCP_EVT_DBG (TCP_EVT_CC_RTX, tc, offset, n_bytes);
1479   return n_bytes;
1480 }
1481
1482 /**
1483  * Reset congestion control, switch cwnd to loss window and try again.
1484  */
1485 static void
1486 tcp_rxt_timeout_cc (tcp_connection_t * tc)
1487 {
1488   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 6);
1489   tc->prev_ssthresh = tc->ssthresh;
1490   tc->prev_cwnd = tc->cwnd;
1491
1492   /* Cleanly recover cc (also clears up fast retransmit) */
1493   if (tcp_in_fastrecovery (tc))
1494     {
1495       /* TODO be less aggressive about this */
1496       scoreboard_clear (&tc->sack_sb);
1497       tcp_cc_fastrecovery_exit (tc);
1498     }
1499
1500   /* Start again from the beginning */
1501   tc->cc_algo->congestion (tc);
1502   tc->cwnd = tcp_loss_wnd (tc);
1503   tc->snd_congestion = tc->snd_una_max;
1504   tc->rtt_ts = 0;
1505   tc->cwnd_acc_bytes = 0;
1506   tcp_connection_tx_pacer_reset (tc, tc->cwnd, 2 * tc->snd_mss);
1507   tcp_recovery_on (tc);
1508 }
1509
1510 static inline void
1511 tcp_timer_retransmit_handler_i (u32 index, u8 is_syn)
1512 {
1513   u32 thread_index = vlib_get_thread_index ();
1514   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1515   vlib_main_t *vm = wrk->vm;
1516   tcp_connection_t *tc;
1517   vlib_buffer_t *b = 0;
1518   u32 bi, n_bytes;
1519
1520   if (is_syn)
1521     {
1522       tc = tcp_half_open_connection_get (index);
1523       /* Note: the connection may have transitioned to ESTABLISHED... */
1524       if (PREDICT_FALSE (tc == 0 || tc->state != TCP_STATE_SYN_SENT))
1525         return;
1526       tc->timers[TCP_TIMER_RETRANSMIT_SYN] = TCP_TIMER_HANDLE_INVALID;
1527     }
1528   else
1529     {
1530       tc = tcp_connection_get (index, thread_index);
1531       /* Note: the connection may have been closed and pool_put */
1532       if (PREDICT_FALSE (tc == 0 || tc->state < TCP_STATE_SYN_RCVD))
1533         return;
1534       tc->timers[TCP_TIMER_RETRANSMIT] = TCP_TIMER_HANDLE_INVALID;
1535     }
1536
1537   if (tc->state >= TCP_STATE_ESTABLISHED)
1538     {
1539       TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 2);
1540
1541       /* Lost FIN, retransmit and return */
1542       if (tcp_is_lost_fin (tc))
1543         {
1544           tcp_send_fin (tc);
1545           tc->rto_boff += 1;
1546           tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1547           return;
1548         }
1549
1550       /* Shouldn't be here. This condition is tricky because it has to take
1551        * into account boff > 0 due to persist timeout. */
1552       if ((tc->rto_boff == 0 && tc->snd_una == tc->snd_una_max)
1553           || (tc->rto_boff > 0 && seq_geq (tc->snd_una, tc->snd_congestion)
1554               && !tcp_flight_size (tc)))
1555         {
1556           ASSERT (!tcp_in_recovery (tc));
1557           tc->rto_boff = 0;
1558           return;
1559         }
1560
1561       /* We're not in recovery so make sure rto_boff is 0. Can be non 0 due
1562        * to persist timer timeout */
1563       if (!tcp_in_recovery (tc) && tc->rto_boff > 0)
1564         {
1565           tc->rto_boff = 0;
1566           tcp_update_rto (tc);
1567         }
1568
1569       /* Increment RTO backoff (also equal to number of retries) and go back
1570        * to first un-acked byte  */
1571       tc->rto_boff += 1;
1572
1573       /* First retransmit timeout */
1574       if (tc->rto_boff == 1)
1575         tcp_rxt_timeout_cc (tc);
1576       else
1577         scoreboard_clear (&tc->sack_sb);
1578
1579       /* If we've sent beyond snd_congestion, update it */
1580       if (seq_gt (tc->snd_una_max, tc->snd_congestion))
1581         tc->snd_congestion = tc->snd_una_max;
1582
1583       tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1584       tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1585
1586       /* Send one segment. Note that n_bytes may be zero due to buffer
1587        * shortfall */
1588       n_bytes = tcp_prepare_retransmit_segment (wrk, tc, 0, tc->snd_mss, &b);
1589
1590       if (n_bytes == 0)
1591         {
1592           tcp_retransmit_timer_force_update (tc);
1593           return;
1594         }
1595
1596       bi = vlib_get_buffer_index (vm, b);
1597
1598       /* For first retransmit, record timestamp (Eifel detection RFC3522) */
1599       if (tc->rto_boff == 1)
1600         tc->snd_rxt_ts = tcp_time_now_w_thread (tc->c_thread_index);
1601
1602       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1603       tcp_retransmit_timer_force_update (tc);
1604     }
1605   /* Retransmit for SYN */
1606   else if (tc->state == TCP_STATE_SYN_SENT)
1607     {
1608       /* Half-open connection actually moved to established but we were
1609        * waiting for syn retransmit to pop to call cleanup from the right
1610        * thread. */
1611       if (tc->flags & TCP_CONN_HALF_OPEN_DONE)
1612         {
1613           if (tcp_half_open_connection_cleanup (tc))
1614             {
1615               clib_warning ("could not remove half-open connection");
1616               ASSERT (0);
1617             }
1618           return;
1619         }
1620
1621       TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 2);
1622
1623       /* Try without increasing RTO a number of times. If this fails,
1624        * start growing RTO exponentially */
1625       tc->rto_boff += 1;
1626       if (tc->rto_boff > TCP_RTO_SYN_RETRIES)
1627         tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1628
1629       tcp_timer_update (tc, TCP_TIMER_RETRANSMIT_SYN,
1630                         tc->rto * TCP_TO_TIMER_TICK);
1631
1632       if (PREDICT_FALSE (tcp_get_free_buffer_index (wrk, &bi)))
1633         return;
1634
1635       b = vlib_get_buffer (vm, bi);
1636       tcp_init_buffer (vm, b);
1637       tcp_make_syn (tc, b);
1638
1639       tc->rtt_ts = 0;
1640       TCP_EVT_DBG (TCP_EVT_SYN_RXT, tc, 0);
1641
1642       /* This goes straight to ipx_lookup. Retransmit timer set already */
1643       tcp_push_ip_hdr (wrk, tc, b);
1644       tcp_enqueue_to_ip_lookup (wrk, b, bi, tc->c_is_ip4, tc->c_fib_index);
1645     }
1646   /* Retransmit SYN-ACK */
1647   else if (tc->state == TCP_STATE_SYN_RCVD)
1648     {
1649       TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 2);
1650
1651       tc->rto_boff += 1;
1652       if (tc->rto_boff > TCP_RTO_SYN_RETRIES)
1653         tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1654       tc->rtt_ts = 0;
1655
1656       if (PREDICT_FALSE (tcp_get_free_buffer_index (wrk, &bi)))
1657         {
1658           tcp_retransmit_timer_force_update (tc);
1659           return;
1660         }
1661
1662       b = vlib_get_buffer (vm, bi);
1663       tcp_init_buffer (vm, b);
1664       tcp_make_synack (tc, b);
1665       TCP_EVT_DBG (TCP_EVT_SYN_RXT, tc, 1);
1666
1667       /* Retransmit timer already updated, just enqueue to output */
1668       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1669     }
1670   else
1671     {
1672       ASSERT (tc->state == TCP_STATE_CLOSED);
1673       return;
1674     }
1675 }
1676
1677 void
1678 tcp_timer_retransmit_handler (u32 index)
1679 {
1680   tcp_timer_retransmit_handler_i (index, 0);
1681 }
1682
1683 void
1684 tcp_timer_retransmit_syn_handler (u32 index)
1685 {
1686   tcp_timer_retransmit_handler_i (index, 1);
1687 }
1688
1689 /**
1690  * Got 0 snd_wnd from peer, try to do something about it.
1691  *
1692  */
1693 void
1694 tcp_timer_persist_handler (u32 index)
1695 {
1696   u32 thread_index = vlib_get_thread_index ();
1697   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1698   u32 bi, max_snd_bytes, available_bytes, offset;
1699   tcp_main_t *tm = vnet_get_tcp_main ();
1700   vlib_main_t *vm = wrk->vm;
1701   tcp_connection_t *tc;
1702   vlib_buffer_t *b;
1703   int n_bytes = 0;
1704   u8 *data;
1705
1706   tc = tcp_connection_get_if_valid (index, thread_index);
1707
1708   if (!tc)
1709     return;
1710
1711   /* Make sure timer handle is set to invalid */
1712   tc->timers[TCP_TIMER_PERSIST] = TCP_TIMER_HANDLE_INVALID;
1713
1714   /* Problem already solved or worse */
1715   if (tc->state == TCP_STATE_CLOSED || tc->state > TCP_STATE_ESTABLISHED
1716       || tc->snd_wnd > tc->snd_mss)
1717     return;
1718
1719   available_bytes = session_tx_fifo_max_dequeue (&tc->connection);
1720   offset = tc->snd_una_max - tc->snd_una;
1721
1722   /* Reprogram persist if no new bytes available to send. We may have data
1723    * next time */
1724   if (!available_bytes)
1725     {
1726       tcp_persist_timer_set (tc);
1727       return;
1728     }
1729
1730   if (available_bytes <= offset)
1731     {
1732       ASSERT (tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT));
1733       return;
1734     }
1735
1736   /* Increment RTO backoff */
1737   tc->rto_boff += 1;
1738   tc->rto = clib_min (tc->rto << 1, TCP_RTO_MAX);
1739
1740   /*
1741    * Try to force the first unsent segment (or buffer)
1742    */
1743   if (PREDICT_FALSE (tcp_get_free_buffer_index (wrk, &bi)))
1744     {
1745       tcp_persist_timer_set (tc);
1746       return;
1747     }
1748   b = vlib_get_buffer (vm, bi);
1749   data = tcp_init_buffer (vm, b);
1750
1751   tcp_validate_txf_size (tc, offset);
1752   tc->snd_opts_len = tcp_make_options (tc, &tc->snd_opts, tc->state);
1753   max_snd_bytes = clib_min (tc->snd_mss, tm->bytes_per_buffer - MAX_HDRS_LEN);
1754   n_bytes = stream_session_peek_bytes (&tc->connection, data, offset,
1755                                        max_snd_bytes);
1756   b->current_length = n_bytes;
1757   ASSERT (n_bytes != 0 && (tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT)
1758                            || tc->snd_nxt == tc->snd_una_max
1759                            || tc->rto_boff > 1));
1760
1761   tcp_push_hdr_i (tc, b, tc->state, /* compute opts */ 0, /* burst */ 0);
1762   tc->snd_una_max = tc->snd_nxt;
1763   tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
1764   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1765
1766   /* Just sent new data, enable retransmit */
1767   tcp_retransmit_timer_update (tc);
1768 }
1769
1770 /**
1771  * Retransmit first unacked segment
1772  */
1773 int
1774 tcp_retransmit_first_unacked (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1775 {
1776   u32 bi, old_snd_nxt, n_bytes;
1777   vlib_main_t *vm = wrk->vm;
1778   vlib_buffer_t *b;
1779
1780   old_snd_nxt = tc->snd_nxt;
1781   tc->snd_nxt = tc->snd_una;
1782
1783   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 1);
1784
1785   n_bytes = tcp_prepare_retransmit_segment (wrk, tc, 0, tc->snd_mss, &b);
1786   if (!n_bytes)
1787     return -1;
1788
1789   bi = vlib_get_buffer_index (vm, b);
1790   tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1791   tc->snd_nxt = old_snd_nxt;
1792
1793   return 0;
1794 }
1795
1796 static int
1797 tcp_fast_retransmit_unsent (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1798                             u32 burst_size)
1799 {
1800   u32 offset, n_segs = 0, n_written, bi;
1801   vlib_main_t *vm = wrk->vm;
1802   vlib_buffer_t *b = 0;
1803
1804   tc->snd_nxt = tc->snd_una_max;
1805   offset = tc->snd_una_max - tc->snd_una;
1806   while (n_segs < burst_size)
1807     {
1808       n_written = tcp_prepare_segment (wrk, tc, offset, tc->snd_mss, &b);
1809       if (!n_written)
1810         goto done;
1811
1812       bi = vlib_get_buffer_index (vm, b);
1813       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1814       offset += n_written;
1815       n_segs += 1;
1816     }
1817
1818 done:
1819   return n_segs;
1820 }
1821
1822 #define scoreboard_rescue_rxt_valid(_sb, _tc)                   \
1823     (seq_geq (_sb->rescue_rxt, _tc->snd_una)                    \
1824         && seq_leq (_sb->rescue_rxt, _tc->snd_congestion))
1825
1826 /**
1827  * Do fast retransmit with SACKs
1828  */
1829 int
1830 tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1831                           u32 burst_size)
1832 {
1833   u32 n_written = 0, offset, max_bytes, n_segs = 0, n_segs_now;
1834   sack_scoreboard_hole_t *hole;
1835   vlib_main_t *vm = wrk->vm;
1836   vlib_buffer_t *b = 0;
1837   sack_scoreboard_t *sb;
1838   u32 bi, old_snd_nxt;
1839   int snd_space;
1840   u32 max_deq;
1841   u8 snd_limited = 0, can_rescue = 0;
1842
1843   ASSERT (tcp_in_fastrecovery (tc));
1844
1845   snd_space = tcp_available_cc_snd_space (tc);
1846   if (snd_space < tc->snd_mss)
1847     {
1848       tcp_program_fastretransmit (wrk, tc);
1849       return 0;
1850     }
1851
1852   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 0);
1853   old_snd_nxt = tc->snd_nxt;
1854   sb = &tc->sack_sb;
1855   hole = scoreboard_get_hole (sb, sb->cur_rxt_hole);
1856
1857   max_deq = session_tx_fifo_max_dequeue (&tc->connection);
1858   max_deq -= tc->snd_una_max - tc->snd_una;
1859
1860   while (snd_space > 0 && n_segs < burst_size)
1861     {
1862       hole = scoreboard_next_rxt_hole (sb, hole, max_deq, &can_rescue,
1863                                        &snd_limited);
1864       if (!hole)
1865         {
1866           if (max_deq)
1867             {
1868               snd_space = clib_min (max_deq, snd_space);
1869               burst_size = clib_min (burst_size - n_segs,
1870                                      snd_space / tc->snd_mss);
1871               n_segs_now = tcp_fast_retransmit_unsent (wrk, tc, burst_size);
1872               if (max_deq > n_segs_now * tc->snd_mss)
1873                 tcp_program_fastretransmit (wrk, tc);
1874               n_segs += n_segs_now;
1875               goto done;
1876             }
1877
1878           if (!can_rescue || scoreboard_rescue_rxt_valid (sb, tc))
1879             break;
1880
1881           /* If rescue rxt undefined or less than snd_una then one segment of
1882            * up to SMSS octets that MUST include the highest outstanding
1883            * unSACKed sequence number SHOULD be returned, and RescueRxt set to
1884            * RecoveryPoint. HighRxt MUST NOT be updated.
1885            */
1886           max_bytes = clib_min (tc->snd_mss,
1887                                 tc->snd_congestion - tc->snd_una);
1888           max_bytes = clib_min (max_bytes, snd_space);
1889           offset = tc->snd_congestion - tc->snd_una - max_bytes;
1890           sb->rescue_rxt = tc->snd_congestion;
1891           tc->snd_nxt = tc->snd_una + offset;
1892           n_written = tcp_prepare_retransmit_segment (wrk, tc, offset,
1893                                                       max_bytes, &b);
1894           if (!n_written)
1895             goto done;
1896
1897           bi = vlib_get_buffer_index (vm, b);
1898           tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1899           n_segs += 1;
1900           break;
1901         }
1902
1903       max_bytes = clib_min (hole->end - sb->high_rxt, snd_space);
1904       max_bytes = snd_limited ? clib_min (max_bytes, tc->snd_mss) : max_bytes;
1905       if (max_bytes == 0)
1906         break;
1907
1908       offset = sb->high_rxt - tc->snd_una;
1909       tc->snd_nxt = sb->high_rxt;
1910       n_written = tcp_prepare_retransmit_segment (wrk, tc, offset, max_bytes,
1911                                                   &b);
1912       ASSERT (n_written <= snd_space);
1913
1914       /* Nothing left to retransmit */
1915       if (n_written == 0)
1916         break;
1917
1918       bi = vlib_get_buffer_index (vm, b);
1919       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1920
1921       sb->high_rxt += n_written;
1922       snd_space -= n_written;
1923       n_segs += 1;
1924     }
1925
1926   if (hole)
1927     tcp_program_fastretransmit (wrk, tc);
1928
1929 done:
1930   /* If window allows, send 1 SMSS of new data */
1931   tc->snd_nxt = old_snd_nxt;
1932   return n_segs;
1933 }
1934
1935 /**
1936  * Fast retransmit without SACK info
1937  */
1938 int
1939 tcp_fast_retransmit_no_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1940                              u32 burst_size)
1941 {
1942   u32 n_written = 0, offset = 0, bi, old_snd_nxt, max_deq, n_segs_now;
1943   vlib_main_t *vm = wrk->vm;
1944   int snd_space, n_segs = 0;
1945   vlib_buffer_t *b;
1946
1947   ASSERT (tcp_in_fastrecovery (tc));
1948   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 0);
1949   old_snd_nxt = tc->snd_nxt;
1950
1951   if (!tcp_fastrecovery_first (tc))
1952     goto send_unsent;
1953
1954   /* RFC 6582: [If a partial ack], retransmit the first unacknowledged
1955    * segment. */
1956   snd_space = tc->sack_sb.last_bytes_delivered;
1957   tc->snd_nxt = tc->snd_una;
1958   while (snd_space > 0 && n_segs < burst_size)
1959     {
1960       n_written = tcp_prepare_retransmit_segment (wrk, tc, offset,
1961                                                   tc->snd_mss, &b);
1962
1963       /* Nothing left to retransmit */
1964       if (n_written == 0)
1965         break;
1966
1967       bi = vlib_get_buffer_index (vm, b);
1968       tcp_enqueue_to_output (wrk, b, bi, tc->c_is_ip4);
1969       snd_space -= n_written;
1970       offset += n_written;
1971       n_segs += 1;
1972     }
1973
1974   if (n_segs == burst_size)
1975     goto done;
1976
1977 send_unsent:
1978
1979   /* RFC 6582: Send a new segment if permitted by the new value of cwnd. */
1980   snd_space = tcp_available_cc_snd_space (tc);
1981   if (snd_space < tc->snd_mss || tc->snd_mss == 0)
1982     goto done;
1983
1984   max_deq = session_tx_fifo_max_dequeue (&tc->connection);
1985   max_deq -= tc->snd_una_max - tc->snd_una;
1986   if (max_deq)
1987     {
1988       snd_space = clib_min (max_deq, snd_space);
1989       burst_size = clib_min (burst_size - n_segs, snd_space / tc->snd_mss);
1990       n_segs_now = tcp_fast_retransmit_unsent (wrk, tc, burst_size);
1991       if (max_deq > n_segs_now * tc->snd_mss)
1992         tcp_program_fastretransmit (wrk, tc);
1993       n_segs += n_segs_now;
1994     }
1995
1996   /* Restore snd_nxt */
1997   tc->snd_nxt = old_snd_nxt;
1998
1999 done:
2000   tcp_fastrecovery_first_off (tc);
2001   return n_segs;
2002 }
2003
2004 /**
2005  * Do fast retransmit
2006  */
2007 int
2008 tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
2009                      u32 burst_size)
2010 {
2011   if (tcp_opts_sack_permitted (&tc->rcv_opts))
2012     return tcp_fast_retransmit_sack (wrk, tc, burst_size);
2013   else
2014     return tcp_fast_retransmit_no_sack (wrk, tc, burst_size);
2015 }
2016
2017 static void
2018 tcp_output_handle_link_local (tcp_connection_t * tc0, vlib_buffer_t * b0,
2019                               u16 * next0, u32 * error0)
2020 {
2021   ip_adjacency_t *adj;
2022   adj_index_t ai;
2023
2024   /* Not thread safe but as long as the connection exists the adj should
2025    * not be removed */
2026   ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &tc0->c_rmt_ip,
2027                      tc0->sw_if_index);
2028   if (ai == ADJ_INDEX_INVALID)
2029     {
2030       vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
2031       *next0 = TCP_OUTPUT_NEXT_DROP;
2032       *error0 = TCP_ERROR_LINK_LOCAL_RW;
2033       return;
2034     }
2035
2036   adj = adj_get (ai);
2037   if (PREDICT_TRUE (adj->lookup_next_index == IP_LOOKUP_NEXT_REWRITE))
2038     *next0 = TCP_OUTPUT_NEXT_IP_REWRITE;
2039   else if (adj->lookup_next_index == IP_LOOKUP_NEXT_ARP)
2040     *next0 = TCP_OUTPUT_NEXT_IP_ARP;
2041   else
2042     {
2043       *next0 = TCP_OUTPUT_NEXT_DROP;
2044       *error0 = TCP_ERROR_LINK_LOCAL_RW;
2045     }
2046   vnet_buffer (b0)->ip.adj_index[VLIB_TX] = ai;
2047 }
2048
2049 static void
2050 tcp46_output_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
2051                           u32 * to_next, u32 n_bufs)
2052 {
2053   u32 n_trace = vlib_get_trace_count (vm, node);
2054   tcp_connection_t *tc;
2055   tcp_tx_trace_t *t;
2056   vlib_buffer_t *b;
2057   tcp_header_t *th;
2058   int i;
2059
2060   for (i = 0; i < clib_min (n_trace, n_bufs); i++)
2061     {
2062       b = vlib_get_buffer (vm, to_next[i]);
2063       th = vlib_buffer_get_current (b);
2064       tc = tcp_connection_get (vnet_buffer (b)->tcp.connection_index,
2065                                vm->thread_index);
2066       t = vlib_add_trace (vm, node, b, sizeof (*t));
2067       clib_memcpy_fast (&t->tcp_header, th, sizeof (t->tcp_header));
2068       clib_memcpy_fast (&t->tcp_connection, tc, sizeof (t->tcp_connection));
2069     }
2070 }
2071
2072 always_inline void
2073 tcp_output_push_ip (vlib_main_t * vm, vlib_buffer_t * b0,
2074                     tcp_connection_t * tc0, u8 is_ip4)
2075 {
2076   tcp_header_t *th0 = 0;
2077
2078   th0 = vlib_buffer_get_current (b0);
2079   TCP_EVT_DBG (TCP_EVT_OUTPUT, tc0, th0->flags, b0->current_length);
2080   if (is_ip4)
2081     {
2082       vlib_buffer_push_ip4 (vm, b0, &tc0->c_lcl_ip4, &tc0->c_rmt_ip4,
2083                             IP_PROTOCOL_TCP, 1);
2084       b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
2085       vnet_buffer (b0)->l4_hdr_offset = (u8 *) th0 - b0->data;
2086       th0->checksum = 0;
2087     }
2088   else
2089     {
2090       ip6_header_t *ih0;
2091       ih0 = vlib_buffer_push_ip6 (vm, b0, &tc0->c_lcl_ip6,
2092                                   &tc0->c_rmt_ip6, IP_PROTOCOL_TCP);
2093       b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
2094       vnet_buffer (b0)->l3_hdr_offset = (u8 *) ih0 - b0->data;
2095       vnet_buffer (b0)->l4_hdr_offset = (u8 *) th0 - b0->data;
2096       th0->checksum = 0;
2097     }
2098 }
2099
2100 always_inline void
2101 tcp_output_handle_packet (tcp_connection_t * tc0, vlib_buffer_t * b0,
2102                           u32 * error0, u16 * next0, u8 is_ip4)
2103 {
2104
2105   if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
2106     {
2107       *error0 = TCP_ERROR_INVALID_CONNECTION;
2108       *next0 = TCP_OUTPUT_NEXT_DROP;
2109       return;
2110     }
2111
2112   vnet_buffer (b0)->sw_if_index[VLIB_TX] = tc0->c_fib_index;
2113   vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
2114
2115   if (!is_ip4)
2116     {
2117       if (PREDICT_FALSE (ip6_address_is_link_local_unicast (&tc0->c_rmt_ip6)))
2118         tcp_output_handle_link_local (tc0, b0, next0, error0);
2119     }
2120
2121   if (!TCP_ALWAYS_ACK)
2122     tcp_timer_reset (tc0, TCP_TIMER_DELACK);
2123 }
2124
2125 always_inline uword
2126 tcp46_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2127                      vlib_frame_t * frame, int is_ip4)
2128 {
2129   u32 n_left_from, *from, thread_index = vm->thread_index;
2130   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
2131   u16 nexts[VLIB_FRAME_SIZE], *next;
2132
2133   from = vlib_frame_vector_args (frame);
2134   n_left_from = frame->n_vectors;
2135   tcp_set_time_now (tcp_get_worker (thread_index));
2136
2137   if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
2138     tcp46_output_trace_frame (vm, node, from, n_left_from);
2139
2140   vlib_get_buffers (vm, from, bufs, n_left_from);
2141   b = bufs;
2142   next = nexts;
2143
2144   while (n_left_from >= 4)
2145     {
2146       u32 error0 = TCP_ERROR_PKTS_SENT, error1 = TCP_ERROR_PKTS_SENT;
2147       tcp_connection_t *tc0, *tc1;
2148
2149       {
2150         vlib_prefetch_buffer_header (b[2], STORE);
2151         CLIB_PREFETCH (b[2]->data, 2 * CLIB_CACHE_LINE_BYTES, STORE);
2152
2153         vlib_prefetch_buffer_header (b[3], STORE);
2154         CLIB_PREFETCH (b[3]->data, 2 * CLIB_CACHE_LINE_BYTES, STORE);
2155       }
2156
2157       next[0] = next[1] = TCP_OUTPUT_NEXT_IP_LOOKUP;
2158
2159       tc0 = tcp_connection_get (vnet_buffer (b[0])->tcp.connection_index,
2160                                 thread_index);
2161       tc1 = tcp_connection_get (vnet_buffer (b[1])->tcp.connection_index,
2162                                 thread_index);
2163
2164       tcp_output_push_ip (vm, b[0], tc0, is_ip4);
2165       tcp_output_push_ip (vm, b[1], tc1, is_ip4);
2166
2167       tcp_output_handle_packet (tc0, b[0], &error0, &next[0], is_ip4);
2168       tcp_output_handle_packet (tc1, b[1], &error1, &next[1], is_ip4);
2169
2170       b += 2;
2171       next += 2;
2172       n_left_from -= 2;
2173     }
2174   while (n_left_from > 0)
2175     {
2176       u32 error0 = TCP_ERROR_PKTS_SENT;
2177       tcp_connection_t *tc0;
2178
2179       if (n_left_from > 1)
2180         {
2181           vlib_prefetch_buffer_header (b[1], STORE);
2182           CLIB_PREFETCH (b[1]->data, 2 * CLIB_CACHE_LINE_BYTES, STORE);
2183         }
2184
2185       next[0] = TCP_OUTPUT_NEXT_IP_LOOKUP;
2186       tc0 = tcp_connection_get (vnet_buffer (b[0])->tcp.connection_index,
2187                                 thread_index);
2188
2189       tcp_output_push_ip (vm, b[0], tc0, is_ip4);
2190       tcp_output_handle_packet (tc0, b[0], &error0, &next[0], is_ip4);
2191
2192       b += 1;
2193       next += 1;
2194       n_left_from -= 1;
2195     }
2196
2197   vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
2198   return frame->n_vectors;
2199 }
2200
2201 static uword
2202 tcp4_output (vlib_main_t * vm, vlib_node_runtime_t * node,
2203              vlib_frame_t * from_frame)
2204 {
2205   return tcp46_output_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2206 }
2207
2208 static uword
2209 tcp6_output (vlib_main_t * vm, vlib_node_runtime_t * node,
2210              vlib_frame_t * from_frame)
2211 {
2212   return tcp46_output_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2213 }
2214
2215 /* *INDENT-OFF* */
2216 VLIB_REGISTER_NODE (tcp4_output_node) =
2217 {
2218   .function = tcp4_output,
2219   .name = "tcp4-output",
2220   /* Takes a vector of packets. */
2221   .vector_size = sizeof (u32),
2222   .n_errors = TCP_N_ERROR,
2223   .protocol_hint = VLIB_NODE_PROTO_HINT_TCP,
2224   .error_strings = tcp_error_strings,
2225   .n_next_nodes = TCP_OUTPUT_N_NEXT,
2226   .next_nodes = {
2227 #define _(s,n) [TCP_OUTPUT_NEXT_##s] = n,
2228     foreach_tcp4_output_next
2229 #undef _
2230   },
2231   .format_buffer = format_tcp_header,
2232   .format_trace = format_tcp_tx_trace,
2233 };
2234 /* *INDENT-ON* */
2235
2236 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_output_node, tcp4_output);
2237
2238 /* *INDENT-OFF* */
2239 VLIB_REGISTER_NODE (tcp6_output_node) =
2240 {
2241   .function = tcp6_output,
2242   .name = "tcp6-output",
2243     /* Takes a vector of packets. */
2244   .vector_size = sizeof (u32),
2245   .n_errors = TCP_N_ERROR,
2246   .protocol_hint = VLIB_NODE_PROTO_HINT_TCP,
2247   .error_strings = tcp_error_strings,
2248   .n_next_nodes = TCP_OUTPUT_N_NEXT,
2249   .next_nodes = {
2250 #define _(s,n) [TCP_OUTPUT_NEXT_##s] = n,
2251     foreach_tcp6_output_next
2252 #undef _
2253   },
2254   .format_buffer = format_tcp_header,
2255   .format_trace = format_tcp_tx_trace,
2256 };
2257 /* *INDENT-ON* */
2258
2259 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_output_node, tcp6_output);
2260
2261 typedef enum _tcp_reset_next
2262 {
2263   TCP_RESET_NEXT_DROP,
2264   TCP_RESET_NEXT_IP_LOOKUP,
2265   TCP_RESET_N_NEXT
2266 } tcp_reset_next_t;
2267
2268 #define foreach_tcp4_reset_next         \
2269   _(DROP, "error-drop")                 \
2270   _(IP_LOOKUP, "ip4-lookup")
2271
2272 #define foreach_tcp6_reset_next         \
2273   _(DROP, "error-drop")                 \
2274   _(IP_LOOKUP, "ip6-lookup")
2275
2276 static uword
2277 tcp46_send_reset_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2278                          vlib_frame_t * from_frame, u8 is_ip4)
2279 {
2280   u32 n_left_from, next_index, *from, *to_next;
2281   u32 my_thread_index = vm->thread_index;
2282
2283   from = vlib_frame_vector_args (from_frame);
2284   n_left_from = from_frame->n_vectors;
2285
2286   next_index = node->cached_next_index;
2287
2288   while (n_left_from > 0)
2289     {
2290       u32 n_left_to_next;
2291
2292       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2293
2294       while (n_left_from > 0 && n_left_to_next > 0)
2295         {
2296           u32 bi0;
2297           vlib_buffer_t *b0;
2298           tcp_tx_trace_t *t0;
2299           tcp_header_t *th0;
2300           u32 error0 = TCP_ERROR_RST_SENT, next0 = TCP_RESET_NEXT_IP_LOOKUP;
2301
2302           bi0 = from[0];
2303           to_next[0] = bi0;
2304           from += 1;
2305           to_next += 1;
2306           n_left_from -= 1;
2307           n_left_to_next -= 1;
2308
2309           b0 = vlib_get_buffer (vm, bi0);
2310
2311           if (tcp_make_reset_in_place (vm, b0, vnet_buffer (b0)->tcp.flags,
2312                                        my_thread_index, is_ip4))
2313             {
2314               error0 = TCP_ERROR_LOOKUP_DROPS;
2315               next0 = TCP_RESET_NEXT_DROP;
2316               goto done;
2317             }
2318
2319           /* Prepare to send to IP lookup */
2320           vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
2321           next0 = TCP_RESET_NEXT_IP_LOOKUP;
2322
2323         done:
2324           b0->error = node->errors[error0];
2325           b0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
2326           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2327             {
2328               th0 = vlib_buffer_get_current (b0);
2329               if (is_ip4)
2330                 th0 = ip4_next_header ((ip4_header_t *) th0);
2331               else
2332                 th0 = ip6_next_header ((ip6_header_t *) th0);
2333               t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2334               clib_memcpy_fast (&t0->tcp_header, th0,
2335                                 sizeof (t0->tcp_header));
2336             }
2337
2338           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2339                                            n_left_to_next, bi0, next0);
2340         }
2341       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2342     }
2343   return from_frame->n_vectors;
2344 }
2345
2346 static uword
2347 tcp4_send_reset (vlib_main_t * vm, vlib_node_runtime_t * node,
2348                  vlib_frame_t * from_frame)
2349 {
2350   return tcp46_send_reset_inline (vm, node, from_frame, 1);
2351 }
2352
2353 static uword
2354 tcp6_send_reset (vlib_main_t * vm, vlib_node_runtime_t * node,
2355                  vlib_frame_t * from_frame)
2356 {
2357   return tcp46_send_reset_inline (vm, node, from_frame, 0);
2358 }
2359
2360 /* *INDENT-OFF* */
2361 VLIB_REGISTER_NODE (tcp4_reset_node) = {
2362   .function = tcp4_send_reset,
2363   .name = "tcp4-reset",
2364   .vector_size = sizeof (u32),
2365   .n_errors = TCP_N_ERROR,
2366   .error_strings = tcp_error_strings,
2367   .n_next_nodes = TCP_RESET_N_NEXT,
2368   .next_nodes = {
2369 #define _(s,n) [TCP_RESET_NEXT_##s] = n,
2370     foreach_tcp4_reset_next
2371 #undef _
2372   },
2373   .format_trace = format_tcp_tx_trace,
2374 };
2375 /* *INDENT-ON* */
2376
2377 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_reset_node, tcp4_send_reset);
2378
2379 /* *INDENT-OFF* */
2380 VLIB_REGISTER_NODE (tcp6_reset_node) = {
2381   .function = tcp6_send_reset,
2382   .name = "tcp6-reset",
2383   .vector_size = sizeof (u32),
2384   .n_errors = TCP_N_ERROR,
2385   .error_strings = tcp_error_strings,
2386   .n_next_nodes = TCP_RESET_N_NEXT,
2387   .next_nodes = {
2388 #define _(s,n) [TCP_RESET_NEXT_##s] = n,
2389     foreach_tcp6_reset_next
2390 #undef _
2391   },
2392   .format_trace = format_tcp_tx_trace,
2393 };
2394 /* *INDENT-ON* */
2395
2396 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_reset_node, tcp6_send_reset);
2397
2398 /*
2399  * fd.io coding-style-patch-verification: ON
2400  *
2401  * Local Variables:
2402  * eval: (c-set-style "gnu")
2403  * End:
2404  */