tcp/session: debug improvements/fixes
[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->cwnd_acc_bytes = 0;
945   tc->cc_algo->congestion (tc);
946   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 4);
947 }
948
949 static void
950 tcp_cc_recovery_exit (tcp_connection_t * tc)
951 {
952   /* Deflate rto */
953   tc->rto_boff = 0;
954   tcp_update_rto (tc);
955   tc->snd_rxt_ts = 0;
956   tc->snd_nxt = tc->snd_una_max;
957   tcp_recovery_off (tc);
958   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
959 }
960
961 void
962 tcp_cc_fastrecovery_exit (tcp_connection_t * tc)
963 {
964   tc->cc_algo->recovered (tc);
965   tc->snd_rxt_bytes = 0;
966   tc->rcv_dupacks = 0;
967   tc->snd_nxt = tc->snd_una_max;
968   tcp_fastrecovery_off (tc);
969   tcp_fastrecovery_1_smss_off (tc);
970   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
971 }
972
973 static void
974 tcp_cc_congestion_undo (tcp_connection_t * tc)
975 {
976   tc->cwnd = tc->prev_cwnd;
977   tc->ssthresh = tc->prev_ssthresh;
978   tc->snd_nxt = tc->snd_una_max;
979   tc->rcv_dupacks = 0;
980   if (tcp_in_recovery (tc))
981     tcp_cc_recovery_exit (tc);
982   ASSERT (tc->rto_boff == 0);
983   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 5);
984   /* TODO extend for fastrecovery */
985 }
986
987 static u8
988 tcp_cc_is_spurious_retransmit (tcp_connection_t * tc)
989 {
990   return (tcp_in_recovery (tc) && tc->rto_boff == 1
991           && tc->snd_rxt_ts
992           && tcp_opts_tstamp (&tc->rcv_opts)
993           && timestamp_lt (tc->rcv_opts.tsecr, tc->snd_rxt_ts));
994 }
995
996 int
997 tcp_cc_recover (tcp_connection_t * tc)
998 {
999   ASSERT (tcp_in_cong_recovery (tc));
1000   if (tcp_cc_is_spurious_retransmit (tc))
1001     {
1002       tcp_cc_congestion_undo (tc);
1003       return 1;
1004     }
1005
1006   if (tcp_in_recovery (tc))
1007     tcp_cc_recovery_exit (tc);
1008   else if (tcp_in_fastrecovery (tc))
1009     tcp_cc_fastrecovery_exit (tc);
1010
1011   ASSERT (tc->rto_boff == 0);
1012   ASSERT (!tcp_in_cong_recovery (tc));
1013   ASSERT (tcp_scoreboard_is_sane_post_recovery (tc));
1014   return 0;
1015 }
1016
1017 static void
1018 tcp_cc_update (tcp_connection_t * tc, vlib_buffer_t * b)
1019 {
1020   ASSERT (!tcp_in_cong_recovery (tc) || tcp_is_lost_fin (tc));
1021
1022   /* Congestion avoidance */
1023   tc->cc_algo->rcv_ack (tc);
1024   tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1025
1026   /* If a cumulative ack, make sure dupacks is 0 */
1027   tc->rcv_dupacks = 0;
1028
1029   /* When dupacks hits the threshold we only enter fast retransmit if
1030    * cumulative ack covers more than snd_congestion. Should snd_una
1031    * wrap this test may fail under otherwise valid circumstances.
1032    * Therefore, proactively update snd_congestion when wrap detected. */
1033   if (PREDICT_FALSE
1034       (seq_leq (tc->snd_congestion, tc->snd_una - tc->bytes_acked)
1035        && seq_gt (tc->snd_congestion, tc->snd_una)))
1036     tc->snd_congestion = tc->snd_una - 1;
1037 }
1038
1039 static u8
1040 tcp_should_fastrecover_sack (tcp_connection_t * tc)
1041 {
1042   return (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss < tc->sack_sb.sacked_bytes;
1043 }
1044
1045 static u8
1046 tcp_should_fastrecover (tcp_connection_t * tc)
1047 {
1048   return (tc->rcv_dupacks == TCP_DUPACK_THRESHOLD
1049           || tcp_should_fastrecover_sack (tc));
1050 }
1051
1052 /**
1053  * One function to rule them all ... and in the darkness bind them
1054  */
1055 static void
1056 tcp_cc_handle_event (tcp_connection_t * tc, u32 is_dack)
1057 {
1058   u32 rxt_delivered;
1059
1060   /*
1061    * Duplicate ACK. Check if we should enter fast recovery, or if already in
1062    * it account for the bytes that left the network.
1063    */
1064   if (is_dack)
1065     {
1066       ASSERT (tc->snd_una != tc->snd_una_max
1067               || tc->sack_sb.last_sacked_bytes);
1068
1069       tc->rcv_dupacks++;
1070
1071       if (tc->rcv_dupacks > TCP_DUPACK_THRESHOLD && !tc->bytes_acked)
1072         {
1073           ASSERT (tcp_in_fastrecovery (tc));
1074           /* Pure duplicate ack. If some data got acked, it's handled lower */
1075           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1076           return;
1077         }
1078       else if (tcp_should_fastrecover (tc))
1079         {
1080           /* Things are already bad */
1081           if (tcp_in_cong_recovery (tc))
1082             {
1083               tc->rcv_dupacks = 0;
1084               goto partial_ack_test;
1085             }
1086
1087           /* If of of the two conditions lower hold, reset dupacks because
1088            * we're probably after timeout (RFC6582 heuristics).
1089            * If Cumulative ack does not cover more than congestion threshold,
1090            * and:
1091            * 1) The following doesn't hold: The congestion window is greater
1092            *    than SMSS bytes and the difference between highest_ack
1093            *    and prev_highest_ack is at most 4*SMSS bytes
1094            * 2) Echoed timestamp in the last non-dup ack does not equal the
1095            *    stored timestamp
1096            */
1097           if (seq_leq (tc->snd_una, tc->snd_congestion)
1098               && ((!(tc->cwnd > tc->snd_mss
1099                      && tc->bytes_acked <= 4 * tc->snd_mss))
1100                   || (tc->rcv_opts.tsecr != tc->tsecr_last_ack)))
1101             {
1102               tc->rcv_dupacks = 0;
1103               return;
1104             }
1105
1106           tcp_cc_init_congestion (tc);
1107           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1108
1109           /* The first segment MUST be retransmitted */
1110           tcp_retransmit_first_unacked (tc);
1111
1112           /* Post retransmit update cwnd to ssthresh and account for the
1113            * three segments that have left the network and should've been
1114            * buffered at the receiver XXX */
1115           tc->cwnd = tc->ssthresh + tc->rcv_dupacks * tc->snd_mss;
1116           ASSERT (tc->cwnd >= tc->snd_mss);
1117
1118           /* If cwnd allows, send more data */
1119           if (tcp_opts_sack_permitted (&tc->rcv_opts))
1120             {
1121               scoreboard_init_high_rxt (&tc->sack_sb,
1122                                         tc->snd_una + tc->snd_mss);
1123               tcp_fast_retransmit_sack (tc);
1124             }
1125           else
1126             {
1127               tcp_fast_retransmit_no_sack (tc);
1128             }
1129
1130           return;
1131         }
1132       else if (!tc->bytes_acked
1133                || (tc->bytes_acked && !tcp_in_cong_recovery (tc)))
1134         {
1135           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1136           return;
1137         }
1138       else
1139         goto partial_ack;
1140     }
1141
1142 partial_ack_test:
1143
1144   if (!tc->bytes_acked)
1145     return;
1146
1147 partial_ack:
1148   /*
1149    * Legitimate ACK. 1) See if we can exit recovery
1150    */
1151   /* XXX limit this only to first partial ack? */
1152   tcp_retransmit_timer_update (tc);
1153
1154   if (seq_geq (tc->snd_una, tc->snd_congestion))
1155     {
1156       /* If spurious return, we've already updated everything */
1157       if (tcp_cc_recover (tc))
1158         {
1159           tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1160           return;
1161         }
1162
1163       tc->snd_nxt = tc->snd_una_max;
1164
1165       /* Treat as congestion avoidance ack */
1166       tc->cc_algo->rcv_ack (tc);
1167       tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1168       return;
1169     }
1170
1171   /*
1172    * Legitimate ACK. 2) If PARTIAL ACK try to retransmit
1173    */
1174   TCP_EVT_DBG (TCP_EVT_CC_PACK, tc);
1175
1176   /* RFC6675: If the incoming ACK is a cumulative acknowledgment,
1177    * reset dupacks to 0 */
1178   tc->rcv_dupacks = 0;
1179
1180   tcp_retransmit_first_unacked (tc);
1181
1182   /* Post RTO timeout don't try anything fancy */
1183   if (tcp_in_recovery (tc))
1184     return;
1185
1186   /* Remove retransmitted bytes that have been delivered */
1187   ASSERT (tc->bytes_acked + tc->sack_sb.snd_una_adv
1188           >= tc->sack_sb.last_bytes_delivered
1189           || (tc->flags & TCP_CONN_FINSNT));
1190
1191   if (seq_lt (tc->snd_una, tc->sack_sb.high_rxt))
1192     {
1193       /* If we have sacks and we haven't gotten an ack beyond high_rxt,
1194        * remove sacked bytes delivered */
1195       rxt_delivered = tc->bytes_acked + tc->sack_sb.snd_una_adv
1196         - tc->sack_sb.last_bytes_delivered;
1197       ASSERT (tc->snd_rxt_bytes >= rxt_delivered);
1198       tc->snd_rxt_bytes -= rxt_delivered;
1199     }
1200   else
1201     {
1202       /* Either all retransmitted holes have been acked, or we're
1203        * "in the blind" and retransmitting segment by segment */
1204       tc->snd_rxt_bytes = 0;
1205     }
1206
1207   tc->cc_algo->rcv_cong_ack (tc, TCP_CC_PARTIALACK);
1208
1209   /*
1210    * Since this was a partial ack, try to retransmit some more data
1211    */
1212   tcp_fast_retransmit (tc);
1213 }
1214
1215 void
1216 tcp_cc_init (tcp_connection_t * tc)
1217 {
1218   tc->cc_algo = tcp_cc_algo_get (TCP_CC_NEWRENO);
1219   tc->cc_algo->init (tc);
1220 }
1221
1222 /**
1223  * Process incoming ACK
1224  */
1225 static int
1226 tcp_rcv_ack (tcp_connection_t * tc, vlib_buffer_t * b,
1227              tcp_header_t * th, u32 * next, u32 * error)
1228 {
1229   u32 prev_snd_wnd, prev_snd_una;
1230   u8 is_dack;
1231
1232   TCP_EVT_DBG (TCP_EVT_CC_STAT, tc);
1233
1234   /* If the ACK acks something not yet sent (SEG.ACK > SND.NXT) */
1235   if (PREDICT_FALSE (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
1236     {
1237       /* If we have outstanding data and this is within the window, accept it,
1238        * probably retransmit has timed out. Otherwise ACK segment and then
1239        * drop it */
1240       if (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max))
1241         {
1242           tcp_make_ack (tc, b);
1243           *next = tcp_next_output (tc->c_is_ip4);
1244           *error = TCP_ERROR_ACK_INVALID;
1245           TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 0,
1246                        vnet_buffer (b)->tcp.ack_number);
1247           return -1;
1248         }
1249
1250       TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 2,
1251                    vnet_buffer (b)->tcp.ack_number);
1252
1253       tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
1254       *error = TCP_ERROR_ACK_FUTURE;
1255     }
1256
1257   /* If old ACK, probably it's an old dupack */
1258   if (PREDICT_FALSE (seq_lt (vnet_buffer (b)->tcp.ack_number, tc->snd_una)))
1259     {
1260       *error = TCP_ERROR_ACK_OLD;
1261       TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 1,
1262                    vnet_buffer (b)->tcp.ack_number);
1263       if (tcp_in_fastrecovery (tc) && tc->rcv_dupacks == TCP_DUPACK_THRESHOLD)
1264         {
1265           TCP_EVT_DBG (TCP_EVT_DUPACK_RCVD, tc);
1266           tcp_cc_handle_event (tc, 1);
1267         }
1268       /* Don't drop yet */
1269       return 0;
1270     }
1271
1272   /*
1273    * Looks okay, process feedback
1274    */
1275
1276   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1277     tcp_rcv_sacks (tc, vnet_buffer (b)->tcp.ack_number);
1278
1279   prev_snd_wnd = tc->snd_wnd;
1280   prev_snd_una = tc->snd_una;
1281   tcp_update_snd_wnd (tc, vnet_buffer (b)->tcp.seq_number,
1282                       vnet_buffer (b)->tcp.ack_number,
1283                       clib_net_to_host_u16 (th->window) << tc->snd_wscale);
1284   tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
1285   tc->snd_una = vnet_buffer (b)->tcp.ack_number + tc->sack_sb.snd_una_adv;
1286   tcp_validate_txf_size (tc, tc->bytes_acked);
1287
1288   if (tc->bytes_acked)
1289     tcp_dequeue_acked (tc, vnet_buffer (b)->tcp.ack_number);
1290
1291   TCP_EVT_DBG (TCP_EVT_ACK_RCVD, tc);
1292
1293   /*
1294    * Check if we have congestion event
1295    */
1296
1297   if (tcp_ack_is_cc_event (tc, b, prev_snd_wnd, prev_snd_una, &is_dack))
1298     {
1299       tcp_cc_handle_event (tc, is_dack);
1300       if (!tcp_in_cong_recovery (tc))
1301         return 0;
1302       *error = TCP_ERROR_ACK_DUP;
1303       TCP_EVT_DBG (TCP_EVT_DUPACK_RCVD, tc, 1);
1304       return vnet_buffer (b)->tcp.data_len ? 0 : -1;
1305     }
1306
1307   /*
1308    * Update congestion control (slow start/congestion avoidance)
1309    */
1310   tcp_cc_update (tc, b);
1311   *error = TCP_ERROR_ACK_OK;
1312   return 0;
1313 }
1314
1315 static u8
1316 tcp_sack_vector_is_sane (sack_block_t * sacks)
1317 {
1318   int i;
1319   for (i = 1; i < vec_len (sacks); i++)
1320     {
1321       if (sacks[i - 1].end == sacks[i].start)
1322         return 0;
1323     }
1324   return 1;
1325 }
1326
1327 /**
1328  * Build SACK list as per RFC2018.
1329  *
1330  * Makes sure the first block contains the segment that generated the current
1331  * ACK and the following ones are the ones most recently reported in SACK
1332  * blocks.
1333  *
1334  * @param tc TCP connection for which the SACK list is updated
1335  * @param start Start sequence number of the newest SACK block
1336  * @param end End sequence of the newest SACK block
1337  */
1338 void
1339 tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end)
1340 {
1341   sack_block_t *new_list = 0, *block = 0;
1342   int i;
1343
1344   /* If the first segment is ooo add it to the list. Last write might've moved
1345    * rcv_nxt over the first segment. */
1346   if (seq_lt (tc->rcv_nxt, start))
1347     {
1348       vec_add2 (new_list, block, 1);
1349       block->start = start;
1350       block->end = end;
1351     }
1352
1353   /* Find the blocks still worth keeping. */
1354   for (i = 0; i < vec_len (tc->snd_sacks); i++)
1355     {
1356       /* Discard if rcv_nxt advanced beyond current block */
1357       if (seq_leq (tc->snd_sacks[i].start, tc->rcv_nxt))
1358         continue;
1359
1360       /* Merge or drop if segment overlapped by the new segment */
1361       if (block && (seq_geq (tc->snd_sacks[i].end, new_list[0].start)
1362                     && seq_leq (tc->snd_sacks[i].start, new_list[0].end)))
1363         {
1364           if (seq_lt (tc->snd_sacks[i].start, new_list[0].start))
1365             new_list[0].start = tc->snd_sacks[i].start;
1366           if (seq_lt (new_list[0].end, tc->snd_sacks[i].end))
1367             new_list[0].end = tc->snd_sacks[i].end;
1368           continue;
1369         }
1370
1371       /* Save to new SACK list if we have space. */
1372       if (vec_len (new_list) < TCP_MAX_SACK_BLOCKS)
1373         {
1374           vec_add1 (new_list, tc->snd_sacks[i]);
1375         }
1376       else
1377         {
1378           clib_warning ("sack discarded");
1379         }
1380     }
1381
1382   ASSERT (vec_len (new_list) <= TCP_MAX_SACK_BLOCKS);
1383
1384   /* Replace old vector with new one */
1385   vec_free (tc->snd_sacks);
1386   tc->snd_sacks = new_list;
1387
1388   /* Segments should not 'touch' */
1389   ASSERT (tcp_sack_vector_is_sane (tc->snd_sacks));
1390 }
1391
1392 /** Enqueue data for delivery to application */
1393 always_inline int
1394 tcp_session_enqueue_data (tcp_connection_t * tc, vlib_buffer_t * b,
1395                           u16 data_len)
1396 {
1397   int written, error = TCP_ERROR_ENQUEUED;
1398
1399   ASSERT (seq_geq (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1400   ASSERT (data_len);
1401   written = session_enqueue_stream_connection (&tc->connection, b, 0,
1402                                                1 /* queue event */ , 1);
1403
1404   TCP_EVT_DBG (TCP_EVT_INPUT, tc, 0, data_len, written);
1405
1406   /* Update rcv_nxt */
1407   if (PREDICT_TRUE (written == data_len))
1408     {
1409       tc->rcv_nxt += written;
1410     }
1411   /* If more data written than expected, account for out-of-order bytes. */
1412   else if (written > data_len)
1413     {
1414       tc->rcv_nxt += written;
1415
1416       /* Send ACK confirming the update */
1417       tc->flags |= TCP_CONN_SNDACK;
1418     }
1419   else if (written > 0)
1420     {
1421       /* We've written something but FIFO is probably full now */
1422       tc->rcv_nxt += written;
1423
1424       /* Depending on how fast the app is, all remaining buffers in burst will
1425        * not be enqueued. Inform peer */
1426       tc->flags |= TCP_CONN_SNDACK;
1427
1428       error = TCP_ERROR_PARTIALLY_ENQUEUED;
1429     }
1430   else
1431     {
1432       tc->flags |= TCP_CONN_SNDACK;
1433       return TCP_ERROR_FIFO_FULL;
1434     }
1435
1436   /* Update SACK list if need be */
1437   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1438     {
1439       /* Remove SACK blocks that have been delivered */
1440       tcp_update_sack_list (tc, tc->rcv_nxt, tc->rcv_nxt);
1441     }
1442
1443   return error;
1444 }
1445
1446 /** Enqueue out-of-order data */
1447 always_inline int
1448 tcp_session_enqueue_ooo (tcp_connection_t * tc, vlib_buffer_t * b,
1449                          u16 data_len)
1450 {
1451   stream_session_t *s0;
1452   int rv, offset;
1453
1454   ASSERT (seq_gt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1455   ASSERT (data_len);
1456
1457   /* Enqueue out-of-order data with relative offset */
1458   rv = session_enqueue_stream_connection (&tc->connection, b,
1459                                           vnet_buffer (b)->tcp.seq_number -
1460                                           tc->rcv_nxt, 0 /* queue event */ ,
1461                                           0);
1462
1463   /* Nothing written */
1464   if (rv)
1465     {
1466       TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, 0);
1467       return TCP_ERROR_FIFO_FULL;
1468     }
1469
1470   TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, data_len);
1471
1472   /* Update SACK list if in use */
1473   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1474     {
1475       ooo_segment_t *newest;
1476       u32 start, end;
1477
1478       s0 = session_get (tc->c_s_index, tc->c_thread_index);
1479
1480       /* Get the newest segment from the fifo */
1481       newest = svm_fifo_newest_ooo_segment (s0->server_rx_fifo);
1482       if (newest)
1483         {
1484           offset = ooo_segment_offset (s0->server_rx_fifo, newest);
1485           ASSERT (offset <= vnet_buffer (b)->tcp.seq_number - tc->rcv_nxt);
1486           start = tc->rcv_nxt + offset;
1487           end = start + ooo_segment_length (s0->server_rx_fifo, newest);
1488           tcp_update_sack_list (tc, start, end);
1489           svm_fifo_newest_ooo_segment_reset (s0->server_rx_fifo);
1490         }
1491     }
1492
1493   return TCP_ERROR_ENQUEUED_OOO;
1494 }
1495
1496 /**
1497  * Check if ACK could be delayed. If ack can be delayed, it should return
1498  * true for a full frame. If we're always acking return 0.
1499  */
1500 always_inline int
1501 tcp_can_delack (tcp_connection_t * tc)
1502 {
1503   /* Send ack if ... */
1504   if (TCP_ALWAYS_ACK
1505       /* just sent a rcv wnd 0 */
1506       || (tc->flags & TCP_CONN_SENT_RCV_WND0) != 0
1507       /* constrained to send ack */
1508       || (tc->flags & TCP_CONN_SNDACK) != 0
1509       /* we're almost out of tx wnd */
1510       || tcp_available_snd_space (tc) < 4 * tc->snd_mss)
1511     return 0;
1512
1513   return 1;
1514 }
1515
1516 static int
1517 tcp_buffer_discard_bytes (vlib_buffer_t * b, u32 n_bytes_to_drop)
1518 {
1519   u32 discard, first = b->current_length;
1520   vlib_main_t *vm = vlib_get_main ();
1521
1522   /* Handle multi-buffer segments */
1523   if (n_bytes_to_drop > b->current_length)
1524     {
1525       if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
1526         return -1;
1527       do
1528         {
1529           discard = clib_min (n_bytes_to_drop, b->current_length);
1530           vlib_buffer_advance (b, discard);
1531           b = vlib_get_buffer (vm, b->next_buffer);
1532           n_bytes_to_drop -= discard;
1533         }
1534       while (n_bytes_to_drop);
1535       if (n_bytes_to_drop > first)
1536         b->total_length_not_including_first_buffer -= n_bytes_to_drop - first;
1537     }
1538   else
1539     vlib_buffer_advance (b, n_bytes_to_drop);
1540   vnet_buffer (b)->tcp.data_len -= n_bytes_to_drop;
1541   return 0;
1542 }
1543
1544 /**
1545  * Receive buffer for connection and handle acks
1546  *
1547  * It handles both in order or out-of-order data.
1548  */
1549 static int
1550 tcp_segment_rcv (tcp_connection_t * tc, vlib_buffer_t * b, u32 * next0)
1551 {
1552   u32 error, n_bytes_to_drop, n_data_bytes;
1553
1554   vlib_buffer_advance (b, vnet_buffer (b)->tcp.data_offset);
1555   n_data_bytes = vnet_buffer (b)->tcp.data_len;
1556   ASSERT (n_data_bytes);
1557
1558   /* Handle out-of-order data */
1559   if (PREDICT_FALSE (vnet_buffer (b)->tcp.seq_number != tc->rcv_nxt))
1560     {
1561       /* Old sequence numbers allowed through because they overlapped
1562        * the rx window */
1563       if (seq_lt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt))
1564         {
1565           /* Completely in the past (possible retransmit). Ack
1566            * retransmissions since we may not have any data to send */
1567           if (seq_leq (vnet_buffer (b)->tcp.seq_end, tc->rcv_nxt))
1568             {
1569               tcp_make_ack (tc, b);
1570               error = TCP_ERROR_SEGMENT_OLD;
1571               *next0 = tcp_next_output (tc->c_is_ip4);
1572               goto done;
1573             }
1574
1575           /* Chop off the bytes in the past and see if what is left
1576            * can be enqueued in order */
1577           n_bytes_to_drop = tc->rcv_nxt - vnet_buffer (b)->tcp.seq_number;
1578           n_data_bytes -= n_bytes_to_drop;
1579           vnet_buffer (b)->tcp.seq_number = tc->rcv_nxt;
1580           if (tcp_buffer_discard_bytes (b, n_bytes_to_drop))
1581             {
1582               error = TCP_ERROR_SEGMENT_OLD;
1583               *next0 = tcp_next_drop (tc->c_is_ip4);
1584               goto done;
1585             }
1586           goto in_order;
1587         }
1588
1589       /* RFC2581: Enqueue and send DUPACK for fast retransmit */
1590       error = tcp_session_enqueue_ooo (tc, b, n_data_bytes);
1591       *next0 = tcp_next_output (tc->c_is_ip4);
1592       tcp_make_ack (tc, b);
1593       vnet_buffer (b)->tcp.flags = TCP_BUF_FLAG_DUPACK;
1594       TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc);
1595       goto done;
1596     }
1597
1598 in_order:
1599
1600   /* In order data, enqueue. Fifo figures out by itself if any out-of-order
1601    * segments can be enqueued after fifo tail offset changes. */
1602   error = tcp_session_enqueue_data (tc, b, n_data_bytes);
1603   if (tcp_can_delack (tc))
1604     {
1605       *next0 = tcp_next_drop (tc->c_is_ip4);
1606       if (!tcp_timer_is_active (tc, TCP_TIMER_DELACK))
1607         tcp_timer_set (tc, TCP_TIMER_DELACK, TCP_DELACK_TIME);
1608       goto done;
1609     }
1610
1611   *next0 = tcp_next_output (tc->c_is_ip4);
1612   tcp_make_ack (tc, b);
1613
1614 done:
1615   return error;
1616 }
1617
1618 typedef struct
1619 {
1620   tcp_header_t tcp_header;
1621   tcp_connection_t tcp_connection;
1622 } tcp_rx_trace_t;
1623
1624 u8 *
1625 format_tcp_rx_trace (u8 * s, va_list * args)
1626 {
1627   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1628   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1629   tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
1630   u32 indent = format_get_indent (s);
1631
1632   s = format (s, "%U\n%U%U",
1633               format_tcp_header, &t->tcp_header, 128,
1634               format_white_space, indent,
1635               format_tcp_connection, &t->tcp_connection, 1);
1636
1637   return s;
1638 }
1639
1640 u8 *
1641 format_tcp_rx_trace_short (u8 * s, va_list * args)
1642 {
1643   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1644   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1645   tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
1646
1647   s = format (s, "%d -> %d (%U)",
1648               clib_net_to_host_u16 (t->tcp_header.src_port),
1649               clib_net_to_host_u16 (t->tcp_header.dst_port), format_tcp_state,
1650               t->tcp_connection.state);
1651
1652   return s;
1653 }
1654
1655 void
1656 tcp_set_rx_trace_data (tcp_rx_trace_t * t0, tcp_connection_t * tc0,
1657                        tcp_header_t * th0, vlib_buffer_t * b0, u8 is_ip4)
1658 {
1659   if (tc0)
1660     {
1661       clib_memcpy (&t0->tcp_connection, tc0, sizeof (t0->tcp_connection));
1662     }
1663   else
1664     {
1665       th0 = tcp_buffer_hdr (b0);
1666     }
1667   clib_memcpy (&t0->tcp_header, th0, sizeof (t0->tcp_header));
1668 }
1669
1670 always_inline void
1671 tcp_node_inc_counter_i (vlib_main_t * vm, u32 tcp4_node, u32 tcp6_node,
1672                         u8 is_ip4, u32 evt, u32 val)
1673 {
1674   if (is_ip4)
1675     vlib_node_increment_counter (vm, tcp4_node, evt, val);
1676   else
1677     vlib_node_increment_counter (vm, tcp6_node, evt, val);
1678 }
1679
1680 #define tcp_maybe_inc_counter(node_id, err, count)                      \
1681 {                                                                       \
1682   if (next0 != tcp_next_drop (is_ip4))                                  \
1683     tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index,            \
1684                             tcp6_##node_id##_node.index, is_ip4, err,   \
1685                             1);                                         \
1686 }
1687 #define tcp_inc_counter(node_id, err, count)                            \
1688   tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index,              \
1689                            tcp6_##node_id##_node.index, is_ip4,         \
1690                            err, count)
1691 #define tcp_maybe_inc_err_counter(cnts, err)                            \
1692 {                                                                       \
1693   cnts[err] += (next0 != tcp_next_drop (is_ip4));                       \
1694 }
1695 #define tcp_inc_err_counter(cnts, err, val)                             \
1696 {                                                                       \
1697   cnts[err] += val;                                                     \
1698 }
1699 #define tcp_store_err_counters(node_id, cnts)                           \
1700 {                                                                       \
1701   int i;                                                                \
1702   for (i = 0; i < TCP_N_ERROR; i++)                                     \
1703     if (cnts[i])                                                        \
1704       tcp_inc_counter(node_id, i, cnts[i]);                             \
1705 }
1706
1707
1708 always_inline uword
1709 tcp46_established_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1710                           vlib_frame_t * from_frame, int is_ip4)
1711 {
1712   u32 my_thread_index = vm->thread_index, errors = 0;
1713   u32 n_left_from, next_index, *from, *to_next;
1714   u16 err_counters[TCP_N_ERROR] = { 0 };
1715   u8 is_fin = 0;
1716
1717   from = vlib_frame_vector_args (from_frame);
1718   n_left_from = from_frame->n_vectors;
1719   next_index = node->cached_next_index;
1720
1721   while (n_left_from > 0)
1722     {
1723       u32 n_left_to_next;
1724
1725       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1726       while (n_left_from > 0 && n_left_to_next > 0)
1727         {
1728           u32 bi0;
1729           vlib_buffer_t *b0;
1730           tcp_header_t *th0 = 0;
1731           tcp_connection_t *tc0;
1732           u32 next0 = tcp_next_drop (is_ip4), error0 = TCP_ERROR_ACK_OK;
1733
1734           if (n_left_from > 1)
1735             {
1736               vlib_buffer_t *pb;
1737               pb = vlib_get_buffer (vm, from[1]);
1738               vlib_prefetch_buffer_header (pb, LOAD);
1739               CLIB_PREFETCH (pb->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
1740             }
1741
1742           bi0 = from[0];
1743           to_next[0] = bi0;
1744           from += 1;
1745           to_next += 1;
1746           n_left_from -= 1;
1747           n_left_to_next -= 1;
1748
1749           b0 = vlib_get_buffer (vm, bi0);
1750           tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
1751                                     my_thread_index);
1752
1753           if (PREDICT_FALSE (tc0 == 0))
1754             {
1755               error0 = TCP_ERROR_INVALID_CONNECTION;
1756               goto done;
1757             }
1758
1759           th0 = tcp_buffer_hdr (b0);
1760           /* N.B. buffer is rewritten if segment is ooo. Thus, th0 becomes a
1761            * dangling reference. */
1762           is_fin = tcp_is_fin (th0);
1763
1764           /* SYNs, FINs and data consume sequence numbers */
1765           vnet_buffer (b0)->tcp.seq_end = vnet_buffer (b0)->tcp.seq_number
1766             + tcp_is_syn (th0) + is_fin + vnet_buffer (b0)->tcp.data_len;
1767
1768           /* TODO header prediction fast path */
1769
1770           /* 1-4: check SEQ, RST, SYN */
1771           if (PREDICT_FALSE (tcp_segment_validate (vm, tc0, b0, th0, &next0,
1772                                                    &error0)))
1773             {
1774               tcp_maybe_inc_err_counter (err_counters, error0);
1775               TCP_EVT_DBG (TCP_EVT_SEG_INVALID, tc0,
1776                            vnet_buffer (b0)->tcp.seq_number,
1777                            vnet_buffer (b0)->tcp.seq_end);
1778               goto done;
1779             }
1780
1781           /* 5: check the ACK field  */
1782           if (PREDICT_FALSE (tcp_rcv_ack (tc0, b0, th0, &next0, &error0)))
1783             {
1784               tcp_maybe_inc_err_counter (err_counters, error0);
1785               goto done;
1786             }
1787
1788           /* 6: check the URG bit TODO */
1789
1790           /* 7: process the segment text */
1791           if (vnet_buffer (b0)->tcp.data_len)
1792             {
1793               error0 = tcp_segment_rcv (tc0, b0, &next0);
1794               tcp_maybe_inc_err_counter (err_counters, error0);
1795             }
1796
1797           /* 8: check the FIN bit */
1798           if (PREDICT_FALSE (is_fin))
1799             {
1800               /* Enter CLOSE-WAIT and notify session. To avoid lingering
1801                * in CLOSE-WAIT, set timer (reuse WAITCLOSE). */
1802               /* Account for the FIN if nothing else was received */
1803               if (vnet_buffer (b0)->tcp.data_len == 0)
1804                 tc0->rcv_nxt += 1;
1805               tcp_make_ack (tc0, b0);
1806               next0 = tcp_next_output (tc0->c_is_ip4);
1807               tc0->state = TCP_STATE_CLOSE_WAIT;
1808               stream_session_disconnect_notify (&tc0->connection);
1809               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
1810               TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc0);
1811               tcp_inc_err_counter (err_counters, TCP_ERROR_FIN_RCVD, 1);
1812             }
1813
1814         done:
1815           b0->error = node->errors[error0];
1816           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1817             {
1818               tcp_rx_trace_t *t0 = vlib_add_trace (vm, node, b0,
1819                                                    sizeof (*t0));
1820               tcp_set_rx_trace_data (t0, tc0, th0, b0, is_ip4);
1821             }
1822
1823           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1824                                            n_left_to_next, bi0, next0);
1825         }
1826
1827       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1828     }
1829
1830   errors = session_manager_flush_enqueue_events (TRANSPORT_PROTO_TCP,
1831                                                  my_thread_index);
1832   err_counters[TCP_ERROR_EVENT_FIFO_FULL] = errors;
1833   tcp_store_err_counters (established, err_counters);
1834   tcp_flush_frame_to_output (vm, my_thread_index, is_ip4);
1835   return from_frame->n_vectors;
1836 }
1837
1838 static uword
1839 tcp4_established (vlib_main_t * vm, vlib_node_runtime_t * node,
1840                   vlib_frame_t * from_frame)
1841 {
1842   return tcp46_established_inline (vm, node, from_frame, 1 /* is_ip4 */ );
1843 }
1844
1845 static uword
1846 tcp6_established (vlib_main_t * vm, vlib_node_runtime_t * node,
1847                   vlib_frame_t * from_frame)
1848 {
1849   return tcp46_established_inline (vm, node, from_frame, 0 /* is_ip4 */ );
1850 }
1851
1852 /* *INDENT-OFF* */
1853 VLIB_REGISTER_NODE (tcp4_established_node) =
1854 {
1855   .function = tcp4_established,
1856   .name = "tcp4-established",
1857   /* Takes a vector of packets. */
1858   .vector_size = sizeof (u32),
1859   .n_errors = TCP_N_ERROR,
1860   .error_strings = tcp_error_strings,
1861   .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
1862   .next_nodes =
1863   {
1864 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
1865     foreach_tcp_state_next
1866 #undef _
1867   },
1868   .format_trace = format_tcp_rx_trace_short,
1869 };
1870 /* *INDENT-ON* */
1871
1872 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_established_node, tcp4_established);
1873
1874 /* *INDENT-OFF* */
1875 VLIB_REGISTER_NODE (tcp6_established_node) =
1876 {
1877   .function = tcp6_established,
1878   .name = "tcp6-established",
1879   /* Takes a vector of packets. */
1880   .vector_size = sizeof (u32),
1881   .n_errors = TCP_N_ERROR,
1882   .error_strings = tcp_error_strings,
1883   .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
1884   .next_nodes =
1885   {
1886 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
1887     foreach_tcp_state_next
1888 #undef _
1889   },
1890   .format_trace = format_tcp_rx_trace_short,
1891 };
1892 /* *INDENT-ON* */
1893
1894
1895 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_established_node, tcp6_established);
1896
1897 vlib_node_registration_t tcp4_syn_sent_node;
1898 vlib_node_registration_t tcp6_syn_sent_node;
1899
1900 static u8
1901 tcp_lookup_is_valid (tcp_connection_t * tc, tcp_header_t * hdr)
1902 {
1903   transport_connection_t *tmp = 0;
1904   u64 handle;
1905
1906   if (!tc)
1907     return 1;
1908
1909   /* Proxy case */
1910   if (tc->c_lcl_port == 0 && tc->state == TCP_STATE_LISTEN)
1911     return 1;
1912
1913   u8 is_valid = (tc->c_lcl_port == hdr->dst_port
1914                  && (tc->state == TCP_STATE_LISTEN
1915                      || tc->c_rmt_port == hdr->src_port));
1916
1917   if (!is_valid)
1918     {
1919       handle = session_lookup_half_open_handle (&tc->connection);
1920       tmp = session_lookup_half_open_connection (handle & 0xFFFFFFFF,
1921                                                  tc->c_proto, tc->c_is_ip4);
1922
1923       if (tmp)
1924         {
1925           if (tmp->lcl_port == hdr->dst_port
1926               && tmp->rmt_port == hdr->src_port)
1927             {
1928               TCP_DBG ("half-open is valid!");
1929             }
1930         }
1931     }
1932   return is_valid;
1933 }
1934
1935 /**
1936  * Lookup transport connection
1937  */
1938 static tcp_connection_t *
1939 tcp_lookup_connection (u32 fib_index, vlib_buffer_t * b, u8 thread_index,
1940                        u8 is_ip4)
1941 {
1942   tcp_header_t *tcp;
1943   transport_connection_t *tconn;
1944   tcp_connection_t *tc;
1945   u8 is_filtered = 0;
1946   if (is_ip4)
1947     {
1948       ip4_header_t *ip4;
1949       ip4 = vlib_buffer_get_current (b);
1950       tcp = ip4_next_header (ip4);
1951       tconn = session_lookup_connection_wt4 (fib_index,
1952                                              &ip4->dst_address,
1953                                              &ip4->src_address,
1954                                              tcp->dst_port,
1955                                              tcp->src_port,
1956                                              TRANSPORT_PROTO_TCP,
1957                                              thread_index, &is_filtered);
1958       tc = tcp_get_connection_from_transport (tconn);
1959       ASSERT (tcp_lookup_is_valid (tc, tcp));
1960     }
1961   else
1962     {
1963       ip6_header_t *ip6;
1964       ip6 = vlib_buffer_get_current (b);
1965       tcp = ip6_next_header (ip6);
1966       tconn = session_lookup_connection_wt6 (fib_index,
1967                                              &ip6->dst_address,
1968                                              &ip6->src_address,
1969                                              tcp->dst_port,
1970                                              tcp->src_port,
1971                                              TRANSPORT_PROTO_TCP,
1972                                              thread_index, &is_filtered);
1973       tc = tcp_get_connection_from_transport (tconn);
1974       ASSERT (tcp_lookup_is_valid (tc, tcp));
1975     }
1976   return tc;
1977 }
1978
1979 always_inline uword
1980 tcp46_syn_sent_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1981                        vlib_frame_t * from_frame, int is_ip4)
1982 {
1983   tcp_main_t *tm = vnet_get_tcp_main ();
1984   u32 n_left_from, next_index, *from, *to_next;
1985   u32 my_thread_index = vm->thread_index, errors = 0;
1986
1987   from = vlib_frame_vector_args (from_frame);
1988   n_left_from = from_frame->n_vectors;
1989
1990   next_index = node->cached_next_index;
1991
1992   while (n_left_from > 0)
1993     {
1994       u32 n_left_to_next;
1995
1996       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1997
1998       while (n_left_from > 0 && n_left_to_next > 0)
1999         {
2000           u32 bi0, ack0, seq0;
2001           vlib_buffer_t *b0;
2002           tcp_rx_trace_t *t0;
2003           tcp_header_t *tcp0 = 0;
2004           tcp_connection_t *tc0;
2005           tcp_connection_t *new_tc0;
2006           u32 next0 = tcp_next_drop (is_ip4), error0 = TCP_ERROR_ENQUEUED;
2007
2008           bi0 = from[0];
2009           to_next[0] = bi0;
2010           from += 1;
2011           to_next += 1;
2012           n_left_from -= 1;
2013           n_left_to_next -= 1;
2014
2015           b0 = vlib_get_buffer (vm, bi0);
2016           tc0 =
2017             tcp_half_open_connection_get (vnet_buffer (b0)->
2018                                           tcp.connection_index);
2019           if (PREDICT_FALSE (tc0 == 0))
2020             {
2021               error0 = TCP_ERROR_INVALID_CONNECTION;
2022               goto drop;
2023             }
2024
2025           /* Half-open completed recently but the connection was't removed
2026            * yet by the owning thread */
2027           if (PREDICT_FALSE (tc0->flags & TCP_CONN_HALF_OPEN_DONE))
2028             {
2029               /* Make sure the connection actually exists */
2030               ASSERT (tcp_lookup_connection (tc0->c_fib_index, b0,
2031                                              my_thread_index, is_ip4));
2032               goto drop;
2033             }
2034
2035           ack0 = vnet_buffer (b0)->tcp.ack_number;
2036           seq0 = vnet_buffer (b0)->tcp.seq_number;
2037           tcp0 = tcp_buffer_hdr (b0);
2038
2039           /* Crude check to see if the connection handle does not match
2040            * the packet. Probably connection just switched to established */
2041           if (PREDICT_FALSE (tcp0->dst_port != tc0->c_lcl_port
2042                              || tcp0->src_port != tc0->c_rmt_port))
2043             goto drop;
2044
2045           if (PREDICT_FALSE
2046               (!tcp_ack (tcp0) && !tcp_rst (tcp0) && !tcp_syn (tcp0)))
2047             goto drop;
2048
2049           /* SYNs, FINs and data consume sequence numbers */
2050           vnet_buffer (b0)->tcp.seq_end = seq0 + tcp_is_syn (tcp0)
2051             + tcp_is_fin (tcp0) + vnet_buffer (b0)->tcp.data_len;
2052
2053           /*
2054            *  1. check the ACK bit
2055            */
2056
2057           /*
2058            *   If the ACK bit is set
2059            *     If SEG.ACK =< ISS, or SEG.ACK > SND.NXT, send a reset (unless
2060            *     the RST bit is set, if so drop the segment and return)
2061            *       <SEQ=SEG.ACK><CTL=RST>
2062            *     and discard the segment.  Return.
2063            *     If SND.UNA =< SEG.ACK =< SND.NXT then the ACK is acceptable.
2064            */
2065           if (tcp_ack (tcp0))
2066             {
2067               if (seq_leq (ack0, tc0->iss) || seq_gt (ack0, tc0->snd_nxt))
2068                 {
2069                   clib_warning ("ack not in rcv wnd");
2070                   if (!tcp_rst (tcp0))
2071                     tcp_send_reset_w_pkt (tc0, b0, is_ip4);
2072                   goto drop;
2073                 }
2074
2075               /* Make sure ACK is valid */
2076               if (seq_gt (tc0->snd_una, ack0))
2077                 {
2078                   clib_warning ("ack invalid");
2079                   goto drop;
2080                 }
2081             }
2082
2083           /*
2084            * 2. check the RST bit
2085            */
2086
2087           if (tcp_rst (tcp0))
2088             {
2089               /* If ACK is acceptable, signal client that peer is not
2090                * willing to accept connection and drop connection*/
2091               if (tcp_ack (tcp0))
2092                 tcp_connection_reset (tc0);
2093               goto drop;
2094             }
2095
2096           /*
2097            * 3. check the security and precedence (skipped)
2098            */
2099
2100           /*
2101            * 4. check the SYN bit
2102            */
2103
2104           /* No SYN flag. Drop. */
2105           if (!tcp_syn (tcp0))
2106             {
2107               clib_warning ("not synack");
2108               goto drop;
2109             }
2110
2111           /* Parse options */
2112           if (tcp_options_parse (tcp0, &tc0->rcv_opts))
2113             {
2114               clib_warning ("options parse fail");
2115               goto drop;
2116             }
2117
2118           /* Valid SYN or SYN-ACK. Move connection from half-open pool to
2119            * current thread pool. */
2120           pool_get (tm->connections[my_thread_index], new_tc0);
2121           clib_memcpy (new_tc0, tc0, sizeof (*new_tc0));
2122           new_tc0->c_c_index = new_tc0 - tm->connections[my_thread_index];
2123           new_tc0->c_thread_index = my_thread_index;
2124           new_tc0->rcv_nxt = vnet_buffer (b0)->tcp.seq_end;
2125           new_tc0->irs = seq0;
2126           new_tc0->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
2127           new_tc0->timers[TCP_TIMER_RETRANSMIT_SYN] =
2128             TCP_TIMER_HANDLE_INVALID;
2129
2130           /* If this is not the owning thread, wait for syn retransmit to
2131            * expire and cleanup then */
2132           if (tcp_half_open_connection_cleanup (tc0))
2133             tc0->flags |= TCP_CONN_HALF_OPEN_DONE;
2134
2135           if (tcp_opts_tstamp (&new_tc0->rcv_opts))
2136             {
2137               new_tc0->tsval_recent = new_tc0->rcv_opts.tsval;
2138               new_tc0->tsval_recent_age = tcp_time_now ();
2139             }
2140
2141           if (tcp_opts_wscale (&new_tc0->rcv_opts))
2142             new_tc0->snd_wscale = new_tc0->rcv_opts.wscale;
2143
2144           /* RFC1323: SYN and SYN-ACK wnd not scaled */
2145           new_tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window);
2146           new_tc0->snd_wl1 = seq0;
2147           new_tc0->snd_wl2 = ack0;
2148
2149           tcp_connection_init_vars (new_tc0);
2150
2151           /* SYN-ACK: See if we can switch to ESTABLISHED state */
2152           if (PREDICT_TRUE (tcp_ack (tcp0)))
2153             {
2154               /* Our SYN is ACKed: we have iss < ack = snd_una */
2155
2156               /* TODO Dequeue acknowledged segments if we support Fast Open */
2157               new_tc0->snd_una = ack0;
2158               new_tc0->state = TCP_STATE_ESTABLISHED;
2159
2160               /* Make sure las is initialized for the wnd computation */
2161               new_tc0->rcv_las = new_tc0->rcv_nxt;
2162
2163               /* Notify app that we have connection. If session layer can't
2164                * allocate session send reset */
2165               if (session_stream_connect_notify (&new_tc0->connection, 0))
2166                 {
2167                   clib_warning ("connect notify fail");
2168                   tcp_send_reset_w_pkt (new_tc0, b0, is_ip4);
2169                   tcp_connection_cleanup (new_tc0);
2170                   goto drop;
2171                 }
2172
2173               /* Make sure after data segment processing ACK is sent */
2174               new_tc0->flags |= TCP_CONN_SNDACK;
2175
2176               /* Update rtt with the syn-ack sample */
2177               tcp_update_rtt (new_tc0, vnet_buffer (b0)->tcp.ack_number);
2178               TCP_EVT_DBG (TCP_EVT_SYNACK_RCVD, new_tc0);
2179             }
2180           /* SYN: Simultaneous open. Change state to SYN-RCVD and send SYN-ACK */
2181           else
2182             {
2183               new_tc0->state = TCP_STATE_SYN_RCVD;
2184
2185               /* Notify app that we have connection */
2186               if (session_stream_connect_notify (&new_tc0->connection, 0))
2187                 {
2188                   tcp_connection_cleanup (new_tc0);
2189                   tcp_send_reset_w_pkt (tc0, b0, is_ip4);
2190                   TCP_EVT_DBG (TCP_EVT_RST_SENT, tc0);
2191                   goto drop;
2192                 }
2193
2194               tc0->rtt_ts = 0;
2195               tcp_init_snd_vars (tc0);
2196               tcp_make_synack (new_tc0, b0);
2197               next0 = tcp_next_output (is_ip4);
2198
2199               goto drop;
2200             }
2201
2202           /* Read data, if any */
2203           if (PREDICT_FALSE (vnet_buffer (b0)->tcp.data_len))
2204             {
2205               clib_warning ("rcvd data in syn-sent");
2206               error0 = tcp_segment_rcv (new_tc0, b0, &next0);
2207               if (error0 == TCP_ERROR_ACK_OK)
2208                 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2209               tcp_maybe_inc_counter (syn_sent, error0, 1);
2210             }
2211           else
2212             {
2213               tcp_make_ack (new_tc0, b0);
2214               next0 = tcp_next_output (new_tc0->c_is_ip4);
2215             }
2216
2217         drop:
2218
2219           b0->error = error0 ? node->errors[error0] : 0;
2220           if (PREDICT_FALSE
2221               ((b0->flags & VLIB_BUFFER_IS_TRACED) && tcp0 != 0))
2222             {
2223               t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2224               clib_memcpy (&t0->tcp_header, tcp0, sizeof (t0->tcp_header));
2225               clib_memcpy (&t0->tcp_connection, tc0,
2226                            sizeof (t0->tcp_connection));
2227             }
2228
2229           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2230                                            n_left_to_next, bi0, next0);
2231         }
2232
2233       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2234     }
2235
2236   errors = session_manager_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2237                                                  my_thread_index);
2238   tcp_inc_counter (syn_sent, TCP_ERROR_EVENT_FIFO_FULL, errors);
2239   return from_frame->n_vectors;
2240 }
2241
2242 static uword
2243 tcp4_syn_sent (vlib_main_t * vm, vlib_node_runtime_t * node,
2244                vlib_frame_t * from_frame)
2245 {
2246   return tcp46_syn_sent_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2247 }
2248
2249 static uword
2250 tcp6_syn_sent_rcv (vlib_main_t * vm, vlib_node_runtime_t * node,
2251                    vlib_frame_t * from_frame)
2252 {
2253   return tcp46_syn_sent_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2254 }
2255
2256 /* *INDENT-OFF* */
2257 VLIB_REGISTER_NODE (tcp4_syn_sent_node) =
2258 {
2259   .function = tcp4_syn_sent,
2260   .name = "tcp4-syn-sent",
2261   /* Takes a vector of packets. */
2262   .vector_size = sizeof (u32),
2263   .n_errors = TCP_N_ERROR,
2264   .error_strings = tcp_error_strings,
2265   .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2266   .next_nodes =
2267   {
2268 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2269     foreach_tcp_state_next
2270 #undef _
2271   },
2272   .format_trace = format_tcp_rx_trace_short,
2273 };
2274 /* *INDENT-ON* */
2275
2276 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_syn_sent_node, tcp4_syn_sent);
2277
2278 /* *INDENT-OFF* */
2279 VLIB_REGISTER_NODE (tcp6_syn_sent_node) =
2280 {
2281   .function = tcp6_syn_sent_rcv,
2282   .name = "tcp6-syn-sent",
2283   /* Takes a vector of packets. */
2284   .vector_size = sizeof (u32),
2285   .n_errors = TCP_N_ERROR,
2286   .error_strings = tcp_error_strings,
2287   .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2288   .next_nodes =
2289   {
2290 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2291     foreach_tcp_state_next
2292 #undef _
2293   },
2294   .format_trace = format_tcp_rx_trace_short,
2295 };
2296 /* *INDENT-ON* */
2297
2298 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_syn_sent_node, tcp6_syn_sent_rcv);
2299
2300 vlib_node_registration_t tcp4_rcv_process_node;
2301 vlib_node_registration_t tcp6_rcv_process_node;
2302
2303 /**
2304  * Handles reception for all states except LISTEN, SYN-SENT and ESTABLISHED
2305  * as per RFC793 p. 64
2306  */
2307 always_inline uword
2308 tcp46_rcv_process_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2309                           vlib_frame_t * from_frame, int is_ip4)
2310 {
2311   u32 n_left_from, next_index, *from, *to_next, n_fins = 0;
2312   u32 my_thread_index = vm->thread_index, errors = 0;
2313
2314   from = vlib_frame_vector_args (from_frame);
2315   n_left_from = from_frame->n_vectors;
2316   next_index = node->cached_next_index;
2317
2318   while (n_left_from > 0)
2319     {
2320       u32 n_left_to_next;
2321
2322       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2323
2324       while (n_left_from > 0 && n_left_to_next > 0)
2325         {
2326           u32 bi0;
2327           vlib_buffer_t *b0;
2328           tcp_header_t *tcp0 = 0;
2329           tcp_connection_t *tc0;
2330           u32 next0 = tcp_next_drop (is_ip4), error0 = TCP_ERROR_NONE;
2331           u8 is_fin0;
2332
2333           bi0 = from[0];
2334           to_next[0] = bi0;
2335           from += 1;
2336           to_next += 1;
2337           n_left_from -= 1;
2338           n_left_to_next -= 1;
2339
2340           b0 = vlib_get_buffer (vm, bi0);
2341           tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2342                                     my_thread_index);
2343           if (PREDICT_FALSE (tc0 == 0))
2344             {
2345               error0 = TCP_ERROR_INVALID_CONNECTION;
2346               goto drop;
2347             }
2348
2349           tcp0 = tcp_buffer_hdr (b0);
2350           is_fin0 = tcp_is_fin (tcp0);
2351
2352           /* SYNs, FINs and data consume sequence numbers */
2353           vnet_buffer (b0)->tcp.seq_end = vnet_buffer (b0)->tcp.seq_number
2354             + tcp_is_syn (tcp0) + is_fin0 + vnet_buffer (b0)->tcp.data_len;
2355
2356           if (CLIB_DEBUG)
2357             {
2358               tcp_connection_t *tmp;
2359               tmp = tcp_lookup_connection (tc0->c_fib_index, b0,
2360                                            my_thread_index, is_ip4);
2361               if (tmp->state != tc0->state)
2362                 {
2363                   clib_warning ("state changed");
2364                   goto drop;
2365                 }
2366             }
2367
2368           /*
2369            * Special treatment for CLOSED
2370            */
2371           if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
2372             {
2373               error0 = TCP_ERROR_CONNECTION_CLOSED;
2374               goto drop;
2375             }
2376
2377           /*
2378            * For all other states (except LISTEN)
2379            */
2380
2381           /* 1-4: check SEQ, RST, SYN */
2382           if (PREDICT_FALSE (tcp_segment_validate (vm, tc0, b0, tcp0,
2383                                                    &next0, &error0)))
2384             {
2385               tcp_maybe_inc_counter (rcv_process, error0, 1);
2386               goto drop;
2387             }
2388
2389           /* 5: check the ACK field  */
2390           switch (tc0->state)
2391             {
2392             case TCP_STATE_SYN_RCVD:
2393               /*
2394                * If the segment acknowledgment is not acceptable, form a
2395                * reset segment,
2396                *  <SEQ=SEG.ACK><CTL=RST>
2397                * and send it.
2398                */
2399               if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2400                 {
2401                   TCP_DBG ("connection not accepted");
2402                   tcp_send_reset_w_pkt (tc0, b0, is_ip4);
2403                   error0 = TCP_ERROR_ACK_INVALID;
2404                   goto drop;
2405                 }
2406
2407               /* Update rtt and rto */
2408               tcp_update_rtt (tc0, vnet_buffer (b0)->tcp.ack_number);
2409
2410               /* Switch state to ESTABLISHED */
2411               tc0->state = TCP_STATE_ESTABLISHED;
2412               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2413
2414               /* Initialize session variables */
2415               tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2416               tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2417                 << tc0->rcv_opts.wscale;
2418               tc0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
2419               tc0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
2420
2421               /* Reset SYN-ACK retransmit and SYN_RCV establish timers */
2422               tcp_retransmit_timer_reset (tc0);
2423               tcp_timer_reset (tc0, TCP_TIMER_ESTABLISH);
2424               stream_session_accept_notify (&tc0->connection);
2425               error0 = TCP_ERROR_ACK_OK;
2426               break;
2427             case TCP_STATE_ESTABLISHED:
2428               /* We can get packets in established state here because they
2429                * were enqueued before state change */
2430               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2431                 {
2432                   tcp_maybe_inc_counter (rcv_process, error0, 1);
2433                   goto drop;
2434                 }
2435
2436               break;
2437             case TCP_STATE_FIN_WAIT_1:
2438               /* In addition to the processing for the ESTABLISHED state, if
2439                * our FIN is now acknowledged then enter FIN-WAIT-2 and
2440                * continue processing in that state. */
2441               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2442                 {
2443                   tcp_maybe_inc_counter (rcv_process, error0, 1);
2444                   goto drop;
2445                 }
2446
2447               /* Still have to send the FIN */
2448               if (tc0->flags & TCP_CONN_FINPNDG)
2449                 {
2450                   /* TX fifo finally drained */
2451                   if (!stream_session_tx_fifo_max_dequeue (&tc0->connection))
2452                     tcp_send_fin (tc0);
2453                 }
2454               /* If FIN is ACKed */
2455               else if (tc0->snd_una == tc0->snd_una_max)
2456                 {
2457                   tc0->state = TCP_STATE_FIN_WAIT_2;
2458                   TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2459
2460                   /* Stop all retransmit timers because we have nothing more
2461                    * to send. Enable waitclose though because we're willing to
2462                    * wait for peer's FIN but not indefinitely. */
2463                   tcp_connection_timers_reset (tc0);
2464                   tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2465                 }
2466               break;
2467             case TCP_STATE_FIN_WAIT_2:
2468               /* In addition to the processing for the ESTABLISHED state, if
2469                * the retransmission queue is empty, the user's CLOSE can be
2470                * acknowledged ("ok") but do not delete the TCB. */
2471               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2472                 {
2473                   tcp_maybe_inc_counter (rcv_process, error0, 1);
2474                   goto drop;
2475                 }
2476               break;
2477             case TCP_STATE_CLOSE_WAIT:
2478               /* Do the same processing as for the ESTABLISHED state. */
2479               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2480                 {
2481                   tcp_maybe_inc_counter (rcv_process, error0, 1);
2482                   goto drop;
2483                 }
2484               break;
2485             case TCP_STATE_CLOSING:
2486               /* In addition to the processing for the ESTABLISHED state, if
2487                * the ACK acknowledges our FIN then enter the TIME-WAIT state,
2488                * otherwise ignore the segment. */
2489               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2490                 {
2491                   tcp_maybe_inc_counter (rcv_process, error0, 1);
2492                   goto drop;
2493                 }
2494
2495               tc0->state = TCP_STATE_TIME_WAIT;
2496               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2497               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2498               goto drop;
2499
2500               break;
2501             case TCP_STATE_LAST_ACK:
2502               /* The only thing that [should] arrive in this state is an
2503                * acknowledgment of our FIN. If our FIN is now acknowledged,
2504                * delete the TCB, enter the CLOSED state, and return. */
2505
2506               if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2507                 {
2508                   error0 = TCP_ERROR_ACK_INVALID;
2509                   goto drop;
2510                 }
2511               error0 = TCP_ERROR_ACK_OK;
2512               tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2513               /* Apparently our ACK for the peer's FIN was lost */
2514               if (is_fin0 && tc0->snd_una != tc0->snd_una_max)
2515                 {
2516                   tcp_send_fin (tc0);
2517                   goto drop;
2518                 }
2519
2520               tc0->state = TCP_STATE_CLOSED;
2521               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2522               tcp_connection_timers_reset (tc0);
2523
2524               /* Don't delete the connection/session yet. Instead, wait a
2525                * reasonable amount of time until the pipes are cleared. In
2526                * particular, this makes sure that we won't have dead sessions
2527                * when processing events on the tx path */
2528               tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
2529
2530               goto drop;
2531
2532               break;
2533             case TCP_STATE_TIME_WAIT:
2534               /* The only thing that can arrive in this state is a
2535                * retransmission of the remote FIN. Acknowledge it, and restart
2536                * the 2 MSL timeout. */
2537
2538               if (tcp_rcv_ack (tc0, b0, tcp0, &next0, &error0))
2539                 {
2540                   tcp_maybe_inc_counter (rcv_process, error0, 1);
2541                   goto drop;
2542                 }
2543
2544               tcp_make_ack (tc0, b0);
2545               next0 = tcp_next_output (is_ip4);
2546               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2547               goto drop;
2548
2549               break;
2550             default:
2551               ASSERT (0);
2552             }
2553
2554           /* 6: check the URG bit TODO */
2555
2556           /* 7: process the segment text */
2557           switch (tc0->state)
2558             {
2559             case TCP_STATE_ESTABLISHED:
2560             case TCP_STATE_FIN_WAIT_1:
2561             case TCP_STATE_FIN_WAIT_2:
2562               if (vnet_buffer (b0)->tcp.data_len)
2563                 {
2564                   error0 = tcp_segment_rcv (tc0, b0, &next0);
2565                   tcp_maybe_inc_counter (rcv_process, error0, 1);
2566                 }
2567               else if (is_fin0)
2568                 tc0->rcv_nxt += 1;
2569               break;
2570             case TCP_STATE_CLOSE_WAIT:
2571             case TCP_STATE_CLOSING:
2572             case TCP_STATE_LAST_ACK:
2573             case TCP_STATE_TIME_WAIT:
2574               /* This should not occur, since a FIN has been received from the
2575                * remote side.  Ignore the segment text. */
2576               break;
2577             }
2578
2579           /* 8: check the FIN bit */
2580           if (!is_fin0)
2581             goto drop;
2582
2583           switch (tc0->state)
2584             {
2585             case TCP_STATE_ESTABLISHED:
2586             case TCP_STATE_SYN_RCVD:
2587               /* Send FIN-ACK notify app and enter CLOSE-WAIT */
2588               tcp_connection_timers_reset (tc0);
2589               tcp_make_fin (tc0, b0);
2590               tc0->snd_nxt += 1;
2591               next0 = tcp_next_output (tc0->c_is_ip4);
2592               stream_session_disconnect_notify (&tc0->connection);
2593               tc0->state = TCP_STATE_CLOSE_WAIT;
2594               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2595               break;
2596             case TCP_STATE_CLOSE_WAIT:
2597             case TCP_STATE_CLOSING:
2598             case TCP_STATE_LAST_ACK:
2599               /* move along .. */
2600               break;
2601             case TCP_STATE_FIN_WAIT_1:
2602               tc0->state = TCP_STATE_CLOSING;
2603               tcp_make_ack (tc0, b0);
2604               next0 = tcp_next_output (is_ip4);
2605               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2606               /* Wait for ACK but not forever */
2607               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2608               break;
2609             case TCP_STATE_FIN_WAIT_2:
2610               /* Got FIN, send ACK! Be more aggressive with resource cleanup */
2611               tc0->state = TCP_STATE_TIME_WAIT;
2612               tcp_connection_timers_reset (tc0);
2613               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2614               tcp_make_ack (tc0, b0);
2615               next0 = tcp_next_output (is_ip4);
2616               TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2617               break;
2618             case TCP_STATE_TIME_WAIT:
2619               /* Remain in the TIME-WAIT state. Restart the time-wait
2620                * timeout.
2621                */
2622               tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2623               break;
2624             }
2625           TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc0);
2626           n_fins += 1;
2627
2628         drop:
2629           b0->error = error0 ? node->errors[error0] : 0;
2630
2631           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2632             {
2633               tcp_rx_trace_t *t0 =
2634                 vlib_add_trace (vm, node, b0, sizeof (*t0));
2635               tcp_set_rx_trace_data (t0, tc0, tcp0, b0, is_ip4);
2636             }
2637
2638           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
2639                                            n_left_to_next, bi0, next0);
2640         }
2641
2642       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2643     }
2644
2645   errors = session_manager_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2646                                                  my_thread_index);
2647   tcp_inc_counter (rcv_process, TCP_ERROR_EVENT_FIFO_FULL, errors);
2648   tcp_inc_counter (rcv_process, TCP_ERROR_FIN_RCVD, n_fins);
2649   return from_frame->n_vectors;
2650 }
2651
2652 static uword
2653 tcp4_rcv_process (vlib_main_t * vm, vlib_node_runtime_t * node,
2654                   vlib_frame_t * from_frame)
2655 {
2656   return tcp46_rcv_process_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2657 }
2658
2659 static uword
2660 tcp6_rcv_process (vlib_main_t * vm, vlib_node_runtime_t * node,
2661                   vlib_frame_t * from_frame)
2662 {
2663   return tcp46_rcv_process_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2664 }
2665
2666 /* *INDENT-OFF* */
2667 VLIB_REGISTER_NODE (tcp4_rcv_process_node) =
2668 {
2669   .function = tcp4_rcv_process,
2670   .name = "tcp4-rcv-process",
2671   /* Takes a vector of packets. */
2672   .vector_size = sizeof (u32),
2673   .n_errors = TCP_N_ERROR,
2674   .error_strings = tcp_error_strings,
2675   .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
2676   .next_nodes =
2677   {
2678 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
2679     foreach_tcp_state_next
2680 #undef _
2681   },
2682   .format_trace = format_tcp_rx_trace_short,
2683 };
2684 /* *INDENT-ON* */
2685
2686 VLIB_NODE_FUNCTION_MULTIARCH (tcp4_rcv_process_node, tcp4_rcv_process);
2687
2688 /* *INDENT-OFF* */
2689 VLIB_REGISTER_NODE (tcp6_rcv_process_node) =
2690 {
2691   .function = tcp6_rcv_process,
2692   .name = "tcp6-rcv-process",
2693   /* Takes a vector of packets. */
2694   .vector_size = sizeof (u32),
2695   .n_errors = TCP_N_ERROR,
2696   .error_strings = tcp_error_strings,
2697   .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
2698   .next_nodes =
2699   {
2700 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
2701     foreach_tcp_state_next
2702 #undef _
2703   },
2704   .format_trace = format_tcp_rx_trace_short,
2705 };
2706 /* *INDENT-ON* */
2707
2708 VLIB_NODE_FUNCTION_MULTIARCH (tcp6_rcv_process_node, tcp6_rcv_process);
2709
2710 vlib_node_registration_t tcp4_listen_node;
2711 vlib_node_registration_t tcp6_listen_node;
2712
2713 /**
2714  * LISTEN state processing as per RFC 793 p. 65
2715  */
2716 always_inline uword
2717 tcp46_listen_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2718                      vlib_frame_t * from_frame, int is_ip4)
2719 {
2720   u32 n_left_from, next_index, *from, *to_next, n_syns = 0;
2721   u32 my_thread_index = vm->thread_index;
2722
2723   from = vlib_frame_vector_args (from_frame);
2724   n_left_from = from_frame->n_vectors;
2725
2726   next_index = node->cached_next_index;
2727
2728   while (n_left_from > 0)
2729     {
2730       u32 n_left_to_next;
2731
2732       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2733
2734       while (n_left_from > 0 && n_left_to_next > 0)
2735         {
2736           u32 bi0;
2737           vlib_buffer_t *b0;
2738           tcp_rx_trace_t *t0;
2739           tcp_header_t *th0 = 0;
2740           tcp_connection_t *lc0;
2741           ip4_header_t *ip40;
2742           ip6_header_t *ip60;
2743           tcp_connection_t *child0;
2744           u32 error0 = TCP_ERROR_NONE, next0 = tcp_next_drop (is_ip4);
2745
2746           bi0 = from[0];
2747           to_next[0] = bi0;
2748           from += 1;
2749           to_next += 1;
2750           n_left_from -= 1;
2751           n_left_to_next -= 1;
2752
2753           b0 = vlib_get_buffer (vm, bi0);
2754           lc0 = tcp_listener_get (vnet_buffer (b0)->tcp.connection_index);
2755
2756           if (is_ip4)
2757             {
2758               ip40 = vlib_buffer_get_current (b0);
2759               th0 = ip4_next_header (ip40);
2760             }
2761           else
2762             {
2763               ip60 = vlib_buffer_get_current (b0);
2764               th0 = ip6_next_header (ip60);
2765             }
2766
2767           /* Create child session. For syn-flood protection use filter */
2768
2769           /* 1. first check for an RST: handled in dispatch */
2770           /* if (tcp_rst (th0))
2771              goto drop; */
2772
2773           /* 2. second check for an ACK: handled in dispatch */
2774           /* if (tcp_ack (th0))
2775              {
2776              tcp_send_reset (b0, is_ip4);
2777              goto drop;
2778              } */
2779
2780           /* 3. check for a SYN (did that already) */
2781
2782           /* Make sure connection wasn't just created */
2783           child0 = tcp_lookup_connection (lc0->c_fib_index, b0,
2784                                           my_thread_index, 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  */