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/tcp/tcp_inlines.h>
  23 #include <vnet/session/session.h>
  24 #include <vnet/fib/fib.h>
  25 #include <vnet/dpo/load_balance.h>
  26 #include <math.h>
  27
  28 tcp_main_t tcp_main;
  29
  30 typedef struct
  31 {
  32   fib_protocol_t nh_proto;
  33   vnet_link_t link_type;
  34   ip46_address_t ip;
  35   u32 sw_if_index;
  36   u8 is_add;
  37 } tcp_add_del_adj_args_t;
  38
  39 static void
  40 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
  41 {
  42   u32 ai;
  43   if (args->is_add)
  44     {
  45       adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
  46                            args->sw_if_index);
  47     }
  48   else
  49     {
  50       ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
  51                          args->sw_if_index);
  52       if (ai != ADJ_INDEX_INVALID)
  53         adj_unlock (ai);
  54     }
  55 }
  56
  57 static void
  58 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
  59 {
  60   tcp_add_del_adj_args_t args = {
  61     .nh_proto = FIB_PROTOCOL_IP6,
  62     .link_type = VNET_LINK_IP6,
  63     .ip = tc->c_rmt_ip,
  64     .sw_if_index = tc->sw_if_index,
  65     .is_add = is_add
  66   };
  67   vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
  68                              sizeof (args));
  69 }
  70
  71 static void
  72 tcp_cc_init (tcp_connection_t * tc)
  73 {
  74   tc->cc_algo->init (tc);
  75 }
  76
  77 static void
  78 tcp_cc_cleanup (tcp_connection_t * tc)
  79 {
  80   if (tc->cc_algo->cleanup)
  81     tc->cc_algo->cleanup (tc);
  82 }
  83
  84 void
  85 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
  86                       const tcp_cc_algorithm_t * vft)
  87 {
  88   tcp_main_t *tm = vnet_get_tcp_main ();
  89   vec_validate (tm->cc_algos, type);
  90
  91   tm->cc_algos[type] = *vft;
  92   hash_set_mem (tm->cc_algo_by_name, vft->name, type);
  93 }
  94
  95 tcp_cc_algorithm_t *
  96 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
  97 {
  98   tcp_main_t *tm = vnet_get_tcp_main ();
  99   return &tm->cc_algos[type];
 100 }
 101
 102 tcp_cc_algorithm_type_e
 103 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
 104 {
 105   tcp_main_t *tm = vnet_get_tcp_main ();
 106   tcp_cc_algo_register (++tm->cc_last_type, vft);
 107   return tm->cc_last_type;
 108 }
 109
 110 static u32
 111 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
 112 {
 113   tcp_main_t *tm = &tcp_main;
 114   tcp_connection_t *listener;
 115   void *iface_ip;
 116
 117   pool_get (tm->listener_pool, listener);
 118   clib_memset (listener, 0, sizeof (*listener));
 119
 120   listener->c_c_index = listener - tm->listener_pool;
 121   listener->c_lcl_port = lcl->port;
 122
 123   /* If we are provided a sw_if_index, bind using one of its ips */
 124   if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
 125     {
 126       if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
 127                                                  lcl->is_ip4)))
 128         ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
 129     }
 130   ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
 131   listener->c_is_ip4 = lcl->is_ip4;
 132   listener->c_proto = TRANSPORT_PROTO_TCP;
 133   listener->c_s_index = session_index;
 134   listener->c_fib_index = lcl->fib_index;
 135   listener->state = TCP_STATE_LISTEN;
 136   listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
 137
 138   tcp_connection_timers_init (listener);
 139
 140   TCP_EVT (TCP_EVT_BIND, listener);
 141
 142   return listener->c_c_index;
 143 }
 144
 145 static u32
 146 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
 147 {
 148   return tcp_connection_bind (session_index, tep);
 149 }
 150
 151 static void
 152 tcp_connection_unbind (u32 listener_index)
 153 {
 154   tcp_main_t *tm = vnet_get_tcp_main ();
 155   tcp_connection_t *tc;
 156
 157   tc = pool_elt_at_index (tm->listener_pool, listener_index);
 158
 159   TCP_EVT (TCP_EVT_UNBIND, tc);
 160
 161   /* Poison the entry */
 162   if (CLIB_DEBUG > 0)
 163     clib_memset (tc, 0xFA, sizeof (*tc));
 164
 165   pool_put_index (tm->listener_pool, listener_index);
 166 }
 167
 168 static u32
 169 tcp_session_unbind (u32 listener_index)
 170 {
 171   tcp_connection_unbind (listener_index);
 172   return 0;
 173 }
 174
 175 static transport_connection_t *
 176 tcp_session_get_listener (u32 listener_index)
 177 {
 178   tcp_main_t *tm = vnet_get_tcp_main ();
 179   tcp_connection_t *tc;
 180   tc = pool_elt_at_index (tm->listener_pool, listener_index);
 181   return &tc->connection;
 182 }
 183
 184 static tcp_connection_t *
 185 tcp_half_open_connection_alloc (void)
 186 {
 187   ASSERT (vlib_get_thread_index () == 0);
 188   return tcp_connection_alloc (0);
 189 }
 190
 191 /**
 192  * Cleanup half-open connection
 193  *
 194  */
 195 static void
 196 tcp_half_open_connection_free (tcp_connection_t * tc)
 197 {
 198   ASSERT (vlib_get_thread_index () == 0);
 199   return tcp_connection_free (tc);
 200 }
 201
 202 /**
 203  * Try to cleanup half-open connection
 204  *
 205  * If called from a thread that doesn't own tc, the call won't have any
 206  * effect.
 207  *
 208  * @param tc - connection to be cleaned up
 209  * @return non-zero if cleanup failed.
 210  */
 211 int
 212 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
 213 {
 214   tcp_worker_ctx_t *wrk;
 215
 216   /* Make sure this is the owning thread */
 217   if (tc->c_thread_index != vlib_get_thread_index ())
 218     return 1;
 219
 220   session_half_open_delete_notify (&tc->connection);
 221   wrk = tcp_get_worker (tc->c_thread_index);
 222   tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
 223   tcp_half_open_connection_free (tc);
 224   return 0;
 225 }
 226
 227 /**
 228  * Cleans up connection state.
 229  *
 230  * No notifications.
 231  */
 232 void
 233 tcp_connection_cleanup (tcp_connection_t * tc)
 234 {
 235   TCP_EVT (TCP_EVT_DELETE, tc);
 236
 237   /* Cleanup local endpoint if this was an active connect */
 238   if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
 239     transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
 240                                 tc->c_lcl_port);
 241
 242   /* Check if connection is not yet fully established */
 243   if (tc->state == TCP_STATE_SYN_SENT)
 244     {
 245       /* Try to remove the half-open connection. If this is not the owning
 246        * thread, tc won't be removed. Retransmit or establish timers will
 247        * eventually expire and call again cleanup on the right thread. */
 248       if (tcp_half_open_connection_cleanup (tc))
 249         tc->flags |= TCP_CONN_HALF_OPEN_DONE;
 250     }
 251   else
 252     {
 253       /* Make sure all timers are cleared */
 254       tcp_connection_timers_reset (tc);
 255
 256       if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
 257         tcp_add_del_adjacency (tc, 0);
 258
 259       tcp_cc_cleanup (tc);
 260       vec_free (tc->snd_sacks);
 261       vec_free (tc->snd_sacks_fl);
 262       vec_free (tc->rcv_opts.sacks);
 263       pool_free (tc->sack_sb.holes);
 264
 265       if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
 266         tcp_bt_cleanup (tc);
 267
 268       tcp_connection_free (tc);
 269     }
 270 }
 271
 272 /**
 273  * Connection removal.
 274  *
 275  * This should be called only once connection enters CLOSED state. Note
 276  * that it notifies the session of the removal event, so if the goal is to
 277  * just remove the connection, call tcp_connection_cleanup instead.
 278  */
 279 void
 280 tcp_connection_del (tcp_connection_t * tc)
 281 {
 282   session_transport_delete_notify (&tc->connection);
 283   tcp_connection_cleanup (tc);
 284 }
 285
 286 tcp_connection_t *
 287 tcp_connection_alloc (u8 thread_index)
 288 {
 289   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
 290   tcp_connection_t *tc;
 291
 292   pool_get (wrk->connections, tc);
 293   clib_memset (tc, 0, sizeof (*tc));
 294   tc->c_c_index = tc - wrk->connections;
 295   tc->c_thread_index = thread_index;
 296   return tc;
 297 }
 298
 299 tcp_connection_t *
 300 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t **base)
 301 {
 302   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
 303   tcp_connection_t *tc;
 304
 305   /* Make sure connection is still valid if pool moves */
 306   if ((*base)->c_thread_index == thread_index)
 307     {
 308       u32 base_index = (*base)->c_c_index;
 309       pool_get (wrk->connections, tc);
 310       *base = tcp_connection_get (base_index, thread_index);
 311     }
 312   else
 313     {
 314       pool_get (wrk->connections, tc);
 315     }
 316   clib_memcpy_fast (tc, *base, sizeof (*tc));
 317   tc->c_c_index = tc - wrk->connections;
 318   tc->c_thread_index = thread_index;
 319   return tc;
 320 }
 321
 322 void
 323 tcp_connection_free (tcp_connection_t * tc)
 324 {
 325   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
 326   if (CLIB_DEBUG)
 327     {
 328       clib_memset (tc, 0xFA, sizeof (*tc));
 329       pool_put (wrk->connections, tc);
 330       return;
 331     }
 332   pool_put (wrk->connections, tc);
 333 }
 334
 335 void
 336 tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
 337 {
 338   tcp_cleanup_req_t *req;
 339   clib_time_type_t now;
 340
 341   now = tcp_time_now_us (tc->c_thread_index);
 342   clib_fifo_add2 (wrk->pending_cleanups, req);
 343   req->connection_index = tc->c_c_index;
 344   req->free_time = now + tcp_cfg.cleanup_time;
 345 }
 346
 347 /**
 348  * Begin connection closing procedure.
 349  *
 350  * If at the end the connection is not in CLOSED state, it is not removed.
 351  * Instead, we rely on on TCP to advance through state machine to either
 352  * 1) LAST_ACK (passive close) whereby when the last ACK is received
 353  * tcp_connection_del is called. This notifies session of the delete and
 354  * calls cleanup.
 355  * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
 356  * and cleanup is called.
 357  *
 358  */
 359 void
 360 tcp_connection_close (tcp_connection_t * tc)
 361 {
 362   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
 363
 364   TCP_EVT (TCP_EVT_CLOSE, tc);
 365
 366   /* Send/Program FIN if needed and switch state */
 367   switch (tc->state)
 368     {
 369     case TCP_STATE_SYN_SENT:
 370       /* Try to cleanup. If not on the right thread, mark as half-open done.
 371        * Connection will be cleaned up when establish timer pops */
 372       tcp_connection_cleanup (tc);
 373       break;
 374     case TCP_STATE_SYN_RCVD:
 375       tcp_connection_timers_reset (tc);
 376       tcp_send_fin (tc);
 377       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
 378       tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
 379                         tcp_cfg.finwait1_time);
 380       break;
 381     case TCP_STATE_ESTABLISHED:
 382       /* If closing with unread data, reset the connection */
 383       if (transport_max_rx_dequeue (&tc->connection))
 384         {
 385           tcp_send_reset (tc);
 386           tcp_connection_timers_reset (tc);
 387           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
 388           session_transport_closed_notify (&tc->connection);
 389           tcp_program_cleanup (tcp_get_worker (tc->c_thread_index), tc);
 390           tcp_worker_stats_inc (wrk, rst_unread, 1);
 391           break;
 392         }
 393       if (!transport_max_tx_dequeue (&tc->connection))
 394         tcp_send_fin (tc);
 395       else
 396         tc->flags |= TCP_CONN_FINPNDG;
 397       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
 398       /* Set a timer in case the peer stops responding. Otherwise the
 399        * connection will be stuck here forever. */
 400       ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
 401       tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
 402                      tcp_cfg.finwait1_time);
 403       break;
 404     case TCP_STATE_CLOSE_WAIT:
 405       if (!transport_max_tx_dequeue (&tc->connection))
 406         {
 407           tcp_send_fin (tc);
 408           tcp_connection_timers_reset (tc);
 409           tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
 410           tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
 411                             tcp_cfg.lastack_time);
 412         }
 413       else
 414         tc->flags |= TCP_CONN_FINPNDG;
 415       break;
 416     case TCP_STATE_FIN_WAIT_1:
 417       tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
 418                         tcp_cfg.finwait1_time);
 419       break;
 420     case TCP_STATE_CLOSED:
 421       /* Cleanup should've been programmed already */
 422       break;
 423     default:
 424       TCP_DBG ("state: %u", tc->state);
 425     }
 426 }
 427
 428 static void
 429 tcp_session_half_close (u32 conn_index, u32 thread_index)
 430 {
 431   tcp_worker_ctx_t *wrk;
 432   tcp_connection_t *tc;
 433
 434   tc = tcp_connection_get (conn_index, thread_index);
 435   wrk = tcp_get_worker (tc->c_thread_index);
 436
 437   /* If the connection is not in ESTABLISHED state, ignore it */
 438   if (tc->state != TCP_STATE_ESTABLISHED)
 439     return;
 440   if (!transport_max_tx_dequeue (&tc->connection))
 441     tcp_send_fin (tc);
 442   else
 443     tc->flags |= TCP_CONN_FINPNDG;
 444   tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
 445   /* Set a timer in case the peer stops responding. Otherwise the
 446    * connection will be stuck here forever. */
 447   ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
 448   tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
 449                  tcp_cfg.finwait1_time);
 450 }
 451
 452 static void
 453 tcp_session_close (u32 conn_index, u32 thread_index)
 454 {
 455   tcp_connection_t *tc;
 456   tc = tcp_connection_get (conn_index, thread_index);
 457   tcp_connection_close (tc);
 458 }
 459
 460 static void
 461 tcp_session_cleanup (u32 conn_index, u32 thread_index)
 462 {
 463   tcp_connection_t *tc;
 464   tc = tcp_connection_get (conn_index, thread_index);
 465   if (!tc)
 466     return;
 467   tcp_connection_set_state (tc, TCP_STATE_CLOSED);
 468   tcp_connection_cleanup (tc);
 469 }
 470
 471 static void
 472 tcp_session_cleanup_ho (u32 conn_index)
 473 {
 474   tcp_worker_ctx_t *wrk;
 475   tcp_connection_t *tc;
 476
 477   tc = tcp_half_open_connection_get (conn_index);
 478   wrk = tcp_get_worker (tc->c_thread_index);
 479   tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
 480   tcp_half_open_connection_free (tc);
 481 }
 482
 483 static void
 484 tcp_session_reset (u32 conn_index, u32 thread_index)
 485 {
 486   tcp_connection_t *tc;
 487   tc = tcp_connection_get (conn_index, thread_index);
 488   tcp_send_reset (tc);
 489   tcp_connection_timers_reset (tc);
 490   tcp_cong_recovery_off (tc);
 491   tcp_connection_set_state (tc, TCP_STATE_CLOSED);
 492   session_transport_closed_notify (&tc->connection);
 493   tcp_program_cleanup (tcp_get_worker (thread_index), tc);
 494 }
 495
 496 /**
 497  * Initialize all connection timers as invalid
 498  */
 499 void
 500 tcp_connection_timers_init (tcp_connection_t * tc)
 501 {
 502   int i;
 503
 504   /* Set all to invalid */
 505   for (i = 0; i < TCP_N_TIMERS; i++)
 506     {
 507       tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
 508     }
 509
 510   tc->rto = TCP_RTO_INIT;
 511 }
 512
 513 /**
 514  * Stop all connection timers
 515  */
 516 void
 517 tcp_connection_timers_reset (tcp_connection_t * tc)
 518 {
 519   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
 520   int i;
 521
 522   for (i = 0; i < TCP_N_TIMERS; i++)
 523     tcp_timer_reset (&wrk->timer_wheel, tc, i);
 524 }
 525
 526 #if 0
 527 typedef struct ip4_tcp_hdr
 528 {
 529   ip4_header_t ip;
 530   tcp_header_t tcp;
 531 } ip4_tcp_hdr_t;
 532
 533 typedef struct ip6_tcp_hdr
 534 {
 535   ip6_header_t ip;
 536   tcp_header_t tcp;
 537 } ip6_tcp_hdr_t;
 538
 539 static void
 540 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
 541                                  dpo_id_t * result)
 542 {
 543   const dpo_id_t *choice;
 544   load_balance_t *lb;
 545   int hash;
 546
 547   lb = load_balance_get (dpo->dpoi_index);
 548   if (tc->c_is_ip4)
 549     {
 550       ip4_tcp_hdr_t hdr;
 551       clib_memset (&hdr, 0, sizeof (hdr));
 552       hdr.ip.protocol = IP_PROTOCOL_TCP;
 553       hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
 554       hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
 555       hdr.tcp.src_port = tc->c_lcl_port;
 556       hdr.tcp.dst_port = tc->c_rmt_port;
 557       hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
 558     }
 559   else
 560     {
 561       ip6_tcp_hdr_t hdr;
 562       clib_memset (&hdr, 0, sizeof (hdr));
 563       hdr.ip.protocol = IP_PROTOCOL_TCP;
 564       clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
 565                         sizeof (ip6_address_t));
 566       clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
 567                         sizeof (ip6_address_t));
 568       hdr.tcp.src_port = tc->c_lcl_port;
 569       hdr.tcp.dst_port = tc->c_rmt_port;
 570       hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
 571     }
 572   choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
 573   dpo_copy (result, choice);
 574 }
 575
 576 fib_node_index_t
 577 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
 578 {
 579   fib_prefix_t prefix;
 580   u32 fib_index;
 581
 582   clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
 583   prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 584   prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
 585   fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
 586   return fib_table_lookup (fib_index, &prefix);
 587 }
 588
 589 static int
 590 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
 591 {
 592   dpo_id_t choice = DPO_INVALID;
 593   u32 output_node_index;
 594   fib_entry_t *fe;
 595
 596   fe = fib_entry_get (tc->c_rmt_fei);
 597   if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
 598     return -1;
 599
 600   tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
 601
 602   output_node_index =
 603     tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
 604   dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
 605   return 0;
 606 }
 607
 608 /** Stack tcp connection on peer's fib entry.
 609  *
 610  * This ultimately populates the dpo the connection will use to send packets.
 611  */
 612 static void
 613 tcp_connection_fib_attach (tcp_connection_t * tc)
 614 {
 615   tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
 616
 617   ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
 618
 619   tcp_connection_stack_on_fib_entry (tc);
 620 }
 621 #endif /* 0 */
 622
 623 /**
 624  * Generate random iss as per rfc6528
 625  */
 626 static u32
 627 tcp_generate_random_iss (tcp_connection_t * tc)
 628 {
 629   tcp_main_t *tm = &tcp_main;
 630   u64 tmp;
 631
 632   if (tc->c_is_ip4)
 633     tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
 634   else
 635     tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
 636       ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
 637
 638   tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
 639   tmp ^= tm->iss_seed.second;
 640   tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
 641   return ((tmp >> 32) ^ (tmp & 0xffffffff));
 642 }
 643
 644 /**
 645  * Initialize max segment size we're able to process.
 646  *
 647  * The value is constrained by the output interface's MTU and by the size
 648  * of the IP and TCP headers (see RFC6691). It is also what we advertise
 649  * to our peer.
 650  */
 651 static void
 652 tcp_init_rcv_mss (tcp_connection_t * tc)
 653 {
 654   u8 ip_hdr_len;
 655
 656   /* Already provided at connection init time */
 657   if (tc->mss)
 658     return;
 659
 660   ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
 661   tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
 662 }
 663
 664 static void
 665 tcp_init_mss (tcp_connection_t * tc)
 666 {
 667   u16 default_min_mss = 536;
 668
 669   tcp_init_rcv_mss (tc);
 670
 671   /* TODO consider PMTU discovery */
 672   tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
 673
 674   if (tc->snd_mss < 45)
 675     {
 676       /* Assume that at least the min default mss works */
 677       tc->snd_mss = default_min_mss;
 678       tc->rcv_opts.mss = default_min_mss;
 679     }
 680
 681   /* We should have enough space for 40 bytes of options */
 682   ASSERT (tc->snd_mss > 45);
 683
 684   /* If we use timestamp option, account for it and make sure
 685    * the options are 4-byte aligned */
 686   if (tcp_opts_tstamp (&tc->rcv_opts))
 687     tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP + 2 /* alignment */;
 688 }
 689
 690 /**
 691  * Initialize connection send variables.
 692  */
 693 void
 694 tcp_init_snd_vars (tcp_connection_t * tc)
 695 {
 696   /*
 697    * We use the time to randomize iss and for setting up the initial
 698    * timestamp. Make sure it's updated otherwise syn and ack in the
 699    * handshake may make it look as if time has flown in the opposite
 700    * direction for us.
 701    */
 702   tcp_update_time_now (tcp_get_worker (vlib_get_thread_index ()));
 703
 704   tcp_init_rcv_mss (tc);
 705   tc->iss = tcp_generate_random_iss (tc);
 706   tc->snd_una = tc->iss;
 707   tc->snd_nxt = tc->iss + 1;
 708   tc->srtt = 0.1 * THZ;         /* 100 ms */
 709
 710   if (!tcp_cfg.csum_offload)
 711     tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
 712 }
 713
 714 void
 715 tcp_enable_pacing (tcp_connection_t * tc)
 716 {
 717   u32 byte_rate;
 718   byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
 719   transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
 720   tc->mrtt_us = (u32) ~ 0;
 721 }
 722
 723 /** Initialize tcp connection variables
 724  *
 725  * Should be called after having received a msg from the peer, i.e., a SYN or
 726  * a SYNACK, such that connection options have already been exchanged. */
 727 void
 728 tcp_connection_init_vars (tcp_connection_t * tc)
 729 {
 730   tcp_connection_timers_init (tc);
 731   tcp_init_mss (tc);
 732   scoreboard_init (&tc->sack_sb);
 733   if (tc->state == TCP_STATE_SYN_RCVD)
 734     tcp_init_snd_vars (tc);
 735
 736   tcp_cc_init (tc);
 737
 738   if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
 739     tcp_add_del_adjacency (tc, 1);
 740
 741   /*  tcp_connection_fib_attach (tc); */
 742
 743   if (transport_connection_is_tx_paced (&tc->connection)
 744       || tcp_cfg.enable_tx_pacing)
 745     tcp_enable_pacing (tc);
 746
 747   if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
 748     tcp_bt_init (tc);
 749
 750   if (!tcp_cfg.allow_tso)
 751     tc->cfg_flags |= TCP_CFG_F_NO_TSO;
 752
 753   tc->start_ts = tcp_time_now_us (tc->c_thread_index);
 754 }
 755
 756 static int
 757 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
 758                                  u16 * lcl_port, u8 is_ip4)
 759 {
 760   int index, port;
 761   if (is_ip4)
 762     {
 763       index = tm->last_v4_addr_rotor++;
 764       if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
 765         tm->last_v4_addr_rotor = 0;
 766       lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
 767     }
 768   else
 769     {
 770       index = tm->last_v6_addr_rotor++;
 771       if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
 772         tm->last_v6_addr_rotor = 0;
 773       clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
 774                         sizeof (ip6_address_t));
 775     }
 776   port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
 777   if (port < 1)
 778     return SESSION_E_NOPORT;
 779   *lcl_port = port;
 780   return 0;
 781 }
 782
 783 static int
 784 tcp_session_open (transport_endpoint_cfg_t * rmt)
 785 {
 786   tcp_main_t *tm = vnet_get_tcp_main ();
 787   tcp_connection_t *tc;
 788   ip46_address_t lcl_addr;
 789   u16 lcl_port;
 790   int rv;
 791
 792   /*
 793    * Allocate local endpoint
 794    */
 795   if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
 796       || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
 797     rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
 798                                           rmt->is_ip4);
 799   else
 800     rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
 801                                          rmt, &lcl_addr, &lcl_port);
 802
 803   if (rv)
 804     {
 805       if (rv != SESSION_E_PORTINUSE)
 806         return rv;
 807
 808       if (session_lookup_connection (rmt->fib_index, &lcl_addr, &rmt->ip,
 809                                      lcl_port, rmt->port, TRANSPORT_PROTO_TCP,
 810                                      rmt->is_ip4))
 811         return SESSION_E_PORTINUSE;
 812
 813       /* 5-tuple is available so increase lcl endpoint refcount and proceed
 814        * with connection allocation */
 815       transport_share_local_endpoint (TRANSPORT_PROTO_TCP, &lcl_addr,
 816                                       lcl_port);
 817     }
 818
 819   /*
 820    * Create connection and send SYN
 821    */
 822   tc = tcp_half_open_connection_alloc ();
 823   ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
 824   ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
 825   tc->c_rmt_port = rmt->port;
 826   tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
 827   tc->c_is_ip4 = rmt->is_ip4;
 828   tc->c_proto = TRANSPORT_PROTO_TCP;
 829   tc->c_fib_index = rmt->fib_index;
 830   tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
 831   /* The other connection vars will be initialized after SYN ACK */
 832   tcp_connection_timers_init (tc);
 833   tc->mss = rmt->mss;
 834   tc->sw_if_index = rmt->peer.sw_if_index;
 835   tc->next_node_index = rmt->next_node_index;
 836   tc->next_node_opaque = rmt->next_node_opaque;
 837
 838   TCP_EVT (TCP_EVT_OPEN, tc);
 839   tc->state = TCP_STATE_SYN_SENT;
 840   tcp_init_snd_vars (tc);
 841   tcp_send_syn (tc);
 842
 843   return tc->c_c_index;
 844 }
 845
 846 static u8 *
 847 format_tcp_session (u8 * s, va_list * args)
 848 {
 849   u32 tci = va_arg (*args, u32);
 850   u32 thread_index = va_arg (*args, u32);
 851   u32 verbose = va_arg (*args, u32);
 852   tcp_connection_t *tc;
 853
 854   tc = tcp_connection_get (tci, thread_index);
 855   if (tc)
 856     s = format (s, "%U", format_tcp_connection, tc, verbose);
 857   else
 858     s = format (s, "empty\n");
 859   return s;
 860 }
 861
 862 static u8 *
 863 format_tcp_listener_session (u8 * s, va_list * args)
 864 {
 865   u32 tci = va_arg (*args, u32);
 866   u32 __clib_unused thread_index = va_arg (*args, u32);
 867   u32 verbose = va_arg (*args, u32);
 868   tcp_connection_t *tc = tcp_listener_get (tci);
 869   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tcp_connection_id, tc);
 870   if (verbose)
 871     s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tcp_state,
 872                 tc->state);
 873   return s;
 874 }
 875
 876 static u8 *
 877 format_tcp_half_open_session (u8 * s, va_list * args)
 878 {
 879   u32 tci = va_arg (*args, u32);
 880   u32 __clib_unused thread_index = va_arg (*args, u32);
 881   u32 verbose = va_arg (*args, u32);
 882   tcp_connection_t *tc;
 883   u8 *state = 0;
 884
 885   tc = tcp_half_open_connection_get (tci);
 886   if (tc->flags & TCP_CONN_HALF_OPEN_DONE)
 887     state = format (state, "%s", "CLOSED");
 888   else
 889     state = format (state, "%U", format_tcp_state, tc->state);
 890   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tcp_connection_id, tc);
 891   if (verbose)
 892     s = format (s, "%-" SESSION_CLI_STATE_LEN "v", state);
 893   vec_free (state);
 894   return s;
 895 }
 896
 897 static transport_connection_t *
 898 tcp_session_get_transport (u32 conn_index, u32 thread_index)
 899 {
 900   tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
 901   if (PREDICT_FALSE (!tc))
 902     return 0;
 903   return &tc->connection;
 904 }
 905
 906 static transport_connection_t *
 907 tcp_half_open_session_get_transport (u32 conn_index)
 908 {
 909   tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
 910   return &tc->connection;
 911 }
 912
 913 static int
 914 tcp_set_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
 915 {
 916   int rv = 0;
 917
 918   switch (attr->type)
 919     {
 920     case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
 921       tc->next_node_index = attr->next_output_node & 0xffffffff;
 922       tc->next_node_opaque = attr->next_output_node >> 32;
 923       break;
 924     case TRANSPORT_ENDPT_ATTR_MSS:
 925       tc->mss = attr->mss;
 926       tc->snd_mss = clib_min (tc->snd_mss, tc->mss);
 927       break;
 928     case TRANSPORT_ENDPT_ATTR_FLAGS:
 929       if (attr->flags & TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD)
 930         tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
 931       else
 932         tc->cfg_flags &= ~TCP_CFG_F_NO_CSUM_OFFLOAD;
 933       if (attr->flags & TRANSPORT_ENDPT_ATTR_F_GSO)
 934         {
 935           if (!(tc->cfg_flags & TCP_CFG_F_TSO))
 936             tcp_check_gso (tc);
 937           tc->cfg_flags &= ~TCP_CFG_F_NO_TSO;
 938         }
 939       else
 940         {
 941           tc->cfg_flags |= TCP_CFG_F_NO_TSO;
 942           tc->cfg_flags &= ~TCP_CFG_F_TSO;
 943         }
 944       if (attr->flags & TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING)
 945         {
 946           if (!(tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE))
 947             tcp_bt_init (tc);
 948           tc->cfg_flags |= TCP_CFG_F_RATE_SAMPLE;
 949         }
 950       else
 951         {
 952           if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
 953             tcp_bt_cleanup (tc);
 954           tc->cfg_flags &= ~TCP_CFG_F_RATE_SAMPLE;
 955         }
 956       break;
 957     case TRANSPORT_ENDPT_ATTR_CC_ALGO:
 958       if (tc->cc_algo == tcp_cc_algo_get (attr->cc_algo))
 959         break;
 960       tcp_cc_cleanup (tc);
 961       tc->cc_algo = tcp_cc_algo_get (attr->cc_algo);
 962       tcp_cc_init (tc);
 963       break;
 964     default:
 965       rv = -1;
 966       break;
 967     }
 968
 969   return rv;
 970 }
 971
 972 static int
 973 tcp_get_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
 974 {
 975   int rv = 0;
 976   u64 non;
 977
 978   switch (attr->type)
 979     {
 980     case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
 981       non = (u64) tc->next_node_opaque << 32 | tc->next_node_index;
 982       attr->next_output_node = non;
 983       break;
 984     case TRANSPORT_ENDPT_ATTR_MSS:
 985       attr->mss = tc->snd_mss;
 986       break;
 987     case TRANSPORT_ENDPT_ATTR_FLAGS:
 988       attr->flags = 0;
 989       if (!(tc->cfg_flags & TCP_CFG_F_NO_CSUM_OFFLOAD))
 990         attr->flags |= TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD;
 991       if (tc->cfg_flags & TCP_CFG_F_TSO)
 992         attr->flags |= TRANSPORT_ENDPT_ATTR_F_GSO;
 993       if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
 994         attr->flags |= TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING;
 995       break;
 996     case TRANSPORT_ENDPT_ATTR_CC_ALGO:
 997       attr->cc_algo = tc->cc_algo - tcp_main.cc_algos;
 998       break;
 999     default:
1000       rv = -1;
1001       break;
1002     }
1003
1004   return rv;
1005 }
1006
1007 static int
1008 tcp_session_attribute (u32 conn_index, u32 thread_index, u8 is_get,
1009                        transport_endpt_attr_t *attr)
1010 {
1011   tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1012
1013   if (PREDICT_FALSE (!tc))
1014     return -1;
1015
1016   if (is_get)
1017     return tcp_get_attribute (tc, attr);
1018   else
1019     return tcp_set_attribute (tc, attr);
1020 }
1021
1022 static u16
1023 tcp_session_cal_goal_size (tcp_connection_t * tc)
1024 {
1025   u16 goal_size = tc->snd_mss;
1026
1027   goal_size = tcp_cfg.max_gso_size - tc->snd_mss % tcp_cfg.max_gso_size;
1028   goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1029
1030   return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1031 }
1032
1033 always_inline u32
1034 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1035 {
1036   if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1037     {
1038       return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1039     }
1040
1041   /* If not snd_wnd constrained and we can't write at least a segment,
1042    * don't try at all */
1043   if (PREDICT_FALSE (snd_space < tc->snd_mss))
1044     return snd_space < tc->cwnd ? 0 : snd_space;
1045
1046   /* round down to mss multiple */
1047   return snd_space - (snd_space % tc->snd_mss);
1048 }
1049
1050 /**
1051  * Compute tx window session is allowed to fill.
1052  *
1053  * Takes into account available send space, snd_mss and the congestion
1054  * state of the connection. If possible, the value returned is a multiple
1055  * of snd_mss.
1056  *
1057  * @param tc tcp connection
1058  * @return number of bytes session is allowed to write
1059  */
1060 static inline u32
1061 tcp_snd_space_inline (tcp_connection_t * tc)
1062 {
1063   int snd_space;
1064
1065   /* Fast path is disabled when recovery is on. @ref tcp_session_custom_tx
1066    * controls both retransmits and the sending of new data while congested
1067    */
1068   if (PREDICT_FALSE (tcp_in_cong_recovery (tc)
1069                      || tc->state == TCP_STATE_CLOSED))
1070     return 0;
1071
1072   snd_space = tcp_available_output_snd_space (tc);
1073
1074   /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1075    * to force the peer to send enough dupacks to start retransmitting as
1076    * per Limited Transmit (RFC3042)
1077    */
1078   if (PREDICT_FALSE (tc->rcv_dupacks || tc->sack_sb.sacked_bytes))
1079     {
1080       int snt_limited, n_pkts;
1081
1082       n_pkts = tcp_opts_sack_permitted (&tc->rcv_opts)
1083         ? tc->sack_sb.reorder - 1 : 2;
1084
1085       if ((seq_lt (tc->limited_transmit, tc->snd_nxt - n_pkts * tc->snd_mss)
1086            || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1087         tc->limited_transmit = tc->snd_nxt;
1088
1089       ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1090
1091       snt_limited = tc->snd_nxt - tc->limited_transmit;
1092       snd_space = clib_max (n_pkts * tc->snd_mss - snt_limited, 0);
1093     }
1094   return tcp_round_snd_space (tc, snd_space);
1095 }
1096
1097 u32
1098 tcp_snd_space (tcp_connection_t * tc)
1099 {
1100   return tcp_snd_space_inline (tc);
1101 }
1102
1103 static int
1104 tcp_session_send_params (transport_connection_t * trans_conn,
1105                          transport_send_params_t * sp)
1106 {
1107   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1108
1109   /* Ensure snd_mss does accurately reflect the amount of data we can push
1110    * in a segment. This also makes sure that options are updated according to
1111    * the current state of the connection. */
1112   tcp_update_burst_snd_vars (tc);
1113
1114   if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1115     sp->snd_mss = tcp_session_cal_goal_size (tc);
1116   else
1117     sp->snd_mss = tc->snd_mss;
1118
1119   sp->snd_space = clib_min (tcp_snd_space_inline (tc),
1120                             tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1121
1122   ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1123   /* This still works if fast retransmit is on */
1124   sp->tx_offset = tc->snd_nxt - tc->snd_una;
1125
1126   sp->flags = sp->snd_space ? 0 : TRANSPORT_SND_F_DESCHED;
1127
1128   return 0;
1129 }
1130
1131 static void
1132 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1133 {
1134   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1135
1136   switch (tc->state)
1137     {
1138     case TCP_STATE_CLOSE_WAIT:
1139       tcp_connection_timers_reset (tc);
1140       /* App never returned with a close */
1141       if (!(tc->flags & TCP_CONN_FINPNDG))
1142         {
1143           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1144           session_transport_closed_notify (&tc->connection);
1145           tcp_program_cleanup (wrk, tc);
1146           tcp_worker_stats_inc (wrk, to_closewait, 1);
1147           break;
1148         }
1149
1150       /* Send FIN either way and switch to LAST_ACK. */
1151       tcp_cong_recovery_off (tc);
1152       /* Make sure we don't try to send unsent data */
1153       tc->snd_nxt = tc->snd_una;
1154       tcp_send_fin (tc);
1155       tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1156       session_transport_closed_notify (&tc->connection);
1157
1158       /* Make sure we don't wait in LAST ACK forever */
1159       tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
1160                      tcp_cfg.lastack_time);
1161       tcp_worker_stats_inc (wrk, to_closewait2, 1);
1162
1163       /* Don't delete the connection yet */
1164       break;
1165     case TCP_STATE_FIN_WAIT_1:
1166       tcp_connection_timers_reset (tc);
1167       if (tc->flags & TCP_CONN_FINPNDG)
1168         {
1169           /* If FIN pending, we haven't sent everything, but we did try.
1170            * Notify session layer that transport is closed. */
1171           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1172           tcp_send_reset (tc);
1173           tcp_program_cleanup (wrk, tc);
1174         }
1175       else
1176         {
1177           /* We've sent the fin but no progress. Close the connection and
1178            * to make sure everything is flushed, setup a cleanup timer */
1179           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1180           tcp_program_cleanup (wrk, tc);
1181         }
1182       session_transport_closed_notify (&tc->connection);
1183       tcp_worker_stats_inc (wrk, to_finwait1, 1);
1184       break;
1185     case TCP_STATE_LAST_ACK:
1186       tcp_connection_timers_reset (tc);
1187       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1188       session_transport_closed_notify (&tc->connection);
1189       tcp_program_cleanup (wrk, tc);
1190       tcp_worker_stats_inc (wrk, to_lastack, 1);
1191       break;
1192     case TCP_STATE_CLOSING:
1193       tcp_connection_timers_reset (tc);
1194       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1195       session_transport_closed_notify (&tc->connection);
1196       tcp_program_cleanup (wrk, tc);
1197       tcp_worker_stats_inc (wrk, to_closing, 1);
1198       break;
1199     case TCP_STATE_FIN_WAIT_2:
1200       tcp_send_reset (tc);
1201       tcp_connection_timers_reset (tc);
1202       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1203       session_transport_closed_notify (&tc->connection);
1204       tcp_program_cleanup (wrk, tc);
1205       tcp_worker_stats_inc (wrk, to_finwait2, 1);
1206       break;
1207     case TCP_STATE_TIME_WAIT:
1208       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1209       tcp_program_cleanup (wrk, tc);
1210       break;
1211     default:
1212       clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
1213       break;
1214     }
1215 }
1216
1217 /* *INDENT-OFF* */
1218 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1219 {
1220     tcp_timer_retransmit_handler,
1221     tcp_timer_persist_handler,
1222     tcp_timer_waitclose_handler,
1223     tcp_timer_retransmit_syn_handler,
1224 };
1225 /* *INDENT-ON* */
1226
1227 static void
1228 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1229 {
1230   u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1231   tcp_connection_t *tc;
1232   int i;
1233
1234   if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1235     return;
1236
1237   thread_index = wrk->vm->thread_index;
1238   for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
1239     {
1240       clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1241       connection_index = timer_handle & 0x0FFFFFFF;
1242       timer_id = timer_handle >> 28;
1243
1244       if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1245         tc = tcp_connection_get (connection_index, thread_index);
1246       else
1247         tc = tcp_half_open_connection_get (connection_index);
1248
1249       if (PREDICT_FALSE (!tc))
1250         continue;
1251
1252       /* Skip if the timer is not pending. Probably it was reset while
1253        * waiting for dispatch */
1254       if (PREDICT_FALSE (!(tc->pending_timers & (1 << timer_id))))
1255         continue;
1256
1257       tc->pending_timers &= ~(1 << timer_id);
1258
1259       /* Skip timer if it was rearmed while pending dispatch */
1260       if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1261         continue;
1262
1263       (*timer_expiration_handlers[timer_id]) (tc);
1264     }
1265
1266   if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
1267     session_queue_run_on_main_thread (wrk->vm);
1268 }
1269
1270 static void
1271 tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1272 {
1273   u32 thread_index = wrk->vm->thread_index;
1274   tcp_cleanup_req_t *req;
1275   tcp_connection_t *tc;
1276
1277   while (clib_fifo_elts (wrk->pending_cleanups))
1278     {
1279       req = clib_fifo_head (wrk->pending_cleanups);
1280       if (req->free_time > now)
1281         break;
1282       clib_fifo_sub2 (wrk->pending_cleanups, req);
1283       tc = tcp_connection_get (req->connection_index, thread_index);
1284       if (PREDICT_FALSE (!tc))
1285         continue;
1286       session_transport_delete_notify (&tc->connection);
1287       tcp_connection_cleanup (tc);
1288     }
1289 }
1290
1291 static void
1292 tcp_update_time (f64 now, u8 thread_index)
1293 {
1294   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1295
1296   tcp_set_time_now (wrk, now);
1297   tcp_handle_cleanups (wrk, now);
1298   tcp_timer_expire_timers (&wrk->timer_wheel, now);
1299   tcp_dispatch_pending_timers (wrk);
1300 }
1301
1302 static void
1303 tcp_session_flush_data (transport_connection_t * tconn)
1304 {
1305   tcp_connection_t *tc = (tcp_connection_t *) tconn;
1306   if (tc->flags & TCP_CONN_PSH_PENDING)
1307     return;
1308   tc->flags |= TCP_CONN_PSH_PENDING;
1309   tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1310 }
1311
1312 static int
1313 tcp_session_app_rx_evt (transport_connection_t *conn)
1314 {
1315   tcp_connection_t *tc = (tcp_connection_t *) conn;
1316   u32 min_free, lo = 4 << 10, hi = 128 << 10;
1317
1318   if (!(tc->flags & TCP_CONN_ZERO_RWND_SENT))
1319     return 0;
1320
1321   min_free = clib_clamp (transport_rx_fifo_size (conn) >> 3, lo, hi);
1322   if (transport_max_rx_enqueue (conn) < min_free)
1323     {
1324       transport_rx_fifo_req_deq_ntf (conn);
1325       return 0;
1326     }
1327
1328   tcp_send_ack (tc);
1329
1330   return 0;
1331 }
1332
1333 /* *INDENT-OFF* */
1334 const static transport_proto_vft_t tcp_proto = {
1335   .enable = vnet_tcp_enable_disable,
1336   .start_listen = tcp_session_bind,
1337   .stop_listen = tcp_session_unbind,
1338   .push_header = tcp_session_push_header,
1339   .get_connection = tcp_session_get_transport,
1340   .get_listener = tcp_session_get_listener,
1341   .get_half_open = tcp_half_open_session_get_transport,
1342   .attribute = tcp_session_attribute,
1343   .connect = tcp_session_open,
1344   .half_close = tcp_session_half_close,
1345   .close = tcp_session_close,
1346   .cleanup = tcp_session_cleanup,
1347   .cleanup_ho = tcp_session_cleanup_ho,
1348   .reset = tcp_session_reset,
1349   .send_params = tcp_session_send_params,
1350   .update_time = tcp_update_time,
1351   .flush_data = tcp_session_flush_data,
1352   .custom_tx = tcp_session_custom_tx,
1353   .app_rx_evt = tcp_session_app_rx_evt,
1354   .format_connection = format_tcp_session,
1355   .format_listener = format_tcp_listener_session,
1356   .format_half_open = format_tcp_half_open_session,
1357   .transport_options = {
1358     .name = "tcp",
1359     .short_name = "T",
1360     .tx_type = TRANSPORT_TX_PEEK,
1361     .service_type = TRANSPORT_SERVICE_VC,
1362   },
1363 };
1364 /* *INDENT-ON* */
1365
1366 void
1367 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1368 {
1369   if (!transport_connection_is_tx_paced (&tc->connection))
1370     return;
1371
1372   f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1373
1374   transport_connection_tx_pacer_update (&tc->connection,
1375                                         tcp_cc_get_pacing_rate (tc),
1376                                         srtt * CLIB_US_TIME_FREQ);
1377 }
1378
1379 void
1380 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1381                                u32 start_bucket)
1382 {
1383   f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1384   transport_connection_tx_pacer_reset (&tc->connection,
1385                                        tcp_cc_get_pacing_rate (tc),
1386                                        start_bucket,
1387                                        srtt * CLIB_US_TIME_FREQ);
1388 }
1389
1390 void
1391 tcp_reschedule (tcp_connection_t * tc)
1392 {
1393   if (tcp_in_cong_recovery (tc) || tcp_snd_space_inline (tc))
1394     transport_connection_reschedule (&tc->connection);
1395 }
1396
1397 static void
1398 tcp_expired_timers_dispatch (u32 * expired_timers)
1399 {
1400   u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1401   u32 connection_index, timer_id, n_expired, max_loops;
1402   tcp_worker_ctx_t *wrk;
1403   tcp_connection_t *tc;
1404   int i;
1405
1406   wrk = tcp_get_worker (thread_index);
1407   n_expired = vec_len (expired_timers);
1408   tcp_worker_stats_inc (wrk, timer_expirations, n_expired);
1409   n_left = clib_fifo_elts (wrk->pending_timers);
1410
1411   /*
1412    * Invalidate all timer handles before dispatching. This avoids dangling
1413    * index references to timer wheel pool entries that have been freed.
1414    */
1415   for (i = 0; i < n_expired; i++)
1416     {
1417       connection_index = expired_timers[i] & 0x0FFFFFFF;
1418       timer_id = expired_timers[i] >> 28;
1419
1420       if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1421         tc = tcp_connection_get (connection_index, thread_index);
1422       else
1423         tc = tcp_half_open_connection_get (connection_index);
1424
1425       TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1426
1427       tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1428       tc->pending_timers |= (1 << timer_id);
1429     }
1430
1431   clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1432
1433   max_loops = clib_max (1, 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second);
1434   max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1435   max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1436   wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1437                                        max_per_loop);
1438
1439   if (thread_index == 0)
1440     session_queue_run_on_main_thread (wrk->vm);
1441 }
1442
1443 static void
1444 tcp_initialize_iss_seed (tcp_main_t * tm)
1445 {
1446   u32 default_seed = random_default_seed ();
1447   u64 time_now = clib_cpu_time_now ();
1448
1449   tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1450   tm->iss_seed.second = random_u64 (&time_now);
1451 }
1452
1453 static clib_error_t *
1454 tcp_main_enable (vlib_main_t * vm)
1455 {
1456   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1457   u32 num_threads, n_workers, prealloc_conn_per_wrk;
1458   tcp_connection_t *tc __attribute__ ((unused));
1459   tcp_main_t *tm = vnet_get_tcp_main ();
1460   tcp_worker_ctx_t *wrk;
1461   clib_error_t *error = 0;
1462   int thread;
1463
1464   if ((error = vlib_call_init_function (vm, ip_main_init)))
1465     return error;
1466   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1467     return error;
1468   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1469     return error;
1470
1471   /*
1472    * Registrations
1473    */
1474
1475   ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1476   ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1477
1478   /*
1479    * Initialize data structures
1480    */
1481
1482   num_threads = 1 /* main thread */  + vtm->n_threads;
1483   vec_validate (tm->wrk_ctx, num_threads - 1);
1484   n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1485   prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1486
1487   wrk = &tm->wrk_ctx[0];
1488   wrk->tco_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1489                                               tcp4_output_node.index);
1490   wrk->tco_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1491                                               tcp6_output_node.index);
1492
1493   for (thread = 0; thread < num_threads; thread++)
1494     {
1495       wrk = &tm->wrk_ctx[thread];
1496
1497       vec_validate (wrk->pending_deq_acked, 255);
1498       vec_validate (wrk->pending_disconnects, 255);
1499       vec_validate (wrk->pending_resets, 255);
1500       vec_reset_length (wrk->pending_deq_acked);
1501       vec_reset_length (wrk->pending_disconnects);
1502       vec_reset_length (wrk->pending_resets);
1503       wrk->vm = vlib_get_main_by_index (thread);
1504       wrk->max_timers_per_loop = 10;
1505
1506       if (thread > 0)
1507         {
1508           wrk->tco_next_node[0] = tm->wrk_ctx[0].tco_next_node[0];
1509           wrk->tco_next_node[1] = tm->wrk_ctx[0].tco_next_node[1];
1510         }
1511
1512       /*
1513        * Preallocate connections. Assume that thread 0 won't
1514        * use preallocated threads when running multi-core
1515        */
1516       if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1517         pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1518
1519       tcp_timer_initialize_wheel (&wrk->timer_wheel,
1520                                   tcp_expired_timers_dispatch,
1521                                   vlib_time_now (vm));
1522     }
1523
1524   tcp_initialize_iss_seed (tm);
1525
1526   tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1527   tm->cc_last_type = TCP_CC_LAST;
1528
1529   tm->ipl_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1530                                              ip4_lookup_node.index);
1531   tm->ipl_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1532                                              ip6_lookup_node.index);
1533   return error;
1534 }
1535
1536 clib_error_t *
1537 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1538 {
1539   if (is_en)
1540     {
1541       if (tcp_main.is_enabled)
1542         return 0;
1543
1544       return tcp_main_enable (vm);
1545     }
1546   else
1547     {
1548       tcp_main.is_enabled = 0;
1549     }
1550
1551   return 0;
1552 }
1553
1554 void
1555 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1556 {
1557   tcp_main_t *tm = &tcp_main;
1558   if (is_ip4)
1559     tm->punt_unknown4 = is_add;
1560   else
1561     tm->punt_unknown6 = is_add;
1562 }
1563
1564 /**
1565  * Initialize default values for tcp parameters
1566  */
1567 static void
1568 tcp_configuration_init (void)
1569 {
1570   /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1571    * predefined value. For SYN-ACK we still want the scale to be computed in
1572    * the same way */
1573   tcp_cfg.max_rx_fifo = 32 << 20;
1574   tcp_cfg.min_rx_fifo = 4 << 10;
1575
1576   tcp_cfg.default_mtu = 1500;
1577   tcp_cfg.initial_cwnd_multiplier = 0;
1578   tcp_cfg.enable_tx_pacing = 1;
1579   tcp_cfg.allow_tso = 0;
1580   tcp_cfg.csum_offload = 1;
1581   tcp_cfg.cc_algo = TCP_CC_CUBIC;
1582   tcp_cfg.rwnd_min_update_ack = 1;
1583   tcp_cfg.max_gso_size = TCP_MAX_GSO_SZ;
1584
1585   /* Time constants defined as timer tick (100us) multiples */
1586   tcp_cfg.closewait_time = 20000;       /* 2s */
1587   tcp_cfg.timewait_time = 100000;       /* 10s */
1588   tcp_cfg.finwait1_time = 600000;       /* 60s */
1589   tcp_cfg.lastack_time = 300000;        /* 30s */
1590   tcp_cfg.finwait2_time = 300000;       /* 30s */
1591   tcp_cfg.closing_time = 300000;        /* 30s */
1592   tcp_cfg.alloc_err_timeout = 1000;     /* 100ms */
1593
1594   /* This value is seconds */
1595   tcp_cfg.cleanup_time = 0.1;   /* 100ms */
1596 }
1597
1598 static clib_error_t *
1599 tcp_init (vlib_main_t * vm)
1600 {
1601   tcp_main_t *tm = vnet_get_tcp_main ();
1602   ip_main_t *im = &ip_main;
1603   ip_protocol_info_t *pi;
1604
1605   /* Session layer, and by implication tcp, are disabled by default */
1606   tm->is_enabled = 0;
1607
1608   /* Register with IP for header parsing */
1609   pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1610   if (pi == 0)
1611     return clib_error_return (0, "TCP protocol info AWOL");
1612   pi->format_header = format_tcp_header;
1613   pi->unformat_pg_edit = unformat_pg_tcp_header;
1614
1615   /* Register as transport with session layer */
1616   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1617                                FIB_PROTOCOL_IP4, tcp4_output_node.index);
1618   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1619                                FIB_PROTOCOL_IP6, tcp6_output_node.index);
1620
1621   tcp_configuration_init ();
1622
1623   tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1624
1625   return 0;
1626 }
1627
1628 VLIB_INIT_FUNCTION (tcp_init);
1629
1630 /*
1631  * fd.io coding-style-patch-verification: ON
1632  *
1633  * Local Variables:
1634  * eval: (c-set-style "gnu")
1635  * End:
1636  */