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