src/vnet/tcp/tcp.c

   1 /*
   2  * Copyright (c) 2016-2019 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 /**
  17  * @file
  18  * @brief TCP host stack utilities
  19  */
  20
  21 #include <vnet/tcp/tcp.h>
  22 #include <vnet/session/session.h>
  23 #include <vnet/fib/fib.h>
  24 #include <vnet/dpo/load_balance.h>
  25 #include <vnet/dpo/receive_dpo.h>
  26 #include <vnet/ip-neighbor/ip_neighbor.h>
  27 #include <math.h>
  28
  29 tcp_main_t tcp_main;
  30
  31 typedef struct
  32 {
  33   fib_protocol_t nh_proto;
  34   vnet_link_t link_type;
  35   ip46_address_t ip;
  36   u32 sw_if_index;
  37   u8 is_add;
  38 } tcp_add_del_adj_args_t;
  39
  40 static void
  41 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
  42 {
  43   u32 ai;
  44   if (args->is_add)
  45     {
  46       adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
  47                            args->sw_if_index);
  48     }
  49   else
  50     {
  51       ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
  52                          args->sw_if_index);
  53       if (ai != ADJ_INDEX_INVALID)
  54         adj_unlock (ai);
  55     }
  56 }
  57
  58 static void
  59 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
  60 {
  61   tcp_add_del_adj_args_t args = {
  62     .nh_proto = FIB_PROTOCOL_IP6,
  63     .link_type = VNET_LINK_IP6,
  64     .ip = tc->c_rmt_ip,
  65     .sw_if_index = tc->sw_if_index,
  66     .is_add = is_add
  67   };
  68   vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
  69                              sizeof (args));
  70 }
  71
  72 static void
  73 tcp_cc_init (tcp_connection_t * tc)
  74 {
  75   tc->cc_algo->init (tc);
  76 }
  77
  78 static void
  79 tcp_cc_cleanup (tcp_connection_t * tc)
  80 {
  81   if (tc->cc_algo->cleanup)
  82     tc->cc_algo->cleanup (tc);
  83 }
  84
  85 void
  86 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
  87                       const tcp_cc_algorithm_t * vft)
  88 {
  89   tcp_main_t *tm = vnet_get_tcp_main ();
  90   vec_validate (tm->cc_algos, type);
  91
  92   tm->cc_algos[type] = *vft;
  93   hash_set_mem (tm->cc_algo_by_name, vft->name, type);
  94 }
  95
  96 tcp_cc_algorithm_t *
  97 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
  98 {
  99   tcp_main_t *tm = vnet_get_tcp_main ();
 100   return &tm->cc_algos[type];
 101 }
 102
 103 tcp_cc_algorithm_type_e
 104 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
 105 {
 106   tcp_main_t *tm = vnet_get_tcp_main ();
 107   tcp_cc_algo_register (++tm->cc_last_type, vft);
 108   return tm->cc_last_type;
 109 }
 110
 111 static u32
 112 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
 113 {
 114   tcp_main_t *tm = &tcp_main;
 115   tcp_connection_t *listener;
 116   void *iface_ip;
 117
 118   pool_get (tm->listener_pool, listener);
 119   clib_memset (listener, 0, sizeof (*listener));
 120
 121   listener->c_c_index = listener - tm->listener_pool;
 122   listener->c_lcl_port = lcl->port;
 123
 124   /* If we are provided a sw_if_index, bind using one of its ips */
 125   if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
 126     {
 127       if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
 128                                                  lcl->is_ip4)))
 129         ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
 130     }
 131   ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
 132   listener->c_is_ip4 = lcl->is_ip4;
 133   listener->c_proto = TRANSPORT_PROTO_TCP;
 134   listener->c_s_index = session_index;
 135   listener->c_fib_index = lcl->fib_index;
 136   listener->state = TCP_STATE_LISTEN;
 137   listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
 138
 139   tcp_connection_timers_init (listener);
 140
 141   TCP_EVT (TCP_EVT_BIND, listener);
 142
 143   return listener->c_c_index;
 144 }
 145
 146 static u32
 147 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
 148 {
 149   return tcp_connection_bind (session_index, tep);
 150 }
 151
 152 static void
 153 tcp_connection_unbind (u32 listener_index)
 154 {
 155   tcp_main_t *tm = vnet_get_tcp_main ();
 156   tcp_connection_t *tc;
 157
 158   tc = pool_elt_at_index (tm->listener_pool, listener_index);
 159
 160   TCP_EVT (TCP_EVT_UNBIND, tc);
 161
 162   /* Poison the entry */
 163   if (CLIB_DEBUG > 0)
 164     clib_memset (tc, 0xFA, sizeof (*tc));
 165
 166   pool_put_index (tm->listener_pool, listener_index);
 167 }
 168
 169 static u32
 170 tcp_session_unbind (u32 listener_index)
 171 {
 172   tcp_connection_unbind (listener_index);
 173   return 0;
 174 }
 175
 176 static transport_connection_t *
 177 tcp_session_get_listener (u32 listener_index)
 178 {
 179   tcp_main_t *tm = vnet_get_tcp_main ();
 180   tcp_connection_t *tc;
 181   tc = pool_elt_at_index (tm->listener_pool, listener_index);
 182   return &tc->connection;
 183 }
 184
 185 /**
 186  * Cleanup half-open connection
 187  *
 188  */
 189 static void
 190 tcp_half_open_connection_del (tcp_connection_t * tc)
 191 {
 192   tcp_main_t *tm = vnet_get_tcp_main ();
 193   clib_spinlock_lock_if_init (&tm->half_open_lock);
 194   if (CLIB_DEBUG)
 195     clib_memset (tc, 0xFA, sizeof (*tc));
 196   pool_put (tm->half_open_connections, tc);
 197   clib_spinlock_unlock_if_init (&tm->half_open_lock);
 198 }
 199
 200 /**
 201  * Try to cleanup half-open connection
 202  *
 203  * If called from a thread that doesn't own tc, the call won't have any
 204  * effect.
 205  *
 206  * @param tc - connection to be cleaned up
 207  * @return non-zero if cleanup failed.
 208  */
 209 int
 210 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
 211 {
 212   /* Make sure this is the owning thread */
 213   if (tc->c_thread_index != vlib_get_thread_index ())
 214     return 1;
 215   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
 216   tcp_half_open_connection_del (tc);
 217   return 0;
 218 }
 219
 220 static tcp_connection_t *
 221 tcp_half_open_connection_new (void)
 222 {
 223   tcp_main_t *tm = vnet_get_tcp_main ();
 224   tcp_connection_t *tc = 0;
 225   ASSERT (vlib_get_thread_index () == 0);
 226   pool_get (tm->half_open_connections, tc);
 227   clib_memset (tc, 0, sizeof (*tc));
 228   tc->c_c_index = tc - tm->half_open_connections;
 229   return tc;
 230 }
 231
 232 /**
 233  * Cleans up connection state.
 234  *
 235  * No notifications.
 236  */
 237 void
 238 tcp_connection_cleanup (tcp_connection_t * tc)
 239 {
 240   TCP_EVT (TCP_EVT_DELETE, tc);
 241
 242   /* Cleanup local endpoint if this was an active connect */
 243   if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
 244     transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
 245                                 tc->c_lcl_port);
 246
 247   /* Check if connection is not yet fully established */
 248   if (tc->state == TCP_STATE_SYN_SENT)
 249     {
 250       /* Try to remove the half-open connection. If this is not the owning
 251        * thread, tc won't be removed. Retransmit or establish timers will
 252        * eventually expire and call again cleanup on the right thread. */
 253       if (tcp_half_open_connection_cleanup (tc))
 254         tc->flags |= TCP_CONN_HALF_OPEN_DONE;
 255     }
 256   else
 257     {
 258       /* Make sure all timers are cleared */
 259       tcp_connection_timers_reset (tc);
 260
 261       if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
 262         tcp_add_del_adjacency (tc, 0);
 263
 264       tcp_cc_cleanup (tc);
 265       vec_free (tc->snd_sacks);
 266       vec_free (tc->snd_sacks_fl);
 267       vec_free (tc->rcv_opts.sacks);
 268       pool_free (tc->sack_sb.holes);
 269
 270       if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
 271         tcp_bt_cleanup (tc);
 272
 273       tcp_connection_free (tc);
 274     }
 275 }
 276
 277 /**
 278  * Connection removal.
 279  *
 280  * This should be called only once connection enters CLOSED state. Note
 281  * that it notifies the session of the removal event, so if the goal is to
 282  * just remove the connection, call tcp_connection_cleanup instead.
 283  */
 284 void
 285 tcp_connection_del (tcp_connection_t * tc)
 286 {
 287   session_transport_delete_notify (&tc->connection);
 288   tcp_connection_cleanup (tc);
 289 }
 290
 291 tcp_connection_t *
 292 tcp_connection_alloc (u8 thread_index)
 293 {
 294   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
 295   tcp_connection_t *tc;
 296
 297   pool_get (wrk->connections, tc);
 298   clib_memset (tc, 0, sizeof (*tc));
 299   tc->c_c_index = tc - wrk->connections;
 300   tc->c_thread_index = thread_index;
 301   return tc;
 302 }
 303
 304 tcp_connection_t *
 305 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
 306 {
 307   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
 308   tcp_connection_t *tc;
 309
 310   pool_get (wrk->connections, tc);
 311   clib_memcpy_fast (tc, base, sizeof (*tc));
 312   tc->c_c_index = tc - wrk->connections;
 313   tc->c_thread_index = thread_index;
 314   return tc;
 315 }
 316
 317 void
 318 tcp_connection_free (tcp_connection_t * tc)
 319 {
 320   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
 321   if (CLIB_DEBUG)
 322     {
 323       clib_memset (tc, 0xFA, sizeof (*tc));
 324       pool_put (wrk->connections, tc);
 325       return;
 326     }
 327   pool_put (wrk->connections, tc);
 328 }
 329
 330 /**
 331  * Begin connection closing procedure.
 332  *
 333  * If at the end the connection is not in CLOSED state, it is not removed.
 334  * Instead, we rely on on TCP to advance through state machine to either
 335  * 1) LAST_ACK (passive close) whereby when the last ACK is received
 336  * tcp_connection_del is called. This notifies session of the delete and
 337  * calls cleanup.
 338  * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
 339  * and cleanup is called.
 340  *
 341  * N.B. Half-close connections are not supported
 342  */
 343 void
 344 tcp_connection_close (tcp_connection_t * tc)
 345 {
 346   TCP_EVT (TCP_EVT_CLOSE, tc);
 347
 348   /* Send/Program FIN if needed and switch state */
 349   switch (tc->state)
 350     {
 351     case TCP_STATE_SYN_SENT:
 352       /* Try to cleanup. If not on the right thread, mark as half-open done.
 353        * Connection will be cleaned up when establish timer pops */
 354       tcp_connection_cleanup (tc);
 355       break;
 356     case TCP_STATE_SYN_RCVD:
 357       tcp_connection_timers_reset (tc);
 358       tcp_send_fin (tc);
 359       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
 360       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
 361       break;
 362     case TCP_STATE_ESTABLISHED:
 363       /* If closing with unread data, reset the connection */
 364       if (transport_max_rx_dequeue (&tc->connection))
 365         {
 366           tcp_send_reset (tc);
 367           tcp_connection_timers_reset (tc);
 368           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
 369           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
 370           session_transport_closed_notify (&tc->connection);
 371           tcp_worker_stats_inc (tc->c_thread_index, rst_unread, 1);
 372           break;
 373         }
 374       if (!transport_max_tx_dequeue (&tc->connection))
 375         tcp_send_fin (tc);
 376       else
 377         tc->flags |= TCP_CONN_FINPNDG;
 378       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
 379       /* Set a timer in case the peer stops responding. Otherwise the
 380        * connection will be stuck here forever. */
 381       ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
 382       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
 383       break;
 384     case TCP_STATE_CLOSE_WAIT:
 385       if (!transport_max_tx_dequeue (&tc->connection))
 386         {
 387           tcp_send_fin (tc);
 388           tcp_connection_timers_reset (tc);
 389           tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
 390           tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
 391         }
 392       else
 393         tc->flags |= TCP_CONN_FINPNDG;
 394       break;
 395     case TCP_STATE_FIN_WAIT_1:
 396       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
 397       break;
 398     case TCP_STATE_CLOSED:
 399       tcp_connection_timers_reset (tc);
 400       /* Delete connection but instead of doing it now wait until next
 401        * dispatch cycle to give the session layer a chance to clear
 402        * unhandled events */
 403       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
 404       break;
 405     default:
 406       TCP_DBG ("state: %u", tc->state);
 407     }
 408 }
 409
 410 static void
 411 tcp_session_close (u32 conn_index, u32 thread_index)
 412 {
 413   tcp_connection_t *tc;
 414   tc = tcp_connection_get (conn_index, thread_index);
 415   tcp_connection_close (tc);
 416 }
 417
 418 static void
 419 tcp_session_cleanup (u32 conn_index, u32 thread_index)
 420 {
 421   tcp_connection_t *tc;
 422   tc = tcp_connection_get (conn_index, thread_index);
 423   if (!tc)
 424     return;
 425   tcp_connection_set_state (tc, TCP_STATE_CLOSED);
 426   tcp_connection_cleanup (tc);
 427 }
 428
 429 static void
 430 tcp_session_reset (u32 conn_index, u32 thread_index)
 431 {
 432   tcp_connection_t *tc;
 433   tc = tcp_connection_get (conn_index, thread_index);
 434   session_transport_closed_notify (&tc->connection);
 435   tcp_send_reset (tc);
 436   tcp_connection_timers_reset (tc);
 437   tcp_cong_recovery_off (tc);
 438   tcp_connection_set_state (tc, TCP_STATE_CLOSED);
 439   tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
 440 }
 441
 442 /**
 443  * Initialize all connection timers as invalid
 444  */
 445 void
 446 tcp_connection_timers_init (tcp_connection_t * tc)
 447 {
 448   int i;
 449
 450   /* Set all to invalid */
 451   for (i = 0; i < TCP_N_TIMERS; i++)
 452     {
 453       tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
 454     }
 455
 456   tc->rto = TCP_RTO_INIT;
 457 }
 458
 459 /**
 460  * Stop all connection timers
 461  */
 462 void
 463 tcp_connection_timers_reset (tcp_connection_t * tc)
 464 {
 465   int i;
 466   for (i = 0; i < TCP_N_TIMERS; i++)
 467     {
 468       tcp_timer_reset (tc, i);
 469     }
 470 }
 471
 472 #if 0
 473 typedef struct ip4_tcp_hdr
 474 {
 475   ip4_header_t ip;
 476   tcp_header_t tcp;
 477 } ip4_tcp_hdr_t;
 478
 479 typedef struct ip6_tcp_hdr
 480 {
 481   ip6_header_t ip;
 482   tcp_header_t tcp;
 483 } ip6_tcp_hdr_t;
 484
 485 static void
 486 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
 487                                  dpo_id_t * result)
 488 {
 489   const dpo_id_t *choice;
 490   load_balance_t *lb;
 491   int hash;
 492
 493   lb = load_balance_get (dpo->dpoi_index);
 494   if (tc->c_is_ip4)
 495     {
 496       ip4_tcp_hdr_t hdr;
 497       clib_memset (&hdr, 0, sizeof (hdr));
 498       hdr.ip.protocol = IP_PROTOCOL_TCP;
 499       hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
 500       hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
 501       hdr.tcp.src_port = tc->c_lcl_port;
 502       hdr.tcp.dst_port = tc->c_rmt_port;
 503       hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
 504     }
 505   else
 506     {
 507       ip6_tcp_hdr_t hdr;
 508       clib_memset (&hdr, 0, sizeof (hdr));
 509       hdr.ip.protocol = IP_PROTOCOL_TCP;
 510       clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
 511                         sizeof (ip6_address_t));
 512       clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
 513                         sizeof (ip6_address_t));
 514       hdr.tcp.src_port = tc->c_lcl_port;
 515       hdr.tcp.dst_port = tc->c_rmt_port;
 516       hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
 517     }
 518   choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
 519   dpo_copy (result, choice);
 520 }
 521
 522 fib_node_index_t
 523 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
 524 {
 525   fib_prefix_t prefix;
 526   u32 fib_index;
 527
 528   clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
 529   prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 530   prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
 531   fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
 532   return fib_table_lookup (fib_index, &prefix);
 533 }
 534
 535 static int
 536 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
 537 {
 538   dpo_id_t choice = DPO_INVALID;
 539   u32 output_node_index;
 540   fib_entry_t *fe;
 541
 542   fe = fib_entry_get (tc->c_rmt_fei);
 543   if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
 544     return -1;
 545
 546   tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
 547
 548   output_node_index =
 549     tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
 550   dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
 551   return 0;
 552 }
 553
 554 /** Stack tcp connection on peer's fib entry.
 555  *
 556  * This ultimately populates the dpo the connection will use to send packets.
 557  */
 558 static void
 559 tcp_connection_fib_attach (tcp_connection_t * tc)
 560 {
 561   tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
 562
 563   ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
 564
 565   tcp_connection_stack_on_fib_entry (tc);
 566 }
 567 #endif /* 0 */
 568
 569 /**
 570  * Generate random iss as per rfc6528
 571  */
 572 static u32
 573 tcp_generate_random_iss (tcp_connection_t * tc)
 574 {
 575   tcp_main_t *tm = &tcp_main;
 576   u64 tmp;
 577
 578   if (tc->c_is_ip4)
 579     tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
 580   else
 581     tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
 582       ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
 583
 584   tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
 585   tmp ^= tm->iss_seed.second;
 586   tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
 587   return ((tmp >> 32) ^ (tmp & 0xffffffff));
 588 }
 589
 590 /**
 591  * Initialize max segment size we're able to process.
 592  *
 593  * The value is constrained by the output interface's MTU and by the size
 594  * of the IP and TCP headers (see RFC6691). It is also what we advertise
 595  * to our peer.
 596  */
 597 static void
 598 tcp_init_rcv_mss (tcp_connection_t * tc)
 599 {
 600   u8 ip_hdr_len;
 601
 602   ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
 603   tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
 604 }
 605
 606 static void
 607 tcp_init_mss (tcp_connection_t * tc)
 608 {
 609   u16 default_min_mss = 536;
 610
 611   tcp_init_rcv_mss (tc);
 612
 613   /* TODO consider PMTU discovery */
 614   tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
 615
 616   if (tc->snd_mss < 45)
 617     {
 618       /* Assume that at least the min default mss works */
 619       tc->snd_mss = default_min_mss;
 620       tc->rcv_opts.mss = default_min_mss;
 621     }
 622
 623   /* We should have enough space for 40 bytes of options */
 624   ASSERT (tc->snd_mss > 45);
 625
 626   /* If we use timestamp option, account for it */
 627   if (tcp_opts_tstamp (&tc->rcv_opts))
 628     tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
 629 }
 630
 631 /**
 632  * Initialize connection send variables.
 633  */
 634 void
 635 tcp_init_snd_vars (tcp_connection_t * tc)
 636 {
 637   /*
 638    * We use the time to randomize iss and for setting up the initial
 639    * timestamp. Make sure it's updated otherwise syn and ack in the
 640    * handshake may make it look as if time has flown in the opposite
 641    * direction for us.
 642    */
 643   tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
 644
 645   tcp_init_rcv_mss (tc);
 646   tc->iss = tcp_generate_random_iss (tc);
 647   tc->snd_una = tc->iss;
 648   tc->snd_nxt = tc->iss + 1;
 649   tc->snd_una_max = tc->snd_nxt;
 650   tc->srtt = 100;               /* 100 ms */
 651
 652   if (!tcp_cfg.csum_offload)
 653     tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
 654 }
 655
 656 void
 657 tcp_enable_pacing (tcp_connection_t * tc)
 658 {
 659   u32 byte_rate;
 660   byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
 661   transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
 662   tc->mrtt_us = (u32) ~ 0;
 663 }
 664
 665 /** Initialize tcp connection variables
 666  *
 667  * Should be called after having received a msg from the peer, i.e., a SYN or
 668  * a SYNACK, such that connection options have already been exchanged. */
 669 void
 670 tcp_connection_init_vars (tcp_connection_t * tc)
 671 {
 672   tcp_connection_timers_init (tc);
 673   tcp_init_mss (tc);
 674   scoreboard_init (&tc->sack_sb);
 675   if (tc->state == TCP_STATE_SYN_RCVD)
 676     tcp_init_snd_vars (tc);
 677
 678   tcp_cc_init (tc);
 679
 680   if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
 681     tcp_add_del_adjacency (tc, 1);
 682
 683   /*  tcp_connection_fib_attach (tc); */
 684
 685   if (transport_connection_is_tx_paced (&tc->connection)
 686       || tcp_cfg.enable_tx_pacing)
 687     tcp_enable_pacing (tc);
 688
 689   if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
 690     tcp_bt_init (tc);
 691
 692   if (!tcp_cfg.allow_tso)
 693     tc->cfg_flags |= TCP_CFG_F_NO_TSO;
 694
 695   tc->start_ts = tcp_time_now_us (tc->c_thread_index);
 696 }
 697
 698 static int
 699 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
 700                                  u16 * lcl_port, u8 is_ip4)
 701 {
 702   int index, port;
 703   if (is_ip4)
 704     {
 705       index = tm->last_v4_addr_rotor++;
 706       if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
 707         tm->last_v4_addr_rotor = 0;
 708       lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
 709     }
 710   else
 711     {
 712       index = tm->last_v6_addr_rotor++;
 713       if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
 714         tm->last_v6_addr_rotor = 0;
 715       clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
 716                         sizeof (ip6_address_t));
 717     }
 718   port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
 719   if (port < 1)
 720     {
 721       clib_warning ("Failed to allocate src port");
 722       return -1;
 723     }
 724   *lcl_port = port;
 725   return 0;
 726 }
 727
 728 static int
 729 tcp_session_open (transport_endpoint_cfg_t * rmt)
 730 {
 731   tcp_main_t *tm = vnet_get_tcp_main ();
 732   tcp_connection_t *tc;
 733   ip46_address_t lcl_addr;
 734   u16 lcl_port;
 735   int rv;
 736
 737   /*
 738    * Allocate local endpoint
 739    */
 740   if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
 741       || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
 742     rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
 743                                           rmt->is_ip4);
 744   else
 745     rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
 746                                          rmt, &lcl_addr, &lcl_port);
 747
 748   if (rv)
 749     return -1;
 750
 751   /*
 752    * Create connection and send SYN
 753    */
 754   clib_spinlock_lock_if_init (&tm->half_open_lock);
 755   tc = tcp_half_open_connection_new ();
 756   ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
 757   ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
 758   tc->c_rmt_port = rmt->port;
 759   tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
 760   tc->c_is_ip4 = rmt->is_ip4;
 761   tc->c_proto = TRANSPORT_PROTO_TCP;
 762   tc->c_fib_index = rmt->fib_index;
 763   tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
 764   /* The other connection vars will be initialized after SYN ACK */
 765   tcp_connection_timers_init (tc);
 766
 767   TCP_EVT (TCP_EVT_OPEN, tc);
 768   tc->state = TCP_STATE_SYN_SENT;
 769   tcp_init_snd_vars (tc);
 770   tcp_send_syn (tc);
 771   clib_spinlock_unlock_if_init (&tm->half_open_lock);
 772
 773   return tc->c_c_index;
 774 }
 775
 776 const char *tcp_fsm_states[] = {
 777 #define _(sym, str) str,
 778   foreach_tcp_fsm_state
 779 #undef _
 780 };
 781
 782 u8 *
 783 format_tcp_state (u8 * s, va_list * args)
 784 {
 785   u32 state = va_arg (*args, u32);
 786
 787   if (state < TCP_N_STATES)
 788     s = format (s, "%s", tcp_fsm_states[state]);
 789   else
 790     s = format (s, "UNKNOWN (%d (0x%x))", state, state);
 791   return s;
 792 }
 793
 794 const char *tcp_cfg_flags_str[] = {
 795 #define _(sym, str) str,
 796   foreach_tcp_cfg_flag
 797 #undef _
 798 };
 799
 800 static u8 *
 801 format_tcp_cfg_flags (u8 * s, va_list * args)
 802 {
 803   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 804   int i, last = -1;
 805
 806   for (i = 0; i < TCP_CFG_N_FLAG_BITS; i++)
 807     if (tc->cfg_flags & (1 << i))
 808       last = i;
 809   for (i = 0; i < last; i++)
 810     {
 811       if (tc->cfg_flags & (1 << i))
 812         s = format (s, "%s, ", tcp_cfg_flags_str[i]);
 813     }
 814   if (last >= 0)
 815     s = format (s, "%s", tcp_cfg_flags_str[last]);
 816   return s;
 817 }
 818
 819 const char *tcp_connection_flags_str[] = {
 820 #define _(sym, str) str,
 821   foreach_tcp_connection_flag
 822 #undef _
 823 };
 824
 825 static u8 *
 826 format_tcp_connection_flags (u8 * s, va_list * args)
 827 {
 828   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 829   int i, last = -1;
 830
 831   for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
 832     if (tc->flags & (1 << i))
 833       last = i;
 834   for (i = 0; i < last; i++)
 835     {
 836       if (tc->flags & (1 << i))
 837         s = format (s, "%s, ", tcp_connection_flags_str[i]);
 838     }
 839   if (last >= 0)
 840     s = format (s, "%s", tcp_connection_flags_str[last]);
 841   return s;
 842 }
 843
 844 const char *tcp_conn_timers[] = {
 845 #define _(sym, str) str,
 846   foreach_tcp_timer
 847 #undef _
 848 };
 849
 850 static u8 *
 851 format_tcp_timers (u8 * s, va_list * args)
 852 {
 853   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 854   int i, last = -1;
 855
 856   for (i = 0; i < TCP_N_TIMERS; i++)
 857     if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
 858       last = i;
 859
 860   for (i = 0; i < last; i++)
 861     {
 862       if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
 863         s = format (s, "%s,", tcp_conn_timers[i]);
 864     }
 865
 866   if (last >= 0)
 867     s = format (s, "%s", tcp_conn_timers[i]);
 868
 869   return s;
 870 }
 871
 872 static u8 *
 873 format_tcp_congestion_status (u8 * s, va_list * args)
 874 {
 875   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 876   if (tcp_in_recovery (tc))
 877     s = format (s, "recovery");
 878   else if (tcp_in_fastrecovery (tc))
 879     s = format (s, "fastrecovery");
 880   else
 881     s = format (s, "none");
 882   return s;
 883 }
 884
 885 static i32
 886 tcp_rcv_wnd_available (tcp_connection_t * tc)
 887 {
 888   return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
 889 }
 890
 891 static u8 *
 892 format_tcp_congestion (u8 * s, va_list * args)
 893 {
 894   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 895   u32 indent = format_get_indent (s), prr_space = 0;
 896
 897   s = format (s, "%U ", format_tcp_congestion_status, tc);
 898   s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
 899               tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
 900   s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u\n",
 901               format_white_space, indent, tcp_available_cc_snd_space (tc),
 902               tc->prev_cwnd, tc->prev_ssthresh);
 903   s = format (s, "%Usnd_cong %u dupack %u limited_tx %u\n",
 904               format_white_space, indent, tc->snd_congestion - tc->iss,
 905               tc->rcv_dupacks, tc->limited_transmit - tc->iss);
 906   s = format (s, "%Urxt_bytes %u rxt_delivered %u rxt_head %u rxt_ts %u\n",
 907               format_white_space, indent, tc->snd_rxt_bytes,
 908               tc->rxt_delivered, tc->rxt_head - tc->iss,
 909               tcp_time_now_w_thread (tc->c_thread_index) - tc->snd_rxt_ts);
 910   if (tcp_in_fastrecovery (tc))
 911     prr_space = tcp_fastrecovery_prr_snd_space (tc);
 912   s = format (s, "%Uprr_start %u prr_delivered %u prr space %u\n",
 913               format_white_space, indent, tc->prr_start - tc->iss,
 914               tc->prr_delivered, prr_space);
 915   return s;
 916 }
 917
 918 static u8 *
 919 format_tcp_stats (u8 * s, va_list * args)
 920 {
 921   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 922   u32 indent = format_get_indent (s);
 923   s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
 924               tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
 925   s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
 926               format_white_space, indent, tc->segs_out,
 927               tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
 928   s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
 929               format_white_space, indent, tc->fr_occurences,
 930               tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
 931               tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
 932   s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
 933               format_white_space, indent, tc->errors.below_data_wnd,
 934               tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
 935               tc->errors.above_ack_wnd);
 936   return s;
 937 }
 938
 939 static u8 *
 940 format_tcp_vars (u8 * s, va_list * args)
 941 {
 942   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 943   s = format (s, " index: %u cfg: %U flags: %U timers: %U\n", tc->c_c_index,
 944               format_tcp_cfg_flags, tc, format_tcp_connection_flags, tc,
 945               format_tcp_timers, tc);
 946   s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
 947               tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
 948               tc->snd_una_max - tc->iss);
 949   s = format (s, " rcv_nxt %u rcv_las %u\n",
 950               tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
 951   s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
 952               tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
 953   s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
 954               tc->snd_wl2 - tc->iss);
 955   s = format (s, " flight size %u out space %u rcv_wnd_av %u",
 956               tcp_flight_size (tc), tcp_available_output_snd_space (tc),
 957               tcp_rcv_wnd_available (tc));
 958   s = format (s, " tsval_recent %u\n", tc->tsval_recent);
 959   s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
 960               tc->rcv_opts.tsecr, tc->tsecr_last_ack,
 961               tcp_time_now () - tc->tsval_recent_age);
 962   s = format (s, " snd_mss %u\n", tc->snd_mss);
 963   s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
 964               tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
 965               tc->rtt_ts);
 966   s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
 967   s = format (s, " next_node %u opaque 0x%x\n", tc->next_node_index,
 968               tc->next_node_opaque);
 969   s = format (s, " cong:   %U", format_tcp_congestion, tc);
 970
 971   if (tc->state >= TCP_STATE_ESTABLISHED)
 972     {
 973       s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
 974                   tc);
 975       s = format (s, " stats: %U\n", format_tcp_stats, tc);
 976     }
 977   if (vec_len (tc->snd_sacks))
 978     s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
 979
 980   return s;
 981 }
 982
 983 u8 *
 984 format_tcp_connection_id (u8 * s, va_list * args)
 985 {
 986   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 987   if (!tc)
 988     return s;
 989   if (tc->c_is_ip4)
 990     {
 991       s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
 992                   tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
 993                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
 994                   &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
 995     }
 996   else
 997     {
 998       s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
 999                   tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1000                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1001                   &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1002     }
1003
1004   return s;
1005 }
1006
1007 u8 *
1008 format_tcp_connection (u8 * s, va_list * args)
1009 {
1010   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1011   u32 verbose = va_arg (*args, u32);
1012
1013   if (!tc)
1014     return s;
1015   s = format (s, "%-50U", format_tcp_connection_id, tc);
1016   if (verbose)
1017     {
1018       s = format (s, "%-15U", format_tcp_state, tc->state);
1019       if (verbose > 1)
1020         s = format (s, "\n%U", format_tcp_vars, tc);
1021     }
1022
1023   return s;
1024 }
1025
1026 static u8 *
1027 format_tcp_session (u8 * s, va_list * args)
1028 {
1029   u32 tci = va_arg (*args, u32);
1030   u32 thread_index = va_arg (*args, u32);
1031   u32 verbose = va_arg (*args, u32);
1032   tcp_connection_t *tc;
1033
1034   tc = tcp_connection_get (tci, thread_index);
1035   if (tc)
1036     s = format (s, "%U", format_tcp_connection, tc, verbose);
1037   else
1038     s = format (s, "empty\n");
1039   return s;
1040 }
1041
1042 static u8 *
1043 format_tcp_listener_session (u8 * s, va_list * args)
1044 {
1045   u32 tci = va_arg (*args, u32);
1046   u32 __clib_unused thread_index = va_arg (*args, u32);
1047   u32 verbose = va_arg (*args, u32);
1048   tcp_connection_t *tc = tcp_listener_get (tci);
1049   s = format (s, "%-50U", format_tcp_connection_id, tc);
1050   if (verbose)
1051     s = format (s, "%-15U", format_tcp_state, tc->state);
1052   return s;
1053 }
1054
1055 static u8 *
1056 format_tcp_half_open_session (u8 * s, va_list * args)
1057 {
1058   u32 tci = va_arg (*args, u32);
1059   u32 __clib_unused thread_index = va_arg (*args, u32);
1060   tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1061   return format (s, "%U", format_tcp_connection_id, tc);
1062 }
1063
1064 u8 *
1065 format_tcp_sacks (u8 * s, va_list * args)
1066 {
1067   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1068   sack_block_t *sacks = tc->snd_sacks;
1069   sack_block_t *block;
1070   int i, len = 0;
1071
1072   len = vec_len (sacks);
1073   for (i = 0; i < len - 1; i++)
1074     {
1075       block = &sacks[i];
1076       s = format (s, " start %u end %u\n", block->start - tc->irs,
1077                   block->end - tc->irs);
1078     }
1079   if (len)
1080     {
1081       block = &sacks[len - 1];
1082       s = format (s, " start %u end %u", block->start - tc->irs,
1083                   block->end - tc->irs);
1084     }
1085   return s;
1086 }
1087
1088 u8 *
1089 format_tcp_rcv_sacks (u8 * s, va_list * args)
1090 {
1091   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1092   sack_block_t *sacks = tc->rcv_opts.sacks;
1093   sack_block_t *block;
1094   int i, len = 0;
1095
1096   len = vec_len (sacks);
1097   for (i = 0; i < len - 1; i++)
1098     {
1099       block = &sacks[i];
1100       s = format (s, " start %u end %u\n", block->start - tc->iss,
1101                   block->end - tc->iss);
1102     }
1103   if (len)
1104     {
1105       block = &sacks[len - 1];
1106       s = format (s, " start %u end %u", block->start - tc->iss,
1107                   block->end - tc->iss);
1108     }
1109   return s;
1110 }
1111
1112 static u8 *
1113 format_tcp_sack_hole (u8 * s, va_list * args)
1114 {
1115   sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1116   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1117   if (tc)
1118     s = format (s, "  [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1119   else
1120     s = format (s, "  [%u, %u]", hole->start, hole->end);
1121   return s;
1122 }
1123
1124 u8 *
1125 format_tcp_scoreboard (u8 * s, va_list * args)
1126 {
1127   sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1128   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1129   sack_scoreboard_hole_t *hole;
1130   u32 indent = format_get_indent (s);
1131
1132   s = format (s, "sacked %u last_sacked %u lost %u last_lost %u"
1133               " rxt_sacked %u\n",
1134               sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes,
1135               sb->last_lost_bytes, sb->rxt_sacked);
1136   s = format (s, "%Ulast_delivered %u high_sacked %u is_reneging %u\n",
1137               format_white_space, indent, sb->last_bytes_delivered,
1138               sb->high_sacked - tc->iss, sb->is_reneging);
1139   s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1140               format_white_space, indent, sb->cur_rxt_hole,
1141               sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1142
1143   hole = scoreboard_first_hole (sb);
1144   if (hole)
1145     s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1146                 indent, sb->head, sb->tail, pool_elts (sb->holes),
1147                 format_white_space, indent);
1148
1149   while (hole)
1150     {
1151       s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1152       hole = scoreboard_next_hole (sb, hole);
1153     }
1154
1155   return s;
1156 }
1157
1158 static transport_connection_t *
1159 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1160 {
1161   tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1162   if (PREDICT_FALSE (!tc))
1163     return 0;
1164   return &tc->connection;
1165 }
1166
1167 static transport_connection_t *
1168 tcp_half_open_session_get_transport (u32 conn_index)
1169 {
1170   tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1171   return &tc->connection;
1172 }
1173
1174 static u16
1175 tcp_session_cal_goal_size (tcp_connection_t * tc)
1176 {
1177   u16 goal_size = tc->snd_mss;
1178
1179   goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1180   goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1181
1182   return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1183 }
1184
1185 /**
1186  * Compute maximum segment size for session layer.
1187  *
1188  * Since the result needs to be the actual data length, it first computes
1189  * the tcp options to be used in the next burst and subtracts their
1190  * length from the connection's snd_mss.
1191  */
1192 static u16
1193 tcp_session_send_mss (transport_connection_t * trans_conn)
1194 {
1195   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1196
1197   /* Ensure snd_mss does accurately reflect the amount of data we can push
1198    * in a segment. This also makes sure that options are updated according to
1199    * the current state of the connection. */
1200   tcp_update_burst_snd_vars (tc);
1201
1202   if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1203     return tcp_session_cal_goal_size (tc);
1204
1205   return tc->snd_mss;
1206 }
1207
1208 always_inline u32
1209 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1210 {
1211   if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1212     {
1213       return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1214     }
1215
1216   /* If not snd_wnd constrained and we can't write at least a segment,
1217    * don't try at all */
1218   if (PREDICT_FALSE (snd_space < tc->snd_mss))
1219     return snd_space < tc->cwnd ? 0 : snd_space;
1220
1221   /* round down to mss multiple */
1222   return snd_space - (snd_space % tc->snd_mss);
1223 }
1224
1225 /**
1226  * Compute tx window session is allowed to fill.
1227  *
1228  * Takes into account available send space, snd_mss and the congestion
1229  * state of the connection. If possible, the value returned is a multiple
1230  * of snd_mss.
1231  *
1232  * @param tc tcp connection
1233  * @return number of bytes session is allowed to write
1234  */
1235 static inline u32
1236 tcp_snd_space_inline (tcp_connection_t * tc)
1237 {
1238   int snd_space;
1239
1240   if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1241                      || tc->state == TCP_STATE_CLOSED))
1242     return 0;
1243
1244   snd_space = tcp_available_output_snd_space (tc);
1245
1246   /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1247    * to force the peer to send enough dupacks to start retransmitting as
1248    * per Limited Transmit (RFC3042)
1249    */
1250   if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
1251     {
1252       if (tc->limited_transmit != tc->snd_nxt
1253           && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
1254               || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1255         tc->limited_transmit = tc->snd_nxt;
1256
1257       ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1258
1259       int snt_limited = tc->snd_nxt - tc->limited_transmit;
1260       snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
1261     }
1262   return tcp_round_snd_space (tc, snd_space);
1263 }
1264
1265 u32
1266 tcp_snd_space (tcp_connection_t * tc)
1267 {
1268   return tcp_snd_space_inline (tc);
1269 }
1270
1271 static u32
1272 tcp_session_send_space (transport_connection_t * trans_conn)
1273 {
1274   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1275   return clib_min (tcp_snd_space_inline (tc),
1276                    tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1277 }
1278
1279 static u32
1280 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1281 {
1282   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1283
1284   ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1285
1286   /* This still works if fast retransmit is on */
1287   return (tc->snd_nxt - tc->snd_una);
1288 }
1289
1290 static void
1291 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1292 {
1293   switch (tc->state)
1294     {
1295     case TCP_STATE_CLOSE_WAIT:
1296       tcp_connection_timers_reset (tc);
1297       session_transport_closed_notify (&tc->connection);
1298       /* App never returned with a close */
1299       if (!(tc->flags & TCP_CONN_FINPNDG))
1300         {
1301           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1302           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1303           tcp_worker_stats_inc (tc->c_thread_index, to_closewait, 1);
1304           break;
1305         }
1306
1307       /* Send FIN either way and switch to LAST_ACK. */
1308       tcp_cong_recovery_off (tc);
1309       /* Make sure we don't try to send unsent data */
1310       tc->snd_nxt = tc->snd_una;
1311       tcp_send_fin (tc);
1312       tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1313
1314       /* Make sure we don't wait in LAST ACK forever */
1315       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1316       tcp_worker_stats_inc (tc->c_thread_index, to_closewait2, 1);
1317
1318       /* Don't delete the connection yet */
1319       break;
1320     case TCP_STATE_FIN_WAIT_1:
1321       tcp_connection_timers_reset (tc);
1322       session_transport_closed_notify (&tc->connection);
1323       if (tc->flags & TCP_CONN_FINPNDG)
1324         {
1325           /* If FIN pending, we haven't sent everything, but we did try.
1326            * Notify session layer that transport is closed. */
1327           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1328           tcp_send_reset (tc);
1329           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1330         }
1331       else
1332         {
1333           /* We've sent the fin but no progress. Close the connection and
1334            * to make sure everything is flushed, setup a cleanup timer */
1335           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1336           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1337         }
1338       tcp_worker_stats_inc (tc->c_thread_index, to_finwait1, 1);
1339       break;
1340     case TCP_STATE_LAST_ACK:
1341       tcp_connection_timers_reset (tc);
1342       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1343       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1344       session_transport_closed_notify (&tc->connection);
1345       tcp_worker_stats_inc (tc->c_thread_index, to_lastack, 1);
1346       break;
1347     case TCP_STATE_CLOSING:
1348       tcp_connection_timers_reset (tc);
1349       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1350       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1351       session_transport_closed_notify (&tc->connection);
1352       tcp_worker_stats_inc (tc->c_thread_index, to_closing, 1);
1353       break;
1354     case TCP_STATE_FIN_WAIT_2:
1355       tcp_send_reset (tc);
1356       tcp_connection_timers_reset (tc);
1357       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1358       session_transport_closed_notify (&tc->connection);
1359       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1360       tcp_worker_stats_inc (tc->c_thread_index, to_finwait2, 1);
1361       break;
1362     default:
1363       tcp_connection_del (tc);
1364       break;
1365     }
1366 }
1367
1368 /* *INDENT-OFF* */
1369 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1370 {
1371     tcp_timer_retransmit_handler,
1372     tcp_timer_delack_handler,
1373     tcp_timer_persist_handler,
1374     tcp_timer_waitclose_handler,
1375     tcp_timer_retransmit_syn_handler,
1376 };
1377 /* *INDENT-ON* */
1378
1379 static void
1380 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1381 {
1382   u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1383   tcp_connection_t *tc;
1384   int i;
1385
1386   if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1387     return;
1388
1389   thread_index = wrk->vm->thread_index;
1390   for (i = 0; i < clib_min (n_timers, 32); i++)
1391     {
1392       clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1393       connection_index = timer_handle & 0x0FFFFFFF;
1394       timer_id = timer_handle >> 28;
1395
1396       if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1397         tc = tcp_connection_get (connection_index, thread_index);
1398       else
1399         tc = tcp_half_open_connection_get (connection_index);
1400
1401       if (PREDICT_FALSE (!tc))
1402         continue;
1403
1404       /* Skip timer if it was rearmed while pending dispatch */
1405       if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1406         continue;
1407
1408       (*timer_expiration_handlers[timer_id]) (tc);
1409     }
1410 }
1411
1412 /**
1413  * Flush ip lookup tx frames populated by timer pops
1414  */
1415 static void
1416 tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk)
1417 {
1418   if (wrk->ip_lookup_tx_frames[0])
1419     {
1420       vlib_put_frame_to_node (wrk->vm, ip4_lookup_node.index,
1421                               wrk->ip_lookup_tx_frames[0]);
1422       wrk->ip_lookup_tx_frames[0] = 0;
1423     }
1424   if (wrk->ip_lookup_tx_frames[1])
1425     {
1426       vlib_put_frame_to_node (wrk->vm, ip6_lookup_node.index,
1427                               wrk->ip_lookup_tx_frames[1]);
1428       wrk->ip_lookup_tx_frames[1] = 0;
1429     }
1430 }
1431
1432 static void
1433 tcp_update_time (f64 now, u8 thread_index)
1434 {
1435   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1436
1437   tcp_set_time_now (wrk);
1438   tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1439   tcp_dispatch_pending_timers (wrk);
1440   tcp_flush_frames_to_output (wrk);
1441 }
1442
1443 static void
1444 tcp_session_flush_data (transport_connection_t * tconn)
1445 {
1446   tcp_connection_t *tc = (tcp_connection_t *) tconn;
1447   if (tc->flags & TCP_CONN_PSH_PENDING)
1448     return;
1449   tc->flags |= TCP_CONN_PSH_PENDING;
1450   tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1451 }
1452
1453 /* *INDENT-OFF* */
1454 const static transport_proto_vft_t tcp_proto = {
1455   .enable = vnet_tcp_enable_disable,
1456   .start_listen = tcp_session_bind,
1457   .stop_listen = tcp_session_unbind,
1458   .push_header = tcp_session_push_header,
1459   .get_connection = tcp_session_get_transport,
1460   .get_listener = tcp_session_get_listener,
1461   .get_half_open = tcp_half_open_session_get_transport,
1462   .connect = tcp_session_open,
1463   .close = tcp_session_close,
1464   .cleanup = tcp_session_cleanup,
1465   .reset = tcp_session_reset,
1466   .send_mss = tcp_session_send_mss,
1467   .send_space = tcp_session_send_space,
1468   .update_time = tcp_update_time,
1469   .tx_fifo_offset = tcp_session_tx_fifo_offset,
1470   .flush_data = tcp_session_flush_data,
1471   .custom_tx = tcp_session_custom_tx,
1472   .format_connection = format_tcp_session,
1473   .format_listener = format_tcp_listener_session,
1474   .format_half_open = format_tcp_half_open_session,
1475   .transport_options = {
1476     .tx_type = TRANSPORT_TX_PEEK,
1477     .service_type = TRANSPORT_SERVICE_VC,
1478   },
1479 };
1480 /* *INDENT-ON* */
1481
1482 void
1483 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1484 {
1485   if (!transport_connection_is_tx_paced (&tc->connection))
1486     return;
1487
1488   f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1489
1490   transport_connection_tx_pacer_update (&tc->connection,
1491                                         tcp_cc_get_pacing_rate (tc),
1492                                         srtt * CLIB_US_TIME_FREQ);
1493 }
1494
1495 void
1496 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1497                                u32 start_bucket)
1498 {
1499   f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1500   transport_connection_tx_pacer_reset (&tc->connection,
1501                                        tcp_cc_get_pacing_rate (tc),
1502                                        start_bucket,
1503                                        srtt * CLIB_US_TIME_FREQ);
1504 }
1505
1506 static void
1507 tcp_expired_timers_dispatch (u32 * expired_timers)
1508 {
1509   u32 thread_index = vlib_get_thread_index ();
1510   u32 connection_index, timer_id, n_expired;
1511   tcp_worker_ctx_t *wrk;
1512   tcp_connection_t *tc;
1513   int i;
1514
1515   wrk = tcp_get_worker (thread_index);
1516   n_expired = vec_len (expired_timers);
1517   tcp_workerp_stats_inc (wrk, timer_expirations, n_expired);
1518
1519   /*
1520    * Invalidate all timer handles before dispatching. This avoids dangling
1521    * index references to timer wheel pool entries that have been freed.
1522    */
1523   for (i = 0; i < n_expired; i++)
1524     {
1525       connection_index = expired_timers[i] & 0x0FFFFFFF;
1526       timer_id = expired_timers[i] >> 28;
1527
1528       if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1529         tc = tcp_connection_get (connection_index, thread_index);
1530       else
1531         tc = tcp_half_open_connection_get (connection_index);
1532
1533       TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1534
1535       tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1536     }
1537
1538   clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1539 }
1540
1541 static void
1542 tcp_initialize_timer_wheels (tcp_main_t * tm)
1543 {
1544   tw_timer_wheel_16t_2w_512sl_t *tw;
1545   /* *INDENT-OFF* */
1546   foreach_vlib_main (({
1547     tw = &tm->wrk_ctx[ii].timer_wheel;
1548     tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1549                                       TCP_TIMER_TICK, ~0);
1550     tw->last_run_time = vlib_time_now (this_vlib_main);
1551   }));
1552   /* *INDENT-ON* */
1553 }
1554
1555 static void
1556 tcp_initialize_iss_seed (tcp_main_t * tm)
1557 {
1558   u32 default_seed = random_default_seed ();
1559   u64 time_now = clib_cpu_time_now ();
1560
1561   tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1562   tm->iss_seed.second = random_u64 (&time_now);
1563 }
1564
1565 static clib_error_t *
1566 tcp_main_enable (vlib_main_t * vm)
1567 {
1568   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1569   u32 num_threads, n_workers, prealloc_conn_per_wrk;
1570   tcp_connection_t *tc __attribute__ ((unused));
1571   tcp_main_t *tm = vnet_get_tcp_main ();
1572   tcp_worker_ctx_t *wrk;
1573   clib_error_t *error = 0;
1574   int thread;
1575
1576   if ((error = vlib_call_init_function (vm, ip_main_init)))
1577     return error;
1578   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1579     return error;
1580   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1581     return error;
1582
1583   /*
1584    * Registrations
1585    */
1586
1587   ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1588   ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1589
1590   /*
1591    * Initialize data structures
1592    */
1593
1594   num_threads = 1 /* main thread */  + vtm->n_threads;
1595   vec_validate (tm->wrk_ctx, num_threads - 1);
1596   n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1597   prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1598
1599   for (thread = 0; thread < num_threads; thread++)
1600     {
1601       wrk = &tm->wrk_ctx[thread];
1602
1603       vec_validate (wrk->pending_deq_acked, 255);
1604       vec_validate (wrk->pending_disconnects, 255);
1605       vec_validate (wrk->pending_resets, 255);
1606       vec_reset_length (wrk->pending_deq_acked);
1607       vec_reset_length (wrk->pending_disconnects);
1608       vec_reset_length (wrk->pending_resets);
1609       wrk->vm = vlib_mains[thread];
1610
1611       /*
1612        * Preallocate connections. Assume that thread 0 won't
1613        * use preallocated threads when running multi-core
1614        */
1615       if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1616         pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1617     }
1618
1619   /*
1620    * Use a preallocated half-open connection pool?
1621    */
1622   if (tcp_cfg.preallocated_half_open_connections)
1623     pool_init_fixed (tm->half_open_connections,
1624                      tcp_cfg.preallocated_half_open_connections);
1625
1626   /* Initialize clocks per tick for TCP timestamp. Used to compute
1627    * monotonically increasing timestamps. */
1628   tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1629     / TCP_TSTAMP_RESOLUTION;
1630
1631   if (num_threads > 1)
1632     {
1633       clib_spinlock_init (&tm->half_open_lock);
1634     }
1635
1636   tcp_initialize_timer_wheels (tm);
1637   tcp_initialize_iss_seed (tm);
1638
1639   tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1640   tm->cc_last_type = TCP_CC_LAST;
1641   return error;
1642 }
1643
1644 clib_error_t *
1645 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1646 {
1647   if (is_en)
1648     {
1649       if (tcp_main.is_enabled)
1650         return 0;
1651
1652       return tcp_main_enable (vm);
1653     }
1654   else
1655     {
1656       tcp_main.is_enabled = 0;
1657     }
1658
1659   return 0;
1660 }
1661
1662 void
1663 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1664 {
1665   tcp_main_t *tm = &tcp_main;
1666   if (is_ip4)
1667     tm->punt_unknown4 = is_add;
1668   else
1669     tm->punt_unknown6 = is_add;
1670 }
1671
1672 /**
1673  * Initialize default values for tcp parameters
1674  */
1675 static void
1676 tcp_configuration_init (void)
1677 {
1678   /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1679    * predefined value. For SYN-ACK we still want the scale to be computed in
1680    * the same way */
1681   tcp_cfg.max_rx_fifo = 32 << 20;
1682   tcp_cfg.min_rx_fifo = 4 << 10;
1683
1684   tcp_cfg.default_mtu = 1500;
1685   tcp_cfg.initial_cwnd_multiplier = 0;
1686   tcp_cfg.enable_tx_pacing = 1;
1687   tcp_cfg.allow_tso = 0;
1688   tcp_cfg.csum_offload = 1;
1689   tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1690   tcp_cfg.rwnd_min_update_ack = 1;
1691
1692   /* Time constants defined as timer tick (100ms) multiples */
1693   tcp_cfg.delack_time = 1;      /* 0.1s */
1694   tcp_cfg.closewait_time = 20;  /* 2s */
1695   tcp_cfg.timewait_time = 100;  /* 10s */
1696   tcp_cfg.finwait1_time = 600;  /* 60s */
1697   tcp_cfg.lastack_time = 300;   /* 30s */
1698   tcp_cfg.finwait2_time = 300;  /* 30s */
1699   tcp_cfg.closing_time = 300;   /* 30s */
1700   tcp_cfg.cleanup_time = 1;     /* 0.1s */
1701 }
1702
1703 static clib_error_t *
1704 tcp_init (vlib_main_t * vm)
1705 {
1706   tcp_main_t *tm = vnet_get_tcp_main ();
1707   ip_main_t *im = &ip_main;
1708   ip_protocol_info_t *pi;
1709
1710   /* Session layer, and by implication tcp, are disabled by default */
1711   tm->is_enabled = 0;
1712
1713   /* Register with IP for header parsing */
1714   pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1715   if (pi == 0)
1716     return clib_error_return (0, "TCP protocol info AWOL");
1717   pi->format_header = format_tcp_header;
1718   pi->unformat_pg_edit = unformat_pg_tcp_header;
1719
1720   /* Register as transport with session layer */
1721   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1722                                FIB_PROTOCOL_IP4, tcp4_output_node.index);
1723   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1724                                FIB_PROTOCOL_IP6, tcp6_output_node.index);
1725
1726   tcp_api_reference ();
1727   tcp_configuration_init ();
1728
1729   tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1730
1731   return 0;
1732 }
1733
1734 VLIB_INIT_FUNCTION (tcp_init);
1735
1736 uword
1737 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1738 {
1739   tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1740   tcp_main_t *tm = &tcp_main;
1741   char *cc_algo_name;
1742   u8 found = 0;
1743   uword *p;
1744
1745   if (unformat (input, "%s", &cc_algo_name)
1746       && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1747     {
1748       *result = *p;
1749       found = 1;
1750     }
1751
1752   vec_free (cc_algo_name);
1753   return found;
1754 }
1755
1756 uword
1757 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1758 {
1759   tcp_main_t *tm = vnet_get_tcp_main ();
1760   tcp_cc_algorithm_t *cc_alg;
1761   unformat_input_t sub_input;
1762   int found = 0;
1763
1764   vec_foreach (cc_alg, tm->cc_algos)
1765   {
1766     if (!unformat (input, cc_alg->name))
1767       continue;
1768
1769     if (cc_alg->unformat_cfg
1770         && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1771       {
1772         if (cc_alg->unformat_cfg (&sub_input))
1773           found = 1;
1774       }
1775   }
1776   return found;
1777 }
1778
1779 static clib_error_t *
1780 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1781 {
1782   u32 cwnd_multiplier, tmp_time;
1783   uword memory_size;
1784
1785   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1786     {
1787       if (unformat (input, "preallocated-connections %d",
1788                     &tcp_cfg.preallocated_connections))
1789         ;
1790       else if (unformat (input, "preallocated-half-open-connections %d",
1791                          &tcp_cfg.preallocated_half_open_connections))
1792         ;
1793       else if (unformat (input, "buffer-fail-fraction %f",
1794                          &tcp_cfg.buffer_fail_fraction))
1795         ;
1796       else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1797                          &memory_size))
1798         {
1799           if (memory_size >= 0x100000000)
1800             {
1801               return clib_error_return
1802                 (0, "max-rx-fifo %llu (0x%llx) too large", memory_size,
1803                  memory_size);
1804             }
1805           tcp_cfg.max_rx_fifo = memory_size;
1806         }
1807       else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1808                          &memory_size))
1809         {
1810           if (memory_size >= 0x100000000)
1811             {
1812               return clib_error_return
1813                 (0, "min-rx-fifo %llu (0x%llx) too large", memory_size,
1814                  memory_size);
1815             }
1816           tcp_cfg.min_rx_fifo = memory_size;
1817         }
1818       else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1819         ;
1820       else if (unformat (input, "rwnd-min-update-ack %d",
1821                          &tcp_cfg.rwnd_min_update_ack))
1822         ;
1823       else if (unformat (input, "initial-cwnd-multiplier %u",
1824                          &cwnd_multiplier))
1825         tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1826       else if (unformat (input, "no-tx-pacing"))
1827         tcp_cfg.enable_tx_pacing = 0;
1828       else if (unformat (input, "tso"))
1829         tcp_cfg.allow_tso = 1;
1830       else if (unformat (input, "no-csum-offload"))
1831         tcp_cfg.csum_offload = 0;
1832       else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1833                          &tcp_cfg.cc_algo))
1834         ;
1835       else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1836         ;
1837       else if (unformat (input, "closewait-time %u", &tmp_time))
1838         tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1839       else if (unformat (input, "timewait-time %u", &tmp_time))
1840         tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1841       else if (unformat (input, "finwait1-time %u", &tmp_time))
1842         tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1843       else if (unformat (input, "finwait2-time %u", &tmp_time))
1844         tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1845       else if (unformat (input, "lastack-time %u", &tmp_time))
1846         tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1847       else if (unformat (input, "closing-time %u", &tmp_time))
1848         tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1849       else if (unformat (input, "cleanup-time %u", &tmp_time))
1850         tcp_cfg.cleanup_time = tmp_time / TCP_TIMER_TICK;
1851       else
1852         return clib_error_return (0, "unknown input `%U'",
1853                                   format_unformat_error, input);
1854     }
1855   return 0;
1856 }
1857
1858 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1859
1860
1861 /**
1862  * \brief Configure an ipv4 source address range
1863  * @param vm vlib_main_t pointer
1864  * @param start first ipv4 address in the source address range
1865  * @param end last ipv4 address in the source address range
1866  * @param table_id VRF / table ID, 0 for the default FIB
1867  * @return 0 if all OK, else an error indication from api_errno.h
1868  */
1869
1870 int
1871 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1872                                        ip4_address_t * start,
1873                                        ip4_address_t * end, u32 table_id)
1874 {
1875   u32 start_host_byte_order, end_host_byte_order;
1876   fib_prefix_t prefix;
1877   fib_node_index_t fei;
1878   u32 fib_index = 0;
1879   u32 sw_if_index;
1880   int rv;
1881
1882   clib_memset (&prefix, 0, sizeof (prefix));
1883
1884   fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1885
1886   if (fib_index == ~0)
1887     return VNET_API_ERROR_NO_SUCH_FIB;
1888
1889   start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1890   end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1891
1892   /* sanity check for reversed args or some such */
1893   if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1894     return VNET_API_ERROR_INVALID_ARGUMENT;
1895
1896   /* Lookup the last address, to identify the interface involved */
1897   prefix.fp_len = 32;
1898   prefix.fp_proto = FIB_PROTOCOL_IP4;
1899   memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1900
1901   fei = fib_table_lookup (fib_index, &prefix);
1902
1903   /* Couldn't find route to destination. Bail out. */
1904   if (fei == FIB_NODE_INDEX_INVALID)
1905     return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1906
1907   sw_if_index = fib_entry_get_resolving_interface (fei);
1908
1909   /* Configure proxy arp across the range */
1910   rv = ip4_neighbor_proxy_add (fib_index, start, end);
1911
1912   if (rv)
1913     return rv;
1914
1915   rv = ip4_neighbor_proxy_enable (sw_if_index);
1916
1917   if (rv)
1918     return rv;
1919
1920   do
1921     {
1922       dpo_id_t dpo = DPO_INVALID;
1923
1924       vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1925
1926       /* Add local adjacencies for the range */
1927
1928       receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1929                                NULL, &dpo);
1930       prefix.fp_len = 32;
1931       prefix.fp_proto = FIB_PROTOCOL_IP4;
1932       prefix.fp_addr.ip4.as_u32 = start->as_u32;
1933
1934       fib_table_entry_special_dpo_update (fib_index,
1935                                           &prefix,
1936                                           FIB_SOURCE_API,
1937                                           FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1938       dpo_reset (&dpo);
1939
1940       start_host_byte_order++;
1941       start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1942     }
1943   while (start_host_byte_order <= end_host_byte_order);
1944
1945   return 0;
1946 }
1947
1948 /**
1949  * \brief Configure an ipv6 source address range
1950  * @param vm vlib_main_t pointer
1951  * @param start first ipv6 address in the source address range
1952  * @param end last ipv6 address in the source address range
1953  * @param table_id VRF / table ID, 0 for the default FIB
1954  * @return 0 if all OK, else an error indication from api_errno.h
1955  */
1956
1957 int
1958 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1959                                        ip6_address_t * start,
1960                                        ip6_address_t * end, u32 table_id)
1961 {
1962   fib_prefix_t prefix;
1963   u32 fib_index = 0;
1964   fib_node_index_t fei;
1965   u32 sw_if_index;
1966
1967   clib_memset (&prefix, 0, sizeof (prefix));
1968
1969   fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1970
1971   if (fib_index == ~0)
1972     return VNET_API_ERROR_NO_SUCH_FIB;
1973
1974   while (1)
1975     {
1976       int i;
1977       ip6_address_t tmp;
1978       dpo_id_t dpo = DPO_INVALID;
1979
1980       /* Remember this address */
1981       vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1982
1983       /* Lookup the prefix, to identify the interface involved */
1984       prefix.fp_len = 128;
1985       prefix.fp_proto = FIB_PROTOCOL_IP6;
1986       memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1987
1988       fei = fib_table_lookup (fib_index, &prefix);
1989
1990       /* Couldn't find route to destination. Bail out. */
1991       if (fei == FIB_NODE_INDEX_INVALID)
1992         return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1993
1994       sw_if_index = fib_entry_get_resolving_interface (fei);
1995
1996       if (sw_if_index == (u32) ~ 0)
1997         return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1998
1999       /* Add a proxy neighbor discovery entry for this address */
2000       ip6_neighbor_proxy_add (sw_if_index, start);
2001
2002       /* Add a receive adjacency for this address */
2003       receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
2004                                NULL, &dpo);
2005
2006       fib_table_entry_special_dpo_update (fib_index,
2007                                           &prefix,
2008                                           FIB_SOURCE_API,
2009                                           FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
2010       dpo_reset (&dpo);
2011
2012       /* Done with the entire range? */
2013       if (!memcmp (start, end, sizeof (start[0])))
2014         break;
2015
2016       /* Increment the address. DGMS. */
2017       tmp = start[0];
2018       for (i = 15; i >= 0; i--)
2019         {
2020           tmp.as_u8[i] += 1;
2021           if (tmp.as_u8[i] != 0)
2022             break;
2023         }
2024       start[0] = tmp;
2025     }
2026   return 0;
2027 }
2028
2029 static clib_error_t *
2030 tcp_src_address_fn (vlib_main_t * vm,
2031                     unformat_input_t * input, vlib_cli_command_t * cmd_arg)
2032 {
2033   ip4_address_t v4start, v4end;
2034   ip6_address_t v6start, v6end;
2035   u32 table_id = 0;
2036   int v4set = 0;
2037   int v6set = 0;
2038   int rv;
2039
2040   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2041     {
2042       if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
2043                     unformat_ip4_address, &v4end))
2044         v4set = 1;
2045       else if (unformat (input, "%U", unformat_ip4_address, &v4start))
2046         {
2047           memcpy (&v4end, &v4start, sizeof (v4start));
2048           v4set = 1;
2049         }
2050       else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
2051                          unformat_ip6_address, &v6end))
2052         v6set = 1;
2053       else if (unformat (input, "%U", unformat_ip6_address, &v6start))
2054         {
2055           memcpy (&v6end, &v6start, sizeof (v6start));
2056           v6set = 1;
2057         }
2058       else if (unformat (input, "fib-table %d", &table_id))
2059         ;
2060       else
2061         break;
2062     }
2063
2064   if (!v4set && !v6set)
2065     return clib_error_return (0, "at least one v4 or v6 address required");
2066
2067   if (v4set)
2068     {
2069       rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
2070                                                   table_id);
2071       switch (rv)
2072         {
2073         case 0:
2074           break;
2075
2076         case VNET_API_ERROR_NO_SUCH_FIB:
2077           return clib_error_return (0, "Invalid table-id %d", table_id);
2078
2079         case VNET_API_ERROR_INVALID_ARGUMENT:
2080           return clib_error_return (0, "Invalid address range %U - %U",
2081                                     format_ip4_address, &v4start,
2082                                     format_ip4_address, &v4end);
2083         default:
2084           return clib_error_return (0, "error %d", rv);
2085           break;
2086         }
2087     }
2088   if (v6set)
2089     {
2090       rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
2091                                                   table_id);
2092       switch (rv)
2093         {
2094         case 0:
2095           break;
2096
2097         case VNET_API_ERROR_NO_SUCH_FIB:
2098           return clib_error_return (0, "Invalid table-id %d", table_id);
2099
2100         default:
2101           return clib_error_return (0, "error %d", rv);
2102           break;
2103         }
2104     }
2105   return 0;
2106 }
2107
2108 /* *INDENT-OFF* */
2109 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2110 {
2111   .path = "tcp src-address",
2112   .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2113   .function = tcp_src_address_fn,
2114 };
2115 /* *INDENT-ON* */
2116
2117 static u8 *
2118 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2119 {
2120 #if TCP_SCOREBOARD_TRACE
2121
2122   scoreboard_trace_elt_t *block;
2123   int i = 0;
2124
2125   if (!sb->trace)
2126     return s;
2127
2128   s = format (s, "scoreboard trace:");
2129   vec_foreach (block, sb->trace)
2130   {
2131     s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2132                 block->ack, block->snd_una_max, block->group);
2133     if ((++i % 3) == 0)
2134       s = format (s, "\n");
2135   }
2136   return s;
2137 #else
2138   return 0;
2139 #endif
2140 }
2141
2142 static clib_error_t *
2143 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2144                               vlib_cli_command_t * cmd_arg)
2145 {
2146   transport_connection_t *tconn = 0;
2147   tcp_connection_t *tc;
2148   u8 *s = 0;
2149   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2150     {
2151       if (unformat (input, "%U", unformat_transport_connection, &tconn,
2152                     TRANSPORT_PROTO_TCP))
2153         ;
2154       else
2155         return clib_error_return (0, "unknown input `%U'",
2156                                   format_unformat_error, input);
2157     }
2158
2159   if (!TCP_SCOREBOARD_TRACE)
2160     {
2161       vlib_cli_output (vm, "scoreboard tracing not enabled");
2162       return 0;
2163     }
2164
2165   tc = tcp_get_connection_from_transport (tconn);
2166   s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2167   vlib_cli_output (vm, "%v", s);
2168   return 0;
2169 }
2170
2171 /* *INDENT-OFF* */
2172 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2173 {
2174   .path = "show tcp scoreboard trace",
2175   .short_help = "show tcp scoreboard trace <connection>",
2176   .function = tcp_show_scoreboard_trace_fn,
2177 };
2178 /* *INDENT-ON* */
2179
2180 u8 *
2181 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2182 {
2183   int i, trace_len;
2184   scoreboard_trace_elt_t *trace;
2185   u32 next_ack, left, group, has_new_ack = 0;
2186   tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2187   sack_block_t *block;
2188
2189   if (!TCP_SCOREBOARD_TRACE)
2190     {
2191       s = format (s, "scoreboard tracing not enabled");
2192       return s;
2193     }
2194
2195   if (!tc)
2196     return s;
2197
2198   clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2199   tcp_connection_timers_init (dummy_tc);
2200   scoreboard_init (&dummy_tc->sack_sb);
2201   dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2202
2203 #if TCP_SCOREBOARD_TRACE
2204   trace = tc->sack_sb.trace;
2205   trace_len = vec_len (tc->sack_sb.trace);
2206 #endif
2207
2208   for (i = 0; i < trace_len; i++)
2209     {
2210       if (trace[i].ack != 0)
2211         {
2212           dummy_tc->snd_una = trace[i].ack - 1448;
2213           dummy_tc->snd_una_max = trace[i].ack;
2214         }
2215     }
2216
2217   left = 0;
2218   while (left < trace_len)
2219     {
2220       group = trace[left].group;
2221       vec_reset_length (dummy_tc->rcv_opts.sacks);
2222       has_new_ack = 0;
2223       while (trace[left].group == group)
2224         {
2225           if (trace[left].ack != 0)
2226             {
2227               if (verbose)
2228                 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2229                             trace[left].ack, trace[left].snd_una_max);
2230               dummy_tc->snd_una_max = trace[left].snd_una_max;
2231               next_ack = trace[left].ack;
2232               has_new_ack = 1;
2233             }
2234           else
2235             {
2236               if (verbose)
2237                 s = format (s, "[%u, %u], ", trace[left].start,
2238                             trace[left].end);
2239               vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2240               block->start = trace[left].start;
2241               block->end = trace[left].end;
2242             }
2243           left++;
2244         }
2245
2246       /* Push segments */
2247       tcp_rcv_sacks (dummy_tc, next_ack);
2248       if (has_new_ack)
2249         dummy_tc->snd_una = next_ack;
2250
2251       if (verbose)
2252         s = format (s, "result: %U", format_tcp_scoreboard,
2253                     &dummy_tc->sack_sb);
2254
2255     }
2256   s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2257
2258   return s;
2259 }
2260
2261 static clib_error_t *
2262 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2263                          vlib_cli_command_t * cmd_arg)
2264 {
2265   transport_connection_t *tconn = 0;
2266   tcp_connection_t *tc = 0;
2267   u8 *str = 0;
2268   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2269     {
2270       if (unformat (input, "%U", unformat_transport_connection, &tconn,
2271                     TRANSPORT_PROTO_TCP))
2272         ;
2273       else
2274         return clib_error_return (0, "unknown input `%U'",
2275                                   format_unformat_error, input);
2276     }
2277
2278   if (!TCP_SCOREBOARD_TRACE)
2279     {
2280       vlib_cli_output (vm, "scoreboard tracing not enabled");
2281       return 0;
2282     }
2283
2284   tc = tcp_get_connection_from_transport (tconn);
2285   if (!tc)
2286     {
2287       vlib_cli_output (vm, "connection not found");
2288       return 0;
2289     }
2290   str = tcp_scoreboard_replay (str, tc, 1);
2291   vlib_cli_output (vm, "%v", str);
2292   return 0;
2293 }
2294
2295 /* *INDENT-OFF* */
2296 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2297 {
2298   .path = "tcp replay scoreboard",
2299   .short_help = "tcp replay scoreboard <connection>",
2300   .function = tcp_scoreboard_trace_fn,
2301 };
2302 /* *INDENT-ON* */
2303
2304 static clib_error_t *
2305 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2306                   vlib_cli_command_t * cmd_arg)
2307 {
2308   tcp_main_t *tm = vnet_get_tcp_main ();
2309   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2310     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2311                               input);
2312   vlib_cli_output (vm, "IPv4 TCP punt: %s",
2313                    tm->punt_unknown4 ? "enabled" : "disabled");
2314   vlib_cli_output (vm, "IPv6 TCP punt: %s",
2315                    tm->punt_unknown6 ? "enabled" : "disabled");
2316   return 0;
2317 }
2318 /* *INDENT-OFF* */
2319 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2320 {
2321   .path = "show tcp punt",
2322   .short_help = "show tcp punt",
2323   .function = show_tcp_punt_fn,
2324 };
2325 /* *INDENT-ON* */
2326
2327 static clib_error_t *
2328 show_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2329                    vlib_cli_command_t * cmd)
2330 {
2331   tcp_main_t *tm = vnet_get_tcp_main ();
2332   tcp_worker_ctx_t *wrk;
2333   u32 thread;
2334
2335   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2336     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2337                               input);
2338   for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2339     {
2340       wrk = tcp_get_worker (thread);
2341       vlib_cli_output (vm, "Thread %u:\n", thread);
2342
2343       if (clib_fifo_elts (wrk->pending_timers))
2344         vlib_cli_output (vm, " %lu pending timers",
2345                          clib_fifo_elts (wrk->pending_timers));
2346
2347 #define _(name,type,str)                                        \
2348   if (wrk->stats.name)                                          \
2349     vlib_cli_output (vm, " %lu %s", wrk->stats.name, str);
2350       foreach_tcp_wrk_stat
2351 #undef _
2352     }
2353
2354   return 0;
2355 }
2356
2357 /* *INDENT-OFF* */
2358 VLIB_CLI_COMMAND (show_tcp_stats_command, static) =
2359 {
2360   .path = "show tcp stats",
2361   .short_help = "show tcp stats",
2362   .function = show_tcp_stats_fn,
2363 };
2364 /* *INDENT-ON* */
2365
2366 static clib_error_t *
2367 clear_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2368                     vlib_cli_command_t * cmd)
2369 {
2370   tcp_main_t *tm = vnet_get_tcp_main ();
2371   tcp_worker_ctx_t *wrk;
2372   u32 thread;
2373
2374   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2375     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2376                               input);
2377
2378   for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2379     {
2380       wrk = tcp_get_worker (thread);
2381       clib_memset (&wrk->stats, 0, sizeof (wrk->stats));
2382     }
2383
2384   return 0;
2385 }
2386
2387 /* *INDENT-OFF* */
2388 VLIB_CLI_COMMAND (clear_tcp_stats_command, static) =
2389 {
2390   .path = "clear tcp stats",
2391   .short_help = "clear tcp stats",
2392   .function = clear_tcp_stats_fn,
2393 };
2394 /* *INDENT-ON* */
2395
2396 /*
2397  * fd.io coding-style-patch-verification: ON
2398  *
2399  * Local Variables:
2400  * eval: (c-set-style "gnu")
2401  * End:
2402  */