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);
371 tcp_worker_stats_inc (tc->c_thread_index, rst_unread, 1);
374 if (!transport_max_tx_dequeue (&tc->connection))
377 tc->flags |= TCP_CONN_FINPNDG;
378 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
379 /* Set a timer in case the peer stops responding. Otherwise the
380 * connection will be stuck here forever. */
381 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
382 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
384 case TCP_STATE_CLOSE_WAIT:
385 if (!transport_max_tx_dequeue (&tc->connection))
388 tcp_connection_timers_reset (tc);
389 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
390 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
393 tc->flags |= TCP_CONN_FINPNDG;
395 case TCP_STATE_FIN_WAIT_1:
396 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
398 case TCP_STATE_CLOSED:
399 tcp_connection_timers_reset (tc);
400 /* Delete connection but instead of doing it now wait until next
401 * dispatch cycle to give the session layer a chance to clear
402 * unhandled events */
403 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
406 TCP_DBG ("state: %u", tc->state);
411 tcp_session_close (u32 conn_index, u32 thread_index)
413 tcp_connection_t *tc;
414 tc = tcp_connection_get (conn_index, thread_index);
415 tcp_connection_close (tc);
419 tcp_session_cleanup (u32 conn_index, u32 thread_index)
421 tcp_connection_t *tc;
422 tc = tcp_connection_get (conn_index, thread_index);
425 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
426 tcp_connection_cleanup (tc);
430 tcp_session_reset (u32 conn_index, u32 thread_index)
432 tcp_connection_t *tc;
433 tc = tcp_connection_get (conn_index, thread_index);
434 session_transport_closed_notify (&tc->connection);
436 tcp_connection_timers_reset (tc);
437 tcp_cong_recovery_off (tc);
438 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
439 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
443 * Initialize all connection timers as invalid
446 tcp_connection_timers_init (tcp_connection_t * tc)
450 /* Set all to invalid */
451 for (i = 0; i < TCP_N_TIMERS; i++)
453 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
456 tc->rto = TCP_RTO_INIT;
460 * Stop all connection timers
463 tcp_connection_timers_reset (tcp_connection_t * tc)
466 for (i = 0; i < TCP_N_TIMERS; i++)
468 tcp_timer_reset (tc, i);
473 typedef struct ip4_tcp_hdr
479 typedef struct ip6_tcp_hdr
486 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
489 const dpo_id_t *choice;
493 lb = load_balance_get (dpo->dpoi_index);
497 clib_memset (&hdr, 0, sizeof (hdr));
498 hdr.ip.protocol = IP_PROTOCOL_TCP;
499 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
500 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
501 hdr.tcp.src_port = tc->c_lcl_port;
502 hdr.tcp.dst_port = tc->c_rmt_port;
503 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
508 clib_memset (&hdr, 0, sizeof (hdr));
509 hdr.ip.protocol = IP_PROTOCOL_TCP;
510 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
511 sizeof (ip6_address_t));
512 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
513 sizeof (ip6_address_t));
514 hdr.tcp.src_port = tc->c_lcl_port;
515 hdr.tcp.dst_port = tc->c_rmt_port;
516 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
518 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
519 dpo_copy (result, choice);
523 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
528 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
529 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
530 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
531 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
532 return fib_table_lookup (fib_index, &prefix);
536 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
538 dpo_id_t choice = DPO_INVALID;
539 u32 output_node_index;
542 fe = fib_entry_get (tc->c_rmt_fei);
543 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
546 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
549 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
550 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
554 /** Stack tcp connection on peer's fib entry.
556 * This ultimately populates the dpo the connection will use to send packets.
559 tcp_connection_fib_attach (tcp_connection_t * tc)
561 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
563 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
565 tcp_connection_stack_on_fib_entry (tc);
570 * Generate random iss as per rfc6528
573 tcp_generate_random_iss (tcp_connection_t * tc)
575 tcp_main_t *tm = &tcp_main;
579 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
581 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
582 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
584 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
585 tmp ^= tm->iss_seed.second;
586 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
587 return ((tmp >> 32) ^ (tmp & 0xffffffff));
591 * Initialize max segment size we're able to process.
593 * The value is constrained by the output interface's MTU and by the size
594 * of the IP and TCP headers (see RFC6691). It is also what we advertise
598 tcp_init_rcv_mss (tcp_connection_t * tc)
602 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
603 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
607 tcp_init_mss (tcp_connection_t * tc)
609 u16 default_min_mss = 536;
611 tcp_init_rcv_mss (tc);
613 /* TODO consider PMTU discovery */
614 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
616 if (tc->snd_mss < 45)
618 /* Assume that at least the min default mss works */
619 tc->snd_mss = default_min_mss;
620 tc->rcv_opts.mss = default_min_mss;
623 /* We should have enough space for 40 bytes of options */
624 ASSERT (tc->snd_mss > 45);
626 /* If we use timestamp option, account for it */
627 if (tcp_opts_tstamp (&tc->rcv_opts))
628 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
632 * Initialize connection send variables.
635 tcp_init_snd_vars (tcp_connection_t * tc)
638 * We use the time to randomize iss and for setting up the initial
639 * timestamp. Make sure it's updated otherwise syn and ack in the
640 * handshake may make it look as if time has flown in the opposite
643 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
645 tcp_init_rcv_mss (tc);
646 tc->iss = tcp_generate_random_iss (tc);
647 tc->snd_una = tc->iss;
648 tc->snd_nxt = tc->iss + 1;
649 tc->snd_una_max = tc->snd_nxt;
650 tc->srtt = 100; /* 100 ms */
652 if (!tcp_cfg.csum_offload)
653 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
657 tcp_enable_pacing (tcp_connection_t * tc)
660 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
661 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
662 tc->mrtt_us = (u32) ~ 0;
665 /** Initialize tcp connection variables
667 * Should be called after having received a msg from the peer, i.e., a SYN or
668 * a SYNACK, such that connection options have already been exchanged. */
670 tcp_connection_init_vars (tcp_connection_t * tc)
672 tcp_connection_timers_init (tc);
674 scoreboard_init (&tc->sack_sb);
675 if (tc->state == TCP_STATE_SYN_RCVD)
676 tcp_init_snd_vars (tc);
680 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
681 tcp_add_del_adjacency (tc, 1);
683 /* tcp_connection_fib_attach (tc); */
685 if (transport_connection_is_tx_paced (&tc->connection)
686 || tcp_cfg.enable_tx_pacing)
687 tcp_enable_pacing (tc);
689 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
692 if (!tcp_cfg.allow_tso)
693 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
695 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
699 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
700 u16 * lcl_port, u8 is_ip4)
705 index = tm->last_v4_addr_rotor++;
706 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
707 tm->last_v4_addr_rotor = 0;
708 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
712 index = tm->last_v6_addr_rotor++;
713 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
714 tm->last_v6_addr_rotor = 0;
715 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
716 sizeof (ip6_address_t));
718 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
721 clib_warning ("Failed to allocate src port");
729 tcp_session_open (transport_endpoint_cfg_t * rmt)
731 tcp_main_t *tm = vnet_get_tcp_main ();
732 tcp_connection_t *tc;
733 ip46_address_t lcl_addr;
738 * Allocate local endpoint
740 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
741 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
742 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
745 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
746 rmt, &lcl_addr, &lcl_port);
752 * Create connection and send SYN
754 clib_spinlock_lock_if_init (&tm->half_open_lock);
755 tc = tcp_half_open_connection_new ();
756 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
757 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
758 tc->c_rmt_port = rmt->port;
759 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
760 tc->c_is_ip4 = rmt->is_ip4;
761 tc->c_proto = TRANSPORT_PROTO_TCP;
762 tc->c_fib_index = rmt->fib_index;
763 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
764 /* The other connection vars will be initialized after SYN ACK */
765 tcp_connection_timers_init (tc);
767 TCP_EVT (TCP_EVT_OPEN, tc);
768 tc->state = TCP_STATE_SYN_SENT;
769 tcp_init_snd_vars (tc);
771 clib_spinlock_unlock_if_init (&tm->half_open_lock);
773 return tc->c_c_index;
776 const char *tcp_fsm_states[] = {
777 #define _(sym, str) str,
778 foreach_tcp_fsm_state
783 format_tcp_state (u8 * s, va_list * args)
785 u32 state = va_arg (*args, u32);
787 if (state < TCP_N_STATES)
788 s = format (s, "%s", tcp_fsm_states[state]);
790 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
794 const char *tcp_cfg_flags_str[] = {
795 #define _(sym, str) str,
801 format_tcp_cfg_flags (u8 * s, va_list * args)
803 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
806 for (i = 0; i < TCP_CFG_N_FLAG_BITS; i++)
807 if (tc->cfg_flags & (1 << i))
809 for (i = 0; i < last; i++)
811 if (tc->cfg_flags & (1 << i))
812 s = format (s, "%s, ", tcp_cfg_flags_str[i]);
815 s = format (s, "%s", tcp_cfg_flags_str[last]);
819 const char *tcp_connection_flags_str[] = {
820 #define _(sym, str) str,
821 foreach_tcp_connection_flag
826 format_tcp_connection_flags (u8 * s, va_list * args)
828 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
831 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
832 if (tc->flags & (1 << i))
834 for (i = 0; i < last; i++)
836 if (tc->flags & (1 << i))
837 s = format (s, "%s, ", tcp_connection_flags_str[i]);
840 s = format (s, "%s", tcp_connection_flags_str[last]);
844 const char *tcp_conn_timers[] = {
845 #define _(sym, str) str,
851 format_tcp_timers (u8 * s, va_list * args)
853 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
856 for (i = 0; i < TCP_N_TIMERS; i++)
857 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
860 for (i = 0; i < last; i++)
862 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
863 s = format (s, "%s,", tcp_conn_timers[i]);
867 s = format (s, "%s", tcp_conn_timers[i]);
873 format_tcp_congestion_status (u8 * s, va_list * args)
875 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
876 if (tcp_in_recovery (tc))
877 s = format (s, "recovery");
878 else if (tcp_in_fastrecovery (tc))
879 s = format (s, "fastrecovery");
881 s = format (s, "none");
886 tcp_rcv_wnd_available (tcp_connection_t * tc)
888 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
892 format_tcp_congestion (u8 * s, va_list * args)
894 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
895 u32 indent = format_get_indent (s), prr_space = 0;
897 s = format (s, "%U ", format_tcp_congestion_status, tc);
898 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
899 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
900 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u\n",
901 format_white_space, indent, tcp_available_cc_snd_space (tc),
902 tc->prev_cwnd, tc->prev_ssthresh);
903 s = format (s, "%Usnd_cong %u dupack %u limited_tx %u\n",
904 format_white_space, indent, tc->snd_congestion - tc->iss,
905 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
906 s = format (s, "%Urxt_bytes %u rxt_delivered %u rxt_head %u rxt_ts %u\n",
907 format_white_space, indent, tc->snd_rxt_bytes,
908 tc->rxt_delivered, tc->rxt_head - tc->iss,
909 tcp_time_now_w_thread (tc->c_thread_index) - tc->snd_rxt_ts);
910 if (tcp_in_fastrecovery (tc))
911 prr_space = tcp_fastrecovery_prr_snd_space (tc);
912 s = format (s, "%Uprr_start %u prr_delivered %u prr space %u\n",
913 format_white_space, indent, tc->prr_start - tc->iss,
914 tc->prr_delivered, prr_space);
919 format_tcp_stats (u8 * s, va_list * args)
921 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
922 u32 indent = format_get_indent (s);
923 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
924 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
925 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
926 format_white_space, indent, tc->segs_out,
927 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
928 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
929 format_white_space, indent, tc->fr_occurences,
930 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
931 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
932 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
933 format_white_space, indent, tc->errors.below_data_wnd,
934 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
935 tc->errors.above_ack_wnd);
940 format_tcp_vars (u8 * s, va_list * args)
942 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
943 s = format (s, " index: %u cfg: %U flags: %U timers: %U\n", tc->c_c_index,
944 format_tcp_cfg_flags, tc, format_tcp_connection_flags, tc,
945 format_tcp_timers, tc);
946 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
947 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
948 tc->snd_una_max - tc->iss);
949 s = format (s, " rcv_nxt %u rcv_las %u\n",
950 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
951 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
952 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
953 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
954 tc->snd_wl2 - tc->iss);
955 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
956 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
957 tcp_rcv_wnd_available (tc));
958 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
959 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
960 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
961 tcp_time_now () - tc->tsval_recent_age);
962 s = format (s, " snd_mss %u\n", tc->snd_mss);
963 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
964 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
966 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
967 s = format (s, " next_node %u opaque 0x%x\n", tc->next_node_index,
968 tc->next_node_opaque);
969 s = format (s, " cong: %U", format_tcp_congestion, tc);
971 if (tc->state >= TCP_STATE_ESTABLISHED)
973 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
975 s = format (s, " stats: %U\n", format_tcp_stats, tc);
977 if (vec_len (tc->snd_sacks))
978 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
984 format_tcp_connection_id (u8 * s, va_list * args)
986 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
991 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
992 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
993 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
994 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
998 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
999 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1000 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1001 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1008 format_tcp_connection (u8 * s, va_list * args)
1010 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1011 u32 verbose = va_arg (*args, u32);
1015 s = format (s, "%-50U", format_tcp_connection_id, tc);
1018 s = format (s, "%-15U", format_tcp_state, tc->state);
1020 s = format (s, "\n%U", format_tcp_vars, tc);
1027 format_tcp_session (u8 * s, va_list * args)
1029 u32 tci = va_arg (*args, u32);
1030 u32 thread_index = va_arg (*args, u32);
1031 u32 verbose = va_arg (*args, u32);
1032 tcp_connection_t *tc;
1034 tc = tcp_connection_get (tci, thread_index);
1036 s = format (s, "%U", format_tcp_connection, tc, verbose);
1038 s = format (s, "empty\n");
1043 format_tcp_listener_session (u8 * s, va_list * args)
1045 u32 tci = va_arg (*args, u32);
1046 u32 __clib_unused thread_index = va_arg (*args, u32);
1047 u32 verbose = va_arg (*args, u32);
1048 tcp_connection_t *tc = tcp_listener_get (tci);
1049 s = format (s, "%-50U", format_tcp_connection_id, tc);
1051 s = format (s, "%-15U", format_tcp_state, tc->state);
1056 format_tcp_half_open_session (u8 * s, va_list * args)
1058 u32 tci = va_arg (*args, u32);
1059 u32 __clib_unused thread_index = va_arg (*args, u32);
1060 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1061 return format (s, "%U", format_tcp_connection_id, tc);
1065 format_tcp_sacks (u8 * s, va_list * args)
1067 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1068 sack_block_t *sacks = tc->snd_sacks;
1069 sack_block_t *block;
1072 len = vec_len (sacks);
1073 for (i = 0; i < len - 1; i++)
1076 s = format (s, " start %u end %u\n", block->start - tc->irs,
1077 block->end - tc->irs);
1081 block = &sacks[len - 1];
1082 s = format (s, " start %u end %u", block->start - tc->irs,
1083 block->end - tc->irs);
1089 format_tcp_rcv_sacks (u8 * s, va_list * args)
1091 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1092 sack_block_t *sacks = tc->rcv_opts.sacks;
1093 sack_block_t *block;
1096 len = vec_len (sacks);
1097 for (i = 0; i < len - 1; i++)
1100 s = format (s, " start %u end %u\n", block->start - tc->iss,
1101 block->end - tc->iss);
1105 block = &sacks[len - 1];
1106 s = format (s, " start %u end %u", block->start - tc->iss,
1107 block->end - tc->iss);
1113 format_tcp_sack_hole (u8 * s, va_list * args)
1115 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1116 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1118 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1120 s = format (s, " [%u, %u]", hole->start, hole->end);
1125 format_tcp_scoreboard (u8 * s, va_list * args)
1127 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1128 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1129 sack_scoreboard_hole_t *hole;
1130 u32 indent = format_get_indent (s);
1132 s = format (s, "sacked %u last_sacked %u lost %u last_lost %u"
1134 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes,
1135 sb->last_lost_bytes, sb->rxt_sacked);
1136 s = format (s, "%Ulast_delivered %u high_sacked %u is_reneging %u\n",
1137 format_white_space, indent, sb->last_bytes_delivered,
1138 sb->high_sacked - tc->iss, sb->is_reneging);
1139 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1140 format_white_space, indent, sb->cur_rxt_hole,
1141 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1143 hole = scoreboard_first_hole (sb);
1145 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1146 indent, sb->head, sb->tail, pool_elts (sb->holes),
1147 format_white_space, indent);
1151 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1152 hole = scoreboard_next_hole (sb, hole);
1158 static transport_connection_t *
1159 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1161 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1162 if (PREDICT_FALSE (!tc))
1164 return &tc->connection;
1167 static transport_connection_t *
1168 tcp_half_open_session_get_transport (u32 conn_index)
1170 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1171 return &tc->connection;
1175 tcp_session_cal_goal_size (tcp_connection_t * tc)
1177 u16 goal_size = tc->snd_mss;
1179 goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1180 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1182 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1186 * Compute maximum segment size for session layer.
1188 * Since the result needs to be the actual data length, it first computes
1189 * the tcp options to be used in the next burst and subtracts their
1190 * length from the connection's snd_mss.
1193 tcp_session_send_mss (transport_connection_t * trans_conn)
1195 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1197 /* Ensure snd_mss does accurately reflect the amount of data we can push
1198 * in a segment. This also makes sure that options are updated according to
1199 * the current state of the connection. */
1200 tcp_update_burst_snd_vars (tc);
1202 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1203 return tcp_session_cal_goal_size (tc);
1209 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1211 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1213 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1216 /* If not snd_wnd constrained and we can't write at least a segment,
1217 * don't try at all */
1218 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1219 return snd_space < tc->cwnd ? 0 : snd_space;
1221 /* round down to mss multiple */
1222 return snd_space - (snd_space % tc->snd_mss);
1226 * Compute tx window session is allowed to fill.
1228 * Takes into account available send space, snd_mss and the congestion
1229 * state of the connection. If possible, the value returned is a multiple
1232 * @param tc tcp connection
1233 * @return number of bytes session is allowed to write
1236 tcp_snd_space_inline (tcp_connection_t * tc)
1240 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1241 || tc->state == TCP_STATE_CLOSED))
1244 snd_space = tcp_available_output_snd_space (tc);
1246 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1247 * to force the peer to send enough dupacks to start retransmitting as
1248 * per Limited Transmit (RFC3042)
1250 if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
1252 if (tc->limited_transmit != tc->snd_nxt
1253 && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
1254 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1255 tc->limited_transmit = tc->snd_nxt;
1257 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1259 int snt_limited = tc->snd_nxt - tc->limited_transmit;
1260 snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
1262 return tcp_round_snd_space (tc, snd_space);
1266 tcp_snd_space (tcp_connection_t * tc)
1268 return tcp_snd_space_inline (tc);
1272 tcp_session_send_space (transport_connection_t * trans_conn)
1274 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1275 return clib_min (tcp_snd_space_inline (tc),
1276 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1280 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1282 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1284 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1286 /* This still works if fast retransmit is on */
1287 return (tc->snd_nxt - tc->snd_una);
1291 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1295 case TCP_STATE_CLOSE_WAIT:
1296 tcp_connection_timers_reset (tc);
1297 session_transport_closed_notify (&tc->connection);
1298 /* App never returned with a close */
1299 if (!(tc->flags & TCP_CONN_FINPNDG))
1301 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1302 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1303 tcp_worker_stats_inc (tc->c_thread_index, to_closewait, 1);
1307 /* Send FIN either way and switch to LAST_ACK. */
1308 tcp_cong_recovery_off (tc);
1309 /* Make sure we don't try to send unsent data */
1310 tc->snd_nxt = tc->snd_una;
1312 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1314 /* Make sure we don't wait in LAST ACK forever */
1315 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1316 tcp_worker_stats_inc (tc->c_thread_index, to_closewait2, 1);
1318 /* Don't delete the connection yet */
1320 case TCP_STATE_FIN_WAIT_1:
1321 tcp_connection_timers_reset (tc);
1322 session_transport_closed_notify (&tc->connection);
1323 if (tc->flags & TCP_CONN_FINPNDG)
1325 /* If FIN pending, we haven't sent everything, but we did try.
1326 * Notify session layer that transport is closed. */
1327 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1328 tcp_send_reset (tc);
1329 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1333 /* We've sent the fin but no progress. Close the connection and
1334 * to make sure everything is flushed, setup a cleanup timer */
1335 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1336 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1338 tcp_worker_stats_inc (tc->c_thread_index, to_finwait1, 1);
1340 case TCP_STATE_LAST_ACK:
1341 tcp_connection_timers_reset (tc);
1342 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1343 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1344 session_transport_closed_notify (&tc->connection);
1345 tcp_worker_stats_inc (tc->c_thread_index, to_lastack, 1);
1347 case TCP_STATE_CLOSING:
1348 tcp_connection_timers_reset (tc);
1349 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1350 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1351 session_transport_closed_notify (&tc->connection);
1352 tcp_worker_stats_inc (tc->c_thread_index, to_closing, 1);
1354 case TCP_STATE_FIN_WAIT_2:
1355 tcp_send_reset (tc);
1356 tcp_connection_timers_reset (tc);
1357 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1358 session_transport_closed_notify (&tc->connection);
1359 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1360 tcp_worker_stats_inc (tc->c_thread_index, to_finwait2, 1);
1363 tcp_connection_del (tc);
1369 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1371 tcp_timer_retransmit_handler,
1372 tcp_timer_delack_handler,
1373 tcp_timer_persist_handler,
1374 tcp_timer_waitclose_handler,
1375 tcp_timer_retransmit_syn_handler,
1380 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1382 u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1383 tcp_connection_t *tc;
1386 if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1389 thread_index = wrk->vm->thread_index;
1390 for (i = 0; i < clib_min (n_timers, 32); i++)
1392 clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1393 connection_index = timer_handle & 0x0FFFFFFF;
1394 timer_id = timer_handle >> 28;
1396 if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1397 tc = tcp_connection_get (connection_index, thread_index);
1399 tc = tcp_half_open_connection_get (connection_index);
1401 if (PREDICT_FALSE (!tc))
1404 /* Skip timer if it was rearmed while pending dispatch */
1405 if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1408 (*timer_expiration_handlers[timer_id]) (tc);
1413 * Flush ip lookup tx frames populated by timer pops
1416 tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk)
1418 if (wrk->ip_lookup_tx_frames[0])
1420 vlib_put_frame_to_node (wrk->vm, ip4_lookup_node.index,
1421 wrk->ip_lookup_tx_frames[0]);
1422 wrk->ip_lookup_tx_frames[0] = 0;
1424 if (wrk->ip_lookup_tx_frames[1])
1426 vlib_put_frame_to_node (wrk->vm, ip6_lookup_node.index,
1427 wrk->ip_lookup_tx_frames[1]);
1428 wrk->ip_lookup_tx_frames[1] = 0;
1433 tcp_update_time (f64 now, u8 thread_index)
1435 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1437 tcp_set_time_now (wrk);
1438 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1439 tcp_dispatch_pending_timers (wrk);
1440 tcp_flush_frames_to_output (wrk);
1444 tcp_session_flush_data (transport_connection_t * tconn)
1446 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1447 if (tc->flags & TCP_CONN_PSH_PENDING)
1449 tc->flags |= TCP_CONN_PSH_PENDING;
1450 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1454 const static transport_proto_vft_t tcp_proto = {
1455 .enable = vnet_tcp_enable_disable,
1456 .start_listen = tcp_session_bind,
1457 .stop_listen = tcp_session_unbind,
1458 .push_header = tcp_session_push_header,
1459 .get_connection = tcp_session_get_transport,
1460 .get_listener = tcp_session_get_listener,
1461 .get_half_open = tcp_half_open_session_get_transport,
1462 .connect = tcp_session_open,
1463 .close = tcp_session_close,
1464 .cleanup = tcp_session_cleanup,
1465 .reset = tcp_session_reset,
1466 .send_mss = tcp_session_send_mss,
1467 .send_space = tcp_session_send_space,
1468 .update_time = tcp_update_time,
1469 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1470 .flush_data = tcp_session_flush_data,
1471 .custom_tx = tcp_session_custom_tx,
1472 .format_connection = format_tcp_session,
1473 .format_listener = format_tcp_listener_session,
1474 .format_half_open = format_tcp_half_open_session,
1475 .transport_options = {
1476 .tx_type = TRANSPORT_TX_PEEK,
1477 .service_type = TRANSPORT_SERVICE_VC,
1483 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1485 if (!transport_connection_is_tx_paced (&tc->connection))
1488 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1490 transport_connection_tx_pacer_update (&tc->connection,
1491 tcp_cc_get_pacing_rate (tc),
1492 srtt * CLIB_US_TIME_FREQ);
1496 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1499 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1500 transport_connection_tx_pacer_reset (&tc->connection,
1501 tcp_cc_get_pacing_rate (tc),
1503 srtt * CLIB_US_TIME_FREQ);
1507 tcp_expired_timers_dispatch (u32 * expired_timers)
1509 u32 thread_index = vlib_get_thread_index ();
1510 u32 connection_index, timer_id, n_expired;
1511 tcp_worker_ctx_t *wrk;
1512 tcp_connection_t *tc;
1515 wrk = tcp_get_worker (thread_index);
1516 n_expired = vec_len (expired_timers);
1517 tcp_workerp_stats_inc (wrk, timer_expirations, n_expired);
1520 * Invalidate all timer handles before dispatching. This avoids dangling
1521 * index references to timer wheel pool entries that have been freed.
1523 for (i = 0; i < n_expired; i++)
1525 connection_index = expired_timers[i] & 0x0FFFFFFF;
1526 timer_id = expired_timers[i] >> 28;
1528 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1529 tc = tcp_connection_get (connection_index, thread_index);
1531 tc = tcp_half_open_connection_get (connection_index);
1533 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1535 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1538 clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1542 tcp_initialize_timer_wheels (tcp_main_t * tm)
1544 tw_timer_wheel_16t_2w_512sl_t *tw;
1546 foreach_vlib_main (({
1547 tw = &tm->wrk_ctx[ii].timer_wheel;
1548 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1549 TCP_TIMER_TICK, ~0);
1550 tw->last_run_time = vlib_time_now (this_vlib_main);
1556 tcp_initialize_iss_seed (tcp_main_t * tm)
1558 u32 default_seed = random_default_seed ();
1559 u64 time_now = clib_cpu_time_now ();
1561 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1562 tm->iss_seed.second = random_u64 (&time_now);
1565 static clib_error_t *
1566 tcp_main_enable (vlib_main_t * vm)
1568 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1569 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1570 tcp_connection_t *tc __attribute__ ((unused));
1571 tcp_main_t *tm = vnet_get_tcp_main ();
1572 tcp_worker_ctx_t *wrk;
1573 clib_error_t *error = 0;
1576 if ((error = vlib_call_init_function (vm, ip_main_init)))
1578 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1580 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1587 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1588 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1591 * Initialize data structures
1594 num_threads = 1 /* main thread */ + vtm->n_threads;
1595 vec_validate (tm->wrk_ctx, num_threads - 1);
1596 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1597 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1599 for (thread = 0; thread < num_threads; thread++)
1601 wrk = &tm->wrk_ctx[thread];
1603 vec_validate (wrk->pending_deq_acked, 255);
1604 vec_validate (wrk->pending_disconnects, 255);
1605 vec_validate (wrk->pending_resets, 255);
1606 vec_reset_length (wrk->pending_deq_acked);
1607 vec_reset_length (wrk->pending_disconnects);
1608 vec_reset_length (wrk->pending_resets);
1609 wrk->vm = vlib_mains[thread];
1612 * Preallocate connections. Assume that thread 0 won't
1613 * use preallocated threads when running multi-core
1615 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1616 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1620 * Use a preallocated half-open connection pool?
1622 if (tcp_cfg.preallocated_half_open_connections)
1623 pool_init_fixed (tm->half_open_connections,
1624 tcp_cfg.preallocated_half_open_connections);
1626 /* Initialize clocks per tick for TCP timestamp. Used to compute
1627 * monotonically increasing timestamps. */
1628 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1629 / TCP_TSTAMP_RESOLUTION;
1631 if (num_threads > 1)
1633 clib_spinlock_init (&tm->half_open_lock);
1636 tcp_initialize_timer_wheels (tm);
1637 tcp_initialize_iss_seed (tm);
1639 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1640 tm->cc_last_type = TCP_CC_LAST;
1645 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1649 if (tcp_main.is_enabled)
1652 return tcp_main_enable (vm);
1656 tcp_main.is_enabled = 0;
1663 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1665 tcp_main_t *tm = &tcp_main;
1667 tm->punt_unknown4 = is_add;
1669 tm->punt_unknown6 = is_add;
1673 * Initialize default values for tcp parameters
1676 tcp_configuration_init (void)
1678 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1679 * predefined value. For SYN-ACK we still want the scale to be computed in
1681 tcp_cfg.max_rx_fifo = 32 << 20;
1682 tcp_cfg.min_rx_fifo = 4 << 10;
1684 tcp_cfg.default_mtu = 1500;
1685 tcp_cfg.initial_cwnd_multiplier = 0;
1686 tcp_cfg.enable_tx_pacing = 1;
1687 tcp_cfg.allow_tso = 0;
1688 tcp_cfg.csum_offload = 1;
1689 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1690 tcp_cfg.rwnd_min_update_ack = 1;
1692 /* Time constants defined as timer tick (100ms) multiples */
1693 tcp_cfg.delack_time = 1; /* 0.1s */
1694 tcp_cfg.closewait_time = 20; /* 2s */
1695 tcp_cfg.timewait_time = 100; /* 10s */
1696 tcp_cfg.finwait1_time = 600; /* 60s */
1697 tcp_cfg.lastack_time = 300; /* 30s */
1698 tcp_cfg.finwait2_time = 300; /* 30s */
1699 tcp_cfg.closing_time = 300; /* 30s */
1700 tcp_cfg.cleanup_time = 1; /* 0.1s */
1703 static clib_error_t *
1704 tcp_init (vlib_main_t * vm)
1706 tcp_main_t *tm = vnet_get_tcp_main ();
1707 ip_main_t *im = &ip_main;
1708 ip_protocol_info_t *pi;
1710 /* Session layer, and by implication tcp, are disabled by default */
1713 /* Register with IP for header parsing */
1714 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1716 return clib_error_return (0, "TCP protocol info AWOL");
1717 pi->format_header = format_tcp_header;
1718 pi->unformat_pg_edit = unformat_pg_tcp_header;
1720 /* Register as transport with session layer */
1721 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1722 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1723 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1724 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1726 tcp_api_reference ();
1727 tcp_configuration_init ();
1729 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1734 VLIB_INIT_FUNCTION (tcp_init);
1737 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1739 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1740 tcp_main_t *tm = &tcp_main;
1745 if (unformat (input, "%s", &cc_algo_name)
1746 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1752 vec_free (cc_algo_name);
1757 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1759 tcp_main_t *tm = vnet_get_tcp_main ();
1760 tcp_cc_algorithm_t *cc_alg;
1761 unformat_input_t sub_input;
1764 vec_foreach (cc_alg, tm->cc_algos)
1766 if (!unformat (input, cc_alg->name))
1769 if (cc_alg->unformat_cfg
1770 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1772 if (cc_alg->unformat_cfg (&sub_input))
1779 static clib_error_t *
1780 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1782 u32 cwnd_multiplier, tmp_time;
1785 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1787 if (unformat (input, "preallocated-connections %d",
1788 &tcp_cfg.preallocated_connections))
1790 else if (unformat (input, "preallocated-half-open-connections %d",
1791 &tcp_cfg.preallocated_half_open_connections))
1793 else if (unformat (input, "buffer-fail-fraction %f",
1794 &tcp_cfg.buffer_fail_fraction))
1796 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1799 if (memory_size >= 0x100000000)
1801 return clib_error_return
1802 (0, "max-rx-fifo %llu (0x%llx) too large", memory_size,
1805 tcp_cfg.max_rx_fifo = memory_size;
1807 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1810 if (memory_size >= 0x100000000)
1812 return clib_error_return
1813 (0, "min-rx-fifo %llu (0x%llx) too large", memory_size,
1816 tcp_cfg.min_rx_fifo = memory_size;
1818 else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1820 else if (unformat (input, "rwnd-min-update-ack %d",
1821 &tcp_cfg.rwnd_min_update_ack))
1823 else if (unformat (input, "initial-cwnd-multiplier %u",
1825 tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1826 else if (unformat (input, "no-tx-pacing"))
1827 tcp_cfg.enable_tx_pacing = 0;
1828 else if (unformat (input, "tso"))
1829 tcp_cfg.allow_tso = 1;
1830 else if (unformat (input, "no-csum-offload"))
1831 tcp_cfg.csum_offload = 0;
1832 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1835 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1837 else if (unformat (input, "closewait-time %u", &tmp_time))
1838 tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1839 else if (unformat (input, "timewait-time %u", &tmp_time))
1840 tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1841 else if (unformat (input, "finwait1-time %u", &tmp_time))
1842 tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1843 else if (unformat (input, "finwait2-time %u", &tmp_time))
1844 tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1845 else if (unformat (input, "lastack-time %u", &tmp_time))
1846 tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1847 else if (unformat (input, "closing-time %u", &tmp_time))
1848 tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1849 else if (unformat (input, "cleanup-time %u", &tmp_time))
1850 tcp_cfg.cleanup_time = tmp_time / TCP_TIMER_TICK;
1852 return clib_error_return (0, "unknown input `%U'",
1853 format_unformat_error, input);
1858 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1862 * \brief Configure an ipv4 source address range
1863 * @param vm vlib_main_t pointer
1864 * @param start first ipv4 address in the source address range
1865 * @param end last ipv4 address in the source address range
1866 * @param table_id VRF / table ID, 0 for the default FIB
1867 * @return 0 if all OK, else an error indication from api_errno.h
1871 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1872 ip4_address_t * start,
1873 ip4_address_t * end, u32 table_id)
1875 u32 start_host_byte_order, end_host_byte_order;
1876 fib_prefix_t prefix;
1877 fib_node_index_t fei;
1882 clib_memset (&prefix, 0, sizeof (prefix));
1884 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1886 if (fib_index == ~0)
1887 return VNET_API_ERROR_NO_SUCH_FIB;
1889 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1890 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1892 /* sanity check for reversed args or some such */
1893 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1894 return VNET_API_ERROR_INVALID_ARGUMENT;
1896 /* Lookup the last address, to identify the interface involved */
1898 prefix.fp_proto = FIB_PROTOCOL_IP4;
1899 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1901 fei = fib_table_lookup (fib_index, &prefix);
1903 /* Couldn't find route to destination. Bail out. */
1904 if (fei == FIB_NODE_INDEX_INVALID)
1905 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1907 sw_if_index = fib_entry_get_resolving_interface (fei);
1909 /* Configure proxy arp across the range */
1910 rv = ip4_neighbor_proxy_add (fib_index, start, end);
1915 rv = ip4_neighbor_proxy_enable (sw_if_index);
1922 dpo_id_t dpo = DPO_INVALID;
1924 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1926 /* Add local adjacencies for the range */
1928 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1931 prefix.fp_proto = FIB_PROTOCOL_IP4;
1932 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1934 fib_table_entry_special_dpo_update (fib_index,
1937 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1940 start_host_byte_order++;
1941 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1943 while (start_host_byte_order <= end_host_byte_order);
1949 * \brief Configure an ipv6 source address range
1950 * @param vm vlib_main_t pointer
1951 * @param start first ipv6 address in the source address range
1952 * @param end last ipv6 address in the source address range
1953 * @param table_id VRF / table ID, 0 for the default FIB
1954 * @return 0 if all OK, else an error indication from api_errno.h
1958 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1959 ip6_address_t * start,
1960 ip6_address_t * end, u32 table_id)
1962 fib_prefix_t prefix;
1964 fib_node_index_t fei;
1967 clib_memset (&prefix, 0, sizeof (prefix));
1969 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1971 if (fib_index == ~0)
1972 return VNET_API_ERROR_NO_SUCH_FIB;
1978 dpo_id_t dpo = DPO_INVALID;
1980 /* Remember this address */
1981 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1983 /* Lookup the prefix, to identify the interface involved */
1984 prefix.fp_len = 128;
1985 prefix.fp_proto = FIB_PROTOCOL_IP6;
1986 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1988 fei = fib_table_lookup (fib_index, &prefix);
1990 /* Couldn't find route to destination. Bail out. */
1991 if (fei == FIB_NODE_INDEX_INVALID)
1992 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1994 sw_if_index = fib_entry_get_resolving_interface (fei);
1996 if (sw_if_index == (u32) ~ 0)
1997 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1999 /* Add a proxy neighbor discovery entry for this address */
2000 ip6_neighbor_proxy_add (sw_if_index, start);
2002 /* Add a receive adjacency for this address */
2003 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
2006 fib_table_entry_special_dpo_update (fib_index,
2009 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
2012 /* Done with the entire range? */
2013 if (!memcmp (start, end, sizeof (start[0])))
2016 /* Increment the address. DGMS. */
2018 for (i = 15; i >= 0; i--)
2021 if (tmp.as_u8[i] != 0)
2029 static clib_error_t *
2030 tcp_src_address_fn (vlib_main_t * vm,
2031 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
2033 ip4_address_t v4start, v4end;
2034 ip6_address_t v6start, v6end;
2040 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2042 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
2043 unformat_ip4_address, &v4end))
2045 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
2047 memcpy (&v4end, &v4start, sizeof (v4start));
2050 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
2051 unformat_ip6_address, &v6end))
2053 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
2055 memcpy (&v6end, &v6start, sizeof (v6start));
2058 else if (unformat (input, "fib-table %d", &table_id))
2064 if (!v4set && !v6set)
2065 return clib_error_return (0, "at least one v4 or v6 address required");
2069 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
2076 case VNET_API_ERROR_NO_SUCH_FIB:
2077 return clib_error_return (0, "Invalid table-id %d", table_id);
2079 case VNET_API_ERROR_INVALID_ARGUMENT:
2080 return clib_error_return (0, "Invalid address range %U - %U",
2081 format_ip4_address, &v4start,
2082 format_ip4_address, &v4end);
2084 return clib_error_return (0, "error %d", rv);
2090 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
2097 case VNET_API_ERROR_NO_SUCH_FIB:
2098 return clib_error_return (0, "Invalid table-id %d", table_id);
2101 return clib_error_return (0, "error %d", rv);
2109 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2111 .path = "tcp src-address",
2112 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2113 .function = tcp_src_address_fn,
2118 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2120 #if TCP_SCOREBOARD_TRACE
2122 scoreboard_trace_elt_t *block;
2128 s = format (s, "scoreboard trace:");
2129 vec_foreach (block, sb->trace)
2131 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2132 block->ack, block->snd_una_max, block->group);
2134 s = format (s, "\n");
2142 static clib_error_t *
2143 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2144 vlib_cli_command_t * cmd_arg)
2146 transport_connection_t *tconn = 0;
2147 tcp_connection_t *tc;
2149 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2151 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2152 TRANSPORT_PROTO_TCP))
2155 return clib_error_return (0, "unknown input `%U'",
2156 format_unformat_error, input);
2159 if (!TCP_SCOREBOARD_TRACE)
2161 vlib_cli_output (vm, "scoreboard tracing not enabled");
2165 tc = tcp_get_connection_from_transport (tconn);
2166 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2167 vlib_cli_output (vm, "%v", s);
2172 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2174 .path = "show tcp scoreboard trace",
2175 .short_help = "show tcp scoreboard trace <connection>",
2176 .function = tcp_show_scoreboard_trace_fn,
2181 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2184 scoreboard_trace_elt_t *trace;
2185 u32 next_ack, left, group, has_new_ack = 0;
2186 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2187 sack_block_t *block;
2189 if (!TCP_SCOREBOARD_TRACE)
2191 s = format (s, "scoreboard tracing not enabled");
2198 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2199 tcp_connection_timers_init (dummy_tc);
2200 scoreboard_init (&dummy_tc->sack_sb);
2201 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2203 #if TCP_SCOREBOARD_TRACE
2204 trace = tc->sack_sb.trace;
2205 trace_len = vec_len (tc->sack_sb.trace);
2208 for (i = 0; i < trace_len; i++)
2210 if (trace[i].ack != 0)
2212 dummy_tc->snd_una = trace[i].ack - 1448;
2213 dummy_tc->snd_una_max = trace[i].ack;
2218 while (left < trace_len)
2220 group = trace[left].group;
2221 vec_reset_length (dummy_tc->rcv_opts.sacks);
2223 while (trace[left].group == group)
2225 if (trace[left].ack != 0)
2228 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2229 trace[left].ack, trace[left].snd_una_max);
2230 dummy_tc->snd_una_max = trace[left].snd_una_max;
2231 next_ack = trace[left].ack;
2237 s = format (s, "[%u, %u], ", trace[left].start,
2239 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2240 block->start = trace[left].start;
2241 block->end = trace[left].end;
2247 tcp_rcv_sacks (dummy_tc, next_ack);
2249 dummy_tc->snd_una = next_ack;
2252 s = format (s, "result: %U", format_tcp_scoreboard,
2253 &dummy_tc->sack_sb);
2256 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2261 static clib_error_t *
2262 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2263 vlib_cli_command_t * cmd_arg)
2265 transport_connection_t *tconn = 0;
2266 tcp_connection_t *tc = 0;
2268 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2270 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2271 TRANSPORT_PROTO_TCP))
2274 return clib_error_return (0, "unknown input `%U'",
2275 format_unformat_error, input);
2278 if (!TCP_SCOREBOARD_TRACE)
2280 vlib_cli_output (vm, "scoreboard tracing not enabled");
2284 tc = tcp_get_connection_from_transport (tconn);
2287 vlib_cli_output (vm, "connection not found");
2290 str = tcp_scoreboard_replay (str, tc, 1);
2291 vlib_cli_output (vm, "%v", str);
2296 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2298 .path = "tcp replay scoreboard",
2299 .short_help = "tcp replay scoreboard <connection>",
2300 .function = tcp_scoreboard_trace_fn,
2304 static clib_error_t *
2305 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2306 vlib_cli_command_t * cmd_arg)
2308 tcp_main_t *tm = vnet_get_tcp_main ();
2309 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2310 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2312 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2313 tm->punt_unknown4 ? "enabled" : "disabled");
2314 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2315 tm->punt_unknown6 ? "enabled" : "disabled");
2319 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2321 .path = "show tcp punt",
2322 .short_help = "show tcp punt",
2323 .function = show_tcp_punt_fn,
2327 static clib_error_t *
2328 show_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2329 vlib_cli_command_t * cmd)
2331 tcp_main_t *tm = vnet_get_tcp_main ();
2332 tcp_worker_ctx_t *wrk;
2335 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2336 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2338 for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2340 wrk = tcp_get_worker (thread);
2341 vlib_cli_output (vm, "Thread %u:\n", thread);
2343 if (clib_fifo_elts (wrk->pending_timers))
2344 vlib_cli_output (vm, " %lu pending timers",
2345 clib_fifo_elts (wrk->pending_timers));
2347 #define _(name,type,str) \
2348 if (wrk->stats.name) \
2349 vlib_cli_output (vm, " %lu %s", wrk->stats.name, str);
2350 foreach_tcp_wrk_stat
2358 VLIB_CLI_COMMAND (show_tcp_stats_command, static) =
2360 .path = "show tcp stats",
2361 .short_help = "show tcp stats",
2362 .function = show_tcp_stats_fn,
2366 static clib_error_t *
2367 clear_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2368 vlib_cli_command_t * cmd)
2370 tcp_main_t *tm = vnet_get_tcp_main ();
2371 tcp_worker_ctx_t *wrk;
2374 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2375 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2378 for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2380 wrk = tcp_get_worker (thread);
2381 clib_memset (&wrk->stats, 0, sizeof (wrk->stats));
2388 VLIB_CLI_COMMAND (clear_tcp_stats_command, static) =
2390 .path = "clear tcp stats",
2391 .short_help = "clear tcp stats",
2392 .function = clear_tcp_stats_fn,
2397 * fd.io coding-style-patch-verification: ON
2400 * eval: (c-set-style "gnu")