src/vnet/tcp/tcp_input.c

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