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