2d36c85e0c9a044227e6f50c628b27f615e6a818
[vpp.git] / src / vnet / tcp / tcp_input.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 <vppinfra/sparse_vec.h>
17 #include <vnet/tcp/tcp_packet.h>
18 #include <vnet/tcp/tcp.h>
19 #include <vnet/session/session.h>
20 #include <math.h>
21
22 static char *tcp_error_strings[] = {
23 #define tcp_error(n,s) s,
24 #include <vnet/tcp/tcp_error.def>
25 #undef tcp_error
26 };
27
28 /* All TCP nodes have the same outgoing arcs */
29 #define foreach_tcp_state_next                  \
30   _ (DROP, "error-drop")                        \
31   _ (TCP4_OUTPUT, "tcp4-output")                \
32   _ (TCP6_OUTPUT, "tcp6-output")
33
34 typedef enum _tcp_established_next
35 {
36 #define _(s,n) TCP_ESTABLISHED_NEXT_##s,
37   foreach_tcp_state_next
38 #undef _
39     TCP_ESTABLISHED_N_NEXT,
40 } tcp_established_next_t;
41
42 typedef enum _tcp_rcv_process_next
43 {
44 #define _(s,n) TCP_RCV_PROCESS_NEXT_##s,
45   foreach_tcp_state_next
46 #undef _
47     TCP_RCV_PROCESS_N_NEXT,
48 } tcp_rcv_process_next_t;
49
50 typedef enum _tcp_syn_sent_next
51 {
52 #define _(s,n) TCP_SYN_SENT_NEXT_##s,
53   foreach_tcp_state_next
54 #undef _
55     TCP_SYN_SENT_N_NEXT,
56 } tcp_syn_sent_next_t;
57
58 typedef enum _tcp_listen_next
59 {
60 #define _(s,n) TCP_LISTEN_NEXT_##s,
61   foreach_tcp_state_next
62 #undef _
63     TCP_LISTEN_N_NEXT,
64 } tcp_listen_next_t;
65
66 /* Generic, state independent indices */
67 typedef enum _tcp_state_next
68 {
69 #define _(s,n) TCP_NEXT_##s,
70   foreach_tcp_state_next
71 #undef _
72     TCP_STATE_N_NEXT,
73 } tcp_state_next_t;
74
75 #define tcp_next_output(is_ip4) (is_ip4 ? TCP_NEXT_TCP4_OUTPUT          \
76                                         : TCP_NEXT_TCP6_OUTPUT)
77
78 vlib_node_registration_t tcp4_established_node;
79 vlib_node_registration_t tcp6_established_node;
80
81 /**
82  * Validate segment sequence number. As per RFC793:
83  *
84  * Segment Receive Test
85  *      Length  Window
86  *      ------- -------  -------------------------------------------
87  *      0       0       SEG.SEQ = RCV.NXT
88  *      0       >0      RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
89  *      >0      0       not acceptable
90  *      >0      >0      RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
91  *                      or RCV.NXT =< SEG.SEQ+SEG.LEN-1 < RCV.NXT+RCV.WND
92  *
93  * This ultimately consists in checking if segment falls within the window.
94  * The one important difference compared to RFC793 is that we use rcv_las,
95  * or the rcv_nxt at last ack sent instead of rcv_nxt since that's the
96  * peer's reference when computing our receive window.
97  *
98  * This:
99  *  seq_leq (end_seq, tc->rcv_las + tc->rcv_wnd) && seq_geq (seq, tc->rcv_las)
100  * however, is too strict when we have retransmits. Instead we just check that
101  * the seq is not beyond the right edge and that the end of the segment is not
102  * less than the left edge.
103  *
104  * N.B. rcv_nxt and rcv_wnd are both updated in this node if acks are sent, so
105  * use rcv_nxt in the right edge window test instead of rcv_las.
106  *
107  */
108 always_inline u8
109 tcp_segment_in_rcv_wnd (tcp_connection_t * tc, u32 seq, u32 end_seq)
110 {
111   return (seq_geq (end_seq, tc->rcv_las)
112           && seq_leq (seq, tc->rcv_nxt + tc->rcv_wnd));
113 }
114
115 /**
116  * Parse TCP header options.
117  *
118  * @param th TCP header
119  * @param to TCP options data structure to be populated
120  * @return -1 if parsing failed
121  */
122 int
123 tcp_options_parse (tcp_header_t * th, tcp_options_t * to)
124 {
125   const u8 *data;
126   u8 opt_len, opts_len, kind;
127   int j;
128   sack_block_t b;
129
130   opts_len = (tcp_doff (th) << 2) - sizeof (tcp_header_t);
131   data = (const u8 *) (th + 1);
132
133   /* Zero out all flags but those set in SYN */
134   to->flags &= (TCP_OPTS_FLAG_SACK_PERMITTED | TCP_OPTS_FLAG_WSCALE);
135
136   for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
137     {
138       kind = data[0];
139
140       /* Get options length */
141       if (kind == TCP_OPTION_EOL)
142         break;
143       else if (kind == TCP_OPTION_NOOP)
144         {
145           opt_len = 1;
146           continue;
147         }
148       else
149         {
150           /* broken options */
151           if (opts_len < 2)
152             return -1;
153           opt_len = data[1];
154
155           /* weird option length */
156           if (opt_len < 2 || opt_len > opts_len)
157             return -1;
158         }
159
160       /* Parse options */
161       switch (kind)
162         {
163         case TCP_OPTION_MSS:
164           if ((opt_len == TCP_OPTION_LEN_MSS) && tcp_syn (th))
165             {
166               to->flags |= TCP_OPTS_FLAG_MSS;
167               to->mss = clib_net_to_host_u16 (*(u16 *) (data + 2));
168             }
169           break;
170         case TCP_OPTION_WINDOW_SCALE:
171           if ((opt_len == TCP_OPTION_LEN_WINDOW_SCALE) && tcp_syn (th))
172             {
173               to->flags |= TCP_OPTS_FLAG_WSCALE;
174               to->wscale = data[2];
175               if (to->wscale > TCP_MAX_WND_SCALE)
176                 {
177                   clib_warning ("Illegal window scaling value: %d",
178                                 to->wscale);
179                   to->wscale = TCP_MAX_WND_SCALE;
180                 }
181             }
182           break;
183         case TCP_OPTION_TIMESTAMP:
184           if (opt_len == TCP_OPTION_LEN_TIMESTAMP)
185             {
186               to->flags |= TCP_OPTS_FLAG_TSTAMP;
187               to->tsval = clib_net_to_host_u32 (*(u32 *) (data + 2));
188               to->tsecr = clib_net_to_host_u32 (*(u32 *) (data + 6));
189             }
190           break;
191         case TCP_OPTION_SACK_PERMITTED:
192           if (opt_len == TCP_OPTION_LEN_SACK_PERMITTED && tcp_syn (th))
193             to->flags |= TCP_OPTS_FLAG_SACK_PERMITTED;
194           break;
195         case TCP_OPTION_SACK_BLOCK:
196           /* If SACK permitted was not advertised or a SYN, break */
197           if ((to->flags & TCP_OPTS_FLAG_SACK_PERMITTED) == 0 || tcp_syn (th))
198             break;
199
200           /* If too short or not correctly formatted, break */
201           if (opt_len < 10 || ((opt_len - 2) % TCP_OPTION_LEN_SACK_BLOCK))
202             break;
203
204           to->flags |= TCP_OPTS_FLAG_SACK;
205           to->n_sack_blocks = (opt_len - 2) / TCP_OPTION_LEN_SACK_BLOCK;
206           vec_reset_length (to->sacks);
207           for (j = 0; j < to->n_sack_blocks; j++)
208             {
209               b.start = clib_net_to_host_u32 (*(u32 *) (data + 2 + 8 * j));
210               b.end = clib_net_to_host_u32 (*(u32 *) (data + 6 + 8 * j));
211               vec_add1 (to->sacks, b);
212             }
213           break;
214         default:
215           /* Nothing to see here */
216           continue;
217         }
218     }
219   return 0;
220 }
221
222 /**
223  * RFC1323: Check against wrapped sequence numbers (PAWS). If we have
224  * timestamp to echo and it's less than tsval_recent, drop segment
225  * but still send an ACK in order to retain TCP's mechanism for detecting
226  * and recovering from half-open connections
227  *
228  * Or at least that's what the theory says. It seems that this might not work
229  * very well with packet reordering and fast retransmit. XXX
230  */
231 always_inline int
232 tcp_segment_check_paws (tcp_connection_t * tc)
233 {
234   return tcp_opts_tstamp (&tc->rcv_opts) && tc->tsval_recent
235     && timestamp_lt (tc->rcv_opts.tsval, tc->tsval_recent);
236 }
237
238 /**
239  * Update tsval recent
240  */
241 always_inline void
242 tcp_update_timestamp (tcp_connection_t * tc, u32 seq, u32 seq_end)
243 {
244   /*
245    * RFC1323: If Last.ACK.sent falls within the range of sequence numbers
246    * of an incoming segment:
247    *    SEG.SEQ <= Last.ACK.sent < SEG.SEQ + SEG.LEN
248    * then the TSval from the segment is copied to TS.Recent;
249    * otherwise, the TSval is ignored.
250    */
251   if (tcp_opts_tstamp (&tc->rcv_opts) && tc->tsval_recent
252       && seq_leq (seq, tc->rcv_las) && seq_leq (tc->rcv_las, seq_end))
253     {
254       ASSERT (timestamp_leq (tc->tsval_recent, tc->rcv_opts.tsval));
255       tc->tsval_recent = tc->rcv_opts.tsval;
256       tc->tsval_recent_age = tcp_time_now ();
257     }
258 }
259
260 /**
261  * Validate incoming segment as per RFC793 p. 69 and RFC1323 p. 19
262  *
263  * It first verifies if segment has a wrapped sequence number (PAWS) and then
264  * does the processing associated to the first four steps (ignoring security
265  * and precedence): sequence number, rst bit and syn bit checks.
266  *
267  * @return 0 if segments passes validation.
268  */
269 static int
270 tcp_segment_validate (vlib_main_t * vm, tcp_connection_t * tc0,
271                       vlib_buffer_t * b0, tcp_header_t * th0, u32 * next0)
272 {
273   if (PREDICT_FALSE (!tcp_ack (th0) && !tcp_rst (th0) && !tcp_syn (th0)))
274     return -1;
275
276   if (PREDICT_FALSE (tcp_options_parse (th0, &tc0->rcv_opts)))
277     {
278       return -1;
279     }
280
281   if (tcp_segment_check_paws (tc0))
282     {
283       if (CLIB_DEBUG > 2)
284         {
285           clib_warning ("paws failed\n%U", format_tcp_connection, tc0, 2);
286           clib_warning ("seq %u seq_end %u ack %u",
287                         vnet_buffer (b0)->tcp.seq_number - tc0->irs,
288                         vnet_buffer (b0)->tcp.seq_end - tc0->irs,
289                         vnet_buffer (b0)->tcp.ack_number - tc0->iss);
290         }
291       TCP_EVT_DBG (TCP_EVT_PAWS_FAIL, tc0, vnet_buffer (b0)->tcp.seq_number,
292                    vnet_buffer (b0)->tcp.seq_end);
293
294       /* If it just so happens that a segment updates tsval_recent for a
295        * segment over 24 days old, invalidate tsval_recent. */
296       if (timestamp_lt (tc0->tsval_recent_age + TCP_PAWS_IDLE,
297                         tcp_time_now ()))
298         {
299           /* Age isn't reset until we get a valid tsval (bsd inspired) */
300           tc0->tsval_recent = 0;
301           clib_warning ("paws failed - really old segment. REALLY?");
302         }
303       else
304         {
305           /* Drop after ack if not rst */
306           if (!tcp_rst (th0))
307             {
308               tcp_make_ack (tc0, b0);
309               *next0 = tcp_next_output (tc0->c_is_ip4);
310               TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc0);
311               return -1;
312             }
313         }
314     }
315
316   /* 1st: check sequence number */
317   if (!tcp_segment_in_rcv_wnd (tc0, vnet_buffer (b0)->tcp.seq_number,
318                                vnet_buffer (b0)->tcp.seq_end))
319     {
320       /* If our window is 0 and the packet is in sequence, let it pass
321        * through for ack processing. It should be dropped later.*/
322       if (tc0->rcv_wnd == 0
323           && tc0->rcv_nxt == vnet_buffer (b0)->tcp.seq_number)
324         {
325           /* TODO Should segment be tagged?  */
326         }
327       else
328         {
329           /* If not RST, send dup ack */
330           if (!tcp_rst (th0))
331             {
332               tcp_make_ack (tc0, b0);
333               *next0 = tcp_next_output (tc0->c_is_ip4);
334               TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc0);
335             }
336           return -1;
337         }
338     }
339
340   /* 2nd: check the RST bit */
341   if (tcp_rst (th0))
342     {
343       tcp_connection_reset (tc0);
344       return -1;
345     }
346
347   /* 3rd: check security and precedence (skip) */
348
349   /* 4th: check the SYN bit */
350   if (tcp_syn (th0))
351     {
352       /* TODO implement RFC 5961 */
353       tcp_make_ack (tc0, b0);
354       *next0 = tcp_next_output (tc0->c_is_ip4);
355       TCP_EVT_DBG (TCP_EVT_SYN_RCVD, tc0);
356       return -1;
357     }
358
359   /* If segment in window, save timestamp */
360   tcp_update_timestamp (tc0, vnet_buffer (b0)->tcp.seq_number,
361                         vnet_buffer (b0)->tcp.seq_end);
362   return 0;
363 }
364
365 always_inline int
366 tcp_rcv_ack_is_acceptable (tcp_connection_t * tc0, vlib_buffer_t * tb0)
367 {
368   /* SND.UNA =< SEG.ACK =< SND.NXT */
369   return (seq_leq (tc0->snd_una, vnet_buffer (tb0)->tcp.ack_number)
370           && seq_leq (vnet_buffer (tb0)->tcp.ack_number, tc0->snd_nxt));
371 }
372
373 /**
374  * Compute smoothed RTT as per VJ's '88 SIGCOMM and RFC6298
375  *
376  * Note that although the original article, srtt and rttvar are scaled
377  * to minimize round-off errors, here we don't. Instead, we rely on
378  * better precision time measurements.
379  *
380  * TODO support us rtt resolution
381  */
382 static void
383 tcp_estimate_rtt (tcp_connection_t * tc, u32 mrtt)
384 {
385   int err, diff;
386
387   if (tc->srtt != 0)
388     {
389       err = mrtt - tc->srtt;
390
391       /* XXX Drop in RTT results in RTTVAR increase and bigger RTO.
392        * The increase should be bound */
393       tc->srtt = clib_max ((int) tc->srtt + (err >> 3), 1);
394       diff = (clib_abs (err) - (int) tc->rttvar) >> 2;
395       tc->rttvar = clib_max ((int) tc->rttvar + diff, 1);
396     }
397   else
398     {
399       /* First measurement. */
400       tc->srtt = mrtt;
401       tc->rttvar = mrtt >> 1;
402     }
403 }
404
405 void
406 tcp_update_rto (tcp_connection_t * tc)
407 {
408   tc->rto = clib_min (tc->srtt + (tc->rttvar << 2), TCP_RTO_MAX);
409   tc->rto = clib_max (tc->rto, TCP_RTO_MIN);
410 }
411
412 /** Update RTT estimate and RTO timer
413  *
414  * Measure RTT: We have two sources of RTT measurements: TSOPT and ACK
415  * timing. Middle boxes are known to fiddle with TCP options so we
416  * should give higher priority to ACK timing.
417  *
418  * return 1 if valid rtt 0 otherwise
419  */
420 static int
421 tcp_update_rtt (tcp_connection_t * tc, u32 ack)
422 {
423   u32 mrtt = 0;
424   u8 rtx_acked;
425
426   /* Determine if only rtx bytes are acked. */
427   rtx_acked = tcp_in_cong_recovery (tc) || !tc->bytes_acked;
428
429   /* Karn's rule, part 1. Don't use retransmitted segments to estimate
430    * RTT because they're ambiguous. */
431   if (tc->rtt_ts && seq_geq (ack, tc->rtt_seq) && !rtx_acked)
432     {
433       mrtt = tcp_time_now () - tc->rtt_ts;
434     }
435   /* As per RFC7323 TSecr can be used for RTTM only if the segment advances
436    * snd_una, i.e., the left side of the send window:
437    * seq_lt (tc->snd_una, ack). */
438   else if (tcp_opts_tstamp (&tc->rcv_opts) && tc->rcv_opts.tsecr
439            && tc->bytes_acked)
440     {
441       mrtt = tcp_time_now () - tc->rcv_opts.tsecr;
442     }
443
444   /* Allow measuring of a new RTT */
445   tc->rtt_ts = 0;
446
447   /* If ACK moves left side of the wnd make sure boff is 0, even if mrtt is
448    * not valid */
449   if (tc->bytes_acked)
450     tc->rto_boff = 0;
451
452   /* Ignore dubious measurements */
453   if (mrtt == 0 || mrtt > TCP_RTT_MAX)
454     return 0;
455
456   tcp_estimate_rtt (tc, mrtt);
457   tcp_update_rto (tc);
458
459   return 0;
460 }
461
462 /**
463  * Dequeue bytes that have been acked and while at it update RTT estimates.
464  */
465 static void
466 tcp_dequeue_acked (tcp_connection_t * tc, u32 ack)
467 {
468   /* Dequeue the newly ACKed add SACKed bytes */
469   stream_session_dequeue_drop (&tc->connection,
470                                tc->bytes_acked + tc->sack_sb.snd_una_adv);
471
472   tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
473
474   /* Update rtt and rto */
475   tcp_update_rtt (tc, ack);
476
477   /* If everything has been acked, stop retransmit timer
478    * otherwise update. */
479   tcp_retransmit_timer_update (tc);
480 }
481
482 /**
483  * Check if duplicate ack as per RFC5681 Sec. 2
484  */
485 static u8
486 tcp_ack_is_dupack (tcp_connection_t * tc, vlib_buffer_t * b, u32 prev_snd_wnd,
487                    u32 prev_snd_una)
488 {
489   return ((vnet_buffer (b)->tcp.ack_number == prev_snd_una)
490           && seq_gt (tc->snd_una_max, tc->snd_una)
491           && (vnet_buffer (b)->tcp.seq_end == vnet_buffer (b)->tcp.seq_number)
492           && (prev_snd_wnd == tc->snd_wnd));
493 }
494
495 /**
496  * Checks if ack is a congestion control event.
497  */
498 static u8
499 tcp_ack_is_cc_event (tcp_connection_t * tc, vlib_buffer_t * b,
500                      u32 prev_snd_wnd, u32 prev_snd_una, u8 * is_dack)
501 {
502   /* Check if ack is duplicate. Per RFC 6675, ACKs that SACK new data are
503    * defined to be 'duplicate' */
504   *is_dack = tc->sack_sb.last_sacked_bytes
505     || tcp_ack_is_dupack (tc, b, prev_snd_wnd, prev_snd_una);
506
507   return ((*is_dack || tcp_in_cong_recovery (tc)) && !tcp_is_lost_fin (tc));
508 }
509
510 void
511 scoreboard_remove_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
512 {
513   sack_scoreboard_hole_t *next, *prev;
514
515   if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
516     {
517       next = pool_elt_at_index (sb->holes, hole->next);
518       next->prev = hole->prev;
519     }
520   else
521     {
522       sb->tail = hole->prev;
523     }
524
525   if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
526     {
527       prev = pool_elt_at_index (sb->holes, hole->prev);
528       prev->next = hole->next;
529     }
530   else
531     {
532       sb->head = hole->next;
533     }
534
535   if (scoreboard_hole_index (sb, hole) == sb->cur_rxt_hole)
536     sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
537
538   /* Poison the entry */
539   if (CLIB_DEBUG > 0)
540     memset (hole, 0xfe, sizeof (*hole));
541
542   pool_put (sb->holes, hole);
543 }
544
545 sack_scoreboard_hole_t *
546 scoreboard_insert_hole (sack_scoreboard_t * sb, u32 prev_index,
547                         u32 start, u32 end)
548 {
549   sack_scoreboard_hole_t *hole, *next, *prev;
550   u32 hole_index;
551
552   pool_get (sb->holes, hole);
553   memset (hole, 0, sizeof (*hole));
554
555   hole->start = start;
556   hole->end = end;
557   hole_index = scoreboard_hole_index (sb, hole);
558
559   prev = scoreboard_get_hole (sb, prev_index);
560   if (prev)
561     {
562       hole->prev = prev_index;
563       hole->next = prev->next;
564
565       if ((next = scoreboard_next_hole (sb, hole)))
566         next->prev = hole_index;
567       else
568         sb->tail = hole_index;
569
570       prev->next = hole_index;
571     }
572   else
573     {
574       sb->head = hole_index;
575       hole->prev = TCP_INVALID_SACK_HOLE_INDEX;
576       hole->next = TCP_INVALID_SACK_HOLE_INDEX;
577     }
578
579   return hole;
580 }
581
582 void
583 scoreboard_update_bytes (tcp_connection_t * tc, sack_scoreboard_t * sb)
584 {
585   sack_scoreboard_hole_t *hole, *prev;
586   u32 bytes = 0, blks = 0;
587
588   sb->lost_bytes = 0;
589   sb->sacked_bytes = 0;
590   hole = scoreboard_last_hole (sb);
591   if (!hole)
592     return;
593
594   if (seq_gt (sb->high_sacked, hole->end))
595     {
596       bytes = sb->high_sacked - hole->end;
597       blks = 1;
598     }
599
600   while ((prev = scoreboard_prev_hole (sb, hole))
601          && (bytes < (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss
602              && blks < TCP_DUPACK_THRESHOLD))
603     {
604       bytes += hole->start - prev->end;
605       blks++;
606       hole = prev;
607     }
608
609   while (hole)
610     {
611       sb->lost_bytes += scoreboard_hole_bytes (hole);
612       hole->is_lost = 1;
613       prev = hole;
614       hole = scoreboard_prev_hole (sb, hole);
615       if (hole)
616         bytes += prev->start - hole->end;
617     }
618   sb->sacked_bytes = bytes;
619 }
620
621 /**
622  * Figure out the next hole to retransmit
623  *
624  * Follows logic proposed in RFC6675 Sec. 4, NextSeg()
625  */
626 sack_scoreboard_hole_t *
627 scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
628                           sack_scoreboard_hole_t * start,
629                           u8 have_sent_1_smss,
630                           u8 * can_rescue, u8 * snd_limited)
631 {
632   sack_scoreboard_hole_t *hole = 0;
633
634   hole = start ? start : scoreboard_first_hole (sb);
635   while (hole && seq_leq (hole->end, sb->high_rxt) && hole->is_lost)
636     hole = scoreboard_next_hole (sb, hole);
637
638   /* Nothing, return */
639   if (!hole)
640     {
641       sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
642       return 0;
643     }
644
645   /* Rule (1): if higher than rxt, less than high_sacked and lost */
646   if (hole->is_lost && seq_lt (hole->start, sb->high_sacked))
647     {
648       sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
649     }
650   else
651     {
652       /* Rule (2): output takes care of transmitting new data */
653       if (!have_sent_1_smss)
654         {
655           hole = 0;
656           sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
657         }
658       /* Rule (3): if hole not lost */
659       else if (seq_lt (hole->start, sb->high_sacked))
660         {
661           *snd_limited = 1;
662           sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
663         }
664       /* Rule (4): if hole beyond high_sacked */
665       else
666         {
667           ASSERT (seq_geq (hole->start, sb->high_sacked));
668           *snd_limited = 1;
669           *can_rescue = 1;
670           /* HighRxt MUST NOT be updated */
671           return 0;
672         }
673     }
674
675   if (hole && seq_lt (sb->high_rxt, hole->start))
676     sb->high_rxt = hole->start;
677
678   return hole;
679 }
680
681 void
682 scoreboard_init_high_rxt (sack_scoreboard_t * sb, u32 seq)
683 {
684   sack_scoreboard_hole_t *hole;
685   hole = scoreboard_first_hole (sb);
686   if (hole)
687     {
688       seq = seq_gt (seq, hole->start) ? seq : hole->start;
689       sb->cur_rxt_hole = sb->head;
690     }
691   sb->high_rxt = seq;
692 }
693
694 /**
695  * Test that scoreboard is sane after recovery
696  *
697  * Returns 1 if scoreboard is empty or if first hole beyond
698  * snd_una.
699  */
700 u8
701 tcp_scoreboard_is_sane_post_recovery (tcp_connection_t * tc)
702 {
703   sack_scoreboard_hole_t *hole;
704   hole = scoreboard_first_hole (&tc->sack_sb);
705   return (!hole || seq_geq (hole->start, tc->snd_una));
706 }
707
708 void
709 tcp_rcv_sacks (tcp_connection_t * tc, u32 ack)
710 {
711   sack_scoreboard_t *sb = &tc->sack_sb;
712   sack_block_t *blk, tmp;
713   sack_scoreboard_hole_t *hole, *next_hole, *last_hole;
714   u32 blk_index = 0, old_sacked_bytes, hole_index;
715   int i, j;
716
717   sb->last_sacked_bytes = 0;
718   sb->snd_una_adv = 0;
719   old_sacked_bytes = sb->sacked_bytes;
720   sb->last_bytes_delivered = 0;
721
722   if (!tcp_opts_sack (&tc->rcv_opts)
723       && sb->head == TCP_INVALID_SACK_HOLE_INDEX)
724     return;
725
726   /* Remove invalid blocks */
727   blk = tc->rcv_opts.sacks;
728   while (blk < vec_end (tc->rcv_opts.sacks))
729     {
730       if (seq_lt (blk->start, blk->end)
731           && seq_gt (blk->start, tc->snd_una)
732           && seq_gt (blk->start, ack) && seq_leq (blk->end, tc->snd_una_max))
733         {
734           blk++;
735           continue;
736         }
737       vec_del1 (tc->rcv_opts.sacks, blk - tc->rcv_opts.sacks);
738     }
739
740   /* Add block for cumulative ack */
741   if (seq_gt (ack, tc->snd_una))
742     {
743       tmp.start = tc->snd_una;
744       tmp.end = ack;
745       vec_add1 (tc->rcv_opts.sacks, tmp);
746     }
747
748   if (vec_len (tc->rcv_opts.sacks) == 0)
749     return;
750
751   tcp_scoreboard_trace_add (tc, ack);
752
753   /* Make sure blocks are ordered */
754   for (i = 0; i < vec_len (tc->rcv_opts.sacks); i++)
755     for (j = i + 1; j < vec_len (tc->rcv_opts.sacks); j++)
756       if (seq_lt (tc->rcv_opts.sacks[j].start, tc->rcv_opts.sacks[i].start))
757         {
758           tmp = tc->rcv_opts.sacks[i];
759           tc->rcv_opts.sacks[i] = tc->rcv_opts.sacks[j];
760           tc->rcv_opts.sacks[j] = tmp;
761         }
762
763   if (sb->head == TCP_INVALID_SACK_HOLE_INDEX)
764     {
765       /* If no holes, insert the first that covers all outstanding bytes */
766       last_hole = scoreboard_insert_hole (sb, TCP_INVALID_SACK_HOLE_INDEX,
767                                           tc->snd_una, tc->snd_una_max);
768       sb->tail = scoreboard_hole_index (sb, last_hole);
769       tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
770       sb->high_sacked = tmp.end;
771     }
772   else
773     {
774       /* If we have holes but snd_una_max is beyond the last hole, update
775        * last hole end */
776       tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
777       last_hole = scoreboard_last_hole (sb);
778       if (seq_gt (tc->snd_una_max, last_hole->end))
779         {
780           if (seq_geq (last_hole->start, sb->high_sacked))
781             {
782               last_hole->end = tc->snd_una_max;
783             }
784           /* New hole after high sacked block */
785           else if (seq_lt (sb->high_sacked, tc->snd_una_max))
786             {
787               scoreboard_insert_hole (sb, sb->tail, sb->high_sacked,
788                                       tc->snd_una_max);
789             }
790         }
791       /* Keep track of max byte sacked for when the last hole
792        * is acked */
793       if (seq_gt (tmp.end, sb->high_sacked))
794         sb->high_sacked = tmp.end;
795     }
796
797   /* Walk the holes with the SACK blocks */
798   hole = pool_elt_at_index (sb->holes, sb->head);
799   while (hole && blk_index < vec_len (tc->rcv_opts.sacks))
800     {
801       blk = &tc->rcv_opts.sacks[blk_index];
802       if (seq_leq (blk->start, hole->start))
803         {
804           /* Block covers hole. Remove hole */
805           if (seq_geq (blk->end, hole->end))
806             {
807               next_hole = scoreboard_next_hole (sb, hole);
808
809               /* Byte accounting: snd_una needs to be advanced */
810               if (blk->end == ack)
811                 {
812                   if (next_hole)
813                     {
814                       if (seq_lt (ack, next_hole->start))
815                         sb->snd_una_adv = next_hole->start - ack;
816                       sb->last_bytes_delivered +=
817                         next_hole->start - hole->end;
818                     }
819                   else
820                     {
821                       ASSERT (seq_geq (sb->high_sacked, ack));
822                       sb->snd_una_adv = sb->high_sacked - ack;
823                       sb->last_bytes_delivered += sb->high_sacked - hole->end;
824                     }
825                 }
826
827               scoreboard_remove_hole (sb, hole);
828               hole = next_hole;
829             }
830           /* Partial 'head' overlap */
831           else
832             {
833               if (seq_gt (blk->end, hole->start))
834                 {
835                   hole->start = blk->end;
836                 }
837               blk_index++;
838             }
839         }
840       else
841         {
842           /* Hole must be split */
843           if (seq_lt (blk->end, hole->end))
844             {
845               hole_index = scoreboard_hole_index (sb, hole);
846               next_hole = scoreboard_insert_hole (sb, hole_index, blk->end,
847                                                   hole->end);
848
849               /* Pool might've moved */
850               hole = scoreboard_get_hole (sb, hole_index);
851               hole->end = blk->start;
852               blk_index++;
853               ASSERT (hole->next == scoreboard_hole_index (sb, next_hole));
854             }
855           else if (seq_lt (blk->start, hole->end))
856             {
857               hole->end = blk->start;
858             }
859           hole = scoreboard_next_hole (sb, hole);
860         }
861     }
862
863   scoreboard_update_bytes (tc, sb);
864   sb->last_sacked_bytes = sb->sacked_bytes
865     - (old_sacked_bytes - sb->last_bytes_delivered);
866   ASSERT (sb->last_sacked_bytes <= sb->sacked_bytes);
867   ASSERT (sb->sacked_bytes == 0
868           || sb->sacked_bytes < tc->snd_una_max - seq_max (tc->snd_una, ack));
869   ASSERT (sb->last_sacked_bytes + sb->lost_bytes <= tc->snd_una_max
870           - seq_max (tc->snd_una, ack));
871   ASSERT (sb->head == TCP_INVALID_SACK_HOLE_INDEX || tcp_in_recovery (tc)
872           || sb->holes[sb->head].start == ack + sb->snd_una_adv);
873 }
874
875 /**
876  * Try to update snd_wnd based on feedback received from peer.
877  *
878  * If successful, and new window is 'effectively' 0, activate persist
879  * timer.
880  */
881 static void
882 tcp_update_snd_wnd (tcp_connection_t * tc, u32 seq, u32 ack, u32 snd_wnd)
883 {
884   /* If (SND.WL1 < SEG.SEQ or (SND.WL1 = SEG.SEQ and SND.WL2 =< SEG.ACK)), set
885    * SND.WND <- SEG.WND, set SND.WL1 <- SEG.SEQ, and set SND.WL2 <- SEG.ACK */
886   if (seq_lt (tc->snd_wl1, seq)
887       || (tc->snd_wl1 == seq && seq_leq (tc->snd_wl2, ack)))
888     {
889       tc->snd_wnd = snd_wnd;
890       tc->snd_wl1 = seq;
891       tc->snd_wl2 = ack;
892       TCP_EVT_DBG (TCP_EVT_SND_WND, tc);
893
894       if (tc->snd_wnd < tc->snd_mss)
895         {
896           /* Set persist timer if not set and we just got 0 wnd */
897           if (!tcp_timer_is_active (tc, TCP_TIMER_PERSIST)
898               && !tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT))
899             tcp_persist_timer_set (tc);
900         }
901       else
902         {
903           tcp_persist_timer_reset (tc);
904           if (!tcp_in_recovery (tc) && tc->rto_boff > 0)
905             {
906               tc->rto_boff = 0;
907               tcp_update_rto (tc);
908             }
909         }
910     }
911 }
912
913 void
914 tcp_cc_init_congestion (tcp_connection_t * tc)
915 {
916   tcp_fastrecovery_on (tc);
917   tc->snd_congestion = tc->snd_una_max;
918   tc->cc_algo->congestion (tc);
919   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 4);
920 }
921
922 static void
923 tcp_cc_recovery_exit (tcp_connection_t * tc)
924 {
925   /* Deflate rto */
926   tcp_update_rto (tc);
927   tc->rto_boff = 0;
928   tc->snd_rxt_ts = 0;
929   tcp_recovery_off (tc);
930 }
931
932 void
933 tcp_cc_fastrecovery_exit (tcp_connection_t * tc)
934 {
935   tc->cc_algo->recovered (tc);
936   tc->snd_rxt_bytes = 0;
937   tc->rcv_dupacks = 0;
938   tcp_fastrecovery_off (tc);
939   tcp_fastrecovery_1_smss_off (tc);
940 }
941
942 static void
943 tcp_cc_congestion_undo (tcp_connection_t * tc)
944 {
945   tc->cwnd = tc->prev_cwnd;
946   tc->ssthresh = tc->prev_ssthresh;
947   tc->snd_nxt = tc->snd_una_max;
948   tc->rcv_dupacks = 0;
949   if (tcp_in_recovery (tc))
950     tcp_cc_recovery_exit (tc);
951   ASSERT (tc->rto_boff == 0);
952   /* TODO extend for fastrecovery */
953 }
954
955 static u8
956 tcp_cc_is_spurious_retransmit (tcp_connection_t * tc)
957 {
958   return (tcp_in_recovery (tc)
959           && tc->snd_rxt_ts
960           && tcp_opts_tstamp (&tc->rcv_opts)
961           && timestamp_lt (tc->rcv_opts.tsecr, tc->snd_rxt_ts));
962 }
963
964 int
965 tcp_cc_recover (tcp_connection_t * tc)
966 {
967   ASSERT (tcp_in_cong_recovery (tc));
968   if (tcp_cc_is_spurious_retransmit (tc))
969     {
970       tcp_cc_congestion_undo (tc);
971       return 1;
972     }
973
974   if (tcp_in_recovery (tc))
975     tcp_cc_recovery_exit (tc);
976   else if (tcp_in_fastrecovery (tc))
977     tcp_cc_fastrecovery_exit (tc);
978
979   ASSERT (tc->rto_boff == 0);
980   ASSERT (!tcp_in_cong_recovery (tc));
981   ASSERT (tcp_scoreboard_is_sane_post_recovery (tc));
982   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
983   return 0;
984 }
985
986 static void
987 tcp_cc_update (tcp_connection_t * tc, vlib_buffer_t * b)
988 {
989   ASSERT (!tcp_in_cong_recovery (tc) || tcp_is_lost_fin (tc));
990
991   /* Congestion avoidance */
992   tc->cc_algo->rcv_ack (tc);
993   tc->tsecr_last_ack = tc->rcv_opts.tsecr;
994
995   /* If a cumulative ack, make sure dupacks is 0 */
996   tc->rcv_dupacks = 0;
997
998   /* When dupacks hits the threshold we only enter fast retransmit if
999    * cumulative ack covers more than snd_congestion. Should snd_una
1000    * wrap this test may fail under otherwise valid circumstances.
1001    * Therefore, proactively update snd_congestion when wrap detected. */
1002   if (PREDICT_FALSE
1003       (seq_leq (tc->snd_congestion, tc->snd_una - tc->bytes_acked)
1004        && seq_gt (tc->snd_congestion, tc->snd_una)))
1005     tc->snd_congestion = tc->snd_una - 1;
1006 }
1007
1008 static u8
1009 tcp_should_fastrecover_sack (tcp_connection_t * tc)
1010 {
1011   return (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss < tc->sack_sb.sacked_bytes;
1012 }
1013
1014 static u8
1015 tcp_should_fastrecover (tcp_connection_t * tc)
1016 {
1017   return (tc->rcv_dupacks == TCP_DUPACK_THRESHOLD
1018           || tcp_should_fastrecover_sack (tc));
1019 }
1020
1021 /**
1022  * One function to rule them all ... and in the darkness bind them
1023  */
1024 static void
1025 tcp_cc_handle_event (tcp_connection_t * tc, u32 is_dack)
1026 {
1027   u32 rxt_delivered;
1028
1029   /*
1030    * Duplicate ACK. Check if we should enter fast recovery, or if already in
1031    * it account for the bytes that left the network.
1032    */
1033   if (is_dack)
1034     {
1035       ASSERT (tc->snd_una != tc->snd_una_max
1036               || tc->sack_sb.last_sacked_bytes);
1037
1038       tc->rcv_dupacks++;
1039
1040       if (tc->rcv_dupacks > TCP_DUPACK_THRESHOLD && !tc->bytes_acked)
1041         {
1042           ASSERT (tcp_in_fastrecovery (tc));
1043           /* Pure duplicate ack. If some data got acked, it's handled lower */
1044           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1045           return;
1046         }
1047       else if (tcp_should_fastrecover (tc))
1048         {
1049           /* Things are already bad */
1050           if (tcp_in_cong_recovery (tc))
1051             {
1052               tc->rcv_dupacks = 0;
1053               goto partial_ack_test;
1054             }
1055
1056           /* If of of the two conditions lower hold, reset dupacks because
1057            * we're probably after timeout (RFC6582 heuristics).
1058            * If Cumulative ack does not cover more than congestion threshold,
1059            * and:
1060            * 1) The following doesn't hold: The congestion window is greater
1061            *    than SMSS bytes and the difference between highest_ack
1062            *    and prev_highest_ack is at most 4*SMSS bytes
1063            * 2) Echoed timestamp in the last non-dup ack does not equal the
1064            *    stored timestamp
1065            */
1066           if (seq_leq (tc->snd_una, tc->snd_congestion)
1067               && ((!(tc->cwnd > tc->snd_mss
1068                      && tc->bytes_acked <= 4 * tc->snd_mss))
1069                   || (tc->rcv_opts.tsecr != tc->tsecr_last_ack)))
1070             {
1071               tc->rcv_dupacks = 0;
1072               return;
1073             }
1074
1075           tcp_cc_init_congestion (tc);
1076           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1077
1078           /* The first segment MUST be retransmitted */
1079           tcp_retransmit_first_unacked (tc);
1080
1081           /* Post retransmit update cwnd to ssthresh and account for the
1082            * three segments that have left the network and should've been
1083            * buffered at the receiver XXX */
1084           tc->cwnd = tc->ssthresh + tc->rcv_dupacks * tc->snd_mss;
1085           ASSERT (tc->cwnd >= tc->snd_mss);
1086
1087           /* If cwnd allows, send more data */
1088           if (tcp_opts_sack_permitted (&tc->rcv_opts))
1089             {
1090               scoreboard_init_high_rxt (&tc->sack_sb,
1091                                         tc->snd_una + tc->snd_mss);
1092               tcp_fast_retransmit_sack (tc);
1093             }
1094           else
1095             {
1096               tcp_fast_retransmit_no_sack (tc);
1097             }
1098
1099           return;
1100         }
1101       else if (!tc->bytes_acked
1102                || (tc->bytes_acked && !tcp_in_cong_recovery (tc)))
1103         {
1104           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1105           return;
1106         }
1107       else
1108         goto partial_ack;
1109     }
1110
1111 partial_ack_test:
1112
1113   if (!tc->bytes_acked)
1114     return;
1115
1116 partial_ack:
1117   /*
1118    * Legitimate ACK. 1) See if we can exit recovery
1119    */
1120   /* XXX limit this only to first partial ack? */
1121   tcp_retransmit_timer_update (tc);
1122
1123   if (seq_geq (tc->snd_una, tc->snd_congestion))
1124     {
1125       /* If spurious return, we've already updated everything */
1126       if (tcp_cc_recover (tc))
1127         {
1128           tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1129           return;
1130         }
1131
1132       tc->snd_nxt = tc->snd_una_max;
1133
1134       /* Treat as congestion avoidance ack */
1135       tc->cc_algo->rcv_ack (tc);
1136       tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1137       return;
1138     }
1139
1140   /*
1141    * Legitimate ACK. 2) If PARTIAL ACK try to retransmit
1142    */
1143   TCP_EVT_DBG (TCP_EVT_CC_PACK, tc);
1144
1145   /* RFC6675: If the incoming ACK is a cumulative acknowledgment,
1146    * reset dupacks to 0 */
1147   tc->rcv_dupacks = 0;
1148
1149   tcp_retransmit_first_unacked (tc);
1150
1151   /* Post RTO timeout don't try anything fancy */
1152   if (tcp_in_recovery (tc))
1153     return;
1154
1155   /* Remove retransmitted bytes that have been delivered */
1156   ASSERT (tc->bytes_acked + tc->sack_sb.snd_una_adv
1157           >= tc->sack_sb.last_bytes_delivered
1158           || (tc->flags & TCP_CONN_FINSNT));
1159
1160   if (seq_lt (tc->snd_una, tc->sack_sb.high_rxt))
1161     {
1162       /* If we have sacks and we haven't gotten an ack beyond high_rxt,
1163        * remove sacked bytes delivered */
1164       rxt_delivered = tc->bytes_acked + tc->sack_sb.snd_una_adv
1165         - tc->sack_sb.last_bytes_delivered;
1166       ASSERT (tc->snd_rxt_bytes >= rxt_delivered);
1167       tc->snd_rxt_bytes -= rxt_delivered;
1168     }
1169   else
1170     {
1171       /* Either all retransmitted holes have been acked, or we're
1172        * "in the blind" and retransmitting segment by segment */
1173       tc->snd_rxt_bytes = 0;
1174     }
1175
1176   tc->cc_algo->rcv_cong_ack (tc, TCP_CC_PARTIALACK);
1177
1178   /*
1179    * Since this was a partial ack, try to retransmit some more data
1180    */
1181   tcp_fast_retransmit (tc);
1182 }
1183
1184 void
1185 tcp_cc_init (tcp_connection_t * tc)
1186 {
1187   tc->cc_algo = tcp_cc_algo_get (TCP_CC_NEWRENO);
1188   tc->cc_algo->init (tc);
1189 }
1190
1191 /**
1192  * Process incoming ACK
1193  */
1194 static int
1195 tcp_rcv_ack (tcp_connection_t * tc, vlib_buffer_t * b,
1196              tcp_header_t * th, u32 * next, u32 * error)
1197 {
1198   u32 prev_snd_wnd, prev_snd_una;
1199   u8 is_dack;
1200
1201   TCP_EVT_DBG (TCP_EVT_CC_STAT, tc);
1202
1203   /* If the ACK acks something not yet sent (SEG.ACK > SND.NXT) */
1204   if (PREDICT_FALSE (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
1205     {
1206       /* If we have outstanding data and this is within the window, accept it,
1207        * probably retransmit has timed out. Otherwise ACK segment and then
1208        * drop it */
1209       if (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max))
1210         {
1211           tcp_make_ack (tc, b);
1212           *next = tcp_next_output (tc->c_is_ip4);
1213           *error = TCP_ERROR_ACK_INVALID;
1214           TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 0,
1215                        vnet_buffer (b)->tcp.ack_number);
1216           return -1;
1217         }
1218
1219       TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 2,
1220                    vnet_buffer (b)->tcp.ack_number);
1221
1222       tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
1223       *error = TCP_ERROR_ACK_FUTURE;
1224     }
1225
1226   /* If old ACK, probably it's an old dupack */
1227   if (PREDICT_FALSE (seq_lt (vnet_buffer (b)->tcp.ack_number, tc->snd_una)))
1228     {
1229       *error = TCP_ERROR_ACK_OLD;
1230       TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 1,
1231                    vnet_buffer (b)->tcp.ack_number);
1232       if (tcp_in_fastrecovery (tc) && tc->rcv_dupacks == TCP_DUPACK_THRESHOLD)
1233         {
1234           TCP_EVT_DBG (TCP_EVT_DUPACK_RCVD, tc);
1235           tcp_cc_handle_event (tc, 1);
1236         }
1237       /* Don't drop yet */
1238       return 0;
1239     }
1240
1241   /*
1242    * Looks okay, process feedback
1243    */
1244
1245   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1246     tcp_rcv_sacks (tc, vnet_buffer (b)->tcp.ack_number);
1247
1248   prev_snd_wnd = tc->snd_wnd;
1249   prev_snd_una = tc->snd_una;
1250   tcp_update_snd_wnd (tc, vnet_buffer (b)->tcp.seq_number,
1251                       vnet_buffer (b)->tcp.ack_number,
1252                       clib_net_to_host_u16 (th->window) << tc->snd_wscale);
1253   tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
1254   tc->snd_una = vnet_buffer (b)->tcp.ack_number + tc->sack_sb.snd_una_adv;
1255   tcp_validate_txf_size (tc, tc->bytes_acked);
1256
1257   if (tc->bytes_acked)
1258     tcp_dequeue_acked (tc, vnet_buffer (b)->tcp.ack_number);
1259
1260   TCP_EVT_DBG (TCP_EVT_ACK_RCVD, tc);
1261
1262   /*
1263    * Check if we have congestion event
1264    */
1265
1266   if (tcp_ack_is_cc_event (tc, b, prev_snd_wnd, prev_snd_una, &is_dack))
1267     {
1268       tcp_cc_handle_event (tc, is_dack);
1269       if (!tcp_in_cong_recovery (tc))
1270         return 0;
1271       *error = TCP_ERROR_ACK_DUP;
1272       TCP_EVT_DBG (TCP_EVT_DUPACK_RCVD, tc, 1);
1273       return vnet_buffer (b)->tcp.data_len ? 0 : -1;
1274     }
1275
1276   /*
1277    * Update congestion control (slow start/congestion avoidance)
1278    */
1279   tcp_cc_update (tc, b);
1280
1281   return 0;
1282 }
1283
1284 static u8
1285 tcp_sack_vector_is_sane (sack_block_t * sacks)
1286 {
1287   int i;
1288   for (i = 1; i < vec_len (sacks); i++)
1289     {
1290       if (sacks[i - 1].end == sacks[i].start)
1291         return 0;
1292     }
1293   return 1;
1294 }
1295
1296 /**
1297  * Build SACK list as per RFC2018.
1298  *
1299  * Makes sure the first block contains the segment that generated the current
1300  * ACK and the following ones are the ones most recently reported in SACK
1301  * blocks.
1302  *
1303  * @param tc TCP connection for which the SACK list is updated
1304  * @param start Start sequence number of the newest SACK block
1305  * @param end End sequence of the newest SACK block
1306  */
1307 void
1308 tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end)
1309 {
1310   sack_block_t *new_list = 0, *block = 0;
1311   int i;
1312
1313   /* If the first segment is ooo add it to the list. Last write might've moved
1314    * rcv_nxt over the first segment. */
1315   if (seq_lt (tc->rcv_nxt, start))
1316     {
1317       vec_add2 (new_list, block, 1);
1318       block->start = start;
1319       block->end = end;
1320     }
1321
1322   /* Find the blocks still worth keeping. */
1323   for (i = 0; i < vec_len (tc->snd_sacks); i++)
1324     {
1325       /* Discard if rcv_nxt advanced beyond current block */
1326       if (seq_leq (tc->snd_sacks[i].start, tc->rcv_nxt))
1327         continue;
1328
1329       /* Merge or drop if segment overlapped by the new segment */
1330       if (block && (seq_geq (tc->snd_sacks[i].end, new_list[0].start)
1331                     && seq_leq (tc->snd_sacks[i].start, new_list[0].end)))
1332         {
1333           if (seq_lt (tc->snd_sacks[i].start, new_list[0].start))
1334             new_list[0].start = tc->snd_sacks[i].start;
1335           if (seq_lt (new_list[0].end, tc->snd_sacks[i].end))
1336             new_list[0].end = tc->snd_sacks[i].end;
1337           continue;
1338         }
1339
1340       /* Save to new SACK list if we have space. */
1341       if (vec_len (new_list) < TCP_MAX_SACK_BLOCKS)
1342         {
1343           vec_add1 (new_list, tc->snd_sacks[i]);
1344         }
1345       else
1346         {
1347           clib_warning ("sack discarded");
1348         }
1349     }
1350
1351   ASSERT (vec_len (new_list) <= TCP_MAX_SACK_BLOCKS);
1352
1353   /* Replace old vector with new one */
1354   vec_free (tc->snd_sacks);
1355   tc->snd_sacks = new_list;
1356
1357   /* Segments should not 'touch' */
1358   ASSERT (tcp_sack_vector_is_sane (tc->snd_sacks));
1359 }
1360
1361 /** Enqueue data for delivery to application */
1362 always_inline int
1363 tcp_session_enqueue_data (tcp_connection_t * tc, vlib_buffer_t * b,
1364                           u16 data_len)
1365 {
1366   int written;
1367
1368   ASSERT (seq_geq (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1369
1370   /* Pure ACK. Update rcv_nxt and be done. */
1371   if (PREDICT_FALSE (data_len == 0))
1372     {
1373       return TCP_ERROR_PURE_ACK;
1374     }
1375
1376   written = stream_session_enqueue_data (&tc->connection, b, 0,
1377                                          1 /* queue event */ , 1);
1378
1379   TCP_EVT_DBG (TCP_EVT_INPUT, tc, 0, data_len, written);
1380
1381   /* Update rcv_nxt */
1382   if (PREDICT_TRUE (written == data_len))
1383     {
1384       tc->rcv_nxt = vnet_buffer (b)->tcp.seq_end;
1385     }
1386   /* If more data written than expected, account for out-of-order bytes. */
1387   else if (written > data_len)
1388     {
1389       tc->rcv_nxt = vnet_buffer (b)->tcp.seq_end + written - data_len;
1390
1391       /* Send ACK confirming the update */
1392       tc->flags |= TCP_CONN_SNDACK;
1393     }
1394   else if (written > 0)
1395     {
1396       /* We've written something but FIFO is probably full now */
1397       tc->rcv_nxt += written;
1398
1399       /* Depending on how fast the app is, all remaining buffers in burst will
1400        * not be enqueued. Inform peer */
1401       tc->flags |= TCP_CONN_SNDACK;
1402
1403       return TCP_ERROR_PARTIALLY_ENQUEUED;
1404     }
1405   else
1406     {
1407       tc->flags |= TCP_CONN_SNDACK;
1408       return TCP_ERROR_FIFO_FULL;
1409     }
1410
1411   /* Update SACK list if need be */
1412   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1413     {
1414       /* Remove SACK blocks that have been delivered */
1415       tcp_update_sack_list (tc, tc->rcv_nxt, tc->rcv_nxt);
1416     }
1417
1418   return TCP_ERROR_ENQUEUED;
1419 }
1420
1421 /** Enqueue out-of-order data */
1422 always_inline int
1423 tcp_session_enqueue_ooo (tcp_connection_t * tc, vlib_buffer_t * b,
1424                          u16 data_len)
1425 {
1426   stream_session_t *s0;
1427   int rv, offset;
1428
1429   ASSERT (seq_gt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1430
1431   /* Pure ACK. Do nothing */
1432   if (PREDICT_FALSE (data_len == 0))
1433     {
1434       return TCP_ERROR_PURE_ACK;
1435     }
1436
1437   /* Enqueue out-of-order data with relative offset */
1438   rv = stream_session_enqueue_data (&tc->connection, b,
1439                                     vnet_buffer (b)->tcp.seq_number -
1440                                     tc->rcv_nxt, 0 /* queue event */ , 0);
1441
1442   /* Nothing written */
1443   if (rv)
1444     {
1445       TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, 0);
1446       return TCP_ERROR_FIFO_FULL;
1447     }
1448
1449   TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, data_len);
1450
1451   /* Update SACK list if in use */
1452   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1453     {
1454       ooo_segment_t *newest;
1455       u32 start, end;
1456
1457       s0 = stream_session_get (tc->c_s_index, tc->c_thread_index);
1458
1459       /* Get the newest segment from the fifo */
1460       newest = svm_fifo_newest_ooo_segment (s0->server_rx_fifo);
1461       if (newest)
1462         {
1463           offset = ooo_segment_offset (s0->server_rx_fifo, newest);
1464           ASSERT (offset <= vnet_buffer (b)->tcp.seq_number - tc->rcv_nxt);
1465           start = tc->rcv_nxt + offset;
1466           end = start + ooo_segment_length (s0->server_rx_fifo, newest);
1467           tcp_update_sack_list (tc, start, end);
1468           svm_fifo_newest_ooo_segment_reset (s0->server_rx_fifo);
1469         }
1470     }
1471
1472   return TCP_ERROR_ENQUEUED;
1473 }
1474
1475 /**
1476  * Check if ACK could be delayed. If ack can be delayed, it should return
1477  * true for a full frame. If we're always acking return 0.
1478  */
1479 always_inline int
1480 tcp_can_delack (tcp_connection_t * tc)
1481 {
1482   /* Send ack if ... */
1483   if (TCP_ALWAYS_ACK
1484       /* just sent a rcv wnd 0 */
1485       || (tc->flags & TCP_CONN_SENT_RCV_WND0) != 0
1486       /* constrained to send ack */
1487       || (tc->flags & TCP_CONN_SNDACK) != 0
1488       /* we're almost out of tx wnd */
1489       || tcp_available_snd_space (tc) < 4 * tc->snd_mss)
1490     return 0;
1491
1492   return 1;
1493 }
1494
1495 static int
1496 tcp_buffer_discard_bytes (vlib_buffer_t * b, u32 n_bytes_to_drop)
1497 {
1498   u32 discard;
1499   vlib_main_t *vm = vlib_get_main ();
1500
1501   /* Handle multi segment packets */
1502   if (n_bytes_to_drop > b->current_length)
1503     {
1504       if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
1505         return -1;
1506       do
1507         {
1508           discard = clib_min (n_bytes_to_drop, b->current_length);
1509           vlib_buffer_advance (b, discard);
1510           b = vlib_get_buffer (vm, b->next_buffer);
1511           n_bytes_to_drop -= discard;
1512         }
1513       while (n_bytes_to_drop);
1514     }
1515   return 0;
1516 }
1517
1518 static int
1519 tcp_segment_rcv (tcp_main_t * tm, tcp_connection_t * tc, vlib_buffer_t * b,
1520                  u32 * next0)
1521 {
1522   u32 error = 0, n_bytes_to_drop, n_data_bytes;
1523
1524   vlib_buffer_advance (b, vnet_buffer (b)->tcp.data_offset);
1525   n_data_bytes = vnet_buffer (b)->tcp.data_len;
1526   ASSERT (n_data_bytes);
1527
1528   /* Handle out-of-order data */
1529   if (PREDICT_FALSE (vnet_buffer (b)->tcp.seq_number != tc->rcv_nxt))
1530     {
1531       /* Old sequence numbers allowed through because they overlapped
1532        * the rx window */
1533       if (seq_lt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt))
1534         {
1535           error = TCP_ERROR_SEGMENT_OLD;
1536           *next0 = TCP_NEXT_DROP;
1537
1538           /* Completely in the past (possible retransmit) */
1539           if (seq_leq (vnet_buffer (b)->tcp.seq_end, tc->rcv_nxt))
1540             {
1541               /* Ack retransmissions since we may not have any data to send */
1542               tcp_make_ack (tc, b);
1543               *next0 = tcp_next_output (tc->c_is_ip4);
1544               goto done;
1545             }
1546
1547           /* Chop off the bytes in the past */
1548           n_bytes_to_drop = tc->rcv_nxt - vnet_buffer (b)->tcp.seq_number;
1549           n_data_bytes -= n_bytes_to_drop;
1550           vnet_buffer (b)->tcp.seq_number = tc->rcv_nxt;
1551           if (tcp_buffer_discard_bytes (b, n_bytes_to_drop))
1552             goto done;
1553
1554           goto in_order;
1555         }
1556
1557       error = tcp_session_enqueue_ooo (tc, b, n_data_bytes);
1558
1559       /* N.B. Should not filter burst of dupacks. Two issues 1) dupacks open
1560        * cwnd on remote peer when congested 2) acks leaving should have the
1561        * latest rcv_wnd since the burst may eaten up all of it, so only the
1562        * old ones could be filtered.
1563        */
1564
1565       /* RFC2581: Send DUPACK for fast retransmit */
1566       tcp_make_ack (tc, b);
1567       *next0 = tcp_next_output (tc->c_is_ip4);
1568
1569       /* Mark as DUPACK. We may filter these in output if
1570        * the burst fills the holes. */
1571       if (n_data_bytes)
1572         vnet_buffer (b)->tcp.flags = TCP_BUF_FLAG_DUPACK;
1573
1574       TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc);
1575       goto done;
1576     }
1577
1578 in_order:
1579
1580   /* In order data, enqueue. Fifo figures out by itself if any out-of-order
1581    * segments can be enqueued after fifo tail offset changes. */
1582   error = tcp_session_enqueue_data (tc, b, n_data_bytes);
1583
1584   /* Check if ACK can be delayed */
1585   if (tcp_can_delack (tc))
1586     {
1587       if (!tcp_timer_is_active (tc, TCP_TIMER_DELACK))
1588         tcp_timer_set (tc, TCP_TIMER_DELACK, TCP_DELACK_TIME);
1589       goto done;
1590     }
1591
1592   *next0 = tcp_next_output (tc->c_is_ip4);
1593   tcp_make_ack (tc, b);
1594
1595 done:
1596   return error;
1597 }
1598
1599 typedef struct
1600 {
1601   tcp_header_t tcp_header;
1602   tcp_connection_t tcp_connection;
1603 } tcp_rx_trace_t;
1604
1605 u8 *
1606 format_tcp_rx_trace (u8 * s, va_list * args)
1607 {
1608   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1609   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1610   tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
1611   uword indent = format_get_indent (s);
1612
1613   s = format (s, "%U\n%U%U",
1614               format_tcp_header, &t->tcp_header, 128,
1615               format_white_space, indent,
1616               format_tcp_connection, &t->tcp_connection, 1);
1617
1618   return s;
1619 }
1620
1621 u8 *
1622 format_tcp_rx_trace_short (u8 * s, va_list * args)
1623 {
1624   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1625   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1626   tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
1627
1628   s = format (s, "%d -> %d (%U)",
1629               clib_net_to_host_u16 (t->tcp_header.src_port),
1630               clib_net_to_host_u16 (t->tcp_header.dst_port), format_tcp_state,
1631               t->tcp_connection.state);
1632
1633   return s;
1634 }
1635
1636 void
1637 tcp_set_rx_trace_data (tcp_rx_trace_t * t0, tcp_connection_t * tc0,
1638                        tcp_header_t * th0, vlib_buffer_t * b0, u8 is_ip4)
1639 {
1640   if (tc0)
1641     {
1642       clib_memcpy (&t0->tcp_connection, tc0, sizeof (t0->tcp_connection));
1643     }
1644   else
1645     {
1646       th0 = tcp_buffer_hdr (b0);
1647     }
1648   clib_memcpy (&t0->tcp_header, th0, sizeof (t0->tcp_header));
1649 }
1650
1651 always_inline void
1652 tcp_established_inc_counter (vlib_main_t * vm, u8 is_ip4, u8 evt, u8 val)
1653 {
1654   if (PREDICT_TRUE (!val))
1655     return;
1656
1657   if (is_ip4)
1658     vlib_node_increment_counter (vm, tcp4_established_node.index, evt, val);
1659   else
1660     vlib_node_increment_counter (vm, tcp6_established_node.index, evt, val);
1661 }
1662
1663 always_inline uword
1664 tcp46_established_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1665                           vlib_frame_t * from_frame, int is_ip4)
1666 {
1667   u32 n_left_from, next_index, *from, *to_next;
1668   u32 my_thread_index = vm->thread_index, errors = 0;
1669   tcp_main_t *tm = vnet_get_tcp_main ();
1670   u8 is_fin = 0;
1671
1672   from = vlib_frame_vector_args (from_frame);
1673   n_left_from = from_frame->n_vectors;
1674
1675   next_index = node->cached_next_index;
1676
1677   while (n_left_from > 0)
1678     {
1679       u32 n_left_to_next;
1680
1681       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1682       while (n_left_from > 0 && n_left_to_next > 0)
1683         {
1684           u32 bi0;
1685           vlib_buffer_t *b0;
1686           tcp_header_t *th0 = 0;
1687           tcp_connection_t *tc0;
1688           u32 next0 = TCP_ESTABLISHED_NEXT_DROP, error0 = TCP_ERROR_ENQUEUED;
1689
1690           bi0 = from[0];
1691           to_next[0] = bi0;
1692           from += 1;
1693           to_next += 1;
1694           n_left_from -= 1;
1695           n_left_to_next -= 1;
1696
1697           b0 = vlib_get_buffer (vm, bi0);
1698           tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
1699                                     my_thread_index);
1700
1701           if (PREDICT_FALSE (tc0 == 0))
1702             {
1703               error0 = TCP_ERROR_INVALID_CONNECTION;
1704               goto done;
1705             }
1706
1707           th0 = tcp_buffer_hdr (b0);
1708           /* N.B. buffer is rewritten if segment is ooo. Thus, th0 becomes a
1709            * dangling reference. */
1710           is_fin = tcp_is_fin (th0);
1711
1712           /* SYNs, FINs and data consume sequence numbers */
1713           vnet_buffer (b0)->tcp.seq_end = vnet_buffer (b0)->tcp.seq_number
1714             + tcp_is_syn (th0) + is_fin + vnet_buffer (b0)->tcp.data_len;
1715
1716           /* TODO header prediction fast path */
1717
1718           /* 1-4: check SEQ, RST, SYN */
1719           if (PREDICT_FALSE (tcp_segment_validate (vm, tc0, b0, th0, &next0)))
1720             {
1721               error0 = TCP_ERROR_SEGMENT_INVALID;
1722               TCP_EVT_DBG (TCP_EVT_SEG_INVALID, tc0,
1723                            vnet_buffer (b0)->tcp.seq_number,
1724                            vnet_buffer (b0)->tcp.seq_end);
1725               goto done;
1726             }
1727
1728           /* 5: check the ACK field  */
1729           if (tcp_rcv_ack (tc0, b0, th0, &next0, &error0))
1730             goto done;
1731
1732           /* 6: check the URG bit TODO */
1733
1734           /* 7: process the segment text */
1735           if (vnet_buffer (b0)->tcp.data_len)
1736             error0 = tcp_segment_rcv (tm, tc0, b0, &next0);
1737
1738           /* 8: check the FIN bit */
1739           if (PREDICT_FALSE (is_fin))
1740             {
1741               /* Enter CLOSE-WAIT and notify session. Don't send ACK, instead
1742                * wait for session to call close. To avoid lingering
1743                * in CLOSE-WAIT, set timer (reuse WAITCLOSE). */
1744               tc0->state = TCP_STATE_CLOSE_WAIT;
1745               TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc0);
1746               if (vnet_buffer (b0)->tcp.data_len == 0)
1747                 {
1748                   tc0->rcv_nxt += 1;
1749                   next0 = TCP_ESTABLISHED_NEXT_DROP;
1750                 }
1751               stream_session_disconnect_notify (&tc0->connection);
1752               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
1753             }
1754
1755         done:
1756           b0->error = node->errors[error0];
1757           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1758             {
1759               tcp_rx_trace_t *t0 =
1760                 vlib_add_trace (vm, node, b0, sizeof (*t0));
1761               tcp_set_rx_trace_data (t0, tc0, th0, b0, is_ip4);
1762             }
1763
1764           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1765                                            n_left_to_next, bi0, next0);
1766         }
1767
1768       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1769     }
1770
1771   errors = session_manager_flush_enqueue_events (my_thread_index);
1772   tcp_established_inc_counter (vm, is_ip4, TCP_ERROR_EVENT_FIFO_FULL, errors);
1773   tcp_flush_frame_to_output (vm, my_thread_index, is_ip4);
1774
1775   return from_frame->n_vectors;
1776 }
1777
1778 static uword
1779 tcp4_established (vlib_main_t * vm, vlib_node_runtime_t * node,
1780                   vlib_frame_t * from_frame)
1781 {
1782   return tcp46_established_inline (vm, node, from_frame, 1 /* is_ip4 */ );
1783 }
1784
1785 static uword
1786 tcp6_established (vlib_main_t * vm, vlib_node_runtime_t * node,
1787                   vlib_frame_t * from_frame)
1788 {
1789   return tcp46_established_inline (vm, node, from_frame, 0 /* is_ip4 */ );
1790 }
1791
1792 /* *INDENT-OFF* */
1793 VLIB_REGISTER_NODE (tcp4_established_node) =
1794 {
1795   .function = tcp4_established,
1796   .name = "tcp4-established",
1797   /* Takes a vector of packets. */
1798   .vector_size = sizeof (u32),
1799   .n_errors = TCP_N_ERROR,
1800   .error_strings = tcp_error_strings,
1801   .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
1802   .next_nodes =
1803   {
1804 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
1805     foreach_tcp_state_next
1806 #undef _
1807   },
1808   .format_trace = format_tcp_rx_trace_short,
1809 };
1810 /* *INDENT-ON* */
1811
1812 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_established_node, tcp4_established);
1813
1814 /* *INDENT-OFF* */
1815 VLIB_REGISTER_NODE (tcp6_established_node) =
1816 {
1817   .function = tcp6_established,
1818   .name = "tcp6-established",
1819   /* Takes a vector of packets. */
1820   .vector_size = sizeof (u32),
1821   .n_errors = TCP_N_ERROR,
1822   .error_strings = tcp_error_strings,
1823   .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
1824   .next_nodes =
1825   {
1826 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
1827     foreach_tcp_state_next
1828 #undef _
1829   },
1830   .format_trace = format_tcp_rx_trace_short,
1831 };
1832 /* *INDENT-ON* */
1833
1834
1835 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_established_node, tcp6_established);
1836
1837 vlib_node_registration_t tcp4_syn_sent_node;
1838 vlib_node_registration_t tcp6_syn_sent_node;
1839
1840 always_inline uword
1841 tcp46_syn_sent_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1842                        vlib_frame_t * from_frame, int is_ip4)
1843 {
1844   tcp_main_t *tm = vnet_get_tcp_main ();
1845   u32 n_left_from, next_index, *from, *to_next;
1846   u32 my_thread_index = vm->thread_index, errors = 0;
1847
1848   from = vlib_frame_vector_args (from_frame);
1849   n_left_from = from_frame->n_vectors;
1850
1851   next_index = node->cached_next_index;
1852
1853   while (n_left_from > 0)
1854     {
1855       u32 n_left_to_next;
1856
1857       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1858
1859       while (n_left_from > 0 && n_left_to_next > 0)
1860         {
1861           u32 bi0, ack0, seq0;
1862           vlib_buffer_t *b0;
1863           tcp_rx_trace_t *t0;
1864           tcp_header_t *tcp0 = 0;
1865           tcp_connection_t *tc0;
1866           tcp_connection_t *new_tc0;
1867           u32 next0 = TCP_SYN_SENT_NEXT_DROP, error0 = TCP_ERROR_ENQUEUED;
1868
1869           bi0 = from[0];
1870           to_next[0] = bi0;
1871           from += 1;
1872           to_next += 1;
1873           n_left_from -= 1;
1874           n_left_to_next -= 1;
1875
1876           b0 = vlib_get_buffer (vm, bi0);
1877           tc0 =
1878             tcp_half_open_connection_get (vnet_buffer (b0)->
1879                                           tcp.connection_index);
1880
1881           ack0 = vnet_buffer (b0)->tcp.ack_number;
1882           seq0 = vnet_buffer (b0)->tcp.seq_number;
1883           tcp0 = tcp_buffer_hdr (b0);
1884
1885           if (!tc0)
1886             {
1887               ip4_header_t *ip40 = vlib_buffer_get_current (b0);
1888               tcp0 = ip4_next_header (ip40);
1889               tc0 =
1890                 (tcp_connection_t *)
1891                 stream_session_lookup_transport_wt4 (&ip40->dst_address,
1892                                                      &ip40->src_address,
1893                                                      tcp0->dst_port,
1894                                                      tcp0->src_port,
1895                                                      SESSION_TYPE_IP4_TCP,
1896                                                      my_thread_index);
1897               ASSERT (0);
1898               goto drop;
1899             }
1900           if (PREDICT_FALSE
1901               (!tcp_ack (tcp0) && !tcp_rst (tcp0) && !tcp_syn (tcp0)))
1902             goto drop;
1903
1904           /* SYNs, FINs and data consume sequence numbers */
1905           vnet_buffer (b0)->tcp.seq_end = seq0 + tcp_is_syn (tcp0)
1906             + tcp_is_fin (tcp0) + vnet_buffer (b0)->tcp.data_len;
1907
1908           /*
1909            *  1. check the ACK bit
1910            */
1911
1912           /*
1913            *   If the ACK bit is set
1914            *     If SEG.ACK =< ISS, or SEG.ACK > SND.NXT, send a reset (unless
1915            *     the RST bit is set, if so drop the segment and return)
1916            *       <SEQ=SEG.ACK><CTL=RST>
1917            *     and discard the segment.  Return.
1918            *     If SND.UNA =< SEG.ACK =< SND.NXT then the ACK is acceptable.
1919            */
1920           if (tcp_ack (tcp0))
1921             {
1922               if (ack0 <= tc0->iss || ack0 > tc0->snd_nxt)
1923                 {
1924                   if (!tcp_rst (tcp0))
1925                     tcp_send_reset (tc0, b0, is_ip4);
1926                   goto drop;
1927                 }
1928
1929               /* Make sure ACK is valid */
1930               if (tc0->snd_una > ack0)
1931                 goto drop;
1932             }
1933
1934           /*
1935            * 2. check the RST bit
1936            */
1937
1938           if (tcp_rst (tcp0))
1939             {
1940               /* If ACK is acceptable, signal client that peer is not
1941                * willing to accept connection and drop connection*/
1942               if (tcp_ack (tcp0))
1943                 tcp_connection_reset (tc0);
1944               goto drop;
1945             }
1946
1947           /*
1948            * 3. check the security and precedence (skipped)
1949            */
1950
1951           /*
1952            * 4. check the SYN bit
1953            */
1954
1955           /* No SYN flag. Drop. */
1956           if (!tcp_syn (tcp0))
1957             goto drop;
1958
1959           /* Parse options */
1960           if (tcp_options_parse (tcp0, &tc0->rcv_opts))
1961             goto drop;
1962
1963           /* Valid SYN or SYN-ACK. Move connection from half-open pool to
1964            * current thread pool. */
1965           pool_get (tm->connections[my_thread_index], new_tc0);
1966           clib_memcpy (new_tc0, tc0, sizeof (*new_tc0));
1967           new_tc0->c_c_index = new_tc0 - tm->connections[my_thread_index];
1968           new_tc0->c_thread_index = my_thread_index;
1969           new_tc0->rcv_nxt = vnet_buffer (b0)->tcp.seq_end;
1970           new_tc0->irs = seq0;
1971           new_tc0->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1972           new_tc0->timers[TCP_TIMER_RETRANSMIT_SYN] =
1973             TCP_TIMER_HANDLE_INVALID;
1974
1975           /* If this is not the owning thread, wait for syn retransmit to
1976            * expire and cleanup then */
1977           if (tcp_half_open_connection_cleanup (tc0))
1978             tc0->flags |= TCP_CONN_HALF_OPEN_DONE;
1979
1980           if (tcp_opts_tstamp (&new_tc0->rcv_opts))
1981             {
1982               new_tc0->tsval_recent = new_tc0->rcv_opts.tsval;
1983               new_tc0->tsval_recent_age = tcp_time_now ();
1984             }
1985
1986           if (tcp_opts_wscale (&new_tc0->rcv_opts))
1987             new_tc0->snd_wscale = new_tc0->rcv_opts.wscale;
1988
1989           new_tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
1990             << new_tc0->snd_wscale;
1991           new_tc0->snd_wl1 = seq0;
1992           new_tc0->snd_wl2 = ack0;
1993
1994           tcp_connection_init_vars (new_tc0);
1995
1996           /* SYN-ACK: See if we can switch to ESTABLISHED state */
1997           if (PREDICT_TRUE (tcp_ack (tcp0)))
1998             {
1999               /* Our SYN is ACKed: we have iss < ack = snd_una */
2000
2001               /* TODO Dequeue acknowledged segments if we support Fast Open */
2002               new_tc0->snd_una = ack0;
2003               new_tc0->state = TCP_STATE_ESTABLISHED;
2004
2005               /* Make sure las is initialized for the wnd computation */
2006               new_tc0->rcv_las = new_tc0->rcv_nxt;
2007
2008               /* Notify app that we have connection. If session layer can't
2009                * allocate session send reset */
2010               if (stream_session_connect_notify (&new_tc0->connection, 0))
2011                 {
2012                   tcp_send_reset (new_tc0, b0, is_ip4);
2013                   tcp_connection_cleanup (new_tc0);
2014                   goto drop;
2015                 }
2016
2017               /* Make sure after data segment processing ACK is sent */
2018               new_tc0->flags |= TCP_CONN_SNDACK;
2019
2020               /* Update rtt with the syn-ack sample */
2021               new_tc0->bytes_acked = 1;
2022               tcp_update_rtt (new_tc0, vnet_buffer (b0)->tcp.ack_number);
2023               TCP_EVT_DBG (TCP_EVT_SYNACK_RCVD, new_tc0);
2024             }
2025           /* SYN: Simultaneous open. Change state to SYN-RCVD and send SYN-ACK */
2026           else
2027             {
2028               new_tc0->state = TCP_STATE_SYN_RCVD;
2029
2030               /* Notify app that we have connection */
2031               if (stream_session_connect_notify (&new_tc0->connection, 0))
2032                 {
2033                   tcp_connection_cleanup (new_tc0);
2034                   tcp_send_reset (tc0, b0, is_ip4);
2035                   TCP_EVT_DBG (TCP_EVT_RST_SENT, tc0);
2036                   goto drop;
2037                 }
2038
2039               tc0->rtt_ts = 0;
2040               tcp_make_synack (new_tc0, b0);
2041               next0 = tcp_next_output (is_ip4);
2042
2043               goto drop;
2044             }
2045
2046           /* Read data, if any */
2047           if (PREDICT_FALSE (vnet_buffer (b0)->tcp.data_len))
2048             {
2049               ASSERT (0);
2050               error0 = tcp_segment_rcv (tm, new_tc0, b0, &next0);
2051               if (error0 == TCP_ERROR_PURE_ACK)
2052                 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2053             }
2054           else
2055             {
2056               tcp_make_ack (new_tc0, b0);
2057               next0 = tcp_next_output (new_tc0->c_is_ip4);
2058             }
2059
2060         drop:
2061
2062           b0->error = error0 ? node->errors[error0] : 0;
2063           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2064             {
2065               t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2066               clib_memcpy (&t0->tcp_header, tcp0, sizeof (t0->tcp_header));
2067               clib_memcpy (&t0->tcp_connection, tc0,
2068                            sizeof (t0->tcp_connection));
2069             }
2070
2071           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2072                                            n_left_to_next, bi0, next0);
2073         }
2074
2075       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2076     }
2077
2078   errors = session_manager_flush_enqueue_events (my_thread_index);
2079   if (errors)
2080     {
2081       if (is_ip4)
2082         vlib_node_increment_counter (vm, tcp4_established_node.index,
2083                                      TCP_ERROR_EVENT_FIFO_FULL, errors);
2084       else
2085         vlib_node_increment_counter (vm, tcp6_established_node.index,
2086                                      TCP_ERROR_EVENT_FIFO_FULL, errors);
2087     }
2088
2089   return from_frame->n_vectors;
2090 }
2091
2092 static uword
2093 tcp4_syn_sent (vlib_main_t * vm, vlib_node_runtime_t * node,
2094                vlib_frame_t * from_frame)
2095 {
2096   return tcp46_syn_sent_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2097 }
2098
2099 static uword
2100 tcp6_syn_sent_rcv (vlib_main_t * vm, vlib_node_runtime_t * node,
2101                    vlib_frame_t * from_frame)
2102 {
2103   return tcp46_syn_sent_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2104 }
2105
2106 /* *INDENT-OFF* */
2107 VLIB_REGISTER_NODE (tcp4_syn_sent_node) =
2108 {
2109   .function = tcp4_syn_sent,
2110   .name = "tcp4-syn-sent",
2111   /* Takes a vector of packets. */
2112   .vector_size = sizeof (u32),
2113   .n_errors = TCP_N_ERROR,
2114   .error_strings = tcp_error_strings,
2115   .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2116   .next_nodes =
2117   {
2118 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2119     foreach_tcp_state_next
2120 #undef _
2121   },
2122   .format_trace = format_tcp_rx_trace_short,
2123 };
2124 /* *INDENT-ON* */
2125
2126 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_syn_sent_node, tcp4_syn_sent);
2127
2128 /* *INDENT-OFF* */
2129 VLIB_REGISTER_NODE (tcp6_syn_sent_node) =
2130 {
2131   .function = tcp6_syn_sent_rcv,
2132   .name = "tcp6-syn-sent",
2133   /* Takes a vector of packets. */
2134   .vector_size = sizeof (u32),
2135   .n_errors = TCP_N_ERROR,
2136   .error_strings = tcp_error_strings,
2137   .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2138   .next_nodes =
2139   {
2140 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2141     foreach_tcp_state_next
2142 #undef _
2143   },
2144   .format_trace = format_tcp_rx_trace_short,
2145 };
2146 /* *INDENT-ON* */
2147
2148 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_syn_sent_node, tcp6_syn_sent_rcv);
2149
2150 /**
2151  * Handles reception for all states except LISTEN, SYN-SENT and ESTABLISHED
2152  * as per RFC793 p. 64
2153  */
2154 always_inline uword
2155 tcp46_rcv_process_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2156                           vlib_frame_t * from_frame, int is_ip4)
2157 {
2158   tcp_main_t *tm = vnet_get_tcp_main ();
2159   u32 n_left_from, next_index, *from, *to_next;
2160   u32 my_thread_index = vm->thread_index, errors = 0;
2161
2162   from = vlib_frame_vector_args (from_frame);
2163   n_left_from = from_frame->n_vectors;
2164
2165   next_index = node->cached_next_index;
2166
2167   while (n_left_from > 0)
2168     {
2169       u32 n_left_to_next;
2170
2171       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2172
2173       while (n_left_from > 0 && n_left_to_next > 0)
2174         {
2175           u32 bi0;
2176           vlib_buffer_t *b0;
2177           tcp_header_t *tcp0 = 0;
2178           tcp_connection_t *tc0;
2179           u32 next0 = TCP_RCV_PROCESS_NEXT_DROP, error0 = TCP_ERROR_ENQUEUED;
2180
2181           bi0 = from[0];
2182           to_next[0] = bi0;
2183           from += 1;
2184           to_next += 1;
2185           n_left_from -= 1;
2186           n_left_to_next -= 1;
2187
2188           b0 = vlib_get_buffer (vm, bi0);
2189           tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2190                                     my_thread_index);
2191           if (PREDICT_FALSE (tc0 == 0))
2192             {
2193               error0 = TCP_ERROR_INVALID_CONNECTION;
2194               goto drop;
2195             }
2196
2197           tcp0 = tcp_buffer_hdr (b0);
2198
2199           /* SYNs, FINs and data consume sequence numbers */
2200           vnet_buffer (b0)->tcp.seq_end = vnet_buffer (b0)->tcp.seq_number
2201             + tcp_is_syn (tcp0) + tcp_is_fin (tcp0)
2202             + vnet_buffer (b0)->tcp.data_len;
2203
2204           /*
2205            * Special treatment for CLOSED
2206            */
2207           switch (tc0->state)
2208             {
2209             case TCP_STATE_CLOSED:
2210               goto drop;
2211               break;
2212             }
2213
2214           /*
2215            * For all other states (except LISTEN)
2216            */
2217
2218           /* 1-4: check SEQ, RST, SYN */
2219           if (PREDICT_FALSE
2220               (tcp_segment_validate (vm, tc0, b0, tcp0, &next0)))
2221             {
2222               error0 = TCP_ERROR_SEGMENT_INVALID;
2223               goto drop;
2224             }
2225
2226           /* 5: check the ACK field  */
2227           switch (tc0->state)
2228             {
2229             case TCP_STATE_SYN_RCVD:
2230               /*
2231                * If the segment acknowledgment is not acceptable, form a
2232                * reset segment,
2233                *  <SEQ=SEG.ACK><CTL=RST>
2234                * and send it.
2235                */
2236               if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2237                 {
2238                   tcp_send_reset (tc0, b0, is_ip4);
2239                   goto drop;
2240                 }
2241
2242               /* Update rtt and rto */
2243               tc0->bytes_acked = 1;
2244               tcp_update_rtt (tc0, vnet_buffer (b0)->tcp.ack_number);
2245
2246               /* Switch state to ESTABLISHED */
2247               tc0->state = TCP_STATE_ESTABLISHED;
2248
2249               /* Initialize session variables */
2250               tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2251               tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2252                 << tc0->rcv_opts.wscale;
2253               tc0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
2254               tc0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
2255               stream_session_accept_notify (&tc0->connection);
2256
2257               /* Reset SYN-ACK retransmit timer */
2258               tcp_retransmit_timer_reset (tc0);
2259               break;
2260             case TCP_STATE_ESTABLISHED:
2261               /* We can get packets in established state here because they
2262                * were enqueued before state change */
2263               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2264                 goto drop;
2265
2266               break;
2267             case TCP_STATE_FIN_WAIT_1:
2268               /* In addition to the processing for the ESTABLISHED state, if
2269                * our FIN is now acknowledged then enter FIN-WAIT-2 and
2270                * continue processing in that state. */
2271               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2272                 goto drop;
2273
2274               /* Still have to send the FIN */
2275               if (tc0->flags & TCP_CONN_FINPNDG)
2276                 {
2277                   /* TX fifo finally drained */
2278                   if (!stream_session_tx_fifo_max_dequeue (&tc0->connection))
2279                     tcp_send_fin (tc0);
2280                 }
2281               /* If FIN is ACKed */
2282               else if (tc0->snd_una == tc0->snd_una_max)
2283                 {
2284                   ASSERT (tcp_fin (tcp0));
2285                   tc0->rcv_nxt += 1;
2286                   tc0->state = TCP_STATE_FIN_WAIT_2;
2287                   TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2288
2289                   /* Stop all timers, 2MSL will be set lower */
2290                   tcp_connection_timers_reset (tc0);
2291                 }
2292               break;
2293             case TCP_STATE_FIN_WAIT_2:
2294               /* In addition to the processing for the ESTABLISHED state, if
2295                * the retransmission queue is empty, the user's CLOSE can be
2296                * acknowledged ("ok") but do not delete the TCB. */
2297               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2298                 goto drop;
2299
2300               /* check if rtx queue is empty and ack CLOSE TODO */
2301               break;
2302             case TCP_STATE_CLOSE_WAIT:
2303               /* Do the same processing as for the ESTABLISHED state. */
2304               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2305                 goto drop;
2306               break;
2307             case TCP_STATE_CLOSING:
2308               /* In addition to the processing for the ESTABLISHED state, if
2309                * the ACK acknowledges our FIN then enter the TIME-WAIT state,
2310                * otherwise ignore the segment. */
2311               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2312                 goto drop;
2313
2314               /* XXX test that send queue empty */
2315               tc0->state = TCP_STATE_TIME_WAIT;
2316               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2317               goto drop;
2318
2319               break;
2320             case TCP_STATE_LAST_ACK:
2321               /* The only thing that [should] arrive in this state is an
2322                * acknowledgment of our FIN. If our FIN is now acknowledged,
2323                * delete the TCB, enter the CLOSED state, and return. */
2324
2325               if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2326                 goto drop;
2327
2328               /* Apparently our FIN was lost */
2329               if (tcp_fin (tcp0))
2330                 {
2331                   /* Don't "make" fin since that increments snd_nxt */
2332                   tcp_send_fin (tc0);
2333                   goto drop;
2334                 }
2335
2336               tc0->state = TCP_STATE_CLOSED;
2337               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2338
2339               /* Don't delete the connection/session yet. Instead, wait a
2340                * reasonable amount of time until the pipes are cleared. In
2341                * particular, this makes sure that we won't have dead sessions
2342                * when processing events on the tx path */
2343               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
2344
2345               /* Stop retransmit */
2346               tcp_retransmit_timer_reset (tc0);
2347
2348               goto drop;
2349
2350               break;
2351             case TCP_STATE_TIME_WAIT:
2352               /* The only thing that can arrive in this state is a
2353                * retransmission of the remote FIN. Acknowledge it, and restart
2354                * the 2 MSL timeout. */
2355
2356               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2357                 goto drop;
2358
2359               tcp_make_ack (tc0, b0);
2360               tcp_timer_reset (tc0, TCP_TIMER_WAITCLOSE);
2361               tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2362
2363               goto drop;
2364
2365               break;
2366             default:
2367               ASSERT (0);
2368             }
2369
2370           /* 6: check the URG bit TODO */
2371
2372           /* 7: process the segment text */
2373           switch (tc0->state)
2374             {
2375             case TCP_STATE_ESTABLISHED:
2376             case TCP_STATE_FIN_WAIT_1:
2377             case TCP_STATE_FIN_WAIT_2:
2378               if (vnet_buffer (b0)->tcp.data_len)
2379                 error0 = tcp_segment_rcv (tm, tc0, b0, &next0);
2380               break;
2381             case TCP_STATE_CLOSE_WAIT:
2382             case TCP_STATE_CLOSING:
2383             case TCP_STATE_LAST_ACK:
2384             case TCP_STATE_TIME_WAIT:
2385               /* This should not occur, since a FIN has been received from the
2386                * remote side.  Ignore the segment text. */
2387               break;
2388             }
2389
2390           /* 8: check the FIN bit */
2391           if (!tcp_fin (tcp0))
2392             goto drop;
2393
2394           switch (tc0->state)
2395             {
2396             case TCP_STATE_ESTABLISHED:
2397             case TCP_STATE_SYN_RCVD:
2398               /* Send FIN-ACK notify app and enter CLOSE-WAIT */
2399               tcp_connection_timers_reset (tc0);
2400               tcp_make_fin (tc0, b0);
2401               next0 = tcp_next_output (tc0->c_is_ip4);
2402               stream_session_disconnect_notify (&tc0->connection);
2403               tc0->state = TCP_STATE_CLOSE_WAIT;
2404               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2405               break;
2406             case TCP_STATE_CLOSE_WAIT:
2407             case TCP_STATE_CLOSING:
2408             case TCP_STATE_LAST_ACK:
2409               /* move along .. */
2410               break;
2411             case TCP_STATE_FIN_WAIT_1:
2412               tc0->state = TCP_STATE_TIME_WAIT;
2413               tcp_connection_timers_reset (tc0);
2414               tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2415               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2416               break;
2417             case TCP_STATE_FIN_WAIT_2:
2418               /* Got FIN, send ACK! */
2419               tc0->state = TCP_STATE_TIME_WAIT;
2420               tcp_connection_timers_reset (tc0);
2421               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
2422               tcp_make_ack (tc0, b0);
2423               next0 = tcp_next_output (is_ip4);
2424               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2425               break;
2426             case TCP_STATE_TIME_WAIT:
2427               /* Remain in the TIME-WAIT state. Restart the 2 MSL time-wait
2428                * timeout.
2429                */
2430               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2431               break;
2432             }
2433           TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc0);
2434
2435         drop:
2436           b0->error = error0 ? node->errors[error0] : 0;
2437
2438           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2439             {
2440               tcp_rx_trace_t *t0 =
2441                 vlib_add_trace (vm, node, b0, sizeof (*t0));
2442               tcp_set_rx_trace_data (t0, tc0, tcp0, b0, is_ip4);
2443             }
2444
2445           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2446                                            n_left_to_next, bi0, next0);
2447         }
2448
2449       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2450     }
2451
2452   errors = session_manager_flush_enqueue_events (my_thread_index);
2453   if (errors)
2454     {
2455       if (is_ip4)
2456         vlib_node_increment_counter (vm, tcp4_established_node.index,
2457                                      TCP_ERROR_EVENT_FIFO_FULL, errors);
2458       else
2459         vlib_node_increment_counter (vm, tcp6_established_node.index,
2460                                      TCP_ERROR_EVENT_FIFO_FULL, errors);
2461     }
2462
2463   return from_frame->n_vectors;
2464 }
2465
2466 static uword
2467 tcp4_rcv_process (vlib_main_t * vm, vlib_node_runtime_t * node,
2468                   vlib_frame_t * from_frame)
2469 {
2470   return tcp46_rcv_process_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2471 }
2472
2473 static uword
2474 tcp6_rcv_process (vlib_main_t * vm, vlib_node_runtime_t * node,
2475                   vlib_frame_t * from_frame)
2476 {
2477   return tcp46_rcv_process_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2478 }
2479
2480 /* *INDENT-OFF* */
2481 VLIB_REGISTER_NODE (tcp4_rcv_process_node) =
2482 {
2483   .function = tcp4_rcv_process,
2484   .name = "tcp4-rcv-process",
2485   /* Takes a vector of packets. */
2486   .vector_size = sizeof (u32),
2487   .n_errors = TCP_N_ERROR,
2488   .error_strings = tcp_error_strings,
2489   .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
2490   .next_nodes =
2491   {
2492 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
2493     foreach_tcp_state_next
2494 #undef _
2495   },
2496   .format_trace = format_tcp_rx_trace_short,
2497 };
2498 /* *INDENT-ON* */
2499
2500 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_rcv_process_node, tcp4_rcv_process);
2501
2502 /* *INDENT-OFF* */
2503 VLIB_REGISTER_NODE (tcp6_rcv_process_node) =
2504 {
2505   .function = tcp6_rcv_process,
2506   .name = "tcp6-rcv-process",
2507   /* Takes a vector of packets. */
2508   .vector_size = sizeof (u32),
2509   .n_errors = TCP_N_ERROR,
2510   .error_strings = tcp_error_strings,
2511   .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
2512   .next_nodes =
2513   {
2514 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
2515     foreach_tcp_state_next
2516 #undef _
2517   },
2518   .format_trace = format_tcp_rx_trace_short,
2519 };
2520 /* *INDENT-ON* */
2521
2522 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_rcv_process_node, tcp6_rcv_process);
2523
2524 vlib_node_registration_t tcp4_listen_node;
2525 vlib_node_registration_t tcp6_listen_node;
2526
2527 /**
2528  * LISTEN state processing as per RFC 793 p. 65
2529  */
2530 always_inline uword
2531 tcp46_listen_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2532                      vlib_frame_t * from_frame, int is_ip4)
2533 {
2534   u32 n_left_from, next_index, *from, *to_next;
2535   u32 my_thread_index = vm->thread_index;
2536   u8 sst = is_ip4 ? SESSION_TYPE_IP4_TCP : SESSION_TYPE_IP6_TCP;
2537
2538   from = vlib_frame_vector_args (from_frame);
2539   n_left_from = from_frame->n_vectors;
2540
2541   next_index = node->cached_next_index;
2542
2543   while (n_left_from > 0)
2544     {
2545       u32 n_left_to_next;
2546
2547       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2548
2549       while (n_left_from > 0 && n_left_to_next > 0)
2550         {
2551           u32 bi0;
2552           vlib_buffer_t *b0;
2553           tcp_rx_trace_t *t0;
2554           tcp_header_t *th0 = 0;
2555           tcp_connection_t *lc0;
2556           ip4_header_t *ip40;
2557           ip6_header_t *ip60;
2558           tcp_connection_t *child0;
2559           u32 error0 = TCP_ERROR_SYNS_RCVD, next0 = TCP_LISTEN_NEXT_DROP;
2560
2561           bi0 = from[0];
2562           to_next[0] = bi0;
2563           from += 1;
2564           to_next += 1;
2565           n_left_from -= 1;
2566           n_left_to_next -= 1;
2567
2568           b0 = vlib_get_buffer (vm, bi0);
2569           lc0 = tcp_listener_get (vnet_buffer (b0)->tcp.connection_index);
2570
2571           if (is_ip4)
2572             {
2573               ip40 = vlib_buffer_get_current (b0);
2574               th0 = ip4_next_header (ip40);
2575             }
2576           else
2577             {
2578               ip60 = vlib_buffer_get_current (b0);
2579               th0 = ip6_next_header (ip60);
2580             }
2581
2582           /* Create child session. For syn-flood protection use filter */
2583
2584           /* 1. first check for an RST: handled in dispatch */
2585           /* if (tcp_rst (th0))
2586              goto drop; */
2587
2588           /* 2. second check for an ACK: handled in dispatch */
2589           /* if (tcp_ack (th0))
2590              {
2591              tcp_send_reset (b0, is_ip4);
2592              goto drop;
2593              } */
2594
2595           /* 3. check for a SYN (did that already) */
2596
2597           /* Create child session and send SYN-ACK */
2598           child0 = tcp_connection_new (my_thread_index);
2599           child0->c_lcl_port = lc0->c_lcl_port;
2600           child0->c_rmt_port = th0->src_port;
2601           child0->c_is_ip4 = is_ip4;
2602           child0->state = TCP_STATE_SYN_RCVD;
2603
2604           if (is_ip4)
2605             {
2606               child0->c_lcl_ip4.as_u32 = ip40->dst_address.as_u32;
2607               child0->c_rmt_ip4.as_u32 = ip40->src_address.as_u32;
2608             }
2609           else
2610             {
2611               clib_memcpy (&child0->c_lcl_ip6, &ip60->dst_address,
2612                            sizeof (ip6_address_t));
2613               clib_memcpy (&child0->c_rmt_ip6, &ip60->src_address,
2614                            sizeof (ip6_address_t));
2615             }
2616
2617           if (stream_session_accept (&child0->connection, lc0->c_s_index, sst,
2618                                      0 /* notify */ ))
2619             {
2620               error0 = TCP_ERROR_CREATE_SESSION_FAIL;
2621               goto drop;
2622             }
2623
2624           if (tcp_options_parse (th0, &child0->rcv_opts))
2625             {
2626               goto drop;
2627             }
2628
2629           child0->irs = vnet_buffer (b0)->tcp.seq_number;
2630           child0->rcv_nxt = vnet_buffer (b0)->tcp.seq_number + 1;
2631           child0->rcv_las = child0->rcv_nxt;
2632
2633           /* RFC1323: TSval timestamps sent on {SYN} and {SYN,ACK}
2634            * segments are used to initialize PAWS. */
2635           if (tcp_opts_tstamp (&child0->rcv_opts))
2636             {
2637               child0->tsval_recent = child0->rcv_opts.tsval;
2638               child0->tsval_recent_age = tcp_time_now ();
2639             }
2640
2641           if (tcp_opts_wscale (&child0->rcv_opts))
2642             child0->snd_wscale = child0->rcv_opts.wscale;
2643
2644           child0->snd_wnd = clib_net_to_host_u16 (th0->window)
2645             << child0->snd_wscale;
2646           child0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
2647           child0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
2648
2649           tcp_connection_init_vars (child0);
2650           TCP_EVT_DBG (TCP_EVT_SYN_RCVD, child0);
2651
2652           /* Reuse buffer to make syn-ack and send */
2653           tcp_make_synack (child0, b0);
2654           next0 = tcp_next_output (is_ip4);
2655
2656         drop:
2657           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2658             {
2659               t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2660               clib_memcpy (&t0->tcp_header, th0, sizeof (t0->tcp_header));
2661               clib_memcpy (&t0->tcp_connection, lc0,
2662                            sizeof (t0->tcp_connection));
2663             }
2664
2665           b0->error = node->errors[error0];
2666
2667           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2668                                            n_left_to_next, bi0, next0);
2669         }
2670
2671       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2672     }
2673   return from_frame->n_vectors;
2674 }
2675
2676 static uword
2677 tcp4_listen (vlib_main_t * vm, vlib_node_runtime_t * node,
2678              vlib_frame_t * from_frame)
2679 {
2680   return tcp46_listen_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2681 }
2682
2683 static uword
2684 tcp6_listen (vlib_main_t * vm, vlib_node_runtime_t * node,
2685              vlib_frame_t * from_frame)
2686 {
2687   return tcp46_listen_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2688 }
2689
2690 /* *INDENT-OFF* */
2691 VLIB_REGISTER_NODE (tcp4_listen_node) =
2692 {
2693   .function = tcp4_listen,
2694   .name = "tcp4-listen",
2695   /* Takes a vector of packets. */
2696   .vector_size = sizeof (u32),
2697   .n_errors = TCP_N_ERROR,
2698   .error_strings = tcp_error_strings,
2699   .n_next_nodes = TCP_LISTEN_N_NEXT,
2700   .next_nodes =
2701   {
2702 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
2703     foreach_tcp_state_next
2704 #undef _
2705   },
2706   .format_trace = format_tcp_rx_trace_short,
2707 };
2708 /* *INDENT-ON* */
2709
2710 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_listen_node, tcp4_listen);
2711
2712 /* *INDENT-OFF* */
2713 VLIB_REGISTER_NODE (tcp6_listen_node) =
2714 {
2715   .function = tcp6_listen,
2716   .name = "tcp6-listen",
2717   /* Takes a vector of packets. */
2718   .vector_size = sizeof (u32),
2719   .n_errors = TCP_N_ERROR,
2720   .error_strings = tcp_error_strings,
2721   .n_next_nodes = TCP_LISTEN_N_NEXT,
2722   .next_nodes =
2723   {
2724 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
2725     foreach_tcp_state_next
2726 #undef _
2727   },
2728   .format_trace = format_tcp_rx_trace_short,
2729 };
2730 /* *INDENT-ON* */
2731
2732 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_listen_node, tcp6_listen);
2733
2734 vlib_node_registration_t tcp4_input_node;
2735 vlib_node_registration_t tcp6_input_node;
2736
2737 typedef enum _tcp_input_next
2738 {
2739   TCP_INPUT_NEXT_DROP,
2740   TCP_INPUT_NEXT_LISTEN,
2741   TCP_INPUT_NEXT_RCV_PROCESS,
2742   TCP_INPUT_NEXT_SYN_SENT,
2743   TCP_INPUT_NEXT_ESTABLISHED,
2744   TCP_INPUT_NEXT_RESET,
2745   TCP_INPUT_N_NEXT
2746 } tcp_input_next_t;
2747
2748 #define foreach_tcp4_input_next                 \
2749   _ (DROP, "error-drop")                        \
2750   _ (LISTEN, "tcp4-listen")                     \
2751   _ (RCV_PROCESS, "tcp4-rcv-process")           \
2752   _ (SYN_SENT, "tcp4-syn-sent")                 \
2753   _ (ESTABLISHED, "tcp4-established")           \
2754   _ (RESET, "tcp4-reset")
2755
2756 #define foreach_tcp6_input_next                 \
2757   _ (DROP, "error-drop")                        \
2758   _ (LISTEN, "tcp6-listen")                     \
2759   _ (RCV_PROCESS, "tcp6-rcv-process")           \
2760   _ (SYN_SENT, "tcp6-syn-sent")                 \
2761   _ (ESTABLISHED, "tcp6-established")           \
2762   _ (RESET, "tcp6-reset")
2763
2764 #define filter_flags (TCP_FLAG_SYN|TCP_FLAG_ACK|TCP_FLAG_RST|TCP_FLAG_FIN)
2765
2766 static u8
2767 tcp_lookup_is_valid (tcp_connection_t * tc, tcp_header_t * hdr)
2768 {
2769   transport_connection_t *tmp;
2770   if (!tc)
2771     return 1;
2772
2773   u8 is_valid = (tc->c_lcl_port == hdr->dst_port
2774                  && (tc->state == TCP_STATE_LISTEN
2775                      || tc->c_rmt_port == hdr->src_port));
2776
2777   if (!is_valid)
2778     {
2779       if ((tmp =
2780            stream_session_half_open_lookup (&tc->c_lcl_ip, &tc->c_rmt_ip,
2781                                             tc->c_lcl_port, tc->c_rmt_port,
2782                                             tc->c_transport_proto)))
2783         {
2784           if (tmp->lcl_port == hdr->dst_port
2785               && tmp->rmt_port == hdr->src_port)
2786             {
2787               clib_warning ("half-open is valid!");
2788             }
2789         }
2790     }
2791   return is_valid;
2792 }
2793
2794 always_inline uword
2795 tcp46_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2796                     vlib_frame_t * from_frame, int is_ip4)
2797 {
2798   u32 n_left_from, next_index, *from, *to_next;
2799   u32 my_thread_index = vm->thread_index;
2800   tcp_main_t *tm = vnet_get_tcp_main ();
2801
2802   from = vlib_frame_vector_args (from_frame);
2803   n_left_from = from_frame->n_vectors;
2804   next_index = node->cached_next_index;
2805   tcp_set_time_now (my_thread_index);
2806
2807   while (n_left_from > 0)
2808     {
2809       u32 n_left_to_next;
2810
2811       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2812
2813       while (n_left_from > 0 && n_left_to_next > 0)
2814         {
2815           int n_advance_bytes0, n_data_bytes0;
2816           u32 bi0;
2817           vlib_buffer_t *b0;
2818           tcp_header_t *tcp0 = 0;
2819           tcp_connection_t *tc0;
2820           ip4_header_t *ip40;
2821           ip6_header_t *ip60;
2822           u32 error0 = TCP_ERROR_NO_LISTENER, next0 = TCP_INPUT_NEXT_DROP;
2823           u8 flags0;
2824
2825           bi0 = from[0];
2826           to_next[0] = bi0;
2827           from += 1;
2828           to_next += 1;
2829           n_left_from -= 1;
2830           n_left_to_next -= 1;
2831
2832           b0 = vlib_get_buffer (vm, bi0);
2833           vnet_buffer (b0)->tcp.flags = 0;
2834
2835           /* Checksum computed by ipx_local no need to compute again */
2836
2837           if (is_ip4)
2838             {
2839               ip40 = vlib_buffer_get_current (b0);
2840               tcp0 = ip4_next_header (ip40);
2841               n_advance_bytes0 = (ip4_header_bytes (ip40)
2842                                   + tcp_header_bytes (tcp0));
2843               n_data_bytes0 = clib_net_to_host_u16 (ip40->length)
2844                 - n_advance_bytes0;
2845
2846               tc0 =
2847                 (tcp_connection_t *)
2848                 stream_session_lookup_transport_wt4 (&ip40->dst_address,
2849                                                      &ip40->src_address,
2850                                                      tcp0->dst_port,
2851                                                      tcp0->src_port,
2852                                                      SESSION_TYPE_IP4_TCP,
2853                                                      my_thread_index);
2854               ASSERT (tcp_lookup_is_valid (tc0, tcp0));
2855             }
2856           else
2857             {
2858               ip60 = vlib_buffer_get_current (b0);
2859               tcp0 = ip6_next_header (ip60);
2860               n_advance_bytes0 = tcp_header_bytes (tcp0);
2861               n_data_bytes0 = clib_net_to_host_u16 (ip60->payload_length)
2862                 - n_advance_bytes0;
2863               n_advance_bytes0 += sizeof (ip60[0]);
2864
2865               tc0 =
2866                 (tcp_connection_t *)
2867                 stream_session_lookup_transport_wt6 (&ip60->dst_address,
2868                                                      &ip60->src_address,
2869                                                      tcp0->dst_port,
2870                                                      tcp0->src_port,
2871                                                      SESSION_TYPE_IP6_TCP,
2872                                                      my_thread_index);
2873               ASSERT (tcp_lookup_is_valid (tc0, tcp0));
2874             }
2875
2876           /* Length check */
2877           if (PREDICT_FALSE (n_advance_bytes0 < 0))
2878             {
2879               error0 = TCP_ERROR_LENGTH;
2880               goto done;
2881             }
2882
2883           /* Session exists */
2884           if (PREDICT_TRUE (0 != tc0))
2885             {
2886               /* Save connection index */
2887               vnet_buffer (b0)->tcp.connection_index = tc0->c_c_index;
2888               vnet_buffer (b0)->tcp.seq_number =
2889                 clib_net_to_host_u32 (tcp0->seq_number);
2890               vnet_buffer (b0)->tcp.ack_number =
2891                 clib_net_to_host_u32 (tcp0->ack_number);
2892
2893               vnet_buffer (b0)->tcp.hdr_offset = (u8 *) tcp0
2894                 - (u8 *) vlib_buffer_get_current (b0);
2895               vnet_buffer (b0)->tcp.data_offset = n_advance_bytes0;
2896               vnet_buffer (b0)->tcp.data_len = n_data_bytes0;
2897
2898               flags0 = tcp0->flags & filter_flags;
2899               next0 = tm->dispatch_table[tc0->state][flags0].next;
2900               error0 = tm->dispatch_table[tc0->state][flags0].error;
2901
2902               if (PREDICT_FALSE (error0 == TCP_ERROR_DISPATCH
2903                                  || next0 == TCP_INPUT_NEXT_RESET))
2904                 {
2905                   /* Overload tcp flags to store state */
2906                   tcp_state_t state0 = tc0->state;
2907                   vnet_buffer (b0)->tcp.flags = tc0->state;
2908
2909                   if (error0 == TCP_ERROR_DISPATCH)
2910                     clib_warning ("disp error state %U flags %U",
2911                                   format_tcp_state, state0, format_tcp_flags,
2912                                   (int) flags0);
2913                 }
2914             }
2915           else
2916             {
2917               /* Send reset */
2918               next0 = TCP_INPUT_NEXT_RESET;
2919               error0 = TCP_ERROR_NO_LISTENER;
2920             }
2921
2922         done:
2923           b0->error = error0 ? node->errors[error0] : 0;
2924
2925           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2926             {
2927               tcp_rx_trace_t *t0 =
2928                 vlib_add_trace (vm, node, b0, sizeof (*t0));
2929               tcp_set_rx_trace_data (t0, tc0, tcp0, b0, is_ip4);
2930             }
2931           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2932                                            n_left_to_next, bi0, next0);
2933         }
2934
2935       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2936     }
2937
2938   return from_frame->n_vectors;
2939 }
2940
2941 static uword
2942 tcp4_input (vlib_main_t * vm, vlib_node_runtime_t * node,
2943             vlib_frame_t * from_frame)
2944 {
2945   return tcp46_input_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2946 }
2947
2948 static uword
2949 tcp6_input (vlib_main_t * vm, vlib_node_runtime_t * node,
2950             vlib_frame_t * from_frame)
2951 {
2952   return tcp46_input_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2953 }
2954
2955 /* *INDENT-OFF* */
2956 VLIB_REGISTER_NODE (tcp4_input_node) =
2957 {
2958   .function = tcp4_input,
2959   .name = "tcp4-input",
2960   /* Takes a vector of packets. */
2961   .vector_size = sizeof (u32),
2962   .n_errors = TCP_N_ERROR,
2963   .error_strings = tcp_error_strings,
2964   .n_next_nodes = TCP_INPUT_N_NEXT,
2965   .next_nodes =
2966   {
2967 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
2968     foreach_tcp4_input_next
2969 #undef _
2970   },
2971   .format_buffer = format_tcp_header,
2972   .format_trace = format_tcp_rx_trace,
2973 };
2974 /* *INDENT-ON* */
2975
2976 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_input_node, tcp4_input);
2977
2978 /* *INDENT-OFF* */
2979 VLIB_REGISTER_NODE (tcp6_input_node) =
2980 {
2981   .function = tcp6_input,
2982   .name = "tcp6-input",
2983   /* Takes a vector of packets. */
2984   .vector_size = sizeof (u32),
2985   .n_errors = TCP_N_ERROR,
2986   .error_strings = tcp_error_strings,
2987   .n_next_nodes = TCP_INPUT_N_NEXT,
2988   .next_nodes =
2989   {
2990 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
2991     foreach_tcp6_input_next
2992 #undef _
2993   },
2994   .format_buffer = format_tcp_header,
2995   .format_trace = format_tcp_rx_trace,
2996 };
2997 /* *INDENT-ON* */
2998
2999 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_input_node, tcp6_input);
3000
3001 static void
3002 tcp_dispatch_table_init (tcp_main_t * tm)
3003 {
3004   int i, j;
3005   for (i = 0; i < ARRAY_LEN (tm->dispatch_table); i++)
3006     for (j = 0; j < ARRAY_LEN (tm->dispatch_table[i]); j++)
3007       {
3008         tm->dispatch_table[i][j].next = TCP_INPUT_NEXT_DROP;
3009         tm->dispatch_table[i][j].error = TCP_ERROR_DISPATCH;
3010       }
3011
3012 #define _(t,f,n,e)                                              \
3013 do {                                                            \
3014     tm->dispatch_table[TCP_STATE_##t][f].next = (n);            \
3015     tm->dispatch_table[TCP_STATE_##t][f].error = (e);           \
3016 } while (0)
3017
3018   /* SYNs for new connections -> tcp-listen. */
3019   _(LISTEN, TCP_FLAG_SYN, TCP_INPUT_NEXT_LISTEN, TCP_ERROR_NONE);
3020   _(LISTEN, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3021   _(LISTEN, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_NONE);
3022   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3023     TCP_ERROR_NONE);
3024   /* ACK for for a SYN-ACK -> tcp-rcv-process. */
3025   _(SYN_RCVD, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3026   _(SYN_RCVD, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3027   _(SYN_RCVD, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3028   /* SYN-ACK for a SYN */
3029   _(SYN_SENT, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3030     TCP_ERROR_NONE);
3031   _(SYN_SENT, TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3032   _(SYN_SENT, TCP_FLAG_RST, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3033   _(SYN_SENT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3034     TCP_ERROR_NONE);
3035   /* ACK for for established connection -> tcp-established. */
3036   _(ESTABLISHED, TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3037   /* FIN for for established connection -> tcp-established. */
3038   _(ESTABLISHED, TCP_FLAG_FIN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3039   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3040     TCP_ERROR_NONE);
3041   _(ESTABLISHED, TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3042   _(ESTABLISHED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3043     TCP_ERROR_NONE);
3044   _(ESTABLISHED, TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3045   _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3046     TCP_ERROR_NONE);
3047   /* ACK or FIN-ACK to our FIN */
3048   _(FIN_WAIT_1, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3049   _(FIN_WAIT_1, TCP_FLAG_ACK | TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS,
3050     TCP_ERROR_NONE);
3051   /* FIN in reply to our FIN from the other side */
3052   _(FIN_WAIT_1, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3053   _(FIN_WAIT_1, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3054   /* FIN confirming that the peer (app) has closed */
3055   _(FIN_WAIT_2, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3056   _(FIN_WAIT_2, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3057   _(FIN_WAIT_2, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3058     TCP_ERROR_NONE);
3059   _(CLOSE_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3060   _(CLOSE_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3061     TCP_ERROR_NONE);
3062   _(LAST_ACK, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3063   _(LAST_ACK, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3064   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3065     TCP_ERROR_NONE);
3066   _(LAST_ACK, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3067   _(TIME_WAIT, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3068   _(TIME_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3069     TCP_ERROR_NONE);
3070   _(TIME_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3071   _(CLOSED, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_CONNECTION_CLOSED);
3072   _(CLOSED, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_CONNECTION_CLOSED);
3073   _(CLOSED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3074     TCP_ERROR_CONNECTION_CLOSED);
3075 #undef _
3076 }
3077
3078 clib_error_t *
3079 tcp_input_init (vlib_main_t * vm)
3080 {
3081   clib_error_t *error = 0;
3082   tcp_main_t *tm = vnet_get_tcp_main ();
3083
3084   if ((error = vlib_call_init_function (vm, tcp_init)))
3085     return error;
3086
3087   /* Initialize dispatch table. */
3088   tcp_dispatch_table_init (tm);
3089
3090   return error;
3091 }
3092
3093 VLIB_INIT_FUNCTION (tcp_input_init);
3094
3095 /*
3096  * fd.io coding-style-patch-verification: ON
3097  *
3098  * Local Variables:
3099  * eval: (c-set-style "gnu")
3100  * End:
3101  */