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-neighbor/ip_neighbor.h>
33 fib_protocol_t nh_proto;
34 vnet_link_t link_type;
38 } tcp_add_del_adj_args_t;
41 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
46 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
51 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
53 if (ai != ADJ_INDEX_INVALID)
59 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
61 tcp_add_del_adj_args_t args = {
62 .nh_proto = FIB_PROTOCOL_IP6,
63 .link_type = VNET_LINK_IP6,
65 .sw_if_index = tc->sw_if_index,
68 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
73 tcp_cc_init (tcp_connection_t * tc)
75 tc->cc_algo->init (tc);
79 tcp_cc_cleanup (tcp_connection_t * tc)
81 if (tc->cc_algo->cleanup)
82 tc->cc_algo->cleanup (tc);
86 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
87 const tcp_cc_algorithm_t * vft)
89 tcp_main_t *tm = vnet_get_tcp_main ();
90 vec_validate (tm->cc_algos, type);
92 tm->cc_algos[type] = *vft;
93 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
97 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
99 tcp_main_t *tm = vnet_get_tcp_main ();
100 return &tm->cc_algos[type];
103 tcp_cc_algorithm_type_e
104 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
106 tcp_main_t *tm = vnet_get_tcp_main ();
107 tcp_cc_algo_register (++tm->cc_last_type, vft);
108 return tm->cc_last_type;
112 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
114 tcp_main_t *tm = &tcp_main;
115 tcp_connection_t *listener;
118 pool_get (tm->listener_pool, listener);
119 clib_memset (listener, 0, sizeof (*listener));
121 listener->c_c_index = listener - tm->listener_pool;
122 listener->c_lcl_port = lcl->port;
124 /* If we are provided a sw_if_index, bind using one of its ips */
125 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
127 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
129 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
131 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
132 listener->c_is_ip4 = lcl->is_ip4;
133 listener->c_proto = TRANSPORT_PROTO_TCP;
134 listener->c_s_index = session_index;
135 listener->c_fib_index = lcl->fib_index;
136 listener->state = TCP_STATE_LISTEN;
137 listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
139 tcp_connection_timers_init (listener);
141 TCP_EVT (TCP_EVT_BIND, listener);
143 return listener->c_c_index;
147 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
149 return tcp_connection_bind (session_index, tep);
153 tcp_connection_unbind (u32 listener_index)
155 tcp_main_t *tm = vnet_get_tcp_main ();
156 tcp_connection_t *tc;
158 tc = pool_elt_at_index (tm->listener_pool, listener_index);
160 TCP_EVT (TCP_EVT_UNBIND, tc);
162 /* Poison the entry */
164 clib_memset (tc, 0xFA, sizeof (*tc));
166 pool_put_index (tm->listener_pool, listener_index);
170 tcp_session_unbind (u32 listener_index)
172 tcp_connection_unbind (listener_index);
176 static transport_connection_t *
177 tcp_session_get_listener (u32 listener_index)
179 tcp_main_t *tm = vnet_get_tcp_main ();
180 tcp_connection_t *tc;
181 tc = pool_elt_at_index (tm->listener_pool, listener_index);
182 return &tc->connection;
186 * Cleanup half-open connection
190 tcp_half_open_connection_del (tcp_connection_t * tc)
192 tcp_main_t *tm = vnet_get_tcp_main ();
193 clib_spinlock_lock_if_init (&tm->half_open_lock);
195 clib_memset (tc, 0xFA, sizeof (*tc));
196 pool_put (tm->half_open_connections, tc);
197 clib_spinlock_unlock_if_init (&tm->half_open_lock);
201 * Try to cleanup half-open connection
203 * If called from a thread that doesn't own tc, the call won't have any
206 * @param tc - connection to be cleaned up
207 * @return non-zero if cleanup failed.
210 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
212 /* Make sure this is the owning thread */
213 if (tc->c_thread_index != vlib_get_thread_index ())
215 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
216 tcp_half_open_connection_del (tc);
220 static tcp_connection_t *
221 tcp_half_open_connection_new (void)
223 tcp_main_t *tm = vnet_get_tcp_main ();
224 tcp_connection_t *tc = 0;
225 ASSERT (vlib_get_thread_index () == 0);
226 pool_get (tm->half_open_connections, tc);
227 clib_memset (tc, 0, sizeof (*tc));
228 tc->c_c_index = tc - tm->half_open_connections;
233 * Cleans up connection state.
238 tcp_connection_cleanup (tcp_connection_t * tc)
240 tcp_main_t *tm = &tcp_main;
242 TCP_EVT (TCP_EVT_DELETE, tc);
244 /* Cleanup local endpoint if this was an active connect */
245 if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
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);
271 vec_free (tc->rcv_opts.sacks);
272 pool_free (tc->sack_sb.holes);
274 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
277 /* Poison the entry */
279 clib_memset (tc, 0xFA, sizeof (*tc));
280 pool_put (tm->connections[thread_index], tc);
285 * Connection removal.
287 * This should be called only once connection enters CLOSED state. Note
288 * that it notifies the session of the removal event, so if the goal is to
289 * just remove the connection, call tcp_connection_cleanup instead.
292 tcp_connection_del (tcp_connection_t * tc)
294 session_transport_delete_notify (&tc->connection);
295 tcp_connection_cleanup (tc);
299 tcp_connection_alloc (u8 thread_index)
301 tcp_main_t *tm = vnet_get_tcp_main ();
302 tcp_connection_t *tc;
304 pool_get (tm->connections[thread_index], tc);
305 clib_memset (tc, 0, sizeof (*tc));
306 tc->c_c_index = tc - tm->connections[thread_index];
307 tc->c_thread_index = thread_index;
312 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
314 tcp_main_t *tm = vnet_get_tcp_main ();
315 tcp_connection_t *tc;
317 pool_get (tm->connections[thread_index], tc);
318 clib_memcpy_fast (tc, base, sizeof (*tc));
319 tc->c_c_index = tc - tm->connections[thread_index];
320 tc->c_thread_index = thread_index;
325 tcp_connection_free (tcp_connection_t * tc)
327 tcp_main_t *tm = &tcp_main;
330 u8 thread_index = tc->c_thread_index;
331 clib_memset (tc, 0xFA, sizeof (*tc));
332 pool_put (tm->connections[thread_index], tc);
335 pool_put (tm->connections[tc->c_thread_index], tc);
339 * Begin connection closing procedure.
341 * If at the end the connection is not in CLOSED state, it is not removed.
342 * Instead, we rely on on TCP to advance through state machine to either
343 * 1) LAST_ACK (passive close) whereby when the last ACK is received
344 * tcp_connection_del is called. This notifies session of the delete and
346 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
347 * and cleanup is called.
349 * N.B. Half-close connections are not supported
352 tcp_connection_close (tcp_connection_t * tc)
354 TCP_EVT (TCP_EVT_CLOSE, tc);
356 /* Send/Program FIN if needed and switch state */
359 case TCP_STATE_SYN_SENT:
360 /* Try to cleanup. If not on the right thread, mark as half-open done.
361 * Connection will be cleaned up when establish timer pops */
362 tcp_connection_cleanup (tc);
364 case TCP_STATE_SYN_RCVD:
365 tcp_connection_timers_reset (tc);
367 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
368 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
370 case TCP_STATE_ESTABLISHED:
371 /* If closing with unread data, reset the connection */
372 if (transport_max_rx_dequeue (&tc->connection))
375 tcp_connection_timers_reset (tc);
376 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
377 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
378 session_transport_closed_notify (&tc->connection);
381 if (!transport_max_tx_dequeue (&tc->connection))
384 tc->flags |= TCP_CONN_FINPNDG;
385 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
386 /* Set a timer in case the peer stops responding. Otherwise the
387 * connection will be stuck here forever. */
388 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
389 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
391 case TCP_STATE_CLOSE_WAIT:
392 if (!transport_max_tx_dequeue (&tc->connection))
395 tcp_connection_timers_reset (tc);
396 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
397 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
400 tc->flags |= TCP_CONN_FINPNDG;
402 case TCP_STATE_FIN_WAIT_1:
403 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
405 case TCP_STATE_CLOSED:
406 tcp_connection_timers_reset (tc);
407 /* Delete connection but instead of doing it now wait until next
408 * dispatch cycle to give the session layer a chance to clear
409 * unhandled events */
410 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
413 TCP_DBG ("state: %u", tc->state);
418 tcp_session_close (u32 conn_index, u32 thread_index)
420 tcp_connection_t *tc;
421 tc = tcp_connection_get (conn_index, thread_index);
422 tcp_connection_close (tc);
426 tcp_session_cleanup (u32 conn_index, u32 thread_index)
428 tcp_connection_t *tc;
429 tc = tcp_connection_get (conn_index, thread_index);
432 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
433 tcp_connection_cleanup (tc);
437 tcp_session_reset (u32 conn_index, u32 thread_index)
439 tcp_connection_t *tc;
440 tc = tcp_connection_get (conn_index, thread_index);
441 session_transport_closed_notify (&tc->connection);
443 tcp_connection_timers_reset (tc);
444 tcp_cong_recovery_off (tc);
445 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
446 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
450 * Initialize all connection timers as invalid
453 tcp_connection_timers_init (tcp_connection_t * tc)
457 /* Set all to invalid */
458 for (i = 0; i < TCP_N_TIMERS; i++)
460 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
463 tc->rto = TCP_RTO_INIT;
467 * Stop all connection timers
470 tcp_connection_timers_reset (tcp_connection_t * tc)
473 for (i = 0; i < TCP_N_TIMERS; i++)
475 tcp_timer_reset (tc, i);
480 typedef struct ip4_tcp_hdr
486 typedef struct ip6_tcp_hdr
493 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
496 const dpo_id_t *choice;
500 lb = load_balance_get (dpo->dpoi_index);
504 clib_memset (&hdr, 0, sizeof (hdr));
505 hdr.ip.protocol = IP_PROTOCOL_TCP;
506 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
507 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
508 hdr.tcp.src_port = tc->c_lcl_port;
509 hdr.tcp.dst_port = tc->c_rmt_port;
510 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
515 clib_memset (&hdr, 0, sizeof (hdr));
516 hdr.ip.protocol = IP_PROTOCOL_TCP;
517 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
518 sizeof (ip6_address_t));
519 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
520 sizeof (ip6_address_t));
521 hdr.tcp.src_port = tc->c_lcl_port;
522 hdr.tcp.dst_port = tc->c_rmt_port;
523 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
525 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
526 dpo_copy (result, choice);
530 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
535 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
536 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
537 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
538 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
539 return fib_table_lookup (fib_index, &prefix);
543 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
545 dpo_id_t choice = DPO_INVALID;
546 u32 output_node_index;
549 fe = fib_entry_get (tc->c_rmt_fei);
550 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
553 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
556 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
557 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
561 /** Stack tcp connection on peer's fib entry.
563 * This ultimately populates the dpo the connection will use to send packets.
566 tcp_connection_fib_attach (tcp_connection_t * tc)
568 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
570 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
572 tcp_connection_stack_on_fib_entry (tc);
577 * Generate random iss as per rfc6528
580 tcp_generate_random_iss (tcp_connection_t * tc)
582 tcp_main_t *tm = &tcp_main;
586 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
588 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
589 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
591 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
592 tmp ^= tm->iss_seed.second;
593 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
594 return ((tmp >> 32) ^ (tmp & 0xffffffff));
598 * Initialize max segment size we're able to process.
600 * The value is constrained by the output interface's MTU and by the size
601 * of the IP and TCP headers (see RFC6691). It is also what we advertise
605 tcp_init_rcv_mss (tcp_connection_t * tc)
609 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
610 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
614 tcp_init_mss (tcp_connection_t * tc)
616 u16 default_min_mss = 536;
618 tcp_init_rcv_mss (tc);
620 /* TODO consider PMTU discovery */
621 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
623 if (tc->snd_mss < 45)
625 /* Assume that at least the min default mss works */
626 tc->snd_mss = default_min_mss;
627 tc->rcv_opts.mss = default_min_mss;
630 /* We should have enough space for 40 bytes of options */
631 ASSERT (tc->snd_mss > 45);
633 /* If we use timestamp option, account for it */
634 if (tcp_opts_tstamp (&tc->rcv_opts))
635 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
639 * Initialize connection send variables.
642 tcp_init_snd_vars (tcp_connection_t * tc)
645 * We use the time to randomize iss and for setting up the initial
646 * timestamp. Make sure it's updated otherwise syn and ack in the
647 * handshake may make it look as if time has flown in the opposite
650 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
652 tcp_init_rcv_mss (tc);
653 tc->iss = tcp_generate_random_iss (tc);
654 tc->snd_una = tc->iss;
655 tc->snd_nxt = tc->iss + 1;
656 tc->snd_una_max = tc->snd_nxt;
657 tc->srtt = 100; /* 100 ms */
659 if (!tcp_cfg.csum_offload)
660 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
664 tcp_enable_pacing (tcp_connection_t * tc)
667 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
668 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
669 tc->mrtt_us = (u32) ~ 0;
672 /** Initialize tcp connection variables
674 * Should be called after having received a msg from the peer, i.e., a SYN or
675 * a SYNACK, such that connection options have already been exchanged. */
677 tcp_connection_init_vars (tcp_connection_t * tc)
679 tcp_connection_timers_init (tc);
681 scoreboard_init (&tc->sack_sb);
682 if (tc->state == TCP_STATE_SYN_RCVD)
683 tcp_init_snd_vars (tc);
687 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
688 tcp_add_del_adjacency (tc, 1);
690 /* tcp_connection_fib_attach (tc); */
692 if (transport_connection_is_tx_paced (&tc->connection)
693 || tcp_cfg.enable_tx_pacing)
694 tcp_enable_pacing (tc);
696 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
699 if (!tcp_cfg.allow_tso)
700 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
702 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
706 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
707 u16 * lcl_port, u8 is_ip4)
712 index = tm->last_v4_addr_rotor++;
713 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
714 tm->last_v4_addr_rotor = 0;
715 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
719 index = tm->last_v6_addr_rotor++;
720 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
721 tm->last_v6_addr_rotor = 0;
722 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
723 sizeof (ip6_address_t));
725 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
728 clib_warning ("Failed to allocate src port");
736 tcp_session_open (transport_endpoint_cfg_t * rmt)
738 tcp_main_t *tm = vnet_get_tcp_main ();
739 tcp_connection_t *tc;
740 ip46_address_t lcl_addr;
745 * Allocate local endpoint
747 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
748 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
749 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
752 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
753 rmt, &lcl_addr, &lcl_port);
759 * Create connection and send SYN
761 clib_spinlock_lock_if_init (&tm->half_open_lock);
762 tc = tcp_half_open_connection_new ();
763 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
764 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
765 tc->c_rmt_port = rmt->port;
766 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
767 tc->c_is_ip4 = rmt->is_ip4;
768 tc->c_proto = TRANSPORT_PROTO_TCP;
769 tc->c_fib_index = rmt->fib_index;
770 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
771 /* The other connection vars will be initialized after SYN ACK */
772 tcp_connection_timers_init (tc);
774 TCP_EVT (TCP_EVT_OPEN, tc);
775 tc->state = TCP_STATE_SYN_SENT;
776 tcp_init_snd_vars (tc);
778 clib_spinlock_unlock_if_init (&tm->half_open_lock);
780 return tc->c_c_index;
783 const char *tcp_fsm_states[] = {
784 #define _(sym, str) str,
785 foreach_tcp_fsm_state
790 format_tcp_state (u8 * s, va_list * args)
792 u32 state = va_arg (*args, u32);
794 if (state < TCP_N_STATES)
795 s = format (s, "%s", tcp_fsm_states[state]);
797 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
801 const char *tcp_cfg_flags_str[] = {
802 #define _(sym, str) str,
808 format_tcp_cfg_flags (u8 * s, va_list * args)
810 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
813 for (i = 0; i < TCP_CFG_N_FLAG_BITS; i++)
814 if (tc->cfg_flags & (1 << i))
816 for (i = 0; i < last; i++)
818 if (tc->cfg_flags & (1 << i))
819 s = format (s, "%s, ", tcp_cfg_flags_str[i]);
822 s = format (s, "%s", tcp_cfg_flags_str[last]);
826 const char *tcp_connection_flags_str[] = {
827 #define _(sym, str) str,
828 foreach_tcp_connection_flag
833 format_tcp_connection_flags (u8 * s, va_list * args)
835 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
838 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
839 if (tc->flags & (1 << i))
841 for (i = 0; i < last; i++)
843 if (tc->flags & (1 << i))
844 s = format (s, "%s, ", tcp_connection_flags_str[i]);
847 s = format (s, "%s", tcp_connection_flags_str[last]);
851 const char *tcp_conn_timers[] = {
852 #define _(sym, str) str,
858 format_tcp_timers (u8 * s, va_list * args)
860 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
863 for (i = 0; i < TCP_N_TIMERS; i++)
864 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
867 for (i = 0; i < last; i++)
869 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
870 s = format (s, "%s,", tcp_conn_timers[i]);
874 s = format (s, "%s", tcp_conn_timers[i]);
880 format_tcp_congestion_status (u8 * s, va_list * args)
882 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
883 if (tcp_in_recovery (tc))
884 s = format (s, "recovery");
885 else if (tcp_in_fastrecovery (tc))
886 s = format (s, "fastrecovery");
888 s = format (s, "none");
893 tcp_rcv_wnd_available (tcp_connection_t * tc)
895 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
899 format_tcp_congestion (u8 * s, va_list * args)
901 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
902 u32 indent = format_get_indent (s), prr_space = 0;
904 s = format (s, "%U ", format_tcp_congestion_status, tc);
905 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
906 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
907 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u\n",
908 format_white_space, indent, tcp_available_cc_snd_space (tc),
909 tc->prev_cwnd, tc->prev_ssthresh);
910 s = format (s, "%Usnd_cong %u dupack %u limited_tx %u\n",
911 format_white_space, indent, tc->snd_congestion - tc->iss,
912 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
913 s = format (s, "%Urxt_bytes %u rxt_delivered %u rxt_head %u rxt_ts %u\n",
914 format_white_space, indent, tc->snd_rxt_bytes,
915 tc->rxt_delivered, tc->rxt_head - tc->iss,
916 tcp_time_now_w_thread (tc->c_thread_index) - tc->snd_rxt_ts);
917 if (tcp_in_fastrecovery (tc))
918 prr_space = tcp_fastrecovery_prr_snd_space (tc);
919 s = format (s, "%Uprr_start %u prr_delivered %u prr space %u\n",
920 format_white_space, indent, tc->prr_start - tc->iss,
921 tc->prr_delivered, prr_space);
926 format_tcp_stats (u8 * s, va_list * args)
928 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
929 u32 indent = format_get_indent (s);
930 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
931 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
932 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
933 format_white_space, indent, tc->segs_out,
934 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
935 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
936 format_white_space, indent, tc->fr_occurences,
937 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
938 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
939 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
940 format_white_space, indent, tc->errors.below_data_wnd,
941 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
942 tc->errors.above_ack_wnd);
947 format_tcp_vars (u8 * s, va_list * args)
949 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
950 s = format (s, " index: %u cfg: %U flags: %U timers: %U\n", tc->c_c_index,
951 format_tcp_cfg_flags, tc, format_tcp_connection_flags, tc,
952 format_tcp_timers, tc);
953 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
954 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
955 tc->snd_una_max - tc->iss);
956 s = format (s, " rcv_nxt %u rcv_las %u\n",
957 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
958 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
959 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
960 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
961 tc->snd_wl2 - tc->iss);
962 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
963 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
964 tcp_rcv_wnd_available (tc));
965 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
966 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
967 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
968 tcp_time_now () - tc->tsval_recent_age);
969 s = format (s, " snd_mss %u\n", tc->snd_mss);
970 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
971 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
973 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
974 s = format (s, " next_node %u opaque 0x%x\n", tc->next_node_index,
975 tc->next_node_opaque);
976 s = format (s, " cong: %U", format_tcp_congestion, tc);
978 if (tc->state >= TCP_STATE_ESTABLISHED)
980 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
982 s = format (s, " stats: %U\n", format_tcp_stats, tc);
984 if (vec_len (tc->snd_sacks))
985 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
991 format_tcp_connection_id (u8 * s, va_list * args)
993 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
998 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
999 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
1000 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
1001 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
1005 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1006 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1007 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1008 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1015 format_tcp_connection (u8 * s, va_list * args)
1017 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1018 u32 verbose = va_arg (*args, u32);
1022 s = format (s, "%-50U", format_tcp_connection_id, tc);
1025 s = format (s, "%-15U", format_tcp_state, tc->state);
1027 s = format (s, "\n%U", format_tcp_vars, tc);
1034 format_tcp_session (u8 * s, va_list * args)
1036 u32 tci = va_arg (*args, u32);
1037 u32 thread_index = va_arg (*args, u32);
1038 u32 verbose = va_arg (*args, u32);
1039 tcp_connection_t *tc;
1041 tc = tcp_connection_get (tci, thread_index);
1043 s = format (s, "%U", format_tcp_connection, tc, verbose);
1045 s = format (s, "empty\n");
1050 format_tcp_listener_session (u8 * s, va_list * args)
1052 u32 tci = va_arg (*args, u32);
1053 u32 __clib_unused thread_index = va_arg (*args, u32);
1054 u32 verbose = va_arg (*args, u32);
1055 tcp_connection_t *tc = tcp_listener_get (tci);
1056 s = format (s, "%-50U", format_tcp_connection_id, tc);
1058 s = format (s, "%-15U", format_tcp_state, tc->state);
1063 format_tcp_half_open_session (u8 * s, va_list * args)
1065 u32 tci = va_arg (*args, u32);
1066 u32 __clib_unused thread_index = va_arg (*args, u32);
1067 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1068 return format (s, "%U", format_tcp_connection_id, tc);
1072 format_tcp_sacks (u8 * s, va_list * args)
1074 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1075 sack_block_t *sacks = tc->snd_sacks;
1076 sack_block_t *block;
1079 len = vec_len (sacks);
1080 for (i = 0; i < len - 1; i++)
1083 s = format (s, " start %u end %u\n", block->start - tc->irs,
1084 block->end - tc->irs);
1088 block = &sacks[len - 1];
1089 s = format (s, " start %u end %u", block->start - tc->irs,
1090 block->end - tc->irs);
1096 format_tcp_rcv_sacks (u8 * s, va_list * args)
1098 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1099 sack_block_t *sacks = tc->rcv_opts.sacks;
1100 sack_block_t *block;
1103 len = vec_len (sacks);
1104 for (i = 0; i < len - 1; i++)
1107 s = format (s, " start %u end %u\n", block->start - tc->iss,
1108 block->end - tc->iss);
1112 block = &sacks[len - 1];
1113 s = format (s, " start %u end %u", block->start - tc->iss,
1114 block->end - tc->iss);
1120 format_tcp_sack_hole (u8 * s, va_list * args)
1122 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1123 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1125 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1127 s = format (s, " [%u, %u]", hole->start, hole->end);
1132 format_tcp_scoreboard (u8 * s, va_list * args)
1134 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1135 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1136 sack_scoreboard_hole_t *hole;
1137 u32 indent = format_get_indent (s);
1139 s = format (s, "sacked %u last_sacked %u lost %u last_lost %u"
1141 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes,
1142 sb->last_lost_bytes, sb->rxt_sacked);
1143 s = format (s, "%Ulast_delivered %u high_sacked %u is_reneging %u\n",
1144 format_white_space, indent, sb->last_bytes_delivered,
1145 sb->high_sacked - tc->iss, sb->is_reneging);
1146 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1147 format_white_space, indent, sb->cur_rxt_hole,
1148 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1150 hole = scoreboard_first_hole (sb);
1152 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1153 indent, sb->head, sb->tail, pool_elts (sb->holes),
1154 format_white_space, indent);
1158 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1159 hole = scoreboard_next_hole (sb, hole);
1165 static transport_connection_t *
1166 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1168 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1169 if (PREDICT_FALSE (!tc))
1171 return &tc->connection;
1174 static transport_connection_t *
1175 tcp_half_open_session_get_transport (u32 conn_index)
1177 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1178 return &tc->connection;
1182 tcp_session_cal_goal_size (tcp_connection_t * tc)
1184 u16 goal_size = tc->snd_mss;
1186 goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1187 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1189 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1193 * Compute maximum segment size for session layer.
1195 * Since the result needs to be the actual data length, it first computes
1196 * the tcp options to be used in the next burst and subtracts their
1197 * length from the connection's snd_mss.
1200 tcp_session_send_mss (transport_connection_t * trans_conn)
1202 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1204 /* Ensure snd_mss does accurately reflect the amount of data we can push
1205 * in a segment. This also makes sure that options are updated according to
1206 * the current state of the connection. */
1207 tcp_update_burst_snd_vars (tc);
1209 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1210 return tcp_session_cal_goal_size (tc);
1216 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1218 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1220 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1223 /* If not snd_wnd constrained and we can't write at least a segment,
1224 * don't try at all */
1225 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1226 return snd_space < tc->cwnd ? 0 : snd_space;
1228 /* round down to mss multiple */
1229 return snd_space - (snd_space % tc->snd_mss);
1233 * Compute tx window session is allowed to fill.
1235 * Takes into account available send space, snd_mss and the congestion
1236 * state of the connection. If possible, the value returned is a multiple
1239 * @param tc tcp connection
1240 * @return number of bytes session is allowed to write
1243 tcp_snd_space_inline (tcp_connection_t * tc)
1247 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1248 || tc->state == TCP_STATE_CLOSED))
1251 snd_space = tcp_available_output_snd_space (tc);
1253 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1254 * to force the peer to send enough dupacks to start retransmitting as
1255 * per Limited Transmit (RFC3042)
1257 if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
1259 if (tc->limited_transmit != tc->snd_nxt
1260 && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
1261 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1262 tc->limited_transmit = tc->snd_nxt;
1264 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1266 int snt_limited = tc->snd_nxt - tc->limited_transmit;
1267 snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
1269 return tcp_round_snd_space (tc, snd_space);
1273 tcp_snd_space (tcp_connection_t * tc)
1275 return tcp_snd_space_inline (tc);
1279 tcp_session_send_space (transport_connection_t * trans_conn)
1281 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1282 return clib_min (tcp_snd_space_inline (tc),
1283 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1287 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1289 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1291 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1293 /* This still works if fast retransmit is on */
1294 return (tc->snd_nxt - tc->snd_una);
1298 tcp_update_time (f64 now, u8 thread_index)
1300 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1302 tcp_set_time_now (wrk);
1303 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1304 tcp_flush_frames_to_output (wrk);
1308 tcp_session_flush_data (transport_connection_t * tconn)
1310 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1311 if (tc->flags & TCP_CONN_PSH_PENDING)
1313 tc->flags |= TCP_CONN_PSH_PENDING;
1314 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1318 const static transport_proto_vft_t tcp_proto = {
1319 .enable = vnet_tcp_enable_disable,
1320 .start_listen = tcp_session_bind,
1321 .stop_listen = tcp_session_unbind,
1322 .push_header = tcp_session_push_header,
1323 .get_connection = tcp_session_get_transport,
1324 .get_listener = tcp_session_get_listener,
1325 .get_half_open = tcp_half_open_session_get_transport,
1326 .connect = tcp_session_open,
1327 .close = tcp_session_close,
1328 .cleanup = tcp_session_cleanup,
1329 .reset = tcp_session_reset,
1330 .send_mss = tcp_session_send_mss,
1331 .send_space = tcp_session_send_space,
1332 .update_time = tcp_update_time,
1333 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1334 .flush_data = tcp_session_flush_data,
1335 .custom_tx = tcp_session_custom_tx,
1336 .format_connection = format_tcp_session,
1337 .format_listener = format_tcp_listener_session,
1338 .format_half_open = format_tcp_half_open_session,
1339 .transport_options = {
1340 .tx_type = TRANSPORT_TX_PEEK,
1341 .service_type = TRANSPORT_SERVICE_VC,
1347 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1349 if (!transport_connection_is_tx_paced (&tc->connection))
1352 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1354 transport_connection_tx_pacer_update (&tc->connection,
1355 tcp_cc_get_pacing_rate (tc),
1356 srtt * CLIB_US_TIME_FREQ);
1360 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1363 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1364 transport_connection_tx_pacer_reset (&tc->connection,
1365 tcp_cc_get_pacing_rate (tc),
1367 srtt * CLIB_US_TIME_FREQ);
1371 tcp_timer_waitclose_handler (u32 conn_index, u32 thread_index)
1373 tcp_connection_t *tc;
1375 tc = tcp_connection_get (conn_index, thread_index);
1381 case TCP_STATE_CLOSE_WAIT:
1382 tcp_connection_timers_reset (tc);
1383 session_transport_closed_notify (&tc->connection);
1385 if (!(tc->flags & TCP_CONN_FINPNDG))
1387 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1388 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1392 /* Session didn't come back with a close. Send FIN either way
1393 * and switch to LAST_ACK. */
1394 tcp_cong_recovery_off (tc);
1395 /* Make sure we don't try to send unsent data */
1396 tc->snd_nxt = tc->snd_una;
1398 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1400 /* Make sure we don't wait in LAST ACK forever */
1401 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1403 /* Don't delete the connection yet */
1405 case TCP_STATE_FIN_WAIT_1:
1406 tcp_connection_timers_reset (tc);
1407 session_transport_closed_notify (&tc->connection);
1408 if (tc->flags & TCP_CONN_FINPNDG)
1410 /* If FIN pending, we haven't sent everything, but we did try.
1411 * Notify session layer that transport is closed. */
1412 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1413 tcp_send_reset (tc);
1414 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1418 /* We've sent the fin but no progress. Close the connection and
1419 * to make sure everything is flushed, setup a cleanup timer */
1420 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1421 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1424 case TCP_STATE_LAST_ACK:
1425 case TCP_STATE_CLOSING:
1426 tcp_connection_timers_reset (tc);
1427 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1428 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1429 session_transport_closed_notify (&tc->connection);
1432 tcp_connection_del (tc);
1438 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1440 tcp_timer_retransmit_handler,
1441 tcp_timer_delack_handler,
1442 tcp_timer_persist_handler,
1443 tcp_timer_waitclose_handler,
1444 tcp_timer_retransmit_syn_handler,
1449 tcp_expired_timers_dispatch (u32 * expired_timers)
1451 u32 thread_index = vlib_get_thread_index ();
1452 u32 connection_index, timer_id;
1453 tcp_connection_t *tc;
1457 * Invalidate all timer handles before dispatching. This avoids dangling
1458 * index references to timer wheel pool entries that have been freed.
1460 for (i = 0; i < vec_len (expired_timers); i++)
1462 connection_index = expired_timers[i] & 0x0FFFFFFF;
1463 timer_id = expired_timers[i] >> 28;
1465 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1466 tc = tcp_connection_get (connection_index, thread_index);
1468 tc = tcp_half_open_connection_get (connection_index);
1470 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1472 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1476 * Dispatch expired timers
1478 for (i = 0; i < vec_len (expired_timers); i++)
1480 connection_index = expired_timers[i] & 0x0FFFFFFF;
1481 timer_id = expired_timers[i] >> 28;
1482 (*timer_expiration_handlers[timer_id]) (connection_index, thread_index);
1487 tcp_initialize_timer_wheels (tcp_main_t * tm)
1489 tw_timer_wheel_16t_2w_512sl_t *tw;
1491 foreach_vlib_main (({
1492 tw = &tm->wrk_ctx[ii].timer_wheel;
1493 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1494 TCP_TIMER_TICK, ~0);
1495 tw->last_run_time = vlib_time_now (this_vlib_main);
1501 tcp_initialize_iss_seed (tcp_main_t * tm)
1503 u32 default_seed = random_default_seed ();
1504 u64 time_now = clib_cpu_time_now ();
1506 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1507 tm->iss_seed.second = random_u64 (&time_now);
1510 static clib_error_t *
1511 tcp_main_enable (vlib_main_t * vm)
1513 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1514 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1515 tcp_connection_t *tc __attribute__ ((unused));
1516 tcp_main_t *tm = vnet_get_tcp_main ();
1517 clib_error_t *error = 0;
1520 if ((error = vlib_call_init_function (vm, ip_main_init)))
1522 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1524 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1531 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1532 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1535 * Initialize data structures
1538 num_threads = 1 /* main thread */ + vtm->n_threads;
1539 vec_validate (tm->connections, num_threads - 1);
1540 vec_validate (tm->wrk_ctx, num_threads - 1);
1541 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1542 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1544 for (thread = 0; thread < num_threads; thread++)
1546 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1547 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1548 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1549 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1550 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1553 * Preallocate connections. Assume that thread 0 won't
1554 * use preallocated threads when running multi-core
1556 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1557 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1561 * Use a preallocated half-open connection pool?
1563 if (tcp_cfg.preallocated_half_open_connections)
1564 pool_init_fixed (tm->half_open_connections,
1565 tcp_cfg.preallocated_half_open_connections);
1567 /* Initialize clocks per tick for TCP timestamp. Used to compute
1568 * monotonically increasing timestamps. */
1569 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1570 / TCP_TSTAMP_RESOLUTION;
1572 if (num_threads > 1)
1574 clib_spinlock_init (&tm->half_open_lock);
1577 tcp_initialize_timer_wheels (tm);
1578 tcp_initialize_iss_seed (tm);
1580 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1581 tm->cc_last_type = TCP_CC_LAST;
1586 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1590 if (tcp_main.is_enabled)
1593 return tcp_main_enable (vm);
1597 tcp_main.is_enabled = 0;
1604 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1606 tcp_main_t *tm = &tcp_main;
1608 tm->punt_unknown4 = is_add;
1610 tm->punt_unknown6 = is_add;
1614 * Initialize default values for tcp parameters
1617 tcp_configuration_init (void)
1619 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1620 * predefined value. For SYN-ACK we still want the scale to be computed in
1622 tcp_cfg.max_rx_fifo = 32 << 20;
1623 tcp_cfg.min_rx_fifo = 4 << 10;
1625 tcp_cfg.default_mtu = 1500;
1626 tcp_cfg.initial_cwnd_multiplier = 0;
1627 tcp_cfg.enable_tx_pacing = 1;
1628 tcp_cfg.allow_tso = 0;
1629 tcp_cfg.csum_offload = 1;
1630 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1631 tcp_cfg.rwnd_min_update_ack = 1;
1633 /* Time constants defined as timer tick (100ms) multiples */
1634 tcp_cfg.delack_time = 1; /* 0.1s */
1635 tcp_cfg.closewait_time = 20; /* 2s */
1636 tcp_cfg.timewait_time = 100; /* 10s */
1637 tcp_cfg.finwait1_time = 600; /* 60s */
1638 tcp_cfg.lastack_time = 300; /* 30s */
1639 tcp_cfg.finwait2_time = 300; /* 30s */
1640 tcp_cfg.closing_time = 300; /* 30s */
1641 tcp_cfg.cleanup_time = 1; /* 0.1s */
1644 static clib_error_t *
1645 tcp_init (vlib_main_t * vm)
1647 tcp_main_t *tm = vnet_get_tcp_main ();
1648 ip_main_t *im = &ip_main;
1649 ip_protocol_info_t *pi;
1651 /* Session layer, and by implication tcp, are disabled by default */
1654 /* Register with IP for header parsing */
1655 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1657 return clib_error_return (0, "TCP protocol info AWOL");
1658 pi->format_header = format_tcp_header;
1659 pi->unformat_pg_edit = unformat_pg_tcp_header;
1661 /* Register as transport with session layer */
1662 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1663 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1664 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1665 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1667 tcp_api_reference ();
1668 tcp_configuration_init ();
1670 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1675 VLIB_INIT_FUNCTION (tcp_init);
1678 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1680 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1681 tcp_main_t *tm = &tcp_main;
1686 if (unformat (input, "%s", &cc_algo_name)
1687 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1693 vec_free (cc_algo_name);
1698 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1700 tcp_main_t *tm = vnet_get_tcp_main ();
1701 tcp_cc_algorithm_t *cc_alg;
1702 unformat_input_t sub_input;
1705 vec_foreach (cc_alg, tm->cc_algos)
1707 if (!unformat (input, cc_alg->name))
1710 if (cc_alg->unformat_cfg
1711 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1713 if (cc_alg->unformat_cfg (&sub_input))
1720 static clib_error_t *
1721 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1723 u32 cwnd_multiplier, tmp_time;
1726 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1728 if (unformat (input, "preallocated-connections %d",
1729 &tcp_cfg.preallocated_connections))
1731 else if (unformat (input, "preallocated-half-open-connections %d",
1732 &tcp_cfg.preallocated_half_open_connections))
1734 else if (unformat (input, "buffer-fail-fraction %f",
1735 &tcp_cfg.buffer_fail_fraction))
1737 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1740 if (memory_size >= 0x100000000)
1742 return clib_error_return
1743 (0, "max-rx-fifo %llu (0x%llx) too large", memory_size,
1746 tcp_cfg.max_rx_fifo = memory_size;
1748 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1751 if (memory_size >= 0x100000000)
1753 return clib_error_return
1754 (0, "min-rx-fifo %llu (0x%llx) too large", memory_size,
1757 tcp_cfg.min_rx_fifo = memory_size;
1759 else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1761 else if (unformat (input, "rwnd-min-update-ack %d",
1762 &tcp_cfg.rwnd_min_update_ack))
1764 else if (unformat (input, "initial-cwnd-multiplier %u",
1766 tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1767 else if (unformat (input, "no-tx-pacing"))
1768 tcp_cfg.enable_tx_pacing = 0;
1769 else if (unformat (input, "tso"))
1770 tcp_cfg.allow_tso = 1;
1771 else if (unformat (input, "no-csum-offload"))
1772 tcp_cfg.csum_offload = 0;
1773 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1776 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1778 else if (unformat (input, "closewait-time %u", &tmp_time))
1779 tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1780 else if (unformat (input, "timewait-time %u", &tmp_time))
1781 tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1782 else if (unformat (input, "finwait1-time %u", &tmp_time))
1783 tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1784 else if (unformat (input, "finwait2-time %u", &tmp_time))
1785 tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1786 else if (unformat (input, "lastack-time %u", &tmp_time))
1787 tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1788 else if (unformat (input, "closing-time %u", &tmp_time))
1789 tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1790 else if (unformat (input, "cleanup-time %u", &tmp_time))
1791 tcp_cfg.cleanup_time = tmp_time / TCP_TIMER_TICK;
1793 return clib_error_return (0, "unknown input `%U'",
1794 format_unformat_error, input);
1799 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1803 * \brief Configure an ipv4 source address range
1804 * @param vm vlib_main_t pointer
1805 * @param start first ipv4 address in the source address range
1806 * @param end last ipv4 address in the source address range
1807 * @param table_id VRF / table ID, 0 for the default FIB
1808 * @return 0 if all OK, else an error indication from api_errno.h
1812 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1813 ip4_address_t * start,
1814 ip4_address_t * end, u32 table_id)
1816 u32 start_host_byte_order, end_host_byte_order;
1817 fib_prefix_t prefix;
1818 fib_node_index_t fei;
1823 clib_memset (&prefix, 0, sizeof (prefix));
1825 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1827 if (fib_index == ~0)
1828 return VNET_API_ERROR_NO_SUCH_FIB;
1830 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1831 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1833 /* sanity check for reversed args or some such */
1834 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1835 return VNET_API_ERROR_INVALID_ARGUMENT;
1837 /* Lookup the last address, to identify the interface involved */
1839 prefix.fp_proto = FIB_PROTOCOL_IP4;
1840 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1842 fei = fib_table_lookup (fib_index, &prefix);
1844 /* Couldn't find route to destination. Bail out. */
1845 if (fei == FIB_NODE_INDEX_INVALID)
1846 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1848 sw_if_index = fib_entry_get_resolving_interface (fei);
1850 /* Configure proxy arp across the range */
1851 rv = ip4_neighbor_proxy_add (fib_index, start, end);
1856 rv = ip4_neighbor_proxy_enable (sw_if_index);
1863 dpo_id_t dpo = DPO_INVALID;
1865 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1867 /* Add local adjacencies for the range */
1869 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1872 prefix.fp_proto = FIB_PROTOCOL_IP4;
1873 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1875 fib_table_entry_special_dpo_update (fib_index,
1878 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1881 start_host_byte_order++;
1882 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1884 while (start_host_byte_order <= end_host_byte_order);
1890 * \brief Configure an ipv6 source address range
1891 * @param vm vlib_main_t pointer
1892 * @param start first ipv6 address in the source address range
1893 * @param end last ipv6 address in the source address range
1894 * @param table_id VRF / table ID, 0 for the default FIB
1895 * @return 0 if all OK, else an error indication from api_errno.h
1899 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1900 ip6_address_t * start,
1901 ip6_address_t * end, u32 table_id)
1903 fib_prefix_t prefix;
1905 fib_node_index_t fei;
1908 clib_memset (&prefix, 0, sizeof (prefix));
1910 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1912 if (fib_index == ~0)
1913 return VNET_API_ERROR_NO_SUCH_FIB;
1919 dpo_id_t dpo = DPO_INVALID;
1921 /* Remember this address */
1922 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1924 /* Lookup the prefix, to identify the interface involved */
1925 prefix.fp_len = 128;
1926 prefix.fp_proto = FIB_PROTOCOL_IP6;
1927 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1929 fei = fib_table_lookup (fib_index, &prefix);
1931 /* Couldn't find route to destination. Bail out. */
1932 if (fei == FIB_NODE_INDEX_INVALID)
1933 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1935 sw_if_index = fib_entry_get_resolving_interface (fei);
1937 if (sw_if_index == (u32) ~ 0)
1938 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1940 /* Add a proxy neighbor discovery entry for this address */
1941 ip6_neighbor_proxy_add (sw_if_index, start);
1943 /* Add a receive adjacency for this address */
1944 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1947 fib_table_entry_special_dpo_update (fib_index,
1950 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1953 /* Done with the entire range? */
1954 if (!memcmp (start, end, sizeof (start[0])))
1957 /* Increment the address. DGMS. */
1959 for (i = 15; i >= 0; i--)
1962 if (tmp.as_u8[i] != 0)
1970 static clib_error_t *
1971 tcp_src_address (vlib_main_t * vm,
1972 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1974 ip4_address_t v4start, v4end;
1975 ip6_address_t v6start, v6end;
1981 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1983 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1984 unformat_ip4_address, &v4end))
1986 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1988 memcpy (&v4end, &v4start, sizeof (v4start));
1991 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1992 unformat_ip6_address, &v6end))
1994 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1996 memcpy (&v6end, &v6start, sizeof (v6start));
1999 else if (unformat (input, "fib-table %d", &table_id))
2005 if (!v4set && !v6set)
2006 return clib_error_return (0, "at least one v4 or v6 address required");
2010 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
2017 case VNET_API_ERROR_NO_SUCH_FIB:
2018 return clib_error_return (0, "Invalid table-id %d", table_id);
2020 case VNET_API_ERROR_INVALID_ARGUMENT:
2021 return clib_error_return (0, "Invalid address range %U - %U",
2022 format_ip4_address, &v4start,
2023 format_ip4_address, &v4end);
2025 return clib_error_return (0, "error %d", rv);
2031 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
2038 case VNET_API_ERROR_NO_SUCH_FIB:
2039 return clib_error_return (0, "Invalid table-id %d", table_id);
2042 return clib_error_return (0, "error %d", rv);
2050 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2052 .path = "tcp src-address",
2053 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2054 .function = tcp_src_address,
2059 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2061 #if TCP_SCOREBOARD_TRACE
2063 scoreboard_trace_elt_t *block;
2069 s = format (s, "scoreboard trace:");
2070 vec_foreach (block, sb->trace)
2072 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2073 block->ack, block->snd_una_max, block->group);
2075 s = format (s, "\n");
2083 static clib_error_t *
2084 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2085 vlib_cli_command_t * cmd_arg)
2087 transport_connection_t *tconn = 0;
2088 tcp_connection_t *tc;
2090 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2092 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2093 TRANSPORT_PROTO_TCP))
2096 return clib_error_return (0, "unknown input `%U'",
2097 format_unformat_error, input);
2100 if (!TCP_SCOREBOARD_TRACE)
2102 vlib_cli_output (vm, "scoreboard tracing not enabled");
2106 tc = tcp_get_connection_from_transport (tconn);
2107 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2108 vlib_cli_output (vm, "%v", s);
2113 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2115 .path = "show tcp scoreboard trace",
2116 .short_help = "show tcp scoreboard trace <connection>",
2117 .function = tcp_show_scoreboard_trace_fn,
2122 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2125 scoreboard_trace_elt_t *trace;
2126 u32 next_ack, left, group, has_new_ack = 0;
2127 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2128 sack_block_t *block;
2130 if (!TCP_SCOREBOARD_TRACE)
2132 s = format (s, "scoreboard tracing not enabled");
2139 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2140 tcp_connection_timers_init (dummy_tc);
2141 scoreboard_init (&dummy_tc->sack_sb);
2142 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2144 #if TCP_SCOREBOARD_TRACE
2145 trace = tc->sack_sb.trace;
2146 trace_len = vec_len (tc->sack_sb.trace);
2149 for (i = 0; i < trace_len; i++)
2151 if (trace[i].ack != 0)
2153 dummy_tc->snd_una = trace[i].ack - 1448;
2154 dummy_tc->snd_una_max = trace[i].ack;
2159 while (left < trace_len)
2161 group = trace[left].group;
2162 vec_reset_length (dummy_tc->rcv_opts.sacks);
2164 while (trace[left].group == group)
2166 if (trace[left].ack != 0)
2169 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2170 trace[left].ack, trace[left].snd_una_max);
2171 dummy_tc->snd_una_max = trace[left].snd_una_max;
2172 next_ack = trace[left].ack;
2178 s = format (s, "[%u, %u], ", trace[left].start,
2180 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2181 block->start = trace[left].start;
2182 block->end = trace[left].end;
2188 tcp_rcv_sacks (dummy_tc, next_ack);
2190 dummy_tc->snd_una = next_ack;
2193 s = format (s, "result: %U", format_tcp_scoreboard,
2194 &dummy_tc->sack_sb);
2197 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2202 static clib_error_t *
2203 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2204 vlib_cli_command_t * cmd_arg)
2206 transport_connection_t *tconn = 0;
2207 tcp_connection_t *tc = 0;
2209 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2211 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2212 TRANSPORT_PROTO_TCP))
2215 return clib_error_return (0, "unknown input `%U'",
2216 format_unformat_error, input);
2219 if (!TCP_SCOREBOARD_TRACE)
2221 vlib_cli_output (vm, "scoreboard tracing not enabled");
2225 tc = tcp_get_connection_from_transport (tconn);
2228 vlib_cli_output (vm, "connection not found");
2231 str = tcp_scoreboard_replay (str, tc, 1);
2232 vlib_cli_output (vm, "%v", str);
2237 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2239 .path = "tcp replay scoreboard",
2240 .short_help = "tcp replay scoreboard <connection>",
2241 .function = tcp_scoreboard_trace_fn,
2245 static clib_error_t *
2246 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2247 vlib_cli_command_t * cmd_arg)
2249 tcp_main_t *tm = vnet_get_tcp_main ();
2250 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2251 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2253 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2254 tm->punt_unknown4 ? "enabled" : "disabled");
2255 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2256 tm->punt_unknown6 ? "enabled" : "disabled");
2260 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2262 .path = "show tcp punt",
2263 .short_help = "show tcp punt",
2264 .function = show_tcp_punt_fn,
2269 * fd.io coding-style-patch-verification: ON
2272 * eval: (c-set-style "gnu")