src/vnet/tcp/tcp.c

   1 /*
   2  * Copyright (c) 2016 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 #include <vnet/tcp/tcp.h>
  17 #include <vnet/session/session.h>
  18 #include <vnet/fib/fib.h>
  19 #include <vnet/dpo/load_balance.h>
  20 #include <math.h>
  21
  22 tcp_main_t tcp_main;
  23
  24 static u32
  25 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
  26 {
  27   tcp_main_t *tm = &tcp_main;
  28   tcp_connection_t *listener;
  29
  30   pool_get (tm->listener_pool, listener);
  31   memset (listener, 0, sizeof (*listener));
  32
  33   listener->c_c_index = listener - tm->listener_pool;
  34   listener->c_lcl_port = clib_host_to_net_u16 (lcl->port);
  35
  36   if (lcl->is_ip4)
  37     {
  38       listener->c_lcl_ip4.as_u32 = lcl->ip.ip4.as_u32;
  39       listener->c_is_ip4 = 1;
  40     }
  41   else
  42     {
  43       clib_memcpy (&listener->c_lcl_ip6, &lcl->ip.ip6,
  44                    sizeof (ip6_address_t));
  45
  46     }
  47   listener->c_transport_proto = TRANSPORT_PROTO_TCP;
  48   listener->c_s_index = session_index;
  49   listener->state = TCP_STATE_LISTEN;
  50
  51   tcp_connection_timers_init (listener);
  52
  53   TCP_EVT_DBG (TCP_EVT_BIND, listener);
  54
  55   return listener->c_c_index;
  56 }
  57
  58 u32
  59 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
  60 {
  61   return tcp_connection_bind (session_index, tep);
  62 }
  63
  64 static void
  65 tcp_connection_unbind (u32 listener_index)
  66 {
  67   tcp_main_t *tm = vnet_get_tcp_main ();
  68   tcp_connection_t *tc;
  69
  70   tc = pool_elt_at_index (tm->listener_pool, listener_index);
  71
  72   TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
  73
  74   /* Poison the entry */
  75   if (CLIB_DEBUG > 0)
  76     memset (tc, 0xFA, sizeof (*tc));
  77
  78   pool_put_index (tm->listener_pool, listener_index);
  79 }
  80
  81 u32
  82 tcp_session_unbind (u32 listener_index)
  83 {
  84   tcp_connection_unbind (listener_index);
  85   return 0;
  86 }
  87
  88 transport_connection_t *
  89 tcp_session_get_listener (u32 listener_index)
  90 {
  91   tcp_main_t *tm = vnet_get_tcp_main ();
  92   tcp_connection_t *tc;
  93   tc = pool_elt_at_index (tm->listener_pool, listener_index);
  94   return &tc->connection;
  95 }
  96
  97 always_inline void
  98 transport_endpoint_del (u32 tepi)
  99 {
 100   tcp_main_t *tm = vnet_get_tcp_main ();
 101   clib_spinlock_lock_if_init (&tm->local_endpoints_lock);
 102   pool_put_index (tm->local_endpoints, tepi);
 103   clib_spinlock_unlock_if_init (&tm->local_endpoints_lock);
 104 }
 105
 106 always_inline transport_endpoint_t *
 107 transport_endpoint_new (void)
 108 {
 109   tcp_main_t *tm = vnet_get_tcp_main ();
 110   transport_endpoint_t *tep;
 111   pool_get (tm->local_endpoints, tep);
 112   return tep;
 113 }
 114
 115 /**
 116  * Cleanup half-open connection
 117  *
 118  */
 119 void
 120 tcp_half_open_connection_del (tcp_connection_t * tc)
 121 {
 122   tcp_main_t *tm = vnet_get_tcp_main ();
 123   clib_spinlock_lock_if_init (&tm->half_open_lock);
 124   pool_put_index (tm->half_open_connections, tc->c_c_index);
 125   if (CLIB_DEBUG)
 126     memset (tc, 0xFA, sizeof (*tc));
 127   clib_spinlock_unlock_if_init (&tm->half_open_lock);
 128 }
 129
 130 /**
 131  * Try to cleanup half-open connection
 132  *
 133  * If called from a thread that doesn't own tc, the call won't have any
 134  * effect.
 135  *
 136  * @param tc - connection to be cleaned up
 137  * @return non-zero if cleanup failed.
 138  */
 139 int
 140 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
 141 {
 142   /* Make sure this is the owning thread */
 143   if (tc->c_thread_index != vlib_get_thread_index ())
 144     return 1;
 145   tcp_timer_reset (tc, TCP_TIMER_ESTABLISH);
 146   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
 147   tcp_half_open_connection_del (tc);
 148   return 0;
 149 }
 150
 151 tcp_connection_t *
 152 tcp_half_open_connection_new (void)
 153 {
 154   tcp_main_t *tm = vnet_get_tcp_main ();
 155   tcp_connection_t *tc = 0;
 156   pool_get (tm->half_open_connections, tc);
 157   memset (tc, 0, sizeof (*tc));
 158   tc->c_c_index = tc - tm->half_open_connections;
 159   return tc;
 160 }
 161
 162 /**
 163  * Cleans up connection state.
 164  *
 165  * No notifications.
 166  */
 167 void
 168 tcp_connection_cleanup (tcp_connection_t * tc)
 169 {
 170   tcp_main_t *tm = &tcp_main;
 171   u32 tepi;
 172   transport_endpoint_t *tep;
 173
 174   /* Cleanup local endpoint if this was an active connect */
 175   tepi = transport_endpoint_lookup (&tm->local_endpoints_table, &tc->c_lcl_ip,
 176                                     clib_net_to_host_u16 (tc->c_lcl_port));
 177   if (tepi != TRANSPORT_ENDPOINT_INVALID_INDEX)
 178     {
 179       tep = pool_elt_at_index (tm->local_endpoints, tepi);
 180       transport_endpoint_table_del (&tm->local_endpoints_table, tep);
 181       transport_endpoint_del (tepi);
 182     }
 183
 184   /* Check if connection is not yet fully established */
 185   if (tc->state == TCP_STATE_SYN_SENT)
 186     {
 187       /* Try to remove the half-open connection. If this is not the owning
 188        * thread, tc won't be removed. Retransmit or establish timers will
 189        * eventually expire and call again cleanup on the right thread. */
 190       tcp_half_open_connection_cleanup (tc);
 191     }
 192   else
 193     {
 194       int thread_index = tc->c_thread_index;
 195
 196       /* Make sure all timers are cleared */
 197       tcp_connection_timers_reset (tc);
 198
 199       /* Poison the entry */
 200       if (CLIB_DEBUG > 0)
 201         memset (tc, 0xFA, sizeof (*tc));
 202       pool_put (tm->connections[thread_index], tc);
 203     }
 204 }
 205
 206 /**
 207  * Connection removal.
 208  *
 209  * This should be called only once connection enters CLOSED state. Note
 210  * that it notifies the session of the removal event, so if the goal is to
 211  * just remove the connection, call tcp_connection_cleanup instead.
 212  */
 213 void
 214 tcp_connection_del (tcp_connection_t * tc)
 215 {
 216   TCP_EVT_DBG (TCP_EVT_DELETE, tc);
 217   stream_session_delete_notify (&tc->connection);
 218   tcp_connection_cleanup (tc);
 219 }
 220
 221 tcp_connection_t *
 222 tcp_connection_new (u8 thread_index)
 223 {
 224   tcp_main_t *tm = vnet_get_tcp_main ();
 225   tcp_connection_t *tc;
 226
 227   pool_get (tm->connections[thread_index], tc);
 228   memset (tc, 0, sizeof (*tc));
 229   tc->c_c_index = tc - tm->connections[thread_index];
 230   tc->c_thread_index = thread_index;
 231   return tc;
 232 }
 233
 234 /** Notify session that connection has been reset.
 235  *
 236  * Switch state to closed and wait for session to call cleanup.
 237  */
 238 void
 239 tcp_connection_reset (tcp_connection_t * tc)
 240 {
 241   TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
 242   switch (tc->state)
 243     {
 244     case TCP_STATE_SYN_RCVD:
 245       /* Cleanup everything. App wasn't notified yet */
 246       stream_session_delete_notify (&tc->connection);
 247       tcp_connection_cleanup (tc);
 248       break;
 249     case TCP_STATE_SYN_SENT:
 250       stream_session_connect_notify (&tc->connection, 1 /* fail */ );
 251       tcp_connection_cleanup (tc);
 252       break;
 253     case TCP_STATE_ESTABLISHED:
 254     case TCP_STATE_CLOSE_WAIT:
 255     case TCP_STATE_FIN_WAIT_1:
 256     case TCP_STATE_FIN_WAIT_2:
 257     case TCP_STATE_CLOSING:
 258       tc->state = TCP_STATE_CLOSED;
 259       TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
 260
 261       /* Make sure all timers are cleared */
 262       tcp_connection_timers_reset (tc);
 263       stream_session_reset_notify (&tc->connection);
 264
 265       /* Wait for cleanup from session layer but not forever */
 266       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
 267       break;
 268     case TCP_STATE_CLOSED:
 269       return;
 270     }
 271 }
 272
 273 /**
 274  * Begin connection closing procedure.
 275  *
 276  * If at the end the connection is not in CLOSED state, it is not removed.
 277  * Instead, we rely on on TCP to advance through state machine to either
 278  * 1) LAST_ACK (passive close) whereby when the last ACK is received
 279  * tcp_connection_del is called. This notifies session of the delete and
 280  * calls cleanup.
 281  * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
 282  * and cleanup is called.
 283  *
 284  * N.B. Half-close connections are not supported
 285  */
 286 void
 287 tcp_connection_close (tcp_connection_t * tc)
 288 {
 289   TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
 290
 291   /* Send/Program FIN if needed and switch state */
 292   switch (tc->state)
 293     {
 294     case TCP_STATE_SYN_SENT:
 295       tc->state = TCP_STATE_CLOSED;
 296       break;
 297     case TCP_STATE_SYN_RCVD:
 298       tcp_send_fin (tc);
 299       tc->state = TCP_STATE_FIN_WAIT_1;
 300       break;
 301     case TCP_STATE_ESTABLISHED:
 302       if (!stream_session_tx_fifo_max_dequeue (&tc->connection))
 303         tcp_send_fin (tc);
 304       else
 305         tc->flags |= TCP_CONN_FINPNDG;
 306       tc->state = TCP_STATE_FIN_WAIT_1;
 307       break;
 308     case TCP_STATE_CLOSE_WAIT:
 309       tcp_send_fin (tc);
 310       tc->state = TCP_STATE_LAST_ACK;
 311       break;
 312     default:
 313       clib_warning ("shouldn't be here");
 314     }
 315
 316   TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
 317
 318   /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
 319   if (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID
 320       && tc->state == TCP_STATE_CLOSED)
 321     tcp_connection_del (tc);
 322 }
 323
 324 void
 325 tcp_session_close (u32 conn_index, u32 thread_index)
 326 {
 327   tcp_connection_t *tc;
 328   tc = tcp_connection_get (conn_index, thread_index);
 329   tcp_connection_close (tc);
 330 }
 331
 332 void
 333 tcp_session_cleanup (u32 conn_index, u32 thread_index)
 334 {
 335   tcp_connection_t *tc;
 336   tc = tcp_connection_get (conn_index, thread_index);
 337
 338   /* Wait for the session tx events to clear */
 339   tc->state = TCP_STATE_CLOSED;
 340   TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
 341   tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
 342 }
 343
 344 void *
 345 ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4)
 346 {
 347   ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
 348   ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
 349   ip_interface_address_t *ia = 0;
 350
 351   if (is_ip4)
 352     {
 353       /* *INDENT-OFF* */
 354       foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
 355       ({
 356         return ip_interface_address_get_address (lm4, ia);
 357       }));
 358       /* *INDENT-ON* */
 359     }
 360   else
 361     {
 362       /* *INDENT-OFF* */
 363       foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
 364       ({
 365         return ip_interface_address_get_address (lm6, ia);
 366       }));
 367       /* *INDENT-ON* */
 368     }
 369
 370   return 0;
 371 }
 372
 373 #define PORT_MASK ((1 << 16)- 1)
 374 /**
 375  * Allocate local port and add if successful add entry to local endpoint
 376  * table to mark the pair as used.
 377  */
 378 int
 379 tcp_allocate_local_port (ip46_address_t * ip)
 380 {
 381   tcp_main_t *tm = vnet_get_tcp_main ();
 382   transport_endpoint_t *tep;
 383   u32 tei;
 384   u16 min = 1024, max = 65535;  /* XXX configurable ? */
 385   int tries, limit;
 386
 387   limit = max - min;
 388
 389   /* Only support active opens from thread 0 */
 390   ASSERT (vlib_get_thread_index () == 0);
 391
 392   /* Search for first free slot */
 393   for (tries = 0; tries < limit; tries++)
 394     {
 395       u16 port = 0;
 396
 397       /* Find a port in the specified range */
 398       while (1)
 399         {
 400           port = random_u32 (&tm->port_allocator_seed) & PORT_MASK;
 401           if (PREDICT_TRUE (port >= min && port < max))
 402             break;
 403         }
 404
 405       /* Look it up */
 406       tei = transport_endpoint_lookup (&tm->local_endpoints_table, ip, port);
 407       /* If not found, we're done */
 408       if (tei == TRANSPORT_ENDPOINT_INVALID_INDEX)
 409         {
 410           clib_spinlock_lock_if_init (&tm->local_endpoints_lock);
 411           tep = transport_endpoint_new ();
 412           clib_memcpy (&tep->ip, ip, sizeof (*ip));
 413           tep->port = port;
 414           transport_endpoint_table_add (&tm->local_endpoints_table, tep,
 415                                         tep - tm->local_endpoints);
 416           clib_spinlock_unlock_if_init (&tm->local_endpoints_lock);
 417
 418           return tep->port;
 419         }
 420     }
 421   return -1;
 422 }
 423
 424 /**
 425  * Initialize all connection timers as invalid
 426  */
 427 void
 428 tcp_connection_timers_init (tcp_connection_t * tc)
 429 {
 430   int i;
 431
 432   /* Set all to invalid */
 433   for (i = 0; i < TCP_N_TIMERS; i++)
 434     {
 435       tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
 436     }
 437
 438   tc->rto = TCP_RTO_INIT;
 439 }
 440
 441 /**
 442  * Stop all connection timers
 443  */
 444 void
 445 tcp_connection_timers_reset (tcp_connection_t * tc)
 446 {
 447   int i;
 448   for (i = 0; i < TCP_N_TIMERS; i++)
 449     {
 450       tcp_timer_reset (tc, i);
 451     }
 452 }
 453
 454 #if 0
 455 typedef struct ip4_tcp_hdr
 456 {
 457   ip4_header_t ip;
 458   tcp_header_t tcp;
 459 } ip4_tcp_hdr_t;
 460
 461 typedef struct ip6_tcp_hdr
 462 {
 463   ip6_header_t ip;
 464   tcp_header_t tcp;
 465 } ip6_tcp_hdr_t;
 466
 467 static void
 468 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
 469                                  dpo_id_t * result)
 470 {
 471   const dpo_id_t *choice;
 472   load_balance_t *lb;
 473   int hash;
 474
 475   lb = load_balance_get (dpo->dpoi_index);
 476   if (tc->c_is_ip4)
 477     {
 478       ip4_tcp_hdr_t hdr;
 479       memset (&hdr, 0, sizeof (hdr));
 480       hdr.ip.protocol = IP_PROTOCOL_TCP;
 481       hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
 482       hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
 483       hdr.tcp.src_port = tc->c_lcl_port;
 484       hdr.tcp.dst_port = tc->c_rmt_port;
 485       hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
 486     }
 487   else
 488     {
 489       ip6_tcp_hdr_t hdr;
 490       memset (&hdr, 0, sizeof (hdr));
 491       hdr.ip.protocol = IP_PROTOCOL_TCP;
 492       clib_memcpy (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
 493                    sizeof (ip6_address_t));
 494       clib_memcpy (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
 495                    sizeof (ip6_address_t));
 496       hdr.tcp.src_port = tc->c_lcl_port;
 497       hdr.tcp.dst_port = tc->c_rmt_port;
 498       hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
 499     }
 500   choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
 501   dpo_copy (result, choice);
 502 }
 503
 504 fib_node_index_t
 505 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
 506 {
 507   fib_prefix_t prefix;
 508   u32 fib_index;
 509
 510   clib_memcpy (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
 511   prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 512   prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
 513   fib_index = fib_table_find (prefix.fp_proto, tc->c_vrf);
 514   return fib_table_lookup (fib_index, &prefix);
 515 }
 516
 517 static int
 518 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
 519 {
 520   dpo_id_t choice = DPO_INVALID;
 521   u32 output_node_index;
 522   fib_entry_t *fe;
 523
 524   fe = fib_entry_get (tc->c_rmt_fei);
 525   if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
 526     return -1;
 527
 528   tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
 529
 530   output_node_index =
 531     tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
 532   dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
 533   return 0;
 534 }
 535
 536 /** Stack tcp connection on peer's fib entry.
 537  *
 538  * This ultimately populates the dpo the connection will use to send packets.
 539  */
 540 static void
 541 tcp_connection_fib_attach (tcp_connection_t * tc)
 542 {
 543   tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
 544
 545   ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
 546
 547   tcp_connection_stack_on_fib_entry (tc);
 548 }
 549 #endif /* 0 */
 550
 551 /** Initialize tcp connection variables
 552  *
 553  * Should be called after having received a msg from the peer, i.e., a SYN or
 554  * a SYNACK, such that connection options have already been exchanged. */
 555 void
 556 tcp_connection_init_vars (tcp_connection_t * tc)
 557 {
 558   tcp_connection_timers_init (tc);
 559   tcp_init_mss (tc);
 560   scoreboard_init (&tc->sack_sb);
 561   tcp_cc_init (tc);
 562   //  tcp_connection_fib_attach (tc);
 563 }
 564
 565 int
 566 tcp_connection_open (transport_endpoint_t * rmt)
 567 {
 568   tcp_main_t *tm = vnet_get_tcp_main ();
 569   tcp_connection_t *tc;
 570   fib_prefix_t prefix;
 571   fib_node_index_t fei;
 572   u32 sw_if_index, fib_index;
 573   ip46_address_t lcl_addr;
 574   int lcl_port;
 575
 576   /*
 577    * Find the local address and allocate port
 578    */
 579   memset (&lcl_addr, 0, sizeof (lcl_addr));
 580
 581   /* Find a FIB path to the destination */
 582   clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
 583   prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 584   prefix.fp_len = rmt->is_ip4 ? 32 : 128;
 585
 586   fib_index = fib_table_find (prefix.fp_proto, rmt->vrf);
 587   fei = fib_table_lookup (fib_index, &prefix);
 588
 589   /* Couldn't find route to destination. Bail out. */
 590   if (fei == FIB_NODE_INDEX_INVALID)
 591     {
 592       clib_warning ("no route to destination");
 593       return -1;
 594     }
 595
 596   sw_if_index = fib_entry_get_resolving_interface (fei);
 597
 598   if (sw_if_index == (u32) ~ 0)
 599     {
 600       clib_warning ("no resolving interface for %U", format_ip46_address,
 601                     &rmt->ip, IP46_TYPE_IP4);
 602       return -1;
 603     }
 604
 605   if (rmt->is_ip4)
 606     {
 607       ip4_address_t *ip4;
 608       int index;
 609       if (vec_len (tm->ip4_src_addresses))
 610         {
 611           index = tm->last_v4_address_rotor++;
 612           if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
 613             tm->last_v4_address_rotor = 0;
 614           lcl_addr.ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
 615         }
 616       else
 617         {
 618           ip4 = ip_interface_get_first_ip (sw_if_index, 1);
 619           lcl_addr.ip4.as_u32 = ip4->as_u32;
 620         }
 621     }
 622   else
 623     {
 624       ip6_address_t *ip6;
 625       int index;
 626
 627       if (vec_len (tm->ip6_src_addresses))
 628         {
 629           index = tm->last_v6_address_rotor++;
 630           if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
 631             tm->last_v6_address_rotor = 0;
 632           clib_memcpy (&lcl_addr.ip6, &tm->ip6_src_addresses[index],
 633                        sizeof (*ip6));
 634         }
 635       else
 636         {
 637           ip6 = ip_interface_get_first_ip (sw_if_index, 0);
 638           clib_memcpy (&lcl_addr.ip6, ip6, sizeof (*ip6));
 639         }
 640     }
 641
 642   /* Allocate source port */
 643   lcl_port = tcp_allocate_local_port (&lcl_addr);
 644   if (lcl_port < 1)
 645     {
 646       clib_warning ("Failed to allocate src port");
 647       return -1;
 648     }
 649
 650   /*
 651    * Create connection and send SYN
 652    */
 653   clib_spinlock_lock_if_init (&tm->half_open_lock);
 654   tc = tcp_half_open_connection_new ();
 655   clib_memcpy (&tc->c_rmt_ip, &rmt->ip, sizeof (ip46_address_t));
 656   clib_memcpy (&tc->c_lcl_ip, &lcl_addr, sizeof (ip46_address_t));
 657   tc->c_rmt_port = clib_host_to_net_u16 (rmt->port);
 658   tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
 659   tc->c_is_ip4 = rmt->is_ip4;
 660   tc->c_transport_proto = TRANSPORT_PROTO_TCP;
 661   tc->c_vrf = rmt->vrf;
 662   /* The other connection vars will be initialized after SYN ACK */
 663   tcp_connection_timers_init (tc);
 664
 665   TCP_EVT_DBG (TCP_EVT_OPEN, tc);
 666   tc->state = TCP_STATE_SYN_SENT;
 667   tcp_send_syn (tc);
 668   clib_spinlock_unlock_if_init (&tm->half_open_lock);
 669
 670   return tc->c_c_index;
 671 }
 672
 673 int
 674 tcp_session_open (transport_endpoint_t * tep)
 675 {
 676   return tcp_connection_open (tep);
 677 }
 678
 679 const char *tcp_dbg_evt_str[] = {
 680 #define _(sym, str) str,
 681   foreach_tcp_dbg_evt
 682 #undef _
 683 };
 684
 685 const char *tcp_fsm_states[] = {
 686 #define _(sym, str) str,
 687   foreach_tcp_fsm_state
 688 #undef _
 689 };
 690
 691 u8 *
 692 format_tcp_state (u8 * s, va_list * args)
 693 {
 694   u32 state = va_arg (*args, u32);
 695
 696   if (state < TCP_N_STATES)
 697     s = format (s, "%s", tcp_fsm_states[state]);
 698   else
 699     s = format (s, "UNKNOWN (%d (0x%x))", state, state);
 700   return s;
 701 }
 702
 703 const char *tcp_conn_timers[] = {
 704 #define _(sym, str) str,
 705   foreach_tcp_timer
 706 #undef _
 707 };
 708
 709 u8 *
 710 format_tcp_timers (u8 * s, va_list * args)
 711 {
 712   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 713   int i, last = -1;
 714
 715   for (i = 0; i < TCP_N_TIMERS; i++)
 716     if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
 717       last = i;
 718
 719   s = format (s, "[");
 720   for (i = 0; i < last; i++)
 721     {
 722       if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
 723         s = format (s, "%s,", tcp_conn_timers[i]);
 724     }
 725
 726   if (last >= 0)
 727     s = format (s, "%s]", tcp_conn_timers[i]);
 728   else
 729     s = format (s, "]");
 730
 731   return s;
 732 }
 733
 734 u8 *
 735 format_tcp_congestion_status (u8 * s, va_list * args)
 736 {
 737   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 738   if (tcp_in_recovery (tc))
 739     s = format (s, "recovery");
 740   else if (tcp_in_fastrecovery (tc))
 741     s = format (s, "fastrecovery");
 742   else
 743     s = format (s, "none");
 744   return s;
 745 }
 746
 747 u8 *
 748 format_tcp_vars (u8 * s, va_list * args)
 749 {
 750   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 751   s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
 752               tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
 753               tc->snd_una_max - tc->iss);
 754   s = format (s, " rcv_nxt %u rcv_las %u\n",
 755               tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
 756   s = format (s, " snd_wnd %u rcv_wnd %u snd_wl1 %u snd_wl2 %u\n",
 757               tc->snd_wnd, tc->rcv_wnd, tc->snd_wl1 - tc->irs,
 758               tc->snd_wl2 - tc->iss);
 759   s = format (s, " flight size %u send space %u rcv_wnd_av %d\n",
 760               tcp_flight_size (tc), tcp_available_snd_space (tc),
 761               tcp_rcv_wnd_available (tc));
 762   s = format (s, " cong %U ", format_tcp_congestion_status, tc);
 763   s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
 764               tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
 765   s = format (s, " prev_ssthresh %u snd_congestion %u dupack %u",
 766               tc->prev_ssthresh, tc->snd_congestion - tc->iss,
 767               tc->rcv_dupacks);
 768   s = format (s, " limited_transmit %u\n", tc->limited_transmit - tc->iss);
 769   s = format (s, " tsecr %u tsecr_last_ack %u\n", tc->rcv_opts.tsecr,
 770               tc->tsecr_last_ack);
 771   s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %u ", tc->rto,
 772               tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
 773   s = format (s, "rtt_seq %u\n", tc->rtt_seq);
 774   s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
 775               tcp_time_now () - tc->tsval_recent_age);
 776   s = format (s, " scoreboard: %U\n", format_tcp_scoreboard, &tc->sack_sb);
 777   if (vec_len (tc->snd_sacks))
 778     s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
 779
 780   return s;
 781 }
 782
 783 u8 *
 784 format_tcp_connection_id (u8 * s, va_list * args)
 785 {
 786   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 787   if (!tc)
 788     return s;
 789   if (tc->c_is_ip4)
 790     {
 791       s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
 792                   format_ip4_address, &tc->c_lcl_ip4,
 793                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
 794                   &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
 795     }
 796   else
 797     {
 798       s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
 799                   format_ip6_address, &tc->c_lcl_ip6,
 800                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
 801                   &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
 802     }
 803
 804   return s;
 805 }
 806
 807 u8 *
 808 format_tcp_connection (u8 * s, va_list * args)
 809 {
 810   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 811   u32 verbose = va_arg (*args, u32);
 812
 813   s = format (s, "%-50U", format_tcp_connection_id, tc);
 814   if (verbose)
 815     {
 816       s = format (s, "%-15U", format_tcp_state, tc->state);
 817       if (verbose > 1)
 818         s = format (s, " %U\n%U", format_tcp_timers, tc, format_tcp_vars, tc);
 819     }
 820
 821   return s;
 822 }
 823
 824 u8 *
 825 format_tcp_session (u8 * s, va_list * args)
 826 {
 827   u32 tci = va_arg (*args, u32);
 828   u32 thread_index = va_arg (*args, u32);
 829   u32 verbose = va_arg (*args, u32);
 830   tcp_connection_t *tc;
 831
 832   tc = tcp_connection_get (tci, thread_index);
 833   if (tc)
 834     s = format (s, "%U", format_tcp_connection, tc, verbose);
 835   else
 836     s = format (s, "empty");
 837   return s;
 838 }
 839
 840 u8 *
 841 format_tcp_listener_session (u8 * s, va_list * args)
 842 {
 843   u32 tci = va_arg (*args, u32);
 844   tcp_connection_t *tc = tcp_listener_get (tci);
 845   return format (s, "%U", format_tcp_connection_id, tc);
 846 }
 847
 848 u8 *
 849 format_tcp_half_open_session (u8 * s, va_list * args)
 850 {
 851   u32 tci = va_arg (*args, u32);
 852   tcp_connection_t *tc = tcp_half_open_connection_get (tci);
 853   return format (s, "%U", format_tcp_connection_id, tc);
 854 }
 855
 856 u8 *
 857 format_tcp_sacks (u8 * s, va_list * args)
 858 {
 859   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 860   sack_block_t *sacks = tc->snd_sacks;
 861   sack_block_t *block;
 862   int i, len = 0;
 863
 864   len = vec_len (sacks);
 865   for (i = 0; i < len - 1; i++)
 866     {
 867       block = &sacks[i];
 868       s = format (s, " start %u end %u\n", block->start - tc->irs,
 869                   block->end - tc->irs);
 870     }
 871   if (len)
 872     {
 873       block = &sacks[len - 1];
 874       s = format (s, " start %u end %u", block->start - tc->irs,
 875                   block->end - tc->irs);
 876     }
 877   return s;
 878 }
 879
 880 u8 *
 881 format_tcp_rcv_sacks (u8 * s, va_list * args)
 882 {
 883   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 884   sack_block_t *sacks = tc->rcv_opts.sacks;
 885   sack_block_t *block;
 886   int i, len = 0;
 887
 888   len = vec_len (sacks);
 889   for (i = 0; i < len - 1; i++)
 890     {
 891       block = &sacks[i];
 892       s = format (s, " start %u end %u\n", block->start - tc->iss,
 893                   block->end - tc->iss);
 894     }
 895   if (len)
 896     {
 897       block = &sacks[len - 1];
 898       s = format (s, " start %u end %u", block->start - tc->iss,
 899                   block->end - tc->iss);
 900     }
 901   return s;
 902 }
 903
 904 u8 *
 905 format_tcp_sack_hole (u8 * s, va_list * args)
 906 {
 907   sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
 908   s = format (s, "[%u, %u]", hole->start, hole->end);
 909   return s;
 910 }
 911
 912 u8 *
 913 format_tcp_scoreboard (u8 * s, va_list * args)
 914 {
 915   sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
 916   sack_scoreboard_hole_t *hole;
 917   s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
 918               sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
 919   s = format (s, " last_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
 920               sb->last_bytes_delivered, sb->high_sacked, sb->snd_una_adv);
 921   s = format (s, " cur_rxt_hole %u high_rxt %u rescue_rxt %u",
 922               sb->cur_rxt_hole, sb->high_rxt, sb->rescue_rxt);
 923
 924   hole = scoreboard_first_hole (sb);
 925   if (hole)
 926     s = format (s, "\n head %u tail %u holes:\n", sb->head, sb->tail);
 927
 928   while (hole)
 929     {
 930       s = format (s, "%U", format_tcp_sack_hole, hole);
 931       hole = scoreboard_next_hole (sb, hole);
 932     }
 933
 934   return s;
 935 }
 936
 937 transport_connection_t *
 938 tcp_session_get_transport (u32 conn_index, u32 thread_index)
 939 {
 940   tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
 941   return &tc->connection;
 942 }
 943
 944 transport_connection_t *
 945 tcp_half_open_session_get_transport (u32 conn_index)
 946 {
 947   tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
 948   return &tc->connection;
 949 }
 950
 951 /**
 952  * Compute maximum segment size for session layer.
 953  *
 954  * Since the result needs to be the actual data length, it first computes
 955  * the tcp options to be used in the next burst and subtracts their
 956  * length from the connection's snd_mss.
 957  */
 958 u16
 959 tcp_session_send_mss (transport_connection_t * trans_conn)
 960 {
 961   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
 962
 963   /* Ensure snd_mss does accurately reflect the amount of data we can push
 964    * in a segment. This also makes sure that options are updated according to
 965    * the current state of the connection. */
 966   tcp_update_snd_mss (tc);
 967
 968   return tc->snd_mss;
 969 }
 970
 971 always_inline u32
 972 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
 973 {
 974   if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
 975     {
 976       return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
 977     }
 978
 979   /* If we can't write at least a segment, don't try at all */
 980   if (PREDICT_FALSE (snd_space < tc->snd_mss))
 981     {
 982       if (snd_space > clib_min (tc->mss, tc->rcv_opts.mss) - TCP_HDR_LEN_MAX)
 983         return snd_space;
 984       return 0;
 985     }
 986
 987   /* round down to mss multiple */
 988   return snd_space - (snd_space % tc->snd_mss);
 989 }
 990
 991 /**
 992  * Compute tx window session is allowed to fill.
 993  *
 994  * Takes into account available send space, snd_mss and the congestion
 995  * state of the connection. If possible, the value returned is a multiple
 996  * of snd_mss.
 997  *
 998  * @param tc tcp connection
 999  * @return number of bytes session is allowed to write
1000  */
1001 u32
1002 tcp_snd_space (tcp_connection_t * tc)
1003 {
1004   int snd_space, snt_limited;
1005
1006   if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0))
1007     {
1008       snd_space = tcp_available_snd_space (tc);
1009
1010       /* If we haven't gotten dupacks or if we did and have gotten sacked
1011        * bytes then we can still send as per Limited Transmit (RFC3042) */
1012       if (PREDICT_FALSE (tc->rcv_dupacks != 0
1013                          && (tcp_opts_sack_permitted (tc)
1014                              && tc->sack_sb.last_sacked_bytes == 0)))
1015         {
1016           if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1017             tc->limited_transmit = tc->snd_nxt;
1018           ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1019
1020           snt_limited = tc->snd_nxt - tc->limited_transmit;
1021           snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1022         }
1023       return tcp_round_snd_space (tc, snd_space);
1024     }
1025
1026   if (tcp_in_recovery (tc))
1027     {
1028       tc->snd_nxt = tc->snd_una_max;
1029       snd_space = tcp_available_wnd (tc) - tc->snd_rxt_bytes
1030         - (tc->snd_una_max - tc->snd_congestion);
1031       if (snd_space <= 0 || (tc->snd_una_max - tc->snd_una) >= tc->snd_wnd)
1032         return 0;
1033       return tcp_round_snd_space (tc, snd_space);
1034     }
1035
1036   /* If in fast recovery, send 1 SMSS if wnd allows */
1037   if (tcp_in_fastrecovery (tc)
1038       && tcp_available_snd_space (tc) && !tcp_fastrecovery_sent_1_smss (tc))
1039     {
1040       tcp_fastrecovery_1_smss_on (tc);
1041       return tc->snd_mss;
1042     }
1043
1044   return 0;
1045 }
1046
1047 u32
1048 tcp_session_send_space (transport_connection_t * trans_conn)
1049 {
1050   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1051   return tcp_snd_space (tc);
1052 }
1053
1054 i32
1055 tcp_rcv_wnd_available (tcp_connection_t * tc)
1056 {
1057   return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
1058 }
1059
1060 u32
1061 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1062 {
1063   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1064
1065   ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1066
1067   /* This still works if fast retransmit is on */
1068   return (tc->snd_nxt - tc->snd_una);
1069 }
1070
1071 /* *INDENT-OFF* */
1072 const static transport_proto_vft_t tcp_proto = {
1073   .bind = tcp_session_bind,
1074   .unbind = tcp_session_unbind,
1075   .push_header = tcp_push_header,
1076   .get_connection = tcp_session_get_transport,
1077   .get_listener = tcp_session_get_listener,
1078   .get_half_open = tcp_half_open_session_get_transport,
1079   .open = tcp_session_open,
1080   .close = tcp_session_close,
1081   .cleanup = tcp_session_cleanup,
1082   .send_mss = tcp_session_send_mss,
1083   .send_space = tcp_session_send_space,
1084   .tx_fifo_offset = tcp_session_tx_fifo_offset,
1085   .format_connection = format_tcp_session,
1086   .format_listener = format_tcp_listener_session,
1087   .format_half_open = format_tcp_half_open_session,
1088 };
1089 /* *INDENT-ON* */
1090
1091 void
1092 tcp_timer_keep_handler (u32 conn_index)
1093 {
1094   u32 thread_index = vlib_get_thread_index ();
1095   tcp_connection_t *tc;
1096
1097   tc = tcp_connection_get (conn_index, thread_index);
1098   tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1099
1100   tcp_connection_close (tc);
1101 }
1102
1103 void
1104 tcp_timer_establish_handler (u32 conn_index)
1105 {
1106   tcp_connection_t *tc;
1107
1108   tc = tcp_half_open_connection_get (conn_index);
1109   tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1110
1111   ASSERT (tc->state == TCP_STATE_SYN_SENT);
1112   stream_session_connect_notify (&tc->connection, 1 /* fail */ );
1113   tcp_connection_cleanup (tc);
1114 }
1115
1116 void
1117 tcp_timer_waitclose_handler (u32 conn_index)
1118 {
1119   u32 thread_index = vlib_get_thread_index ();
1120   tcp_connection_t *tc;
1121
1122   tc = tcp_connection_get (conn_index, thread_index);
1123   if (!tc)
1124     return;
1125   tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1126
1127   /* Session didn't come back with a close(). Send FIN either way
1128    * and switch to LAST_ACK. */
1129   if (tc->state == TCP_STATE_CLOSE_WAIT)
1130     {
1131       if (tc->flags & TCP_CONN_FINSNT)
1132         {
1133           clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1134         }
1135
1136       tcp_send_fin (tc);
1137       tc->state = TCP_STATE_LAST_ACK;
1138
1139       /* Make sure we don't wait in LAST ACK forever */
1140       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1141
1142       /* Don't delete the connection yet */
1143       return;
1144     }
1145
1146   tcp_connection_del (tc);
1147 }
1148
1149 /* *INDENT-OFF* */
1150 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1151 {
1152     tcp_timer_retransmit_handler,
1153     tcp_timer_delack_handler,
1154     tcp_timer_persist_handler,
1155     tcp_timer_keep_handler,
1156     tcp_timer_waitclose_handler,
1157     tcp_timer_retransmit_syn_handler,
1158     tcp_timer_establish_handler
1159 };
1160 /* *INDENT-ON* */
1161
1162 static void
1163 tcp_expired_timers_dispatch (u32 * expired_timers)
1164 {
1165   int i;
1166   u32 connection_index, timer_id;
1167
1168   for (i = 0; i < vec_len (expired_timers); i++)
1169     {
1170       /* Get session index and timer id */
1171       connection_index = expired_timers[i] & 0x0FFFFFFF;
1172       timer_id = expired_timers[i] >> 28;
1173
1174       TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1175
1176       /* Handle expiration */
1177       (*timer_expiration_handlers[timer_id]) (connection_index);
1178     }
1179 }
1180
1181 void
1182 tcp_initialize_timer_wheels (tcp_main_t * tm)
1183 {
1184   tw_timer_wheel_16t_2w_512sl_t *tw;
1185   /* *INDENT-OFF* */
1186   foreach_vlib_main (({
1187     tw = &tm->timer_wheels[ii];
1188     tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1189                                       100e-3 /* timer period 100ms */ , ~0);
1190     tw->last_run_time = vlib_time_now (this_vlib_main);
1191   }));
1192   /* *INDENT-ON* */
1193 }
1194
1195 clib_error_t *
1196 tcp_main_enable (vlib_main_t * vm)
1197 {
1198   tcp_main_t *tm = vnet_get_tcp_main ();
1199   ip_protocol_info_t *pi;
1200   ip_main_t *im = &ip_main;
1201   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1202   clib_error_t *error = 0;
1203   u32 num_threads;
1204   int i, thread;
1205   tcp_connection_t *tc __attribute__ ((unused));
1206   u32 preallocated_connections_per_thread;
1207
1208   if ((error = vlib_call_init_function (vm, ip_main_init)))
1209     return error;
1210   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1211     return error;
1212   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1213     return error;
1214
1215   /*
1216    * Registrations
1217    */
1218
1219   /* Register with IP */
1220   pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1221   if (pi == 0)
1222     return clib_error_return (0, "TCP protocol info AWOL");
1223   pi->format_header = format_tcp_header;
1224   pi->unformat_pg_edit = unformat_pg_tcp_header;
1225
1226   ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1227
1228   /* Register as transport with session layer */
1229   session_register_transport (TRANSPORT_PROTO_TCP, 1, &tcp_proto);
1230   session_register_transport (TRANSPORT_PROTO_TCP, 0, &tcp_proto);
1231
1232   /*
1233    * Initialize data structures
1234    */
1235
1236   num_threads = 1 /* main thread */  + vtm->n_threads;
1237   vec_validate (tm->connections, num_threads - 1);
1238
1239   /*
1240    * Preallocate connections. Assume that thread 0 won't
1241    * use preallocated threads when running multi-core
1242    */
1243   if (num_threads == 1)
1244     {
1245       thread = 0;
1246       preallocated_connections_per_thread = tm->preallocated_connections;
1247     }
1248   else
1249     {
1250       thread = 1;
1251       preallocated_connections_per_thread =
1252         tm->preallocated_connections / (num_threads - 1);
1253     }
1254   for (; thread < num_threads; thread++)
1255     {
1256       for (i = 0; i < preallocated_connections_per_thread; i++)
1257         pool_get (tm->connections[thread], tc);
1258
1259       for (i = 0; i < preallocated_connections_per_thread; i++)
1260         pool_put_index (tm->connections[thread], i);
1261     }
1262
1263   /*
1264    * Preallocate half-open connections
1265    */
1266   for (i = 0; i < tm->preallocated_half_open_connections; i++)
1267     pool_get (tm->half_open_connections, tc);
1268
1269   for (i = 0; i < tm->preallocated_half_open_connections; i++)
1270     pool_put_index (tm->half_open_connections, i);
1271
1272   /* Initialize per worker thread tx buffers (used for control messages) */
1273   vec_validate (tm->tx_buffers, num_threads - 1);
1274
1275   /* Initialize timer wheels */
1276   vec_validate (tm->timer_wheels, num_threads - 1);
1277   tcp_initialize_timer_wheels (tm);
1278
1279   /* Initialize clocks per tick for TCP timestamp. Used to compute
1280    * monotonically increasing timestamps. */
1281   tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1282     / TCP_TSTAMP_RESOLUTION;
1283
1284   clib_bihash_init_24_8 (&tm->local_endpoints_table, "local endpoint table",
1285                          1000000 /* $$$$ config parameter nbuckets */ ,
1286                          (512 << 20) /*$$$ config parameter table size */ );
1287
1288   /* Initialize [port-allocator] random number seed */
1289   tm->port_allocator_seed = (u32) clib_cpu_time_now ();
1290
1291   if (num_threads > 1)
1292     {
1293       clib_spinlock_init (&tm->half_open_lock);
1294       clib_spinlock_init (&tm->local_endpoints_lock);
1295     }
1296
1297   vec_validate (tm->tx_frames[0], num_threads - 1);
1298   vec_validate (tm->tx_frames[1], num_threads - 1);
1299
1300   tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1301     (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1302
1303   vec_validate (tm->time_now, num_threads - 1);
1304   return error;
1305 }
1306
1307 clib_error_t *
1308 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1309 {
1310   if (is_en)
1311     {
1312       if (tcp_main.is_enabled)
1313         return 0;
1314
1315       return tcp_main_enable (vm);
1316     }
1317   else
1318     {
1319       tcp_main.is_enabled = 0;
1320     }
1321
1322   return 0;
1323 }
1324
1325 clib_error_t *
1326 tcp_init (vlib_main_t * vm)
1327 {
1328   tcp_main_t *tm = vnet_get_tcp_main ();
1329   tm->is_enabled = 0;
1330   return 0;
1331 }
1332
1333 VLIB_INIT_FUNCTION (tcp_init);
1334
1335 static clib_error_t *
1336 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1337 {
1338   tcp_main_t *tm = vnet_get_tcp_main ();
1339
1340   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1341     {
1342       if (unformat
1343           (input, "preallocated-connections %d",
1344            &tm->preallocated_connections))
1345         ;
1346       else if (unformat (input, "preallocated-half-open-connections %d",
1347                          &tm->preallocated_half_open_connections))
1348         ;
1349       else
1350         return clib_error_return (0, "unknown input `%U'",
1351                                   format_unformat_error, input);
1352     }
1353   return 0;
1354 }
1355
1356 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1357
1358 static clib_error_t *
1359 tcp_src_address (vlib_main_t * vm,
1360                  unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1361 {
1362   tcp_main_t *tm = vnet_get_tcp_main ();
1363   ip4_address_t v4start, v4end;
1364   ip6_address_t v6start, v6end;
1365   int v4set = 0;
1366   int v6set = 0;
1367
1368   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1369     {
1370       if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1371                     unformat_ip4_address, &v4end))
1372         v4set = 1;
1373       else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1374         {
1375           memcpy (&v4end, &v4start, sizeof (v4start));
1376           v4set = 1;
1377         }
1378       else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1379                          unformat_ip4_address, &v6end))
1380         v6set = 1;
1381       else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1382         {
1383           memcpy (&v6end, &v6start, sizeof (v4start));
1384           v6set = 1;
1385         }
1386       else
1387         break;
1388     }
1389
1390   if (!v4set && !v6set)
1391     return clib_error_return (0, "at least one v4 or v6 address required");
1392
1393   if (v4set)
1394     {
1395       u32 tmp;
1396
1397       do
1398         {
1399           vec_add1 (tm->ip4_src_addresses, v4start);
1400           tmp = clib_net_to_host_u32 (v4start.as_u32);
1401           tmp++;
1402           v4start.as_u32 = clib_host_to_net_u32 (tmp);
1403         }
1404       while (clib_host_to_net_u32 (v4start.as_u32) <=
1405              clib_host_to_net_u32 (v4end.as_u32));
1406     }
1407   if (v6set)
1408     {
1409       clib_warning ("v6 src address list unimplemented...");
1410     }
1411   return 0;
1412 }
1413
1414 /* *INDENT-OFF* */
1415 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1416 {
1417   .path = "tcp src-address",
1418   .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1419   .function = tcp_src_address,
1420 };
1421 /* *INDENT-ON* */
1422
1423 static u8 *
1424 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1425 {
1426 #if TCP_SCOREBOARD_TRACE
1427
1428   scoreboard_trace_elt_t *block;
1429   int i = 0;
1430
1431   if (!sb->trace)
1432     return s;
1433
1434   s = format (s, "scoreboard trace:");
1435   vec_foreach (block, sb->trace)
1436   {
1437     s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1438                 block->ack, block->snd_una_max, block->group);
1439     if ((++i % 3) == 0)
1440       s = format (s, "\n");
1441   }
1442   return s;
1443 #else
1444   return 0;
1445 #endif
1446 }
1447
1448 static clib_error_t *
1449 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1450                               vlib_cli_command_t * cmd_arg)
1451 {
1452   transport_connection_t *tconn = 0;
1453   tcp_connection_t *tc;
1454   u8 *s = 0;
1455   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1456     {
1457       if (unformat (input, "%U", unformat_transport_connection, &tconn,
1458                     TRANSPORT_PROTO_TCP))
1459         ;
1460       else
1461         return clib_error_return (0, "unknown input `%U'",
1462                                   format_unformat_error, input);
1463     }
1464
1465   if (!TCP_SCOREBOARD_TRACE)
1466     {
1467       vlib_cli_output (vm, "scoreboard tracing not enabled");
1468       return 0;
1469     }
1470
1471   tc = tcp_get_connection_from_transport (tconn);
1472   s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1473   vlib_cli_output (vm, "%v", s);
1474   return 0;
1475 }
1476
1477 /* *INDENT-OFF* */
1478 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1479 {
1480   .path = "show tcp scoreboard trace",
1481   .short_help = "show tcp scoreboard trace <connection>",
1482   .function = tcp_show_scoreboard_trace_fn,
1483 };
1484 /* *INDENT-ON* */
1485
1486 u8 *
1487 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1488 {
1489   int i, trace_len;
1490   scoreboard_trace_elt_t *trace;
1491   u32 next_ack, left, group, has_new_ack = 0;
1492   tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1493   sack_block_t *block;
1494
1495   if (!tc)
1496     return s;
1497
1498   memset (dummy_tc, 0, sizeof (*dummy_tc));
1499   tcp_connection_timers_init (dummy_tc);
1500   scoreboard_init (&dummy_tc->sack_sb);
1501   dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1502
1503 #if TCP_SCOREBOARD_TRACE
1504   trace = tc->sack_sb.trace;
1505   trace_len = vec_len (tc->sack_sb.trace);
1506 #else
1507   trace = 0;
1508   trace_len = 0;
1509 #endif
1510
1511   for (i = 0; i < trace_len; i++)
1512     {
1513       if (trace[i].ack != 0)
1514         {
1515           dummy_tc->snd_una = trace[i].ack - 1448;
1516           dummy_tc->snd_una_max = trace[i].ack;
1517         }
1518     }
1519
1520   left = 0;
1521   while (left < trace_len)
1522     {
1523       group = trace[left].group;
1524       vec_reset_length (dummy_tc->rcv_opts.sacks);
1525       has_new_ack = 0;
1526       while (trace[left].group == group)
1527         {
1528           if (trace[left].ack != 0)
1529             {
1530               if (verbose)
1531                 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1532                             trace[left].ack, trace[left].snd_una_max);
1533               dummy_tc->snd_una_max = trace[left].snd_una_max;
1534               next_ack = trace[left].ack;
1535               has_new_ack = 1;
1536             }
1537           else
1538             {
1539               if (verbose)
1540                 s = format (s, "[%u, %u], ", trace[left].start,
1541                             trace[left].end);
1542               vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1543               block->start = trace[left].start;
1544               block->end = trace[left].end;
1545             }
1546           left++;
1547         }
1548
1549       /* Push segments */
1550       tcp_rcv_sacks (dummy_tc, next_ack);
1551       if (has_new_ack)
1552         dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1553
1554       if (verbose)
1555         s = format (s, "result: %U", format_tcp_scoreboard,
1556                     &dummy_tc->sack_sb);
1557
1558     }
1559   s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1560
1561   return s;
1562 }
1563
1564 static clib_error_t *
1565 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1566                          vlib_cli_command_t * cmd_arg)
1567 {
1568   transport_connection_t *tconn = 0;
1569   tcp_connection_t *tc = 0;
1570   u8 *str = 0;
1571   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1572     {
1573       if (unformat (input, "%U", unformat_transport_connection, &tconn,
1574                     TRANSPORT_PROTO_TCP))
1575         ;
1576       else
1577         return clib_error_return (0, "unknown input `%U'",
1578                                   format_unformat_error, input);
1579     }
1580
1581   if (!TCP_SCOREBOARD_TRACE)
1582     {
1583       vlib_cli_output (vm, "scoreboard tracing not enabled");
1584       return 0;
1585     }
1586
1587   tc = tcp_get_connection_from_transport (tconn);
1588   if (!tc)
1589     {
1590       vlib_cli_output (vm, "connection not found");
1591       return 0;
1592     }
1593   str = tcp_scoreboard_replay (str, tc, 1);
1594   vlib_cli_output (vm, "%v", str);
1595   return 0;
1596 }
1597
1598 /* *INDENT-OFF* */
1599 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1600 {
1601   .path = "tcp replay scoreboard",
1602   .short_help = "tcp replay scoreboard <connection>",
1603   .function = tcp_scoreboard_trace_fn,
1604 };
1605 /* *INDENT-ON* */
1606
1607 /*
1608  * fd.io coding-style-patch-verification: ON
1609  *
1610  * Local Variables:
1611  * eval: (c-set-style "gnu")
1612  * End:
1613  */