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