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