src/vnet/tcp/tcp_input.c

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