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