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