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_EVT (TCP_EVT_DELETE, tc);
242 /* Cleanup local endpoint if this was an active connect */
243 if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
244 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
247 /* Check if connection is not yet fully established */
248 if (tc->state == TCP_STATE_SYN_SENT)
250 /* Try to remove the half-open connection. If this is not the owning
251 * thread, tc won't be removed. Retransmit or establish timers will
252 * eventually expire and call again cleanup on the right thread. */
253 if (tcp_half_open_connection_cleanup (tc))
254 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
258 /* Make sure all timers are cleared */
259 tcp_connection_timers_reset (tc);
261 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
262 tcp_add_del_adjacency (tc, 0);
265 vec_free (tc->snd_sacks);
266 vec_free (tc->snd_sacks_fl);
267 vec_free (tc->rcv_opts.sacks);
268 pool_free (tc->sack_sb.holes);
270 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
273 tcp_connection_free (tc);
278 * Connection removal.
280 * This should be called only once connection enters CLOSED state. Note
281 * that it notifies the session of the removal event, so if the goal is to
282 * just remove the connection, call tcp_connection_cleanup instead.
285 tcp_connection_del (tcp_connection_t * tc)
287 session_transport_delete_notify (&tc->connection);
288 tcp_connection_cleanup (tc);
292 tcp_connection_alloc (u8 thread_index)
294 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
295 tcp_connection_t *tc;
297 pool_get (wrk->connections, tc);
298 clib_memset (tc, 0, sizeof (*tc));
299 tc->c_c_index = tc - wrk->connections;
300 tc->c_thread_index = thread_index;
305 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
307 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
308 tcp_connection_t *tc;
310 pool_get (wrk->connections, tc);
311 clib_memcpy_fast (tc, base, sizeof (*tc));
312 tc->c_c_index = tc - wrk->connections;
313 tc->c_thread_index = thread_index;
318 tcp_connection_free (tcp_connection_t * tc)
320 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
323 clib_memset (tc, 0xFA, sizeof (*tc));
324 pool_put (wrk->connections, tc);
327 pool_put (wrk->connections, tc);
331 * Begin connection closing procedure.
333 * If at the end the connection is not in CLOSED state, it is not removed.
334 * Instead, we rely on on TCP to advance through state machine to either
335 * 1) LAST_ACK (passive close) whereby when the last ACK is received
336 * tcp_connection_del is called. This notifies session of the delete and
338 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
339 * and cleanup is called.
341 * N.B. Half-close connections are not supported
344 tcp_connection_close (tcp_connection_t * tc)
346 TCP_EVT (TCP_EVT_CLOSE, tc);
348 /* Send/Program FIN if needed and switch state */
351 case TCP_STATE_SYN_SENT:
352 /* Try to cleanup. If not on the right thread, mark as half-open done.
353 * Connection will be cleaned up when establish timer pops */
354 tcp_connection_cleanup (tc);
356 case TCP_STATE_SYN_RCVD:
357 tcp_connection_timers_reset (tc);
359 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
360 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
362 case TCP_STATE_ESTABLISHED:
363 /* If closing with unread data, reset the connection */
364 if (transport_max_rx_dequeue (&tc->connection))
367 tcp_connection_timers_reset (tc);
368 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
369 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
370 session_transport_closed_notify (&tc->connection);
373 if (!transport_max_tx_dequeue (&tc->connection))
376 tc->flags |= TCP_CONN_FINPNDG;
377 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
378 /* Set a timer in case the peer stops responding. Otherwise the
379 * connection will be stuck here forever. */
380 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
381 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
383 case TCP_STATE_CLOSE_WAIT:
384 if (!transport_max_tx_dequeue (&tc->connection))
387 tcp_connection_timers_reset (tc);
388 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
389 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
392 tc->flags |= TCP_CONN_FINPNDG;
394 case TCP_STATE_FIN_WAIT_1:
395 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
397 case TCP_STATE_CLOSED:
398 tcp_connection_timers_reset (tc);
399 /* Delete connection but instead of doing it now wait until next
400 * dispatch cycle to give the session layer a chance to clear
401 * unhandled events */
402 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
405 TCP_DBG ("state: %u", tc->state);
410 tcp_session_close (u32 conn_index, u32 thread_index)
412 tcp_connection_t *tc;
413 tc = tcp_connection_get (conn_index, thread_index);
414 tcp_connection_close (tc);
418 tcp_session_cleanup (u32 conn_index, u32 thread_index)
420 tcp_connection_t *tc;
421 tc = tcp_connection_get (conn_index, thread_index);
424 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
425 tcp_connection_cleanup (tc);
429 tcp_session_reset (u32 conn_index, u32 thread_index)
431 tcp_connection_t *tc;
432 tc = tcp_connection_get (conn_index, thread_index);
433 session_transport_closed_notify (&tc->connection);
435 tcp_connection_timers_reset (tc);
436 tcp_cong_recovery_off (tc);
437 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
438 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
442 * Initialize all connection timers as invalid
445 tcp_connection_timers_init (tcp_connection_t * tc)
449 /* Set all to invalid */
450 for (i = 0; i < TCP_N_TIMERS; i++)
452 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
455 tc->rto = TCP_RTO_INIT;
459 * Stop all connection timers
462 tcp_connection_timers_reset (tcp_connection_t * tc)
465 for (i = 0; i < TCP_N_TIMERS; i++)
467 tcp_timer_reset (tc, i);
472 typedef struct ip4_tcp_hdr
478 typedef struct ip6_tcp_hdr
485 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
488 const dpo_id_t *choice;
492 lb = load_balance_get (dpo->dpoi_index);
496 clib_memset (&hdr, 0, sizeof (hdr));
497 hdr.ip.protocol = IP_PROTOCOL_TCP;
498 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
499 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
500 hdr.tcp.src_port = tc->c_lcl_port;
501 hdr.tcp.dst_port = tc->c_rmt_port;
502 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
507 clib_memset (&hdr, 0, sizeof (hdr));
508 hdr.ip.protocol = IP_PROTOCOL_TCP;
509 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
510 sizeof (ip6_address_t));
511 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
512 sizeof (ip6_address_t));
513 hdr.tcp.src_port = tc->c_lcl_port;
514 hdr.tcp.dst_port = tc->c_rmt_port;
515 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
517 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
518 dpo_copy (result, choice);
522 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
527 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
528 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
529 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
530 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
531 return fib_table_lookup (fib_index, &prefix);
535 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
537 dpo_id_t choice = DPO_INVALID;
538 u32 output_node_index;
541 fe = fib_entry_get (tc->c_rmt_fei);
542 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
545 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
548 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
549 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
553 /** Stack tcp connection on peer's fib entry.
555 * This ultimately populates the dpo the connection will use to send packets.
558 tcp_connection_fib_attach (tcp_connection_t * tc)
560 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
562 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
564 tcp_connection_stack_on_fib_entry (tc);
569 * Generate random iss as per rfc6528
572 tcp_generate_random_iss (tcp_connection_t * tc)
574 tcp_main_t *tm = &tcp_main;
578 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
580 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
581 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
583 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
584 tmp ^= tm->iss_seed.second;
585 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
586 return ((tmp >> 32) ^ (tmp & 0xffffffff));
590 * Initialize max segment size we're able to process.
592 * The value is constrained by the output interface's MTU and by the size
593 * of the IP and TCP headers (see RFC6691). It is also what we advertise
597 tcp_init_rcv_mss (tcp_connection_t * tc)
601 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
602 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
606 tcp_init_mss (tcp_connection_t * tc)
608 u16 default_min_mss = 536;
610 tcp_init_rcv_mss (tc);
612 /* TODO consider PMTU discovery */
613 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
615 if (tc->snd_mss < 45)
617 /* Assume that at least the min default mss works */
618 tc->snd_mss = default_min_mss;
619 tc->rcv_opts.mss = default_min_mss;
622 /* We should have enough space for 40 bytes of options */
623 ASSERT (tc->snd_mss > 45);
625 /* If we use timestamp option, account for it */
626 if (tcp_opts_tstamp (&tc->rcv_opts))
627 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
631 * Initialize connection send variables.
634 tcp_init_snd_vars (tcp_connection_t * tc)
637 * We use the time to randomize iss and for setting up the initial
638 * timestamp. Make sure it's updated otherwise syn and ack in the
639 * handshake may make it look as if time has flown in the opposite
642 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
644 tcp_init_rcv_mss (tc);
645 tc->iss = tcp_generate_random_iss (tc);
646 tc->snd_una = tc->iss;
647 tc->snd_nxt = tc->iss + 1;
648 tc->snd_una_max = tc->snd_nxt;
649 tc->srtt = 100; /* 100 ms */
651 if (!tcp_cfg.csum_offload)
652 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
656 tcp_enable_pacing (tcp_connection_t * tc)
659 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
660 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
661 tc->mrtt_us = (u32) ~ 0;
664 /** Initialize tcp connection variables
666 * Should be called after having received a msg from the peer, i.e., a SYN or
667 * a SYNACK, such that connection options have already been exchanged. */
669 tcp_connection_init_vars (tcp_connection_t * tc)
671 tcp_connection_timers_init (tc);
673 scoreboard_init (&tc->sack_sb);
674 if (tc->state == TCP_STATE_SYN_RCVD)
675 tcp_init_snd_vars (tc);
679 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
680 tcp_add_del_adjacency (tc, 1);
682 /* tcp_connection_fib_attach (tc); */
684 if (transport_connection_is_tx_paced (&tc->connection)
685 || tcp_cfg.enable_tx_pacing)
686 tcp_enable_pacing (tc);
688 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
691 if (!tcp_cfg.allow_tso)
692 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
694 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
698 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
699 u16 * lcl_port, u8 is_ip4)
704 index = tm->last_v4_addr_rotor++;
705 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
706 tm->last_v4_addr_rotor = 0;
707 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
711 index = tm->last_v6_addr_rotor++;
712 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
713 tm->last_v6_addr_rotor = 0;
714 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
715 sizeof (ip6_address_t));
717 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
720 clib_warning ("Failed to allocate src port");
728 tcp_session_open (transport_endpoint_cfg_t * rmt)
730 tcp_main_t *tm = vnet_get_tcp_main ();
731 tcp_connection_t *tc;
732 ip46_address_t lcl_addr;
737 * Allocate local endpoint
739 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
740 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
741 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
744 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
745 rmt, &lcl_addr, &lcl_port);
751 * Create connection and send SYN
753 clib_spinlock_lock_if_init (&tm->half_open_lock);
754 tc = tcp_half_open_connection_new ();
755 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
756 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
757 tc->c_rmt_port = rmt->port;
758 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
759 tc->c_is_ip4 = rmt->is_ip4;
760 tc->c_proto = TRANSPORT_PROTO_TCP;
761 tc->c_fib_index = rmt->fib_index;
762 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
763 /* The other connection vars will be initialized after SYN ACK */
764 tcp_connection_timers_init (tc);
766 TCP_EVT (TCP_EVT_OPEN, tc);
767 tc->state = TCP_STATE_SYN_SENT;
768 tcp_init_snd_vars (tc);
770 clib_spinlock_unlock_if_init (&tm->half_open_lock);
772 return tc->c_c_index;
775 const char *tcp_fsm_states[] = {
776 #define _(sym, str) str,
777 foreach_tcp_fsm_state
782 format_tcp_state (u8 * s, va_list * args)
784 u32 state = va_arg (*args, u32);
786 if (state < TCP_N_STATES)
787 s = format (s, "%s", tcp_fsm_states[state]);
789 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
793 const char *tcp_cfg_flags_str[] = {
794 #define _(sym, str) str,
800 format_tcp_cfg_flags (u8 * s, va_list * args)
802 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
805 for (i = 0; i < TCP_CFG_N_FLAG_BITS; i++)
806 if (tc->cfg_flags & (1 << i))
808 for (i = 0; i < last; i++)
810 if (tc->cfg_flags & (1 << i))
811 s = format (s, "%s, ", tcp_cfg_flags_str[i]);
814 s = format (s, "%s", tcp_cfg_flags_str[last]);
818 const char *tcp_connection_flags_str[] = {
819 #define _(sym, str) str,
820 foreach_tcp_connection_flag
825 format_tcp_connection_flags (u8 * s, va_list * args)
827 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
830 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
831 if (tc->flags & (1 << i))
833 for (i = 0; i < last; i++)
835 if (tc->flags & (1 << i))
836 s = format (s, "%s, ", tcp_connection_flags_str[i]);
839 s = format (s, "%s", tcp_connection_flags_str[last]);
843 const char *tcp_conn_timers[] = {
844 #define _(sym, str) str,
850 format_tcp_timers (u8 * s, va_list * args)
852 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
855 for (i = 0; i < TCP_N_TIMERS; i++)
856 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
859 for (i = 0; i < last; i++)
861 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
862 s = format (s, "%s,", tcp_conn_timers[i]);
866 s = format (s, "%s", tcp_conn_timers[i]);
872 format_tcp_congestion_status (u8 * s, va_list * args)
874 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
875 if (tcp_in_recovery (tc))
876 s = format (s, "recovery");
877 else if (tcp_in_fastrecovery (tc))
878 s = format (s, "fastrecovery");
880 s = format (s, "none");
885 tcp_rcv_wnd_available (tcp_connection_t * tc)
887 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
891 format_tcp_congestion (u8 * s, va_list * args)
893 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
894 u32 indent = format_get_indent (s), prr_space = 0;
896 s = format (s, "%U ", format_tcp_congestion_status, tc);
897 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
898 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
899 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u\n",
900 format_white_space, indent, tcp_available_cc_snd_space (tc),
901 tc->prev_cwnd, tc->prev_ssthresh);
902 s = format (s, "%Usnd_cong %u dupack %u limited_tx %u\n",
903 format_white_space, indent, tc->snd_congestion - tc->iss,
904 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
905 s = format (s, "%Urxt_bytes %u rxt_delivered %u rxt_head %u rxt_ts %u\n",
906 format_white_space, indent, tc->snd_rxt_bytes,
907 tc->rxt_delivered, tc->rxt_head - tc->iss,
908 tcp_time_now_w_thread (tc->c_thread_index) - tc->snd_rxt_ts);
909 if (tcp_in_fastrecovery (tc))
910 prr_space = tcp_fastrecovery_prr_snd_space (tc);
911 s = format (s, "%Uprr_start %u prr_delivered %u prr space %u\n",
912 format_white_space, indent, tc->prr_start - tc->iss,
913 tc->prr_delivered, prr_space);
918 format_tcp_stats (u8 * s, va_list * args)
920 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
921 u32 indent = format_get_indent (s);
922 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
923 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
924 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
925 format_white_space, indent, tc->segs_out,
926 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
927 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
928 format_white_space, indent, tc->fr_occurences,
929 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
930 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
931 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
932 format_white_space, indent, tc->errors.below_data_wnd,
933 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
934 tc->errors.above_ack_wnd);
939 format_tcp_vars (u8 * s, va_list * args)
941 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
942 s = format (s, " index: %u cfg: %U flags: %U timers: %U\n", tc->c_c_index,
943 format_tcp_cfg_flags, tc, format_tcp_connection_flags, tc,
944 format_tcp_timers, tc);
945 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
946 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
947 tc->snd_una_max - tc->iss);
948 s = format (s, " rcv_nxt %u rcv_las %u\n",
949 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
950 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
951 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
952 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
953 tc->snd_wl2 - tc->iss);
954 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
955 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
956 tcp_rcv_wnd_available (tc));
957 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
958 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
959 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
960 tcp_time_now () - tc->tsval_recent_age);
961 s = format (s, " snd_mss %u\n", tc->snd_mss);
962 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
963 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
965 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
966 s = format (s, " next_node %u opaque 0x%x\n", tc->next_node_index,
967 tc->next_node_opaque);
968 s = format (s, " cong: %U", format_tcp_congestion, tc);
970 if (tc->state >= TCP_STATE_ESTABLISHED)
972 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
974 s = format (s, " stats: %U\n", format_tcp_stats, tc);
976 if (vec_len (tc->snd_sacks))
977 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
983 format_tcp_connection_id (u8 * s, va_list * args)
985 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
990 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
991 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
992 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
993 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
997 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
998 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
999 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1000 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1007 format_tcp_connection (u8 * s, va_list * args)
1009 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1010 u32 verbose = va_arg (*args, u32);
1014 s = format (s, "%-50U", format_tcp_connection_id, tc);
1017 s = format (s, "%-15U", format_tcp_state, tc->state);
1019 s = format (s, "\n%U", format_tcp_vars, tc);
1026 format_tcp_session (u8 * s, va_list * args)
1028 u32 tci = va_arg (*args, u32);
1029 u32 thread_index = va_arg (*args, u32);
1030 u32 verbose = va_arg (*args, u32);
1031 tcp_connection_t *tc;
1033 tc = tcp_connection_get (tci, thread_index);
1035 s = format (s, "%U", format_tcp_connection, tc, verbose);
1037 s = format (s, "empty\n");
1042 format_tcp_listener_session (u8 * s, va_list * args)
1044 u32 tci = va_arg (*args, u32);
1045 u32 __clib_unused thread_index = va_arg (*args, u32);
1046 u32 verbose = va_arg (*args, u32);
1047 tcp_connection_t *tc = tcp_listener_get (tci);
1048 s = format (s, "%-50U", format_tcp_connection_id, tc);
1050 s = format (s, "%-15U", format_tcp_state, tc->state);
1055 format_tcp_half_open_session (u8 * s, va_list * args)
1057 u32 tci = va_arg (*args, u32);
1058 u32 __clib_unused thread_index = va_arg (*args, u32);
1059 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1060 return format (s, "%U", format_tcp_connection_id, tc);
1064 format_tcp_sacks (u8 * s, va_list * args)
1066 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1067 sack_block_t *sacks = tc->snd_sacks;
1068 sack_block_t *block;
1071 len = vec_len (sacks);
1072 for (i = 0; i < len - 1; i++)
1075 s = format (s, " start %u end %u\n", block->start - tc->irs,
1076 block->end - tc->irs);
1080 block = &sacks[len - 1];
1081 s = format (s, " start %u end %u", block->start - tc->irs,
1082 block->end - tc->irs);
1088 format_tcp_rcv_sacks (u8 * s, va_list * args)
1090 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1091 sack_block_t *sacks = tc->rcv_opts.sacks;
1092 sack_block_t *block;
1095 len = vec_len (sacks);
1096 for (i = 0; i < len - 1; i++)
1099 s = format (s, " start %u end %u\n", block->start - tc->iss,
1100 block->end - tc->iss);
1104 block = &sacks[len - 1];
1105 s = format (s, " start %u end %u", block->start - tc->iss,
1106 block->end - tc->iss);
1112 format_tcp_sack_hole (u8 * s, va_list * args)
1114 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1115 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1117 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1119 s = format (s, " [%u, %u]", hole->start, hole->end);
1124 format_tcp_scoreboard (u8 * s, va_list * args)
1126 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1127 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1128 sack_scoreboard_hole_t *hole;
1129 u32 indent = format_get_indent (s);
1131 s = format (s, "sacked %u last_sacked %u lost %u last_lost %u"
1133 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes,
1134 sb->last_lost_bytes, sb->rxt_sacked);
1135 s = format (s, "%Ulast_delivered %u high_sacked %u is_reneging %u\n",
1136 format_white_space, indent, sb->last_bytes_delivered,
1137 sb->high_sacked - tc->iss, sb->is_reneging);
1138 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1139 format_white_space, indent, sb->cur_rxt_hole,
1140 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1142 hole = scoreboard_first_hole (sb);
1144 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1145 indent, sb->head, sb->tail, pool_elts (sb->holes),
1146 format_white_space, indent);
1150 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1151 hole = scoreboard_next_hole (sb, hole);
1157 static transport_connection_t *
1158 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1160 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1161 if (PREDICT_FALSE (!tc))
1163 return &tc->connection;
1166 static transport_connection_t *
1167 tcp_half_open_session_get_transport (u32 conn_index)
1169 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1170 return &tc->connection;
1174 tcp_session_cal_goal_size (tcp_connection_t * tc)
1176 u16 goal_size = tc->snd_mss;
1178 goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1179 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1181 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1185 * Compute maximum segment size for session layer.
1187 * Since the result needs to be the actual data length, it first computes
1188 * the tcp options to be used in the next burst and subtracts their
1189 * length from the connection's snd_mss.
1192 tcp_session_send_mss (transport_connection_t * trans_conn)
1194 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1196 /* Ensure snd_mss does accurately reflect the amount of data we can push
1197 * in a segment. This also makes sure that options are updated according to
1198 * the current state of the connection. */
1199 tcp_update_burst_snd_vars (tc);
1201 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1202 return tcp_session_cal_goal_size (tc);
1208 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1210 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1212 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1215 /* If not snd_wnd constrained and we can't write at least a segment,
1216 * don't try at all */
1217 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1218 return snd_space < tc->cwnd ? 0 : snd_space;
1220 /* round down to mss multiple */
1221 return snd_space - (snd_space % tc->snd_mss);
1225 * Compute tx window session is allowed to fill.
1227 * Takes into account available send space, snd_mss and the congestion
1228 * state of the connection. If possible, the value returned is a multiple
1231 * @param tc tcp connection
1232 * @return number of bytes session is allowed to write
1235 tcp_snd_space_inline (tcp_connection_t * tc)
1239 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1240 || tc->state == TCP_STATE_CLOSED))
1243 snd_space = tcp_available_output_snd_space (tc);
1245 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1246 * to force the peer to send enough dupacks to start retransmitting as
1247 * per Limited Transmit (RFC3042)
1249 if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
1251 if (tc->limited_transmit != tc->snd_nxt
1252 && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
1253 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1254 tc->limited_transmit = tc->snd_nxt;
1256 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1258 int snt_limited = tc->snd_nxt - tc->limited_transmit;
1259 snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
1261 return tcp_round_snd_space (tc, snd_space);
1265 tcp_snd_space (tcp_connection_t * tc)
1267 return tcp_snd_space_inline (tc);
1271 tcp_session_send_space (transport_connection_t * trans_conn)
1273 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1274 return clib_min (tcp_snd_space_inline (tc),
1275 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1279 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1281 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1283 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1285 /* This still works if fast retransmit is on */
1286 return (tc->snd_nxt - tc->snd_una);
1290 tcp_update_time (f64 now, u8 thread_index)
1292 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1294 tcp_set_time_now (wrk);
1295 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1296 tcp_flush_frames_to_output (wrk);
1300 tcp_session_flush_data (transport_connection_t * tconn)
1302 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1303 if (tc->flags & TCP_CONN_PSH_PENDING)
1305 tc->flags |= TCP_CONN_PSH_PENDING;
1306 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1310 const static transport_proto_vft_t tcp_proto = {
1311 .enable = vnet_tcp_enable_disable,
1312 .start_listen = tcp_session_bind,
1313 .stop_listen = tcp_session_unbind,
1314 .push_header = tcp_session_push_header,
1315 .get_connection = tcp_session_get_transport,
1316 .get_listener = tcp_session_get_listener,
1317 .get_half_open = tcp_half_open_session_get_transport,
1318 .connect = tcp_session_open,
1319 .close = tcp_session_close,
1320 .cleanup = tcp_session_cleanup,
1321 .reset = tcp_session_reset,
1322 .send_mss = tcp_session_send_mss,
1323 .send_space = tcp_session_send_space,
1324 .update_time = tcp_update_time,
1325 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1326 .flush_data = tcp_session_flush_data,
1327 .custom_tx = tcp_session_custom_tx,
1328 .format_connection = format_tcp_session,
1329 .format_listener = format_tcp_listener_session,
1330 .format_half_open = format_tcp_half_open_session,
1331 .transport_options = {
1332 .tx_type = TRANSPORT_TX_PEEK,
1333 .service_type = TRANSPORT_SERVICE_VC,
1339 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1341 if (!transport_connection_is_tx_paced (&tc->connection))
1344 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1346 transport_connection_tx_pacer_update (&tc->connection,
1347 tcp_cc_get_pacing_rate (tc),
1348 srtt * CLIB_US_TIME_FREQ);
1352 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1355 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1356 transport_connection_tx_pacer_reset (&tc->connection,
1357 tcp_cc_get_pacing_rate (tc),
1359 srtt * CLIB_US_TIME_FREQ);
1363 tcp_timer_waitclose_handler (u32 conn_index, u32 thread_index)
1365 tcp_connection_t *tc;
1367 tc = tcp_connection_get (conn_index, thread_index);
1373 case TCP_STATE_CLOSE_WAIT:
1374 tcp_connection_timers_reset (tc);
1375 session_transport_closed_notify (&tc->connection);
1377 if (!(tc->flags & TCP_CONN_FINPNDG))
1379 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1380 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1384 /* Session didn't come back with a close. Send FIN either way
1385 * and switch to LAST_ACK. */
1386 tcp_cong_recovery_off (tc);
1387 /* Make sure we don't try to send unsent data */
1388 tc->snd_nxt = tc->snd_una;
1390 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1392 /* Make sure we don't wait in LAST ACK forever */
1393 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1395 /* Don't delete the connection yet */
1397 case TCP_STATE_FIN_WAIT_1:
1398 tcp_connection_timers_reset (tc);
1399 session_transport_closed_notify (&tc->connection);
1400 if (tc->flags & TCP_CONN_FINPNDG)
1402 /* If FIN pending, we haven't sent everything, but we did try.
1403 * Notify session layer that transport is closed. */
1404 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1405 tcp_send_reset (tc);
1406 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1410 /* We've sent the fin but no progress. Close the connection and
1411 * to make sure everything is flushed, setup a cleanup timer */
1412 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1413 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1416 case TCP_STATE_LAST_ACK:
1417 case TCP_STATE_CLOSING:
1418 tcp_connection_timers_reset (tc);
1419 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1420 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1421 session_transport_closed_notify (&tc->connection);
1424 tcp_connection_del (tc);
1430 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1432 tcp_timer_retransmit_handler,
1433 tcp_timer_delack_handler,
1434 tcp_timer_persist_handler,
1435 tcp_timer_waitclose_handler,
1436 tcp_timer_retransmit_syn_handler,
1441 tcp_expired_timers_dispatch (u32 * expired_timers)
1443 u32 thread_index = vlib_get_thread_index ();
1444 u32 connection_index, timer_id;
1445 tcp_connection_t *tc;
1449 * Invalidate all timer handles before dispatching. This avoids dangling
1450 * index references to timer wheel pool entries that have been freed.
1452 for (i = 0; i < vec_len (expired_timers); i++)
1454 connection_index = expired_timers[i] & 0x0FFFFFFF;
1455 timer_id = expired_timers[i] >> 28;
1457 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1458 tc = tcp_connection_get (connection_index, thread_index);
1460 tc = tcp_half_open_connection_get (connection_index);
1462 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1464 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1468 * Dispatch expired timers
1470 for (i = 0; i < vec_len (expired_timers); i++)
1472 connection_index = expired_timers[i] & 0x0FFFFFFF;
1473 timer_id = expired_timers[i] >> 28;
1474 (*timer_expiration_handlers[timer_id]) (connection_index, thread_index);
1479 tcp_initialize_timer_wheels (tcp_main_t * tm)
1481 tw_timer_wheel_16t_2w_512sl_t *tw;
1483 foreach_vlib_main (({
1484 tw = &tm->wrk_ctx[ii].timer_wheel;
1485 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1486 TCP_TIMER_TICK, ~0);
1487 tw->last_run_time = vlib_time_now (this_vlib_main);
1493 tcp_initialize_iss_seed (tcp_main_t * tm)
1495 u32 default_seed = random_default_seed ();
1496 u64 time_now = clib_cpu_time_now ();
1498 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1499 tm->iss_seed.second = random_u64 (&time_now);
1502 static clib_error_t *
1503 tcp_main_enable (vlib_main_t * vm)
1505 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1506 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1507 tcp_connection_t *tc __attribute__ ((unused));
1508 tcp_main_t *tm = vnet_get_tcp_main ();
1509 tcp_worker_ctx_t *wrk;
1510 clib_error_t *error = 0;
1513 if ((error = vlib_call_init_function (vm, ip_main_init)))
1515 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1517 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1524 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1525 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1528 * Initialize data structures
1531 num_threads = 1 /* main thread */ + vtm->n_threads;
1532 vec_validate (tm->wrk_ctx, num_threads - 1);
1533 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1534 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1536 for (thread = 0; thread < num_threads; thread++)
1538 wrk = &tm->wrk_ctx[thread];
1540 vec_validate (wrk->pending_deq_acked, 255);
1541 vec_validate (wrk->pending_disconnects, 255);
1542 vec_validate (wrk->pending_resets, 255);
1543 vec_reset_length (wrk->pending_deq_acked);
1544 vec_reset_length (wrk->pending_disconnects);
1545 vec_reset_length (wrk->pending_resets);
1546 wrk->vm = vlib_mains[thread];
1549 * Preallocate connections. Assume that thread 0 won't
1550 * use preallocated threads when running multi-core
1552 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1553 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1557 * Use a preallocated half-open connection pool?
1559 if (tcp_cfg.preallocated_half_open_connections)
1560 pool_init_fixed (tm->half_open_connections,
1561 tcp_cfg.preallocated_half_open_connections);
1563 /* Initialize clocks per tick for TCP timestamp. Used to compute
1564 * monotonically increasing timestamps. */
1565 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1566 / TCP_TSTAMP_RESOLUTION;
1568 if (num_threads > 1)
1570 clib_spinlock_init (&tm->half_open_lock);
1573 tcp_initialize_timer_wheels (tm);
1574 tcp_initialize_iss_seed (tm);
1576 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1577 tm->cc_last_type = TCP_CC_LAST;
1582 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1586 if (tcp_main.is_enabled)
1589 return tcp_main_enable (vm);
1593 tcp_main.is_enabled = 0;
1600 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1602 tcp_main_t *tm = &tcp_main;
1604 tm->punt_unknown4 = is_add;
1606 tm->punt_unknown6 = is_add;
1610 * Initialize default values for tcp parameters
1613 tcp_configuration_init (void)
1615 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1616 * predefined value. For SYN-ACK we still want the scale to be computed in
1618 tcp_cfg.max_rx_fifo = 32 << 20;
1619 tcp_cfg.min_rx_fifo = 4 << 10;
1621 tcp_cfg.default_mtu = 1500;
1622 tcp_cfg.initial_cwnd_multiplier = 0;
1623 tcp_cfg.enable_tx_pacing = 1;
1624 tcp_cfg.allow_tso = 0;
1625 tcp_cfg.csum_offload = 1;
1626 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1627 tcp_cfg.rwnd_min_update_ack = 1;
1629 /* Time constants defined as timer tick (100ms) multiples */
1630 tcp_cfg.delack_time = 1; /* 0.1s */
1631 tcp_cfg.closewait_time = 20; /* 2s */
1632 tcp_cfg.timewait_time = 100; /* 10s */
1633 tcp_cfg.finwait1_time = 600; /* 60s */
1634 tcp_cfg.lastack_time = 300; /* 30s */
1635 tcp_cfg.finwait2_time = 300; /* 30s */
1636 tcp_cfg.closing_time = 300; /* 30s */
1637 tcp_cfg.cleanup_time = 1; /* 0.1s */
1640 static clib_error_t *
1641 tcp_init (vlib_main_t * vm)
1643 tcp_main_t *tm = vnet_get_tcp_main ();
1644 ip_main_t *im = &ip_main;
1645 ip_protocol_info_t *pi;
1647 /* Session layer, and by implication tcp, are disabled by default */
1650 /* Register with IP for header parsing */
1651 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1653 return clib_error_return (0, "TCP protocol info AWOL");
1654 pi->format_header = format_tcp_header;
1655 pi->unformat_pg_edit = unformat_pg_tcp_header;
1657 /* Register as transport with session layer */
1658 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1659 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1660 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1661 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1663 tcp_api_reference ();
1664 tcp_configuration_init ();
1666 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1671 VLIB_INIT_FUNCTION (tcp_init);
1674 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1676 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1677 tcp_main_t *tm = &tcp_main;
1682 if (unformat (input, "%s", &cc_algo_name)
1683 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1689 vec_free (cc_algo_name);
1694 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1696 tcp_main_t *tm = vnet_get_tcp_main ();
1697 tcp_cc_algorithm_t *cc_alg;
1698 unformat_input_t sub_input;
1701 vec_foreach (cc_alg, tm->cc_algos)
1703 if (!unformat (input, cc_alg->name))
1706 if (cc_alg->unformat_cfg
1707 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1709 if (cc_alg->unformat_cfg (&sub_input))
1716 static clib_error_t *
1717 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1719 u32 cwnd_multiplier, tmp_time;
1722 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1724 if (unformat (input, "preallocated-connections %d",
1725 &tcp_cfg.preallocated_connections))
1727 else if (unformat (input, "preallocated-half-open-connections %d",
1728 &tcp_cfg.preallocated_half_open_connections))
1730 else if (unformat (input, "buffer-fail-fraction %f",
1731 &tcp_cfg.buffer_fail_fraction))
1733 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1736 if (memory_size >= 0x100000000)
1738 return clib_error_return
1739 (0, "max-rx-fifo %llu (0x%llx) too large", memory_size,
1742 tcp_cfg.max_rx_fifo = memory_size;
1744 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1747 if (memory_size >= 0x100000000)
1749 return clib_error_return
1750 (0, "min-rx-fifo %llu (0x%llx) too large", memory_size,
1753 tcp_cfg.min_rx_fifo = memory_size;
1755 else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1757 else if (unformat (input, "rwnd-min-update-ack %d",
1758 &tcp_cfg.rwnd_min_update_ack))
1760 else if (unformat (input, "initial-cwnd-multiplier %u",
1762 tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1763 else if (unformat (input, "no-tx-pacing"))
1764 tcp_cfg.enable_tx_pacing = 0;
1765 else if (unformat (input, "tso"))
1766 tcp_cfg.allow_tso = 1;
1767 else if (unformat (input, "no-csum-offload"))
1768 tcp_cfg.csum_offload = 0;
1769 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1772 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1774 else if (unformat (input, "closewait-time %u", &tmp_time))
1775 tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1776 else if (unformat (input, "timewait-time %u", &tmp_time))
1777 tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1778 else if (unformat (input, "finwait1-time %u", &tmp_time))
1779 tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1780 else if (unformat (input, "finwait2-time %u", &tmp_time))
1781 tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1782 else if (unformat (input, "lastack-time %u", &tmp_time))
1783 tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1784 else if (unformat (input, "closing-time %u", &tmp_time))
1785 tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1786 else if (unformat (input, "cleanup-time %u", &tmp_time))
1787 tcp_cfg.cleanup_time = tmp_time / TCP_TIMER_TICK;
1789 return clib_error_return (0, "unknown input `%U'",
1790 format_unformat_error, input);
1795 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1799 * \brief Configure an ipv4 source address range
1800 * @param vm vlib_main_t pointer
1801 * @param start first ipv4 address in the source address range
1802 * @param end last ipv4 address in the source address range
1803 * @param table_id VRF / table ID, 0 for the default FIB
1804 * @return 0 if all OK, else an error indication from api_errno.h
1808 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1809 ip4_address_t * start,
1810 ip4_address_t * end, u32 table_id)
1812 u32 start_host_byte_order, end_host_byte_order;
1813 fib_prefix_t prefix;
1814 fib_node_index_t fei;
1819 clib_memset (&prefix, 0, sizeof (prefix));
1821 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1823 if (fib_index == ~0)
1824 return VNET_API_ERROR_NO_SUCH_FIB;
1826 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1827 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1829 /* sanity check for reversed args or some such */
1830 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1831 return VNET_API_ERROR_INVALID_ARGUMENT;
1833 /* Lookup the last address, to identify the interface involved */
1835 prefix.fp_proto = FIB_PROTOCOL_IP4;
1836 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1838 fei = fib_table_lookup (fib_index, &prefix);
1840 /* Couldn't find route to destination. Bail out. */
1841 if (fei == FIB_NODE_INDEX_INVALID)
1842 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1844 sw_if_index = fib_entry_get_resolving_interface (fei);
1846 /* Configure proxy arp across the range */
1847 rv = ip4_neighbor_proxy_add (fib_index, start, end);
1852 rv = ip4_neighbor_proxy_enable (sw_if_index);
1859 dpo_id_t dpo = DPO_INVALID;
1861 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1863 /* Add local adjacencies for the range */
1865 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1868 prefix.fp_proto = FIB_PROTOCOL_IP4;
1869 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1871 fib_table_entry_special_dpo_update (fib_index,
1874 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1877 start_host_byte_order++;
1878 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1880 while (start_host_byte_order <= end_host_byte_order);
1886 * \brief Configure an ipv6 source address range
1887 * @param vm vlib_main_t pointer
1888 * @param start first ipv6 address in the source address range
1889 * @param end last ipv6 address in the source address range
1890 * @param table_id VRF / table ID, 0 for the default FIB
1891 * @return 0 if all OK, else an error indication from api_errno.h
1895 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1896 ip6_address_t * start,
1897 ip6_address_t * end, u32 table_id)
1899 fib_prefix_t prefix;
1901 fib_node_index_t fei;
1904 clib_memset (&prefix, 0, sizeof (prefix));
1906 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1908 if (fib_index == ~0)
1909 return VNET_API_ERROR_NO_SUCH_FIB;
1915 dpo_id_t dpo = DPO_INVALID;
1917 /* Remember this address */
1918 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1920 /* Lookup the prefix, to identify the interface involved */
1921 prefix.fp_len = 128;
1922 prefix.fp_proto = FIB_PROTOCOL_IP6;
1923 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1925 fei = fib_table_lookup (fib_index, &prefix);
1927 /* Couldn't find route to destination. Bail out. */
1928 if (fei == FIB_NODE_INDEX_INVALID)
1929 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1931 sw_if_index = fib_entry_get_resolving_interface (fei);
1933 if (sw_if_index == (u32) ~ 0)
1934 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1936 /* Add a proxy neighbor discovery entry for this address */
1937 ip6_neighbor_proxy_add (sw_if_index, start);
1939 /* Add a receive adjacency for this address */
1940 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1943 fib_table_entry_special_dpo_update (fib_index,
1946 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1949 /* Done with the entire range? */
1950 if (!memcmp (start, end, sizeof (start[0])))
1953 /* Increment the address. DGMS. */
1955 for (i = 15; i >= 0; i--)
1958 if (tmp.as_u8[i] != 0)
1966 static clib_error_t *
1967 tcp_src_address (vlib_main_t * vm,
1968 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1970 ip4_address_t v4start, v4end;
1971 ip6_address_t v6start, v6end;
1977 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1979 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1980 unformat_ip4_address, &v4end))
1982 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1984 memcpy (&v4end, &v4start, sizeof (v4start));
1987 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1988 unformat_ip6_address, &v6end))
1990 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1992 memcpy (&v6end, &v6start, sizeof (v6start));
1995 else if (unformat (input, "fib-table %d", &table_id))
2001 if (!v4set && !v6set)
2002 return clib_error_return (0, "at least one v4 or v6 address required");
2006 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
2013 case VNET_API_ERROR_NO_SUCH_FIB:
2014 return clib_error_return (0, "Invalid table-id %d", table_id);
2016 case VNET_API_ERROR_INVALID_ARGUMENT:
2017 return clib_error_return (0, "Invalid address range %U - %U",
2018 format_ip4_address, &v4start,
2019 format_ip4_address, &v4end);
2021 return clib_error_return (0, "error %d", rv);
2027 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
2034 case VNET_API_ERROR_NO_SUCH_FIB:
2035 return clib_error_return (0, "Invalid table-id %d", table_id);
2038 return clib_error_return (0, "error %d", rv);
2046 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2048 .path = "tcp src-address",
2049 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2050 .function = tcp_src_address,
2055 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2057 #if TCP_SCOREBOARD_TRACE
2059 scoreboard_trace_elt_t *block;
2065 s = format (s, "scoreboard trace:");
2066 vec_foreach (block, sb->trace)
2068 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2069 block->ack, block->snd_una_max, block->group);
2071 s = format (s, "\n");
2079 static clib_error_t *
2080 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2081 vlib_cli_command_t * cmd_arg)
2083 transport_connection_t *tconn = 0;
2084 tcp_connection_t *tc;
2086 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2088 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2089 TRANSPORT_PROTO_TCP))
2092 return clib_error_return (0, "unknown input `%U'",
2093 format_unformat_error, input);
2096 if (!TCP_SCOREBOARD_TRACE)
2098 vlib_cli_output (vm, "scoreboard tracing not enabled");
2102 tc = tcp_get_connection_from_transport (tconn);
2103 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2104 vlib_cli_output (vm, "%v", s);
2109 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2111 .path = "show tcp scoreboard trace",
2112 .short_help = "show tcp scoreboard trace <connection>",
2113 .function = tcp_show_scoreboard_trace_fn,
2118 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2121 scoreboard_trace_elt_t *trace;
2122 u32 next_ack, left, group, has_new_ack = 0;
2123 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2124 sack_block_t *block;
2126 if (!TCP_SCOREBOARD_TRACE)
2128 s = format (s, "scoreboard tracing not enabled");
2135 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2136 tcp_connection_timers_init (dummy_tc);
2137 scoreboard_init (&dummy_tc->sack_sb);
2138 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2140 #if TCP_SCOREBOARD_TRACE
2141 trace = tc->sack_sb.trace;
2142 trace_len = vec_len (tc->sack_sb.trace);
2145 for (i = 0; i < trace_len; i++)
2147 if (trace[i].ack != 0)
2149 dummy_tc->snd_una = trace[i].ack - 1448;
2150 dummy_tc->snd_una_max = trace[i].ack;
2155 while (left < trace_len)
2157 group = trace[left].group;
2158 vec_reset_length (dummy_tc->rcv_opts.sacks);
2160 while (trace[left].group == group)
2162 if (trace[left].ack != 0)
2165 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2166 trace[left].ack, trace[left].snd_una_max);
2167 dummy_tc->snd_una_max = trace[left].snd_una_max;
2168 next_ack = trace[left].ack;
2174 s = format (s, "[%u, %u], ", trace[left].start,
2176 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2177 block->start = trace[left].start;
2178 block->end = trace[left].end;
2184 tcp_rcv_sacks (dummy_tc, next_ack);
2186 dummy_tc->snd_una = next_ack;
2189 s = format (s, "result: %U", format_tcp_scoreboard,
2190 &dummy_tc->sack_sb);
2193 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2198 static clib_error_t *
2199 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2200 vlib_cli_command_t * cmd_arg)
2202 transport_connection_t *tconn = 0;
2203 tcp_connection_t *tc = 0;
2205 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2207 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2208 TRANSPORT_PROTO_TCP))
2211 return clib_error_return (0, "unknown input `%U'",
2212 format_unformat_error, input);
2215 if (!TCP_SCOREBOARD_TRACE)
2217 vlib_cli_output (vm, "scoreboard tracing not enabled");
2221 tc = tcp_get_connection_from_transport (tconn);
2224 vlib_cli_output (vm, "connection not found");
2227 str = tcp_scoreboard_replay (str, tc, 1);
2228 vlib_cli_output (vm, "%v", str);
2233 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2235 .path = "tcp replay scoreboard",
2236 .short_help = "tcp replay scoreboard <connection>",
2237 .function = tcp_scoreboard_trace_fn,
2241 static clib_error_t *
2242 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2243 vlib_cli_command_t * cmd_arg)
2245 tcp_main_t *tm = vnet_get_tcp_main ();
2246 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2247 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2249 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2250 tm->punt_unknown4 ? "enabled" : "disabled");
2251 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2252 tm->punt_unknown6 ? "enabled" : "disabled");
2256 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2258 .path = "show tcp punt",
2259 .short_help = "show tcp punt",
2260 .function = show_tcp_punt_fn,
2265 * fd.io coding-style-patch-verification: ON
2268 * eval: (c-set-style "gnu")