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 <math.h>
  20
  21 tcp_main_t tcp_main;
  22
  23 static u32
  24 tcp_connection_bind (u32 session_index, ip46_address_t * ip,
  25                      u16 port_host_byte_order, u8 is_ip4)
  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 (port_host_byte_order);
  35
  36   if (is_ip4)
  37     {
  38       listener->c_lcl_ip4.as_u32 = ip->ip4.as_u32;
  39       listener->c_is_ip4 = 1;
  40       listener->c_proto = SESSION_TYPE_IP4_TCP;
  41     }
  42   else
  43     {
  44       clib_memcpy (&listener->c_lcl_ip6, &ip->ip6, sizeof (ip6_address_t));
  45       listener->c_proto = SESSION_TYPE_IP6_TCP;
  46     }
  47
  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_ip4 (u32 session_index, ip46_address_t * ip,
  60                       u16 port_host_byte_order)
  61 {
  62   return tcp_connection_bind (session_index, ip, port_host_byte_order, 1);
  63 }
  64
  65 u32
  66 tcp_session_bind_ip6 (u32 session_index, ip46_address_t * ip,
  67                       u16 port_host_byte_order)
  68 {
  69   return tcp_connection_bind (session_index, ip, port_host_byte_order, 0);
  70 }
  71
  72 static void
  73 tcp_connection_unbind (u32 listener_index)
  74 {
  75   tcp_main_t *tm = vnet_get_tcp_main ();
  76   TCP_EVT_DBG (TCP_EVT_UNBIND,
  77                pool_elt_at_index (tm->listener_pool, listener_index));
  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 /**
  98  * Cleans up connection state.
  99  *
 100  * No notifications.
 101  */
 102 void
 103 tcp_connection_cleanup (tcp_connection_t * tc)
 104 {
 105   tcp_main_t *tm = &tcp_main;
 106   u32 tepi;
 107   transport_endpoint_t *tep;
 108
 109   /* Cleanup local endpoint if this was an active connect */
 110   tepi = transport_endpoint_lookup (&tm->local_endpoints_table, &tc->c_lcl_ip,
 111                                     tc->c_lcl_port);
 112
 113   /*XXX lock */
 114   if (tepi != TRANSPORT_ENDPOINT_INVALID_INDEX)
 115     {
 116       tep = pool_elt_at_index (tm->local_endpoints, tepi);
 117       transport_endpoint_table_del (&tm->local_endpoints_table, tep);
 118       pool_put (tm->local_endpoints, tep);
 119     }
 120
 121   /* Make sure all timers are cleared */
 122   tcp_connection_timers_reset (tc);
 123
 124   /* Check if half-open */
 125   if (tc->state == TCP_STATE_SYN_SENT)
 126     pool_put (tm->half_open_connections, tc);
 127   else
 128     pool_put (tm->connections[tc->c_thread_index], tc);
 129 }
 130
 131 /**
 132  * Connection removal.
 133  *
 134  * This should be called only once connection enters CLOSED state. Note
 135  * that it notifies the session of the removal event, so if the goal is to
 136  * just remove the connection, call tcp_connection_cleanup instead.
 137  */
 138 void
 139 tcp_connection_del (tcp_connection_t * tc)
 140 {
 141   TCP_EVT_DBG (TCP_EVT_DELETE, tc);
 142   stream_session_delete_notify (&tc->connection);
 143   tcp_connection_cleanup (tc);
 144 }
 145
 146 /** Notify session that connection has been reset.
 147  *
 148  * Switch state to closed and wait for session to call cleanup.
 149  */
 150 void
 151 tcp_connection_reset (tcp_connection_t * tc)
 152 {
 153   if (tc->state == TCP_STATE_CLOSED)
 154     return;
 155
 156   tc->state = TCP_STATE_CLOSED;
 157   stream_session_reset_notify (&tc->connection);
 158 }
 159
 160 /**
 161  * Begin connection closing procedure.
 162  *
 163  * If at the end the connection is not in CLOSED state, it is not removed.
 164  * Instead, we rely on on TCP to advance through state machine to either
 165  * 1) LAST_ACK (passive close) whereby when the last ACK is received
 166  * tcp_connection_del is called. This notifies session of the delete and
 167  * calls cleanup.
 168  * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
 169  * and cleanup is called.
 170  *
 171  * N.B. Half-close connections are not supported
 172  */
 173 void
 174 tcp_connection_close (tcp_connection_t * tc)
 175 {
 176   TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
 177
 178   /* Send FIN if needed */
 179   if (tc->state == TCP_STATE_ESTABLISHED || tc->state == TCP_STATE_SYN_RCVD
 180       || tc->state == TCP_STATE_CLOSE_WAIT)
 181     tcp_send_fin (tc);
 182
 183   /* Switch state */
 184   if (tc->state == TCP_STATE_ESTABLISHED || tc->state == TCP_STATE_SYN_RCVD)
 185     tc->state = TCP_STATE_FIN_WAIT_1;
 186   else if (tc->state == TCP_STATE_SYN_SENT)
 187     tc->state = TCP_STATE_CLOSED;
 188   else if (tc->state == TCP_STATE_CLOSE_WAIT)
 189     tc->state = TCP_STATE_LAST_ACK;
 190
 191   /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
 192   if (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID
 193       && tc->state == TCP_STATE_CLOSED)
 194     tcp_connection_del (tc);
 195 }
 196
 197 void
 198 tcp_session_close (u32 conn_index, u32 thread_index)
 199 {
 200   tcp_connection_t *tc;
 201   tc = tcp_connection_get (conn_index, thread_index);
 202   tcp_connection_close (tc);
 203 }
 204
 205 void
 206 tcp_session_cleanup (u32 conn_index, u32 thread_index)
 207 {
 208   tcp_connection_t *tc;
 209   tc = tcp_connection_get (conn_index, thread_index);
 210
 211   /* Wait for the session tx events to clear */
 212   tc->state = TCP_STATE_CLOSED;
 213   tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
 214 }
 215
 216 void *
 217 ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4)
 218 {
 219   ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
 220   ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
 221   ip_interface_address_t *ia = 0;
 222
 223   if (is_ip4)
 224     {
 225       /* *INDENT-OFF* */
 226       foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
 227       ({
 228         return ip_interface_address_get_address (lm4, ia);
 229       }));
 230       /* *INDENT-ON* */
 231     }
 232   else
 233     {
 234       /* *INDENT-OFF* */
 235       foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
 236       ({
 237         return ip_interface_address_get_address (lm6, ia);
 238       }));
 239       /* *INDENT-ON* */
 240     }
 241
 242   return 0;
 243 }
 244
 245 #define PORT_MASK ((1 << 16)- 1)
 246 /**
 247  * Allocate local port and add if successful add entry to local endpoint
 248  * table to mark the pair as used.
 249  */
 250 u16
 251 tcp_allocate_local_port (tcp_main_t * tm, ip46_address_t * ip)
 252 {
 253   transport_endpoint_t *tep;
 254   u32 time_now, tei;
 255   u16 min = 1024, max = 65535;  /* XXX configurable ? */
 256   int tries;
 257
 258   tries = max - min;
 259   time_now = tcp_time_now ();
 260
 261   /* Start at random point or max */
 262   pool_get (tm->local_endpoints, tep);
 263   clib_memcpy (&tep->ip, ip, sizeof (*ip));
 264
 265   /* Search for first free slot */
 266   for (; tries >= 0; tries--)
 267     {
 268       u16 port = 0;
 269
 270       /* Find a port in the specified range */
 271       while (1)
 272         {
 273           port = random_u32 (&time_now) & PORT_MASK;
 274           if (PREDICT_TRUE (port >= min && port < max))
 275             break;
 276         }
 277
 278       tep->port = port;
 279
 280       /* Look it up */
 281       tei = transport_endpoint_lookup (&tm->local_endpoints_table, &tep->ip,
 282                                        tep->port);
 283       /* If not found, we're done */
 284       if (tei == TRANSPORT_ENDPOINT_INVALID_INDEX)
 285         {
 286           transport_endpoint_table_add (&tm->local_endpoints_table, tep,
 287                                         tep - tm->local_endpoints);
 288           return tep->port;
 289         }
 290     }
 291   /* No free ports */
 292   pool_put (tm->local_endpoints, tep);
 293   return -1;
 294 }
 295
 296 /**
 297  * Initialize all connection timers as invalid
 298  */
 299 void
 300 tcp_connection_timers_init (tcp_connection_t * tc)
 301 {
 302   int i;
 303
 304   /* Set all to invalid */
 305   for (i = 0; i < TCP_N_TIMERS; i++)
 306     {
 307       tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
 308     }
 309
 310   tc->rto = TCP_RTO_INIT;
 311 }
 312
 313 /**
 314  * Stop all connection timers
 315  */
 316 void
 317 tcp_connection_timers_reset (tcp_connection_t * tc)
 318 {
 319   int i;
 320   for (i = 0; i < TCP_N_TIMERS; i++)
 321     {
 322       tcp_timer_reset (tc, i);
 323     }
 324 }
 325
 326 /** Initialize tcp connection variables
 327  *
 328  * Should be called after having received a msg from the peer, i.e., a SYN or
 329  * a SYNACK, such that connection options have already been exchanged. */
 330 void
 331 tcp_connection_init_vars (tcp_connection_t * tc)
 332 {
 333   tcp_connection_timers_init (tc);
 334   tcp_set_snd_mss (tc);
 335   scoreboard_init (&tc->sack_sb);
 336   tcp_cc_init (tc);
 337 }
 338
 339 int
 340 tcp_connection_open (ip46_address_t * rmt_addr, u16 rmt_port, u8 is_ip4)
 341 {
 342   tcp_main_t *tm = vnet_get_tcp_main ();
 343   tcp_connection_t *tc;
 344   fib_prefix_t prefix;
 345   u32 fei, sw_if_index;
 346   ip46_address_t lcl_addr;
 347   u16 lcl_port;
 348
 349   /*
 350    * Find the local address and allocate port
 351    */
 352   memset (&lcl_addr, 0, sizeof (lcl_addr));
 353
 354   /* Find a FIB path to the destination */
 355   clib_memcpy (&prefix.fp_addr, rmt_addr, sizeof (*rmt_addr));
 356   prefix.fp_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 357   prefix.fp_len = is_ip4 ? 32 : 128;
 358
 359   fei = fib_table_lookup (0, &prefix);
 360
 361   /* Couldn't find route to destination. Bail out. */
 362   if (fei == FIB_NODE_INDEX_INVALID)
 363     return -1;
 364
 365   sw_if_index = fib_entry_get_resolving_interface (fei);
 366
 367   if (sw_if_index == (u32) ~ 0)
 368     return -1;
 369
 370   if (is_ip4)
 371     {
 372       ip4_address_t *ip4;
 373       ip4 = ip_interface_get_first_ip (sw_if_index, 1);
 374       lcl_addr.ip4.as_u32 = ip4->as_u32;
 375     }
 376   else
 377     {
 378       ip6_address_t *ip6;
 379       ip6 = ip_interface_get_first_ip (sw_if_index, 0);
 380       clib_memcpy (&lcl_addr.ip6, ip6, sizeof (*ip6));
 381     }
 382
 383   /* Allocate source port */
 384   lcl_port = tcp_allocate_local_port (tm, &lcl_addr);
 385   if (lcl_port < 1)
 386     {
 387       clib_warning ("Failed to allocate src port");
 388       return -1;
 389     }
 390
 391   /*
 392    * Create connection and send SYN
 393    */
 394
 395   pool_get (tm->half_open_connections, tc);
 396   memset (tc, 0, sizeof (*tc));
 397
 398   clib_memcpy (&tc->c_rmt_ip, rmt_addr, sizeof (ip46_address_t));
 399   clib_memcpy (&tc->c_lcl_ip, &lcl_addr, sizeof (ip46_address_t));
 400   tc->c_rmt_port = clib_host_to_net_u16 (rmt_port);
 401   tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
 402   tc->c_c_index = tc - tm->half_open_connections;
 403   tc->c_is_ip4 = is_ip4;
 404   tc->c_proto = is_ip4 ? SESSION_TYPE_IP4_TCP : SESSION_TYPE_IP6_TCP;
 405
 406   /* The other connection vars will be initialized after SYN ACK */
 407   tcp_connection_timers_init (tc);
 408
 409   tcp_send_syn (tc);
 410
 411   tc->state = TCP_STATE_SYN_SENT;
 412
 413   TCP_EVT_DBG (TCP_EVT_OPEN, tc);
 414
 415   return tc->c_c_index;
 416 }
 417
 418 int
 419 tcp_session_open_ip4 (ip46_address_t * addr, u16 port)
 420 {
 421   return tcp_connection_open (addr, port, 1);
 422 }
 423
 424 int
 425 tcp_session_open_ip6 (ip46_address_t * addr, u16 port)
 426 {
 427   return tcp_connection_open (addr, port, 0);
 428 }
 429
 430 const char *tcp_dbg_evt_str[] = {
 431 #define _(sym, str) str,
 432   foreach_tcp_dbg_evt
 433 #undef _
 434 };
 435
 436 const char *tcp_fsm_states[] = {
 437 #define _(sym, str) str,
 438   foreach_tcp_fsm_state
 439 #undef _
 440 };
 441
 442 u8 *
 443 format_tcp_state (u8 * s, va_list * args)
 444 {
 445   tcp_state_t *state = va_arg (*args, tcp_state_t *);
 446
 447   if (*state < TCP_N_STATES)
 448     s = format (s, "%s", tcp_fsm_states[*state]);
 449   else
 450     s = format (s, "UNKNOWN (%d (0x%x))", *state, *state);
 451
 452   return s;
 453 }
 454
 455 const char *tcp_conn_timers[] = {
 456 #define _(sym, str) str,
 457   foreach_tcp_timer
 458 #undef _
 459 };
 460
 461 u8 *
 462 format_tcp_timers (u8 * s, va_list * args)
 463 {
 464   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 465   int i, last = 0;
 466
 467   for (i = 0; i < TCP_N_TIMERS; i++)
 468     if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
 469       last = i;
 470
 471   s = format (s, "[");
 472   for (i = 0; i < last; i++)
 473     {
 474       if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
 475         s = format (s, "%s,", tcp_conn_timers[i]);
 476     }
 477
 478   if (last > 0)
 479     s = format (s, "%s]", tcp_conn_timers[i]);
 480   else
 481     s = format (s, "]");
 482
 483   return s;
 484 }
 485
 486 u8 *
 487 format_tcp_connection (u8 * s, va_list * args)
 488 {
 489   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 490   if (!tc)
 491     return s;
 492   if (tc->c_is_ip4)
 493     {
 494       s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
 495                   format_ip4_address, &tc->c_lcl_ip4,
 496                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
 497                   &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
 498     }
 499   else
 500     {
 501       s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
 502                   format_ip6_address, &tc->c_lcl_ip6,
 503                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
 504                   &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
 505     }
 506
 507   return s;
 508 }
 509
 510 u8 *
 511 format_tcp_connection_verbose (u8 * s, va_list * args)
 512 {
 513   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
 514   s = format (s, "%U %U %U", format_tcp_connection, tc, format_tcp_state,
 515               &tc->state, format_tcp_timers, tc);
 516   return s;
 517 }
 518
 519 u8 *
 520 format_tcp_session (u8 * s, va_list * args)
 521 {
 522   u32 tci = va_arg (*args, u32);
 523   u32 thread_index = va_arg (*args, u32);
 524   tcp_connection_t *tc;
 525
 526   tc = tcp_connection_get (tci, thread_index);
 527   if (tc)
 528     return format (s, "%U", format_tcp_connection, tc);
 529   else
 530     return format (s, "empty");
 531 }
 532
 533 u8 *
 534 format_tcp_listener_session (u8 * s, va_list * args)
 535 {
 536   u32 tci = va_arg (*args, u32);
 537   tcp_connection_t *tc = tcp_listener_get (tci);
 538   return format (s, "%U", format_tcp_connection, tc);
 539 }
 540
 541 u8 *
 542 format_tcp_half_open_session (u8 * s, va_list * args)
 543 {
 544   u32 tci = va_arg (*args, u32);
 545   tcp_connection_t *tc = tcp_half_open_connection_get (tci);
 546   return format (s, "%U", format_tcp_connection, tc);
 547 }
 548
 549 transport_connection_t *
 550 tcp_session_get_transport (u32 conn_index, u32 thread_index)
 551 {
 552   tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
 553   return &tc->connection;
 554 }
 555
 556 transport_connection_t *
 557 tcp_half_open_session_get_transport (u32 conn_index)
 558 {
 559   tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
 560   return &tc->connection;
 561 }
 562
 563 u16
 564 tcp_session_send_mss (transport_connection_t * trans_conn)
 565 {
 566   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
 567   return tc->snd_mss;
 568 }
 569
 570 always_inline u32
 571 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
 572 {
 573   if (tc->snd_wnd < tc->snd_mss)
 574     {
 575       return tc->snd_wnd < snd_space ? tc->snd_wnd : 0;
 576     }
 577
 578   /* If we can't write at least a segment, don't try at all */
 579   if (snd_space < tc->snd_mss)
 580     return 0;
 581
 582   /* round down to mss multiple */
 583   return snd_space - (snd_space % tc->snd_mss);
 584 }
 585
 586 /**
 587  * Compute tx window session is allowed to fill.
 588  */
 589 u32
 590 tcp_session_send_space (transport_connection_t * trans_conn)
 591 {
 592   int snd_space;
 593   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
 594
 595   /* If we haven't gotten dupacks or if we did and have gotten sacked bytes
 596    * then we can still send */
 597   if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0
 598                     && (tc->rcv_dupacks == 0
 599                         || tc->sack_sb.last_sacked_bytes)))
 600     {
 601       snd_space = tcp_available_snd_space (tc);
 602       return tcp_round_snd_space (tc, snd_space);
 603     }
 604
 605   if (tcp_in_recovery (tc))
 606     {
 607       tc->snd_nxt = tc->snd_una_max;
 608       snd_space = tcp_available_wnd (tc) - tc->rtx_bytes
 609         - (tc->snd_una_max - tc->snd_congestion);
 610       if (snd_space <= 0)
 611         return 0;
 612       return tcp_round_snd_space (tc, snd_space);
 613     }
 614
 615   /* If in fast recovery, send 1 SMSS if wnd allows */
 616   if (tcp_in_fastrecovery (tc) && tcp_available_snd_space (tc)
 617       && tcp_fastrecovery_sent_1_smss (tc))
 618     {
 619       tcp_fastrecovery_1_smss_on (tc);
 620       return tc->snd_mss;
 621     }
 622
 623   return 0;
 624 }
 625
 626 u32
 627 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
 628 {
 629   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
 630
 631   ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
 632
 633   /* This still works if fast retransmit is on */
 634   return (tc->snd_nxt - tc->snd_una);
 635 }
 636
 637 /* *INDENT-OFF* */
 638 const static transport_proto_vft_t tcp4_proto = {
 639   .bind = tcp_session_bind_ip4,
 640   .unbind = tcp_session_unbind,
 641   .push_header = tcp_push_header,
 642   .get_connection = tcp_session_get_transport,
 643   .get_listener = tcp_session_get_listener,
 644   .get_half_open = tcp_half_open_session_get_transport,
 645   .open = tcp_session_open_ip4,
 646   .close = tcp_session_close,
 647   .cleanup = tcp_session_cleanup,
 648   .send_mss = tcp_session_send_mss,
 649   .send_space = tcp_session_send_space,
 650   .tx_fifo_offset = tcp_session_tx_fifo_offset,
 651   .format_connection = format_tcp_session,
 652   .format_listener = format_tcp_listener_session,
 653   .format_half_open = format_tcp_half_open_session,
 654 };
 655
 656 const static transport_proto_vft_t tcp6_proto = {
 657   .bind = tcp_session_bind_ip6,
 658   .unbind = tcp_session_unbind,
 659   .push_header = tcp_push_header,
 660   .get_connection = tcp_session_get_transport,
 661   .get_listener = tcp_session_get_listener,
 662   .get_half_open = tcp_half_open_session_get_transport,
 663   .open = tcp_session_open_ip6,
 664   .close = tcp_session_close,
 665   .cleanup = tcp_session_cleanup,
 666   .send_mss = tcp_session_send_mss,
 667   .send_space = tcp_session_send_space,
 668   .tx_fifo_offset = tcp_session_tx_fifo_offset,
 669   .format_connection = format_tcp_session,
 670   .format_listener = format_tcp_listener_session,
 671   .format_half_open = format_tcp_half_open_session,
 672 };
 673 /* *INDENT-ON* */
 674
 675 void
 676 tcp_timer_keep_handler (u32 conn_index)
 677 {
 678   u32 thread_index = vlib_get_thread_index ();
 679   tcp_connection_t *tc;
 680
 681   tc = tcp_connection_get (conn_index, thread_index);
 682   tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
 683
 684   tcp_connection_close (tc);
 685 }
 686
 687 void
 688 tcp_timer_establish_handler (u32 conn_index)
 689 {
 690   tcp_connection_t *tc;
 691   u8 sst;
 692
 693   tc = tcp_half_open_connection_get (conn_index);
 694   tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
 695
 696   ASSERT (tc->state == TCP_STATE_SYN_SENT);
 697
 698   sst = tc->c_is_ip4 ? SESSION_TYPE_IP4_TCP : SESSION_TYPE_IP6_TCP;
 699   stream_session_connect_notify (&tc->connection, sst, 1 /* fail */ );
 700
 701   tcp_connection_cleanup (tc);
 702 }
 703
 704 void
 705 tcp_timer_waitclose_handler (u32 conn_index)
 706 {
 707   u32 thread_index = vlib_get_thread_index ();
 708   tcp_connection_t *tc;
 709
 710   tc = tcp_connection_get (conn_index, thread_index);
 711   tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
 712
 713   /* Session didn't come back with a close(). Send FIN either way
 714    * and switch to LAST_ACK. */
 715   if (tc->state == TCP_STATE_CLOSE_WAIT)
 716     {
 717       if (tc->flags & TCP_CONN_FINSNT)
 718         {
 719           clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
 720         }
 721
 722       tcp_send_fin (tc);
 723       tc->state = TCP_STATE_LAST_ACK;
 724
 725       /* Make sure we don't wait in LAST ACK forever */
 726       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
 727
 728       /* Don't delete the connection yet */
 729       return;
 730     }
 731
 732   tcp_connection_del (tc);
 733 }
 734
 735 /* *INDENT-OFF* */
 736 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
 737 {
 738     tcp_timer_retransmit_handler,
 739     tcp_timer_delack_handler,
 740     tcp_timer_persist_handler,
 741     tcp_timer_keep_handler,
 742     tcp_timer_waitclose_handler,
 743     tcp_timer_retransmit_syn_handler,
 744     tcp_timer_establish_handler
 745 };
 746 /* *INDENT-ON* */
 747
 748 static void
 749 tcp_expired_timers_dispatch (u32 * expired_timers)
 750 {
 751   int i;
 752   u32 connection_index, timer_id;
 753
 754   for (i = 0; i < vec_len (expired_timers); i++)
 755     {
 756       /* Get session index and timer id */
 757       connection_index = expired_timers[i] & 0x0FFFFFFF;
 758       timer_id = expired_timers[i] >> 28;
 759
 760       TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
 761
 762       /* Handle expiration */
 763       (*timer_expiration_handlers[timer_id]) (connection_index);
 764     }
 765 }
 766
 767 void
 768 tcp_initialize_timer_wheels (tcp_main_t * tm)
 769 {
 770   tw_timer_wheel_16t_2w_512sl_t *tw;
 771   /* *INDENT-OFF* */
 772   foreach_vlib_main (({
 773     tw = &tm->timer_wheels[ii];
 774     tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
 775                                       100e-3 /* timer period 100ms */ , ~0);
 776     tw->last_run_time = vlib_time_now (this_vlib_main);
 777   }));
 778   /* *INDENT-ON* */
 779 }
 780
 781 clib_error_t *
 782 tcp_main_enable (vlib_main_t * vm)
 783 {
 784   tcp_main_t *tm = vnet_get_tcp_main ();
 785   ip_protocol_info_t *pi;
 786   ip_main_t *im = &ip_main;
 787   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 788   clib_error_t *error = 0;
 789   u32 num_threads;
 790
 791   if ((error = vlib_call_init_function (vm, ip_main_init)))
 792     return error;
 793   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
 794     return error;
 795   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
 796     return error;
 797
 798   /*
 799    * Registrations
 800    */
 801
 802   /* Register with IP */
 803   pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
 804   if (pi == 0)
 805     return clib_error_return (0, "TCP protocol info AWOL");
 806   pi->format_header = format_tcp_header;
 807   pi->unformat_pg_edit = unformat_pg_tcp_header;
 808
 809   ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
 810
 811   /* Register as transport with URI */
 812   session_register_transport (SESSION_TYPE_IP4_TCP, &tcp4_proto);
 813   session_register_transport (SESSION_TYPE_IP6_TCP, &tcp6_proto);
 814
 815   /*
 816    * Initialize data structures
 817    */
 818
 819   num_threads = 1 /* main thread */  + vtm->n_threads;
 820   vec_validate (tm->connections, num_threads - 1);
 821
 822   /* Initialize per worker thread tx buffers (used for control messages) */
 823   vec_validate (tm->tx_buffers, num_threads - 1);
 824
 825   /* Initialize timer wheels */
 826   vec_validate (tm->timer_wheels, num_threads - 1);
 827   tcp_initialize_timer_wheels (tm);
 828
 829 //  vec_validate (tm->delack_connections, num_threads - 1);
 830
 831   /* Initialize clocks per tick for TCP timestamp. Used to compute
 832    * monotonically increasing timestamps. */
 833   tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
 834     / TCP_TSTAMP_RESOLUTION;
 835
 836   clib_bihash_init_24_8 (&tm->local_endpoints_table, "local endpoint table",
 837                          200000 /* $$$$ config parameter nbuckets */ ,
 838                          (64 << 20) /*$$$ config parameter table size */ );
 839
 840   return error;
 841 }
 842
 843 clib_error_t *
 844 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
 845 {
 846   if (is_en)
 847     {
 848       if (tcp_main.is_enabled)
 849         return 0;
 850
 851       return tcp_main_enable (vm);
 852     }
 853   else
 854     {
 855       tcp_main.is_enabled = 0;
 856     }
 857
 858   return 0;
 859 }
 860
 861 clib_error_t *
 862 tcp_init (vlib_main_t * vm)
 863 {
 864   tcp_main_t *tm = vnet_get_tcp_main ();
 865
 866   tm->vlib_main = vm;
 867   tm->vnet_main = vnet_get_main ();
 868   tm->is_enabled = 0;
 869
 870   return 0;
 871 }
 872
 873 VLIB_INIT_FUNCTION (tcp_init);
 874
 875 /*
 876  * fd.io coding-style-patch-verification: ON
 877  *
 878  * Local Variables:
 879  * eval: (c-set-style "gnu")
 880  * End:
 881  */