src/vnet/tcp/tcp_input.c

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