2 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @brief TCP host stack utilities
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>
28 #include <vnet/ethernet/arp.h>
34 fib_protocol_t nh_proto;
35 vnet_link_t link_type;
39 } tcp_add_del_adj_args_t;
42 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
47 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
52 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
54 if (ai != ADJ_INDEX_INVALID)
60 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
62 tcp_add_del_adj_args_t args = {
63 .nh_proto = FIB_PROTOCOL_IP6,
64 .link_type = VNET_LINK_IP6,
66 .sw_if_index = tc->sw_if_index,
69 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
74 tcp_cc_init (tcp_connection_t * tc)
76 tc->cc_algo->init (tc);
80 tcp_cc_cleanup (tcp_connection_t * tc)
82 if (tc->cc_algo->cleanup)
83 tc->cc_algo->cleanup (tc);
87 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
88 const tcp_cc_algorithm_t * vft)
90 tcp_main_t *tm = vnet_get_tcp_main ();
91 vec_validate (tm->cc_algos, type);
93 tm->cc_algos[type] = *vft;
94 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
98 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
100 tcp_main_t *tm = vnet_get_tcp_main ();
101 return &tm->cc_algos[type];
104 tcp_cc_algorithm_type_e
105 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
107 tcp_main_t *tm = vnet_get_tcp_main ();
108 tcp_cc_algo_register (++tm->cc_last_type, vft);
109 return tm->cc_last_type;
113 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
115 tcp_main_t *tm = &tcp_main;
116 tcp_connection_t *listener;
119 pool_get (tm->listener_pool, listener);
120 clib_memset (listener, 0, sizeof (*listener));
122 listener->c_c_index = listener - tm->listener_pool;
123 listener->c_lcl_port = lcl->port;
125 /* If we are provided a sw_if_index, bind using one of its ips */
126 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
128 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
130 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
132 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
133 listener->c_is_ip4 = lcl->is_ip4;
134 listener->c_proto = TRANSPORT_PROTO_TCP;
135 listener->c_s_index = session_index;
136 listener->c_fib_index = lcl->fib_index;
137 listener->state = TCP_STATE_LISTEN;
138 listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
140 tcp_connection_timers_init (listener);
142 TCP_EVT (TCP_EVT_BIND, listener);
144 return listener->c_c_index;
148 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
150 return tcp_connection_bind (session_index, tep);
154 tcp_connection_unbind (u32 listener_index)
156 tcp_main_t *tm = vnet_get_tcp_main ();
157 tcp_connection_t *tc;
159 tc = pool_elt_at_index (tm->listener_pool, listener_index);
161 TCP_EVT (TCP_EVT_UNBIND, tc);
163 /* Poison the entry */
165 clib_memset (tc, 0xFA, sizeof (*tc));
167 pool_put_index (tm->listener_pool, listener_index);
171 tcp_session_unbind (u32 listener_index)
173 tcp_connection_unbind (listener_index);
177 static transport_connection_t *
178 tcp_session_get_listener (u32 listener_index)
180 tcp_main_t *tm = vnet_get_tcp_main ();
181 tcp_connection_t *tc;
182 tc = pool_elt_at_index (tm->listener_pool, listener_index);
183 return &tc->connection;
187 * Cleanup half-open connection
191 tcp_half_open_connection_del (tcp_connection_t * tc)
193 tcp_main_t *tm = vnet_get_tcp_main ();
194 clib_spinlock_lock_if_init (&tm->half_open_lock);
195 pool_put_index (tm->half_open_connections, tc->c_c_index);
197 clib_memset (tc, 0xFA, sizeof (*tc));
198 clib_spinlock_unlock_if_init (&tm->half_open_lock);
202 * Try to cleanup half-open connection
204 * If called from a thread that doesn't own tc, the call won't have any
207 * @param tc - connection to be cleaned up
208 * @return non-zero if cleanup failed.
211 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
213 /* Make sure this is the owning thread */
214 if (tc->c_thread_index != vlib_get_thread_index ())
216 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
217 tcp_half_open_connection_del (tc);
221 static tcp_connection_t *
222 tcp_half_open_connection_new (void)
224 tcp_main_t *tm = vnet_get_tcp_main ();
225 tcp_connection_t *tc = 0;
226 ASSERT (vlib_get_thread_index () == 0);
227 pool_get (tm->half_open_connections, tc);
228 clib_memset (tc, 0, sizeof (*tc));
229 tc->c_c_index = tc - tm->half_open_connections;
234 * Cleans up connection state.
239 tcp_connection_cleanup (tcp_connection_t * tc)
241 tcp_main_t *tm = &tcp_main;
243 TCP_EVT (TCP_EVT_DELETE, tc);
245 /* Cleanup local endpoint if this was an active connect */
246 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
249 /* Check if connection is not yet fully established */
250 if (tc->state == TCP_STATE_SYN_SENT)
252 /* Try to remove the half-open connection. If this is not the owning
253 * thread, tc won't be removed. Retransmit or establish timers will
254 * eventually expire and call again cleanup on the right thread. */
255 if (tcp_half_open_connection_cleanup (tc))
256 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
260 int thread_index = tc->c_thread_index;
262 /* Make sure all timers are cleared */
263 tcp_connection_timers_reset (tc);
265 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
266 tcp_add_del_adjacency (tc, 0);
269 vec_free (tc->snd_sacks);
270 vec_free (tc->snd_sacks_fl);
272 if (tc->flags & TCP_CONN_RATE_SAMPLE)
275 /* Poison the entry */
277 clib_memset (tc, 0xFA, sizeof (*tc));
278 pool_put (tm->connections[thread_index], tc);
283 * Connection removal.
285 * This should be called only once connection enters CLOSED state. Note
286 * that it notifies the session of the removal event, so if the goal is to
287 * just remove the connection, call tcp_connection_cleanup instead.
290 tcp_connection_del (tcp_connection_t * tc)
292 session_transport_delete_notify (&tc->connection);
293 tcp_connection_cleanup (tc);
297 tcp_connection_alloc (u8 thread_index)
299 tcp_main_t *tm = vnet_get_tcp_main ();
300 tcp_connection_t *tc;
302 pool_get (tm->connections[thread_index], tc);
303 clib_memset (tc, 0, sizeof (*tc));
304 tc->c_c_index = tc - tm->connections[thread_index];
305 tc->c_thread_index = thread_index;
310 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
312 tcp_main_t *tm = vnet_get_tcp_main ();
313 tcp_connection_t *tc;
315 pool_get (tm->connections[thread_index], tc);
316 clib_memcpy_fast (tc, base, sizeof (*tc));
317 tc->c_c_index = tc - tm->connections[thread_index];
318 tc->c_thread_index = thread_index;
323 tcp_connection_free (tcp_connection_t * tc)
325 tcp_main_t *tm = &tcp_main;
328 u8 thread_index = tc->c_thread_index;
329 clib_memset (tc, 0xFA, sizeof (*tc));
330 pool_put (tm->connections[thread_index], tc);
333 pool_put (tm->connections[tc->c_thread_index], tc);
336 /** Notify session that connection has been reset.
338 * Switch state to closed and wait for session to call cleanup.
341 tcp_connection_reset (tcp_connection_t * tc)
343 TCP_EVT (TCP_EVT_RST_RCVD, tc);
346 case TCP_STATE_SYN_RCVD:
347 /* Cleanup everything. App wasn't notified yet */
348 session_transport_delete_notify (&tc->connection);
349 tcp_connection_cleanup (tc);
351 case TCP_STATE_SYN_SENT:
352 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
353 tcp_connection_cleanup (tc);
355 case TCP_STATE_ESTABLISHED:
356 tcp_connection_timers_reset (tc);
357 /* Set the cleanup timer, in case the session layer/app don't
358 * cleanly close the connection */
359 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
360 session_transport_reset_notify (&tc->connection);
361 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
362 session_transport_closed_notify (&tc->connection);
364 case TCP_STATE_CLOSE_WAIT:
365 case TCP_STATE_FIN_WAIT_1:
366 case TCP_STATE_FIN_WAIT_2:
367 case TCP_STATE_CLOSING:
368 case TCP_STATE_LAST_ACK:
369 tcp_connection_timers_reset (tc);
370 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
371 /* Make sure we mark the session as closed. In some states we may
372 * be still trying to send data */
373 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
374 session_transport_closed_notify (&tc->connection);
376 case TCP_STATE_CLOSED:
377 case TCP_STATE_TIME_WAIT:
380 TCP_DBG ("reset state: %u", tc->state);
385 * Begin connection closing procedure.
387 * If at the end the connection is not in CLOSED state, it is not removed.
388 * Instead, we rely on on TCP to advance through state machine to either
389 * 1) LAST_ACK (passive close) whereby when the last ACK is received
390 * tcp_connection_del is called. This notifies session of the delete and
392 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
393 * and cleanup is called.
395 * N.B. Half-close connections are not supported
398 tcp_connection_close (tcp_connection_t * tc)
400 TCP_EVT (TCP_EVT_CLOSE, tc);
402 /* Send/Program FIN if needed and switch state */
405 case TCP_STATE_SYN_SENT:
406 /* Try to cleanup. If not on the right thread, mark as half-open done.
407 * Connection will be cleaned up when establish timer pops */
408 tcp_connection_cleanup (tc);
410 case TCP_STATE_SYN_RCVD:
411 tcp_connection_timers_reset (tc);
413 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
414 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
416 case TCP_STATE_ESTABLISHED:
417 /* If closing with unread data, reset the connection */
418 if (transport_max_rx_dequeue (&tc->connection))
421 tcp_connection_timers_reset (tc);
422 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
423 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
424 session_transport_closed_notify (&tc->connection);
427 if (!transport_max_tx_dequeue (&tc->connection))
430 tc->flags |= TCP_CONN_FINPNDG;
431 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
432 /* Set a timer in case the peer stops responding. Otherwise the
433 * connection will be stuck here forever. */
434 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
435 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
437 case TCP_STATE_CLOSE_WAIT:
438 if (!transport_max_tx_dequeue (&tc->connection))
441 tcp_connection_timers_reset (tc);
442 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
443 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
446 tc->flags |= TCP_CONN_FINPNDG;
448 case TCP_STATE_FIN_WAIT_1:
449 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
451 case TCP_STATE_CLOSED:
452 tcp_connection_timers_reset (tc);
453 /* Delete connection but instead of doing it now wait until next
454 * dispatch cycle to give the session layer a chance to clear
455 * unhandled events */
456 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
459 TCP_DBG ("state: %u", tc->state);
464 tcp_session_close (u32 conn_index, u32 thread_index)
466 tcp_connection_t *tc;
467 tc = tcp_connection_get (conn_index, thread_index);
468 tcp_connection_close (tc);
472 tcp_session_cleanup (u32 conn_index, u32 thread_index)
474 tcp_connection_t *tc;
475 tc = tcp_connection_get (conn_index, thread_index);
476 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
477 tcp_connection_cleanup (tc);
481 tcp_session_reset (u32 conn_index, u32 thread_index)
483 tcp_connection_t *tc;
484 tc = tcp_connection_get (conn_index, thread_index);
485 session_transport_closed_notify (&tc->connection);
487 tcp_connection_timers_reset (tc);
488 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
489 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
493 * Initialize all connection timers as invalid
496 tcp_connection_timers_init (tcp_connection_t * tc)
500 /* Set all to invalid */
501 for (i = 0; i < TCP_N_TIMERS; i++)
503 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
506 tc->rto = TCP_RTO_INIT;
510 * Stop all connection timers
513 tcp_connection_timers_reset (tcp_connection_t * tc)
516 for (i = 0; i < TCP_N_TIMERS; i++)
518 tcp_timer_reset (tc, i);
523 typedef struct ip4_tcp_hdr
529 typedef struct ip6_tcp_hdr
536 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
539 const dpo_id_t *choice;
543 lb = load_balance_get (dpo->dpoi_index);
547 clib_memset (&hdr, 0, sizeof (hdr));
548 hdr.ip.protocol = IP_PROTOCOL_TCP;
549 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
550 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
551 hdr.tcp.src_port = tc->c_lcl_port;
552 hdr.tcp.dst_port = tc->c_rmt_port;
553 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
558 clib_memset (&hdr, 0, sizeof (hdr));
559 hdr.ip.protocol = IP_PROTOCOL_TCP;
560 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
561 sizeof (ip6_address_t));
562 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
563 sizeof (ip6_address_t));
564 hdr.tcp.src_port = tc->c_lcl_port;
565 hdr.tcp.dst_port = tc->c_rmt_port;
566 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
568 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
569 dpo_copy (result, choice);
573 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
578 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
579 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
580 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
581 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
582 return fib_table_lookup (fib_index, &prefix);
586 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
588 dpo_id_t choice = DPO_INVALID;
589 u32 output_node_index;
592 fe = fib_entry_get (tc->c_rmt_fei);
593 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
596 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
599 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
600 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
604 /** Stack tcp connection on peer's fib entry.
606 * This ultimately populates the dpo the connection will use to send packets.
609 tcp_connection_fib_attach (tcp_connection_t * tc)
611 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
613 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
615 tcp_connection_stack_on_fib_entry (tc);
620 * Generate random iss as per rfc6528
623 tcp_generate_random_iss (tcp_connection_t * tc)
625 tcp_main_t *tm = &tcp_main;
629 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
631 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
632 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
634 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
635 tmp ^= tm->iss_seed.second;
636 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
637 return ((tmp >> 32) ^ (tmp & 0xffffffff));
641 * Initialize max segment size we're able to process.
643 * The value is constrained by the output interface's MTU and by the size
644 * of the IP and TCP headers (see RFC6691). It is also what we advertise
648 tcp_init_rcv_mss (tcp_connection_t * tc)
652 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
653 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
657 tcp_init_mss (tcp_connection_t * tc)
659 u16 default_min_mss = 536;
661 tcp_init_rcv_mss (tc);
663 /* TODO consider PMTU discovery */
664 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
666 if (tc->snd_mss < 45)
668 /* Assume that at least the min default mss works */
669 tc->snd_mss = default_min_mss;
670 tc->rcv_opts.mss = default_min_mss;
673 /* We should have enough space for 40 bytes of options */
674 ASSERT (tc->snd_mss > 45);
676 /* If we use timestamp option, account for it */
677 if (tcp_opts_tstamp (&tc->rcv_opts))
678 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
682 * Initialize connection send variables.
685 tcp_init_snd_vars (tcp_connection_t * tc)
688 * We use the time to randomize iss and for setting up the initial
689 * timestamp. Make sure it's updated otherwise syn and ack in the
690 * handshake may make it look as if time has flown in the opposite
693 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
695 tcp_init_rcv_mss (tc);
696 tc->iss = tcp_generate_random_iss (tc);
697 tc->snd_una = tc->iss;
698 tc->snd_nxt = tc->iss + 1;
699 tc->snd_una_max = tc->snd_nxt;
704 tcp_enable_pacing (tcp_connection_t * tc)
706 u32 initial_bucket, byte_rate;
707 initial_bucket = 16 * tc->snd_mss;
709 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
711 tc->mrtt_us = (u32) ~ 0;
714 /** Initialize tcp connection variables
716 * Should be called after having received a msg from the peer, i.e., a SYN or
717 * a SYNACK, such that connection options have already been exchanged. */
719 tcp_connection_init_vars (tcp_connection_t * tc)
721 tcp_connection_timers_init (tc);
723 scoreboard_init (&tc->sack_sb);
725 if (tc->state == TCP_STATE_SYN_RCVD)
726 tcp_init_snd_vars (tc);
728 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
729 tcp_add_del_adjacency (tc, 1);
731 /* tcp_connection_fib_attach (tc); */
733 if (transport_connection_is_tx_paced (&tc->connection)
734 || tcp_cfg.enable_tx_pacing)
735 tcp_enable_pacing (tc);
737 if (tc->flags & TCP_CONN_RATE_SAMPLE)
740 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
744 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
745 u16 * lcl_port, u8 is_ip4)
750 index = tm->last_v4_addr_rotor++;
751 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
752 tm->last_v4_addr_rotor = 0;
753 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
757 index = tm->last_v6_addr_rotor++;
758 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
759 tm->last_v6_addr_rotor = 0;
760 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
761 sizeof (ip6_address_t));
763 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
766 clib_warning ("Failed to allocate src port");
774 tcp_session_open (transport_endpoint_cfg_t * rmt)
776 tcp_main_t *tm = vnet_get_tcp_main ();
777 tcp_connection_t *tc;
778 ip46_address_t lcl_addr;
783 * Allocate local endpoint
785 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
786 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
787 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
790 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
791 rmt, &lcl_addr, &lcl_port);
797 * Create connection and send SYN
799 clib_spinlock_lock_if_init (&tm->half_open_lock);
800 tc = tcp_half_open_connection_new ();
801 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
802 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
803 tc->c_rmt_port = rmt->port;
804 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
805 tc->c_is_ip4 = rmt->is_ip4;
806 tc->c_proto = TRANSPORT_PROTO_TCP;
807 tc->c_fib_index = rmt->fib_index;
808 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
809 /* The other connection vars will be initialized after SYN ACK */
810 tcp_connection_timers_init (tc);
812 TCP_EVT (TCP_EVT_OPEN, tc);
813 tc->state = TCP_STATE_SYN_SENT;
814 tcp_init_snd_vars (tc);
816 clib_spinlock_unlock_if_init (&tm->half_open_lock);
818 return tc->c_c_index;
821 const char *tcp_fsm_states[] = {
822 #define _(sym, str) str,
823 foreach_tcp_fsm_state
828 format_tcp_state (u8 * s, va_list * args)
830 u32 state = va_arg (*args, u32);
832 if (state < TCP_N_STATES)
833 s = format (s, "%s", tcp_fsm_states[state]);
835 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
839 const char *tcp_connection_flags_str[] = {
840 #define _(sym, str) str,
841 foreach_tcp_connection_flag
846 format_tcp_connection_flags (u8 * s, va_list * args)
848 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
851 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
852 if (tc->flags & (1 << i))
854 for (i = 0; i < last; i++)
856 if (tc->flags & (1 << i))
857 s = format (s, "%s, ", tcp_connection_flags_str[i]);
860 s = format (s, "%s", tcp_connection_flags_str[last]);
864 const char *tcp_conn_timers[] = {
865 #define _(sym, str) str,
871 format_tcp_timers (u8 * s, va_list * args)
873 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
876 for (i = 0; i < TCP_N_TIMERS; i++)
877 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
880 for (i = 0; i < last; i++)
882 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
883 s = format (s, "%s,", tcp_conn_timers[i]);
887 s = format (s, "%s", tcp_conn_timers[i]);
893 format_tcp_congestion_status (u8 * s, va_list * args)
895 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
896 if (tcp_in_recovery (tc))
897 s = format (s, "recovery");
898 else if (tcp_in_fastrecovery (tc))
899 s = format (s, "fastrecovery");
901 s = format (s, "none");
906 tcp_rcv_wnd_available (tcp_connection_t * tc)
908 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
912 format_tcp_congestion (u8 * s, va_list * args)
914 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
915 u32 indent = format_get_indent (s);
917 s = format (s, "%U ", format_tcp_congestion_status, tc);
918 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
919 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
920 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
921 format_white_space, indent, tcp_available_cc_snd_space (tc),
922 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
923 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
924 format_white_space, indent, tc->snd_congestion - tc->iss,
925 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
930 format_tcp_stats (u8 * s, va_list * args)
932 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
933 u32 indent = format_get_indent (s);
934 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
935 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
936 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
937 format_white_space, indent, tc->segs_out,
938 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
939 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
940 format_white_space, indent, tc->fr_occurences,
941 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
942 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
943 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
944 format_white_space, indent, tc->errors.below_data_wnd,
945 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
946 tc->errors.above_ack_wnd);
951 format_tcp_vars (u8 * s, va_list * args)
953 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
954 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
955 format_tcp_connection_flags, tc, format_tcp_timers, tc);
956 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
957 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
958 tc->snd_una_max - tc->iss);
959 s = format (s, " rcv_nxt %u rcv_las %u\n",
960 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
961 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
962 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
963 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
964 tc->snd_wl2 - tc->iss);
965 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
966 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
967 tcp_rcv_wnd_available (tc));
968 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
969 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
970 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
971 tcp_time_now () - tc->tsval_recent_age);
972 s = format (s, " snd_mss %u\n", tc->snd_mss);
973 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
974 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
976 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
977 s = format (s, " cong: %U", format_tcp_congestion, tc);
979 if (tc->state >= TCP_STATE_ESTABLISHED)
981 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
983 s = format (s, " stats: %U\n", format_tcp_stats, tc);
985 if (vec_len (tc->snd_sacks))
986 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
992 format_tcp_connection_id (u8 * s, va_list * args)
994 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
999 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1000 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
1001 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
1002 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
1006 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1007 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1008 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1009 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1016 format_tcp_connection (u8 * s, va_list * args)
1018 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1019 u32 verbose = va_arg (*args, u32);
1023 s = format (s, "%-50U", format_tcp_connection_id, tc);
1026 s = format (s, "%-15U", format_tcp_state, tc->state);
1028 s = format (s, "\n%U", format_tcp_vars, tc);
1035 format_tcp_session (u8 * s, va_list * args)
1037 u32 tci = va_arg (*args, u32);
1038 u32 thread_index = va_arg (*args, u32);
1039 u32 verbose = va_arg (*args, u32);
1040 tcp_connection_t *tc;
1042 tc = tcp_connection_get (tci, thread_index);
1044 s = format (s, "%U", format_tcp_connection, tc, verbose);
1046 s = format (s, "empty\n");
1051 format_tcp_listener_session (u8 * s, va_list * args)
1053 u32 tci = va_arg (*args, u32);
1054 u32 __clib_unused thread_index = va_arg (*args, u32);
1055 u32 verbose = va_arg (*args, u32);
1056 tcp_connection_t *tc = tcp_listener_get (tci);
1057 s = format (s, "%-50U", format_tcp_connection_id, tc);
1059 s = format (s, "%-15U", format_tcp_state, tc->state);
1064 format_tcp_half_open_session (u8 * s, va_list * args)
1066 u32 tci = va_arg (*args, u32);
1067 u32 __clib_unused thread_index = va_arg (*args, u32);
1068 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1069 return format (s, "%U", format_tcp_connection_id, tc);
1073 format_tcp_sacks (u8 * s, va_list * args)
1075 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1076 sack_block_t *sacks = tc->snd_sacks;
1077 sack_block_t *block;
1080 len = vec_len (sacks);
1081 for (i = 0; i < len - 1; i++)
1084 s = format (s, " start %u end %u\n", block->start - tc->irs,
1085 block->end - tc->irs);
1089 block = &sacks[len - 1];
1090 s = format (s, " start %u end %u", block->start - tc->irs,
1091 block->end - tc->irs);
1097 format_tcp_rcv_sacks (u8 * s, va_list * args)
1099 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1100 sack_block_t *sacks = tc->rcv_opts.sacks;
1101 sack_block_t *block;
1104 len = vec_len (sacks);
1105 for (i = 0; i < len - 1; i++)
1108 s = format (s, " start %u end %u\n", block->start - tc->iss,
1109 block->end - tc->iss);
1113 block = &sacks[len - 1];
1114 s = format (s, " start %u end %u", block->start - tc->iss,
1115 block->end - tc->iss);
1121 format_tcp_sack_hole (u8 * s, va_list * args)
1123 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1124 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1126 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1128 s = format (s, " [%u, %u]", hole->start, hole->end);
1133 format_tcp_scoreboard (u8 * s, va_list * args)
1135 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1136 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1137 sack_scoreboard_hole_t *hole;
1138 u32 indent = format_get_indent (s);
1140 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1141 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1142 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1143 format_white_space, indent, sb->last_bytes_delivered,
1144 sb->high_sacked - tc->iss, sb->snd_una_adv);
1145 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1146 format_white_space, indent, sb->cur_rxt_hole,
1147 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1149 hole = scoreboard_first_hole (sb);
1151 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1152 indent, sb->head, sb->tail, pool_elts (sb->holes),
1153 format_white_space, indent);
1157 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1158 hole = scoreboard_next_hole (sb, hole);
1164 static transport_connection_t *
1165 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1167 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1168 return &tc->connection;
1171 static transport_connection_t *
1172 tcp_half_open_session_get_transport (u32 conn_index)
1174 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1175 return &tc->connection;
1179 * Compute maximum segment size for session layer.
1181 * Since the result needs to be the actual data length, it first computes
1182 * the tcp options to be used in the next burst and subtracts their
1183 * length from the connection's snd_mss.
1186 tcp_session_send_mss (transport_connection_t * trans_conn)
1188 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1190 /* Ensure snd_mss does accurately reflect the amount of data we can push
1191 * in a segment. This also makes sure that options are updated according to
1192 * the current state of the connection. */
1193 tcp_update_burst_snd_vars (tc);
1199 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1201 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1203 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1206 /* If not snd_wnd constrained and we can't write at least a segment,
1207 * don't try at all */
1208 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1209 return snd_space < tc->cwnd ? 0 : snd_space;
1211 /* round down to mss multiple */
1212 return snd_space - (snd_space % tc->snd_mss);
1216 * Compute tx window session is allowed to fill.
1218 * Takes into account available send space, snd_mss and the congestion
1219 * state of the connection. If possible, the value returned is a multiple
1222 * @param tc tcp connection
1223 * @return number of bytes session is allowed to write
1226 tcp_snd_space_inline (tcp_connection_t * tc)
1228 int snd_space, snt_limited;
1230 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1231 || tc->state == TCP_STATE_CLOSED))
1234 snd_space = tcp_available_output_snd_space (tc);
1236 /* If we haven't gotten dupacks or if we did and have gotten sacked
1237 * bytes then we can still send as per Limited Transmit (RFC3042) */
1238 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1239 && (tcp_opts_sack_permitted (tc)
1240 && tc->sack_sb.last_sacked_bytes == 0)))
1242 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1243 tc->limited_transmit = tc->snd_nxt;
1244 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1246 snt_limited = tc->snd_nxt - tc->limited_transmit;
1247 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1249 return tcp_round_snd_space (tc, snd_space);
1253 tcp_snd_space (tcp_connection_t * tc)
1255 return tcp_snd_space_inline (tc);
1259 tcp_session_send_space (transport_connection_t * trans_conn)
1261 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1262 return clib_min (tcp_snd_space_inline (tc),
1263 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1267 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1269 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1271 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1273 /* This still works if fast retransmit is on */
1274 return (tc->snd_nxt - tc->snd_una);
1278 tcp_update_time (f64 now, u8 thread_index)
1280 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1282 tcp_set_time_now (wrk);
1283 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1284 tcp_flush_frames_to_output (wrk);
1288 tcp_session_flush_data (transport_connection_t * tconn)
1290 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1291 if (tc->flags & TCP_CONN_PSH_PENDING)
1293 tc->flags |= TCP_CONN_PSH_PENDING;
1294 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1298 const static transport_proto_vft_t tcp_proto = {
1299 .enable = vnet_tcp_enable_disable,
1300 .start_listen = tcp_session_bind,
1301 .stop_listen = tcp_session_unbind,
1302 .push_header = tcp_session_push_header,
1303 .get_connection = tcp_session_get_transport,
1304 .get_listener = tcp_session_get_listener,
1305 .get_half_open = tcp_half_open_session_get_transport,
1306 .connect = tcp_session_open,
1307 .close = tcp_session_close,
1308 .cleanup = tcp_session_cleanup,
1309 .reset = tcp_session_reset,
1310 .send_mss = tcp_session_send_mss,
1311 .send_space = tcp_session_send_space,
1312 .update_time = tcp_update_time,
1313 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1314 .flush_data = tcp_session_flush_data,
1315 .custom_tx = tcp_session_custom_tx,
1316 .format_connection = format_tcp_session,
1317 .format_listener = format_tcp_listener_session,
1318 .format_half_open = format_tcp_half_open_session,
1319 .transport_options = {
1320 .tx_type = TRANSPORT_TX_PEEK,
1321 .service_type = TRANSPORT_SERVICE_VC,
1327 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1329 if (!transport_connection_is_tx_paced (&tc->connection))
1332 transport_connection_tx_pacer_update (&tc->connection,
1333 tcp_cc_get_pacing_rate (tc));
1337 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1340 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1341 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1342 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1343 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1344 start_bucket, last_time);
1348 tcp_timer_waitclose_handler (u32 conn_index)
1350 u32 thread_index = vlib_get_thread_index ();
1351 tcp_connection_t *tc;
1353 tc = tcp_connection_get (conn_index, thread_index);
1357 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1361 case TCP_STATE_CLOSE_WAIT:
1362 tcp_connection_timers_reset (tc);
1363 session_transport_closed_notify (&tc->connection);
1365 if (!(tc->flags & TCP_CONN_FINPNDG))
1367 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1368 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1372 /* Session didn't come back with a close. Send FIN either way
1373 * and switch to LAST_ACK. */
1374 tcp_cong_recovery_off (tc);
1375 /* Make sure we don't try to send unsent data */
1376 tc->snd_nxt = tc->snd_una;
1378 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1380 /* Make sure we don't wait in LAST ACK forever */
1381 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1383 /* Don't delete the connection yet */
1385 case TCP_STATE_FIN_WAIT_1:
1386 tcp_connection_timers_reset (tc);
1387 session_transport_closed_notify (&tc->connection);
1388 if (tc->flags & TCP_CONN_FINPNDG)
1390 /* If FIN pending, we haven't sent everything, but we did try.
1391 * Notify session layer that transport is closed. */
1392 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1393 tcp_send_reset (tc);
1394 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1398 /* We've sent the fin but no progress. Close the connection and
1399 * to make sure everything is flushed, setup a cleanup timer */
1400 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1401 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1404 case TCP_STATE_LAST_ACK:
1405 case TCP_STATE_CLOSING:
1406 tcp_connection_timers_reset (tc);
1407 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1408 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1409 session_transport_closed_notify (&tc->connection);
1412 tcp_connection_del (tc);
1418 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1420 tcp_timer_retransmit_handler,
1421 tcp_timer_delack_handler,
1422 tcp_timer_persist_handler,
1423 tcp_timer_waitclose_handler,
1424 tcp_timer_retransmit_syn_handler,
1429 tcp_expired_timers_dispatch (u32 * expired_timers)
1432 u32 connection_index, timer_id;
1434 for (i = 0; i < vec_len (expired_timers); i++)
1436 /* Get session index and timer id */
1437 connection_index = expired_timers[i] & 0x0FFFFFFF;
1438 timer_id = expired_timers[i] >> 28;
1440 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1442 /* Handle expiration */
1443 (*timer_expiration_handlers[timer_id]) (connection_index);
1448 tcp_initialize_timer_wheels (tcp_main_t * tm)
1450 tw_timer_wheel_16t_2w_512sl_t *tw;
1452 foreach_vlib_main (({
1453 tw = &tm->wrk_ctx[ii].timer_wheel;
1454 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1455 TCP_TIMER_TICK, ~0);
1456 tw->last_run_time = vlib_time_now (this_vlib_main);
1462 tcp_initialize_iss_seed (tcp_main_t * tm)
1464 u32 default_seed = random_default_seed ();
1465 u64 time_now = clib_cpu_time_now ();
1467 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1468 tm->iss_seed.second = random_u64 (&time_now);
1471 static clib_error_t *
1472 tcp_main_enable (vlib_main_t * vm)
1474 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1475 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1476 tcp_connection_t *tc __attribute__ ((unused));
1477 tcp_main_t *tm = vnet_get_tcp_main ();
1478 clib_error_t *error = 0;
1481 if ((error = vlib_call_init_function (vm, ip_main_init)))
1483 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1485 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1492 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1493 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1496 * Initialize data structures
1499 num_threads = 1 /* main thread */ + vtm->n_threads;
1500 vec_validate (tm->connections, num_threads - 1);
1501 vec_validate (tm->wrk_ctx, num_threads - 1);
1502 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1503 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1505 for (thread = 0; thread < num_threads; thread++)
1507 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1508 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1509 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1510 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1511 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1514 * Preallocate connections. Assume that thread 0 won't
1515 * use preallocated threads when running multi-core
1517 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1518 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1522 * Use a preallocated half-open connection pool?
1524 if (tcp_cfg.preallocated_half_open_connections)
1525 pool_init_fixed (tm->half_open_connections,
1526 tcp_cfg.preallocated_half_open_connections);
1528 /* Initialize clocks per tick for TCP timestamp. Used to compute
1529 * monotonically increasing timestamps. */
1530 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1531 / TCP_TSTAMP_RESOLUTION;
1533 if (num_threads > 1)
1535 clib_spinlock_init (&tm->half_open_lock);
1538 tcp_initialize_timer_wheels (tm);
1539 tcp_initialize_iss_seed (tm);
1541 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1542 tm->cc_last_type = TCP_CC_LAST;
1547 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1551 if (tcp_main.is_enabled)
1554 return tcp_main_enable (vm);
1558 tcp_main.is_enabled = 0;
1565 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1567 tcp_main_t *tm = &tcp_main;
1569 tm->punt_unknown4 = is_add;
1571 tm->punt_unknown6 = is_add;
1575 * Initialize default values for tcp parameters
1578 tcp_configuration_init (void)
1580 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1581 * predefined value. For SYN-ACK we still want the scale to be computed in
1583 tcp_cfg.max_rx_fifo = 32 << 20;
1584 tcp_cfg.min_rx_fifo = 4 << 10;
1586 tcp_cfg.default_mtu = 1500;
1587 tcp_cfg.initial_cwnd_multiplier = 0;
1588 tcp_cfg.enable_tx_pacing = 1;
1589 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1591 /* Time constants defined as timer tick (100ms) multiples */
1592 tcp_cfg.delack_time = 1; /* 0.1s */
1593 tcp_cfg.closewait_time = 20; /* 2s */
1594 tcp_cfg.timewait_time = 100; /* 10s */
1595 tcp_cfg.finwait1_time = 600; /* 60s */
1596 tcp_cfg.lastack_time = 300; /* 30s */
1597 tcp_cfg.finwait2_time = 300; /* 30s */
1598 tcp_cfg.closing_time = 300; /* 30s */
1599 tcp_cfg.cleanup_time = 1; /* 0.1s */
1602 static clib_error_t *
1603 tcp_init (vlib_main_t * vm)
1605 tcp_main_t *tm = vnet_get_tcp_main ();
1606 ip_main_t *im = &ip_main;
1607 ip_protocol_info_t *pi;
1609 /* Session layer, and by implication tcp, are disabled by default */
1612 /* Register with IP for header parsing */
1613 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1615 return clib_error_return (0, "TCP protocol info AWOL");
1616 pi->format_header = format_tcp_header;
1617 pi->unformat_pg_edit = unformat_pg_tcp_header;
1619 /* Register as transport with session layer */
1620 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1621 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1622 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1623 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1625 tcp_api_reference ();
1626 tcp_configuration_init ();
1628 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1633 VLIB_INIT_FUNCTION (tcp_init);
1636 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1638 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1639 tcp_main_t *tm = &tcp_main;
1644 if (unformat (input, "%s", &cc_algo_name)
1645 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1651 vec_free (cc_algo_name);
1656 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1658 tcp_main_t *tm = vnet_get_tcp_main ();
1659 tcp_cc_algorithm_t *cc_alg;
1660 unformat_input_t sub_input;
1663 vec_foreach (cc_alg, tm->cc_algos)
1665 if (!unformat (input, cc_alg->name))
1668 if (cc_alg->unformat_cfg
1669 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1671 if (cc_alg->unformat_cfg (&sub_input))
1678 static clib_error_t *
1679 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1681 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1683 if (unformat (input, "preallocated-connections %d",
1684 &tcp_cfg.preallocated_connections))
1686 else if (unformat (input, "preallocated-half-open-connections %d",
1687 &tcp_cfg.preallocated_half_open_connections))
1689 else if (unformat (input, "buffer-fail-fraction %f",
1690 &tcp_cfg.buffer_fail_fraction))
1692 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1693 &tcp_cfg.max_rx_fifo))
1695 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1696 &tcp_cfg.min_rx_fifo))
1698 else if (unformat (input, "mtu %d", &tcp_cfg.default_mtu))
1700 else if (unformat (input, "initial-cwnd-multiplier %d",
1701 &tcp_cfg.initial_cwnd_multiplier))
1703 else if (unformat (input, "no-tx-pacing"))
1704 tcp_cfg.enable_tx_pacing = 0;
1705 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1708 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1710 else if (unformat (input, "closewait-time %d", &tcp_cfg.closewait_time))
1711 tcp_cfg.closewait_time /= TCP_TIMER_TICK;
1712 else if (unformat (input, "timewait-time %d", &tcp_cfg.timewait_time))
1713 tcp_cfg.timewait_time /= TCP_TIMER_TICK;
1714 else if (unformat (input, "finwait1-time %d", &tcp_cfg.finwait1_time))
1715 tcp_cfg.finwait1_time /= TCP_TIMER_TICK;
1716 else if (unformat (input, "finwait2-time %d", &tcp_cfg.finwait2_time))
1717 tcp_cfg.finwait2_time /= TCP_TIMER_TICK;
1718 else if (unformat (input, "lastack-time %d", &tcp_cfg.lastack_time))
1719 tcp_cfg.lastack_time /= TCP_TIMER_TICK;
1720 else if (unformat (input, "closing-time %d", &tcp_cfg.closing_time))
1721 tcp_cfg.closing_time /= TCP_TIMER_TICK;
1722 else if (unformat (input, "cleanup-time %d", &tcp_cfg.cleanup_time))
1723 tcp_cfg.cleanup_time /= TCP_TIMER_TICK;
1725 return clib_error_return (0, "unknown input `%U'",
1726 format_unformat_error, input);
1731 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1735 * \brief Configure an ipv4 source address range
1736 * @param vm vlib_main_t pointer
1737 * @param start first ipv4 address in the source address range
1738 * @param end last ipv4 address in the source address range
1739 * @param table_id VRF / table ID, 0 for the default FIB
1740 * @return 0 if all OK, else an error indication from api_errno.h
1744 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1745 ip4_address_t * start,
1746 ip4_address_t * end, u32 table_id)
1748 vnet_main_t *vnm = vnet_get_main ();
1749 u32 start_host_byte_order, end_host_byte_order;
1750 fib_prefix_t prefix;
1751 fib_node_index_t fei;
1756 clib_memset (&prefix, 0, sizeof (prefix));
1758 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1760 if (fib_index == ~0)
1761 return VNET_API_ERROR_NO_SUCH_FIB;
1763 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1764 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1766 /* sanity check for reversed args or some such */
1767 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1768 return VNET_API_ERROR_INVALID_ARGUMENT;
1770 /* Lookup the last address, to identify the interface involved */
1772 prefix.fp_proto = FIB_PROTOCOL_IP4;
1773 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1775 fei = fib_table_lookup (fib_index, &prefix);
1777 /* Couldn't find route to destination. Bail out. */
1778 if (fei == FIB_NODE_INDEX_INVALID)
1779 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1781 sw_if_index = fib_entry_get_resolving_interface (fei);
1783 /* Configure proxy arp across the range */
1784 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1789 rv = vnet_proxy_arp_enable_disable (vnm, sw_if_index, 1);
1796 dpo_id_t dpo = DPO_INVALID;
1798 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1800 /* Add local adjacencies for the range */
1802 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1805 prefix.fp_proto = FIB_PROTOCOL_IP4;
1806 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1808 fib_table_entry_special_dpo_update (fib_index,
1811 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1814 start_host_byte_order++;
1815 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1817 while (start_host_byte_order <= end_host_byte_order);
1823 * \brief Configure an ipv6 source address range
1824 * @param vm vlib_main_t pointer
1825 * @param start first ipv6 address in the source address range
1826 * @param end last ipv6 address in the source address range
1827 * @param table_id VRF / table ID, 0 for the default FIB
1828 * @return 0 if all OK, else an error indication from api_errno.h
1832 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1833 ip6_address_t * start,
1834 ip6_address_t * end, u32 table_id)
1836 fib_prefix_t prefix;
1838 fib_node_index_t fei;
1841 clib_memset (&prefix, 0, sizeof (prefix));
1843 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1845 if (fib_index == ~0)
1846 return VNET_API_ERROR_NO_SUCH_FIB;
1852 dpo_id_t dpo = DPO_INVALID;
1854 /* Remember this address */
1855 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1857 /* Lookup the prefix, to identify the interface involved */
1858 prefix.fp_len = 128;
1859 prefix.fp_proto = FIB_PROTOCOL_IP6;
1860 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1862 fei = fib_table_lookup (fib_index, &prefix);
1864 /* Couldn't find route to destination. Bail out. */
1865 if (fei == FIB_NODE_INDEX_INVALID)
1866 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1868 sw_if_index = fib_entry_get_resolving_interface (fei);
1870 if (sw_if_index == (u32) ~ 0)
1871 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1873 /* Add a proxy neighbor discovery entry for this address */
1874 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1876 /* Add a receive adjacency for this address */
1877 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1880 fib_table_entry_special_dpo_update (fib_index,
1883 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1886 /* Done with the entire range? */
1887 if (!memcmp (start, end, sizeof (start[0])))
1890 /* Increment the address. DGMS. */
1892 for (i = 15; i >= 0; i--)
1895 if (tmp.as_u8[i] != 0)
1903 static clib_error_t *
1904 tcp_src_address (vlib_main_t * vm,
1905 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1907 ip4_address_t v4start, v4end;
1908 ip6_address_t v6start, v6end;
1914 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1916 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1917 unformat_ip4_address, &v4end))
1919 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1921 memcpy (&v4end, &v4start, sizeof (v4start));
1924 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1925 unformat_ip6_address, &v6end))
1927 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1929 memcpy (&v6end, &v6start, sizeof (v6start));
1932 else if (unformat (input, "fib-table %d", &table_id))
1938 if (!v4set && !v6set)
1939 return clib_error_return (0, "at least one v4 or v6 address required");
1943 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1950 case VNET_API_ERROR_NO_SUCH_FIB:
1951 return clib_error_return (0, "Invalid table-id %d", table_id);
1953 case VNET_API_ERROR_INVALID_ARGUMENT:
1954 return clib_error_return (0, "Invalid address range %U - %U",
1955 format_ip4_address, &v4start,
1956 format_ip4_address, &v4end);
1958 return clib_error_return (0, "error %d", rv);
1964 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1971 case VNET_API_ERROR_NO_SUCH_FIB:
1972 return clib_error_return (0, "Invalid table-id %d", table_id);
1975 return clib_error_return (0, "error %d", rv);
1983 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1985 .path = "tcp src-address",
1986 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1987 .function = tcp_src_address,
1992 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1994 #if TCP_SCOREBOARD_TRACE
1996 scoreboard_trace_elt_t *block;
2002 s = format (s, "scoreboard trace:");
2003 vec_foreach (block, sb->trace)
2005 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2006 block->ack, block->snd_una_max, block->group);
2008 s = format (s, "\n");
2016 static clib_error_t *
2017 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2018 vlib_cli_command_t * cmd_arg)
2020 transport_connection_t *tconn = 0;
2021 tcp_connection_t *tc;
2023 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2025 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2026 TRANSPORT_PROTO_TCP))
2029 return clib_error_return (0, "unknown input `%U'",
2030 format_unformat_error, input);
2033 if (!TCP_SCOREBOARD_TRACE)
2035 vlib_cli_output (vm, "scoreboard tracing not enabled");
2039 tc = tcp_get_connection_from_transport (tconn);
2040 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2041 vlib_cli_output (vm, "%v", s);
2046 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2048 .path = "show tcp scoreboard trace",
2049 .short_help = "show tcp scoreboard trace <connection>",
2050 .function = tcp_show_scoreboard_trace_fn,
2055 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2058 scoreboard_trace_elt_t *trace;
2059 u32 next_ack, left, group, has_new_ack = 0;
2060 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2061 sack_block_t *block;
2063 if (!TCP_SCOREBOARD_TRACE)
2065 s = format (s, "scoreboard tracing not enabled");
2072 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2073 tcp_connection_timers_init (dummy_tc);
2074 scoreboard_init (&dummy_tc->sack_sb);
2075 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2077 #if TCP_SCOREBOARD_TRACE
2078 trace = tc->sack_sb.trace;
2079 trace_len = vec_len (tc->sack_sb.trace);
2082 for (i = 0; i < trace_len; i++)
2084 if (trace[i].ack != 0)
2086 dummy_tc->snd_una = trace[i].ack - 1448;
2087 dummy_tc->snd_una_max = trace[i].ack;
2092 while (left < trace_len)
2094 group = trace[left].group;
2095 vec_reset_length (dummy_tc->rcv_opts.sacks);
2097 while (trace[left].group == group)
2099 if (trace[left].ack != 0)
2102 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2103 trace[left].ack, trace[left].snd_una_max);
2104 dummy_tc->snd_una_max = trace[left].snd_una_max;
2105 next_ack = trace[left].ack;
2111 s = format (s, "[%u, %u], ", trace[left].start,
2113 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2114 block->start = trace[left].start;
2115 block->end = trace[left].end;
2121 tcp_rcv_sacks (dummy_tc, next_ack);
2123 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2126 s = format (s, "result: %U", format_tcp_scoreboard,
2127 &dummy_tc->sack_sb);
2130 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2135 static clib_error_t *
2136 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2137 vlib_cli_command_t * cmd_arg)
2139 transport_connection_t *tconn = 0;
2140 tcp_connection_t *tc = 0;
2142 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2144 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2145 TRANSPORT_PROTO_TCP))
2148 return clib_error_return (0, "unknown input `%U'",
2149 format_unformat_error, input);
2152 if (!TCP_SCOREBOARD_TRACE)
2154 vlib_cli_output (vm, "scoreboard tracing not enabled");
2158 tc = tcp_get_connection_from_transport (tconn);
2161 vlib_cli_output (vm, "connection not found");
2164 str = tcp_scoreboard_replay (str, tc, 1);
2165 vlib_cli_output (vm, "%v", str);
2170 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2172 .path = "tcp replay scoreboard",
2173 .short_help = "tcp replay scoreboard <connection>",
2174 .function = tcp_scoreboard_trace_fn,
2178 static clib_error_t *
2179 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2180 vlib_cli_command_t * cmd_arg)
2182 tcp_main_t *tm = vnet_get_tcp_main ();
2183 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2184 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2186 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2187 tm->punt_unknown4 ? "enabled" : "disabled");
2188 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2189 tm->punt_unknown6 ? "enabled" : "disabled");
2193 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2195 .path = "show tcp punt",
2196 .short_help = "show tcp punt",
2197 .function = show_tcp_punt_fn,
2202 * fd.io coding-style-patch-verification: ON
2205 * eval: (c-set-style "gnu")