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