src/vnet/tcp/tcp.c

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