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