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