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 tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
333 tcp_cleanup_req_t *req;
334 clib_time_type_t now;
336 now = transport_time_now (tc->c_thread_index);
337 clib_fifo_add2 (wrk->pending_cleanups, req);
338 req->connection_index = tc->c_c_index;
339 req->free_time = now + tcp_cfg.cleanup_time;
343 * Begin connection closing procedure.
345 * If at the end the connection is not in CLOSED state, it is not removed.
346 * Instead, we rely on on TCP to advance through state machine to either
347 * 1) LAST_ACK (passive close) whereby when the last ACK is received
348 * tcp_connection_del is called. This notifies session of the delete and
350 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
351 * and cleanup is called.
353 * N.B. Half-close connections are not supported
356 tcp_connection_close (tcp_connection_t * tc)
358 TCP_EVT (TCP_EVT_CLOSE, tc);
360 /* Send/Program FIN if needed and switch state */
363 case TCP_STATE_SYN_SENT:
364 /* Try to cleanup. If not on the right thread, mark as half-open done.
365 * Connection will be cleaned up when establish timer pops */
366 tcp_connection_cleanup (tc);
368 case TCP_STATE_SYN_RCVD:
369 tcp_connection_timers_reset (tc);
371 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
372 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
374 case TCP_STATE_ESTABLISHED:
375 /* If closing with unread data, reset the connection */
376 if (transport_max_rx_dequeue (&tc->connection))
379 tcp_connection_timers_reset (tc);
380 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
381 session_transport_closed_notify (&tc->connection);
382 tcp_program_cleanup (tcp_get_worker (tc->c_thread_index), tc);
383 tcp_worker_stats_inc (tc->c_thread_index, rst_unread, 1);
386 if (!transport_max_tx_dequeue (&tc->connection))
389 tc->flags |= TCP_CONN_FINPNDG;
390 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
391 /* Set a timer in case the peer stops responding. Otherwise the
392 * connection will be stuck here forever. */
393 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
394 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
396 case TCP_STATE_CLOSE_WAIT:
397 if (!transport_max_tx_dequeue (&tc->connection))
400 tcp_connection_timers_reset (tc);
401 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
402 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
405 tc->flags |= TCP_CONN_FINPNDG;
407 case TCP_STATE_FIN_WAIT_1:
408 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
410 case TCP_STATE_CLOSED:
411 /* Cleanup should've been programmed already */
414 TCP_DBG ("state: %u", tc->state);
419 tcp_session_close (u32 conn_index, u32 thread_index)
421 tcp_connection_t *tc;
422 tc = tcp_connection_get (conn_index, thread_index);
423 tcp_connection_close (tc);
427 tcp_session_cleanup (u32 conn_index, u32 thread_index)
429 tcp_connection_t *tc;
430 tc = tcp_connection_get (conn_index, thread_index);
433 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
434 tcp_connection_cleanup (tc);
438 tcp_session_reset (u32 conn_index, u32 thread_index)
440 tcp_connection_t *tc;
441 tc = tcp_connection_get (conn_index, thread_index);
443 tcp_connection_timers_reset (tc);
444 tcp_cong_recovery_off (tc);
445 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
446 session_transport_closed_notify (&tc->connection);
447 tcp_program_cleanup (tcp_get_worker (thread_index), tc);
451 * Initialize all connection timers as invalid
454 tcp_connection_timers_init (tcp_connection_t * tc)
458 /* Set all to invalid */
459 for (i = 0; i < TCP_N_TIMERS; i++)
461 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
464 tc->rto = TCP_RTO_INIT;
468 * Stop all connection timers
471 tcp_connection_timers_reset (tcp_connection_t * tc)
474 for (i = 0; i < TCP_N_TIMERS; i++)
476 tcp_timer_reset (tc, i);
481 typedef struct ip4_tcp_hdr
487 typedef struct ip6_tcp_hdr
494 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
497 const dpo_id_t *choice;
501 lb = load_balance_get (dpo->dpoi_index);
505 clib_memset (&hdr, 0, sizeof (hdr));
506 hdr.ip.protocol = IP_PROTOCOL_TCP;
507 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
508 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
509 hdr.tcp.src_port = tc->c_lcl_port;
510 hdr.tcp.dst_port = tc->c_rmt_port;
511 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
516 clib_memset (&hdr, 0, sizeof (hdr));
517 hdr.ip.protocol = IP_PROTOCOL_TCP;
518 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
519 sizeof (ip6_address_t));
520 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
521 sizeof (ip6_address_t));
522 hdr.tcp.src_port = tc->c_lcl_port;
523 hdr.tcp.dst_port = tc->c_rmt_port;
524 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
526 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
527 dpo_copy (result, choice);
531 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
536 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
537 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
538 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
539 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
540 return fib_table_lookup (fib_index, &prefix);
544 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
546 dpo_id_t choice = DPO_INVALID;
547 u32 output_node_index;
550 fe = fib_entry_get (tc->c_rmt_fei);
551 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
554 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
557 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
558 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
562 /** Stack tcp connection on peer's fib entry.
564 * This ultimately populates the dpo the connection will use to send packets.
567 tcp_connection_fib_attach (tcp_connection_t * tc)
569 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
571 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
573 tcp_connection_stack_on_fib_entry (tc);
578 * Generate random iss as per rfc6528
581 tcp_generate_random_iss (tcp_connection_t * tc)
583 tcp_main_t *tm = &tcp_main;
587 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
589 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
590 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
592 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
593 tmp ^= tm->iss_seed.second;
594 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
595 return ((tmp >> 32) ^ (tmp & 0xffffffff));
599 * Initialize max segment size we're able to process.
601 * The value is constrained by the output interface's MTU and by the size
602 * of the IP and TCP headers (see RFC6691). It is also what we advertise
606 tcp_init_rcv_mss (tcp_connection_t * tc)
610 /* Already provided at connection init time */
614 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
615 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
619 tcp_init_mss (tcp_connection_t * tc)
621 u16 default_min_mss = 536;
623 tcp_init_rcv_mss (tc);
625 /* TODO consider PMTU discovery */
626 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
628 if (tc->snd_mss < 45)
630 /* Assume that at least the min default mss works */
631 tc->snd_mss = default_min_mss;
632 tc->rcv_opts.mss = default_min_mss;
635 /* We should have enough space for 40 bytes of options */
636 ASSERT (tc->snd_mss > 45);
638 /* If we use timestamp option, account for it */
639 if (tcp_opts_tstamp (&tc->rcv_opts))
640 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
644 * Initialize connection send variables.
647 tcp_init_snd_vars (tcp_connection_t * tc)
650 * We use the time to randomize iss and for setting up the initial
651 * timestamp. Make sure it's updated otherwise syn and ack in the
652 * handshake may make it look as if time has flown in the opposite
655 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
657 tcp_init_rcv_mss (tc);
658 tc->iss = tcp_generate_random_iss (tc);
659 tc->snd_una = tc->iss;
660 tc->snd_nxt = tc->iss + 1;
661 tc->snd_una_max = tc->snd_nxt;
662 tc->srtt = 100; /* 100 ms */
664 if (!tcp_cfg.csum_offload)
665 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
669 tcp_enable_pacing (tcp_connection_t * tc)
672 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
673 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
674 tc->mrtt_us = (u32) ~ 0;
677 /** Initialize tcp connection variables
679 * Should be called after having received a msg from the peer, i.e., a SYN or
680 * a SYNACK, such that connection options have already been exchanged. */
682 tcp_connection_init_vars (tcp_connection_t * tc)
684 tcp_connection_timers_init (tc);
686 scoreboard_init (&tc->sack_sb);
687 if (tc->state == TCP_STATE_SYN_RCVD)
688 tcp_init_snd_vars (tc);
692 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
693 tcp_add_del_adjacency (tc, 1);
695 /* tcp_connection_fib_attach (tc); */
697 if (transport_connection_is_tx_paced (&tc->connection)
698 || tcp_cfg.enable_tx_pacing)
699 tcp_enable_pacing (tc);
701 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
704 if (!tcp_cfg.allow_tso)
705 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
707 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
711 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
712 u16 * lcl_port, u8 is_ip4)
717 index = tm->last_v4_addr_rotor++;
718 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
719 tm->last_v4_addr_rotor = 0;
720 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
724 index = tm->last_v6_addr_rotor++;
725 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
726 tm->last_v6_addr_rotor = 0;
727 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
728 sizeof (ip6_address_t));
730 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
733 clib_warning ("Failed to allocate src port");
741 tcp_session_open (transport_endpoint_cfg_t * rmt)
743 tcp_main_t *tm = vnet_get_tcp_main ();
744 tcp_connection_t *tc;
745 ip46_address_t lcl_addr;
750 * Allocate local endpoint
752 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
753 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
754 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
757 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
758 rmt, &lcl_addr, &lcl_port);
764 * Create connection and send SYN
766 clib_spinlock_lock_if_init (&tm->half_open_lock);
767 tc = tcp_half_open_connection_new ();
768 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
769 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
770 tc->c_rmt_port = rmt->port;
771 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
772 tc->c_is_ip4 = rmt->is_ip4;
773 tc->c_proto = TRANSPORT_PROTO_TCP;
774 tc->c_fib_index = rmt->fib_index;
775 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
776 /* The other connection vars will be initialized after SYN ACK */
777 tcp_connection_timers_init (tc);
780 TCP_EVT (TCP_EVT_OPEN, tc);
781 tc->state = TCP_STATE_SYN_SENT;
782 tcp_init_snd_vars (tc);
784 clib_spinlock_unlock_if_init (&tm->half_open_lock);
786 return tc->c_c_index;
789 const char *tcp_fsm_states[] = {
790 #define _(sym, str) str,
791 foreach_tcp_fsm_state
796 format_tcp_state (u8 * s, va_list * args)
798 u32 state = va_arg (*args, u32);
800 if (state < TCP_N_STATES)
801 s = format (s, "%s", tcp_fsm_states[state]);
803 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
807 const char *tcp_cfg_flags_str[] = {
808 #define _(sym, str) str,
814 format_tcp_cfg_flags (u8 * s, va_list * args)
816 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
819 for (i = 0; i < TCP_CFG_N_FLAG_BITS; i++)
820 if (tc->cfg_flags & (1 << i))
822 for (i = 0; i < last; i++)
824 if (tc->cfg_flags & (1 << i))
825 s = format (s, "%s, ", tcp_cfg_flags_str[i]);
828 s = format (s, "%s", tcp_cfg_flags_str[last]);
832 const char *tcp_connection_flags_str[] = {
833 #define _(sym, str) str,
834 foreach_tcp_connection_flag
839 format_tcp_connection_flags (u8 * s, va_list * args)
841 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
844 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
845 if (tc->flags & (1 << i))
847 for (i = 0; i < last; i++)
849 if (tc->flags & (1 << i))
850 s = format (s, "%s, ", tcp_connection_flags_str[i]);
853 s = format (s, "%s", tcp_connection_flags_str[last]);
857 const char *tcp_conn_timers[] = {
858 #define _(sym, str) str,
864 format_tcp_timers (u8 * s, va_list * args)
866 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
869 for (i = 0; i < TCP_N_TIMERS; i++)
870 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
873 for (i = 0; i < last; i++)
875 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
876 s = format (s, "%s,", tcp_conn_timers[i]);
880 s = format (s, "%s", tcp_conn_timers[i]);
886 format_tcp_congestion_status (u8 * s, va_list * args)
888 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
889 if (tcp_in_recovery (tc))
890 s = format (s, "recovery");
891 else if (tcp_in_fastrecovery (tc))
892 s = format (s, "fastrecovery");
894 s = format (s, "none");
899 tcp_rcv_wnd_available (tcp_connection_t * tc)
901 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
905 format_tcp_congestion (u8 * s, va_list * args)
907 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
908 u32 indent = format_get_indent (s), prr_space = 0;
910 s = format (s, "%U ", format_tcp_congestion_status, tc);
911 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
912 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
913 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u\n",
914 format_white_space, indent, tcp_available_cc_snd_space (tc),
915 tc->prev_cwnd, tc->prev_ssthresh);
916 s = format (s, "%Usnd_cong %u dupack %u limited_tx %u\n",
917 format_white_space, indent, tc->snd_congestion - tc->iss,
918 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
919 s = format (s, "%Urxt_bytes %u rxt_delivered %u rxt_head %u rxt_ts %u\n",
920 format_white_space, indent, tc->snd_rxt_bytes,
921 tc->rxt_delivered, tc->rxt_head - tc->iss,
922 tcp_time_now_w_thread (tc->c_thread_index) - tc->snd_rxt_ts);
923 if (tcp_in_fastrecovery (tc))
924 prr_space = tcp_fastrecovery_prr_snd_space (tc);
925 s = format (s, "%Uprr_start %u prr_delivered %u prr space %u\n",
926 format_white_space, indent, tc->prr_start - tc->iss,
927 tc->prr_delivered, prr_space);
932 format_tcp_stats (u8 * s, va_list * args)
934 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
935 u32 indent = format_get_indent (s);
936 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
937 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
938 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
939 format_white_space, indent, tc->segs_out,
940 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
941 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
942 format_white_space, indent, tc->fr_occurences,
943 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
944 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
945 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
946 format_white_space, indent, tc->errors.below_data_wnd,
947 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
948 tc->errors.above_ack_wnd);
953 format_tcp_vars (u8 * s, va_list * args)
955 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
956 s = format (s, " index: %u cfg: %U flags: %U timers: %U\n", tc->c_c_index,
957 format_tcp_cfg_flags, tc, format_tcp_connection_flags, tc,
958 format_tcp_timers, tc);
959 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
960 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
961 tc->snd_una_max - tc->iss);
962 s = format (s, " rcv_nxt %u rcv_las %u\n",
963 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
964 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
965 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
966 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
967 tc->snd_wl2 - tc->iss);
968 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
969 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
970 tcp_rcv_wnd_available (tc));
971 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
972 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
973 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
974 tcp_time_now () - tc->tsval_recent_age);
975 s = format (s, " snd_mss %u\n", tc->snd_mss);
976 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
977 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
979 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
980 s = format (s, " next_node %u opaque 0x%x fib_index %u\n",
981 tc->next_node_index, tc->next_node_opaque, tc->c_fib_index);
982 s = format (s, " cong: %U", format_tcp_congestion, tc);
984 if (tc->state >= TCP_STATE_ESTABLISHED)
986 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
988 s = format (s, " stats: %U\n", format_tcp_stats, tc);
990 if (vec_len (tc->snd_sacks))
991 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
997 format_tcp_connection_id (u8 * s, va_list * args)
999 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1004 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1005 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
1006 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
1007 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
1011 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1012 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1013 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1014 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1021 format_tcp_connection (u8 * s, va_list * args)
1023 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1024 u32 verbose = va_arg (*args, u32);
1028 s = format (s, "%-50U", format_tcp_connection_id, tc);
1031 s = format (s, "%-15U", format_tcp_state, tc->state);
1033 s = format (s, "\n%U", format_tcp_vars, tc);
1040 format_tcp_session (u8 * s, va_list * args)
1042 u32 tci = va_arg (*args, u32);
1043 u32 thread_index = va_arg (*args, u32);
1044 u32 verbose = va_arg (*args, u32);
1045 tcp_connection_t *tc;
1047 tc = tcp_connection_get (tci, thread_index);
1049 s = format (s, "%U", format_tcp_connection, tc, verbose);
1051 s = format (s, "empty\n");
1056 format_tcp_listener_session (u8 * s, va_list * args)
1058 u32 tci = va_arg (*args, u32);
1059 u32 __clib_unused thread_index = va_arg (*args, u32);
1060 u32 verbose = va_arg (*args, u32);
1061 tcp_connection_t *tc = tcp_listener_get (tci);
1062 s = format (s, "%-50U", format_tcp_connection_id, tc);
1064 s = format (s, "%-15U", format_tcp_state, tc->state);
1069 format_tcp_half_open_session (u8 * s, va_list * args)
1071 u32 tci = va_arg (*args, u32);
1072 u32 __clib_unused thread_index = va_arg (*args, u32);
1073 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1074 return format (s, "%U", format_tcp_connection_id, tc);
1078 format_tcp_sacks (u8 * s, va_list * args)
1080 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1081 sack_block_t *sacks = tc->snd_sacks;
1082 sack_block_t *block;
1085 len = vec_len (sacks);
1086 for (i = 0; i < len - 1; i++)
1089 s = format (s, " start %u end %u\n", block->start - tc->irs,
1090 block->end - tc->irs);
1094 block = &sacks[len - 1];
1095 s = format (s, " start %u end %u", block->start - tc->irs,
1096 block->end - tc->irs);
1102 format_tcp_rcv_sacks (u8 * s, va_list * args)
1104 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1105 sack_block_t *sacks = tc->rcv_opts.sacks;
1106 sack_block_t *block;
1109 len = vec_len (sacks);
1110 for (i = 0; i < len - 1; i++)
1113 s = format (s, " start %u end %u\n", block->start - tc->iss,
1114 block->end - tc->iss);
1118 block = &sacks[len - 1];
1119 s = format (s, " start %u end %u", block->start - tc->iss,
1120 block->end - tc->iss);
1126 format_tcp_sack_hole (u8 * s, va_list * args)
1128 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1129 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1131 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1133 s = format (s, " [%u, %u]", hole->start, hole->end);
1138 format_tcp_scoreboard (u8 * s, va_list * args)
1140 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1141 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1142 sack_scoreboard_hole_t *hole;
1143 u32 indent = format_get_indent (s);
1145 s = format (s, "sacked %u last_sacked %u lost %u last_lost %u"
1147 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes,
1148 sb->last_lost_bytes, sb->rxt_sacked);
1149 s = format (s, "%Ulast_delivered %u high_sacked %u is_reneging %u\n",
1150 format_white_space, indent, sb->last_bytes_delivered,
1151 sb->high_sacked - tc->iss, sb->is_reneging);
1152 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1153 format_white_space, indent, sb->cur_rxt_hole,
1154 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1156 hole = scoreboard_first_hole (sb);
1158 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1159 indent, sb->head, sb->tail, pool_elts (sb->holes),
1160 format_white_space, indent);
1164 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1165 hole = scoreboard_next_hole (sb, hole);
1171 static transport_connection_t *
1172 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1174 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1175 if (PREDICT_FALSE (!tc))
1177 return &tc->connection;
1180 static transport_connection_t *
1181 tcp_half_open_session_get_transport (u32 conn_index)
1183 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1184 return &tc->connection;
1188 tcp_session_cal_goal_size (tcp_connection_t * tc)
1190 u16 goal_size = tc->snd_mss;
1192 goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1193 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1195 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1199 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1201 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1203 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1206 /* If not snd_wnd constrained and we can't write at least a segment,
1207 * don't try at all */
1208 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1209 return snd_space < tc->cwnd ? 0 : snd_space;
1211 /* round down to mss multiple */
1212 return snd_space - (snd_space % tc->snd_mss);
1216 * Compute tx window session is allowed to fill.
1218 * Takes into account available send space, snd_mss and the congestion
1219 * state of the connection. If possible, the value returned is a multiple
1222 * @param tc tcp connection
1223 * @return number of bytes session is allowed to write
1226 tcp_snd_space_inline (tcp_connection_t * tc)
1230 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1231 || tc->state == TCP_STATE_CLOSED))
1234 snd_space = tcp_available_output_snd_space (tc);
1236 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1237 * to force the peer to send enough dupacks to start retransmitting as
1238 * per Limited Transmit (RFC3042)
1240 if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
1242 if (tc->limited_transmit != tc->snd_nxt
1243 && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
1244 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1245 tc->limited_transmit = tc->snd_nxt;
1247 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1249 int snt_limited = tc->snd_nxt - tc->limited_transmit;
1250 snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
1252 return tcp_round_snd_space (tc, snd_space);
1256 tcp_snd_space (tcp_connection_t * tc)
1258 return tcp_snd_space_inline (tc);
1262 tcp_session_send_params (transport_connection_t * trans_conn,
1263 transport_send_params_t * sp)
1265 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1267 /* Ensure snd_mss does accurately reflect the amount of data we can push
1268 * in a segment. This also makes sure that options are updated according to
1269 * the current state of the connection. */
1270 tcp_update_burst_snd_vars (tc);
1272 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1273 sp->snd_mss = tcp_session_cal_goal_size (tc);
1275 sp->snd_mss = tc->snd_mss;
1277 sp->snd_space = clib_min (tcp_snd_space_inline (tc),
1278 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1280 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1281 /* This still works if fast retransmit is on */
1282 sp->tx_offset = tc->snd_nxt - tc->snd_una;
1284 sp->flags = sp->snd_space ? 0 : TRANSPORT_SND_F_DESCHED;
1290 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1292 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1296 case TCP_STATE_CLOSE_WAIT:
1297 tcp_connection_timers_reset (tc);
1298 /* App never returned with a close */
1299 if (!(tc->flags & TCP_CONN_FINPNDG))
1301 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1302 session_transport_closed_notify (&tc->connection);
1303 tcp_program_cleanup (wrk, tc);
1304 tcp_workerp_stats_inc (wrk, to_closewait, 1);
1308 /* Send FIN either way and switch to LAST_ACK. */
1309 tcp_cong_recovery_off (tc);
1310 /* Make sure we don't try to send unsent data */
1311 tc->snd_nxt = tc->snd_una;
1313 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1314 session_transport_closed_notify (&tc->connection);
1316 /* Make sure we don't wait in LAST ACK forever */
1317 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1318 tcp_workerp_stats_inc (wrk, to_closewait2, 1);
1320 /* Don't delete the connection yet */
1322 case TCP_STATE_FIN_WAIT_1:
1323 tcp_connection_timers_reset (tc);
1324 if (tc->flags & TCP_CONN_FINPNDG)
1326 /* If FIN pending, we haven't sent everything, but we did try.
1327 * Notify session layer that transport is closed. */
1328 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1329 tcp_send_reset (tc);
1330 tcp_program_cleanup (wrk, tc);
1334 /* We've sent the fin but no progress. Close the connection and
1335 * to make sure everything is flushed, setup a cleanup timer */
1336 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1337 tcp_program_cleanup (wrk, tc);
1339 session_transport_closed_notify (&tc->connection);
1340 tcp_workerp_stats_inc (wrk, to_finwait1, 1);
1342 case TCP_STATE_LAST_ACK:
1343 tcp_connection_timers_reset (tc);
1344 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1345 session_transport_closed_notify (&tc->connection);
1346 tcp_program_cleanup (wrk, tc);
1347 tcp_workerp_stats_inc (wrk, to_lastack, 1);
1349 case TCP_STATE_CLOSING:
1350 tcp_connection_timers_reset (tc);
1351 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1352 session_transport_closed_notify (&tc->connection);
1353 tcp_program_cleanup (wrk, tc);
1354 tcp_workerp_stats_inc (wrk, to_closing, 1);
1356 case TCP_STATE_FIN_WAIT_2:
1357 tcp_send_reset (tc);
1358 tcp_connection_timers_reset (tc);
1359 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1360 session_transport_closed_notify (&tc->connection);
1361 tcp_program_cleanup (wrk, tc);
1362 tcp_workerp_stats_inc (wrk, to_finwait2, 1);
1364 case TCP_STATE_TIME_WAIT:
1365 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1366 tcp_program_cleanup (wrk, tc);
1369 clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
1375 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1377 tcp_timer_retransmit_handler,
1378 tcp_timer_delack_handler,
1379 tcp_timer_persist_handler,
1380 tcp_timer_waitclose_handler,
1381 tcp_timer_retransmit_syn_handler,
1386 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1388 u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1389 tcp_connection_t *tc;
1392 if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1395 thread_index = wrk->vm->thread_index;
1396 for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
1398 clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1399 connection_index = timer_handle & 0x0FFFFFFF;
1400 timer_id = timer_handle >> 28;
1402 if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1403 tc = tcp_connection_get (connection_index, thread_index);
1405 tc = tcp_half_open_connection_get (connection_index);
1407 if (PREDICT_FALSE (!tc))
1410 /* Skip timer if it was rearmed while pending dispatch */
1411 if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1414 (*timer_expiration_handlers[timer_id]) (tc);
1417 if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
1418 vlib_process_signal_event_mt (wrk->vm, session_queue_process_node.index,
1419 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1423 * Flush ip lookup tx frames populated by timer pops
1426 tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk)
1428 if (wrk->ip_lookup_tx_frames[0])
1430 vlib_put_frame_to_node (wrk->vm, ip4_lookup_node.index,
1431 wrk->ip_lookup_tx_frames[0]);
1432 wrk->ip_lookup_tx_frames[0] = 0;
1434 if (wrk->ip_lookup_tx_frames[1])
1436 vlib_put_frame_to_node (wrk->vm, ip6_lookup_node.index,
1437 wrk->ip_lookup_tx_frames[1]);
1438 wrk->ip_lookup_tx_frames[1] = 0;
1443 tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1445 u32 thread_index = wrk->vm->thread_index;
1446 tcp_cleanup_req_t *req;
1447 tcp_connection_t *tc;
1449 while (clib_fifo_elts (wrk->pending_cleanups))
1451 req = clib_fifo_head (wrk->pending_cleanups);
1452 if (req->free_time > now)
1454 clib_fifo_sub2 (wrk->pending_cleanups, req);
1455 tc = tcp_connection_get (req->connection_index, thread_index);
1456 if (PREDICT_FALSE (!tc))
1458 session_transport_delete_notify (&tc->connection);
1459 tcp_connection_cleanup (tc);
1464 tcp_update_time (f64 now, u8 thread_index)
1466 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1468 tcp_set_time_now (wrk);
1469 tcp_handle_cleanups (wrk, now);
1470 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1471 tcp_dispatch_pending_timers (wrk);
1472 tcp_flush_frames_to_output (wrk);
1476 tcp_session_flush_data (transport_connection_t * tconn)
1478 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1479 if (tc->flags & TCP_CONN_PSH_PENDING)
1481 tc->flags |= TCP_CONN_PSH_PENDING;
1482 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1486 const static transport_proto_vft_t tcp_proto = {
1487 .enable = vnet_tcp_enable_disable,
1488 .start_listen = tcp_session_bind,
1489 .stop_listen = tcp_session_unbind,
1490 .push_header = tcp_session_push_header,
1491 .get_connection = tcp_session_get_transport,
1492 .get_listener = tcp_session_get_listener,
1493 .get_half_open = tcp_half_open_session_get_transport,
1494 .connect = tcp_session_open,
1495 .close = tcp_session_close,
1496 .cleanup = tcp_session_cleanup,
1497 .reset = tcp_session_reset,
1498 .send_params = tcp_session_send_params,
1499 .update_time = tcp_update_time,
1500 .flush_data = tcp_session_flush_data,
1501 .custom_tx = tcp_session_custom_tx,
1502 .format_connection = format_tcp_session,
1503 .format_listener = format_tcp_listener_session,
1504 .format_half_open = format_tcp_half_open_session,
1505 .transport_options = {
1506 .tx_type = TRANSPORT_TX_PEEK,
1507 .service_type = TRANSPORT_SERVICE_VC,
1513 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1515 if (!transport_connection_is_tx_paced (&tc->connection))
1518 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1520 transport_connection_tx_pacer_update (&tc->connection,
1521 tcp_cc_get_pacing_rate (tc),
1522 srtt * CLIB_US_TIME_FREQ);
1526 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1529 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1530 transport_connection_tx_pacer_reset (&tc->connection,
1531 tcp_cc_get_pacing_rate (tc),
1533 srtt * CLIB_US_TIME_FREQ);
1537 tcp_reschedule (tcp_connection_t * tc)
1539 if (tcp_in_cong_recovery (tc) || tcp_snd_space_inline (tc))
1540 transport_connection_reschedule (&tc->connection);
1544 tcp_expired_timers_dispatch (u32 * expired_timers)
1546 u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1547 u32 connection_index, timer_id, n_expired, max_loops;
1548 tcp_worker_ctx_t *wrk;
1549 tcp_connection_t *tc;
1552 wrk = tcp_get_worker (thread_index);
1553 n_expired = vec_len (expired_timers);
1554 tcp_workerp_stats_inc (wrk, timer_expirations, n_expired);
1555 n_left = clib_fifo_elts (wrk->pending_timers);
1558 * Invalidate all timer handles before dispatching. This avoids dangling
1559 * index references to timer wheel pool entries that have been freed.
1561 for (i = 0; i < n_expired; i++)
1563 connection_index = expired_timers[i] & 0x0FFFFFFF;
1564 timer_id = expired_timers[i] >> 28;
1566 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1567 tc = tcp_connection_get (connection_index, thread_index);
1569 tc = tcp_half_open_connection_get (connection_index);
1571 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1573 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1576 clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1578 max_loops = clib_max (1, 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second);
1579 max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1580 max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1581 wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1584 if (thread_index == 0)
1585 vlib_process_signal_event_mt (wrk->vm, session_queue_process_node.index,
1586 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1590 tcp_initialize_timer_wheels (tcp_main_t * tm)
1592 tw_timer_wheel_16t_2w_512sl_t *tw;
1594 foreach_vlib_main (({
1595 tw = &tm->wrk_ctx[ii].timer_wheel;
1596 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1597 TCP_TIMER_TICK, ~0);
1598 tw->last_run_time = vlib_time_now (this_vlib_main);
1604 tcp_initialize_iss_seed (tcp_main_t * tm)
1606 u32 default_seed = random_default_seed ();
1607 u64 time_now = clib_cpu_time_now ();
1609 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1610 tm->iss_seed.second = random_u64 (&time_now);
1613 static clib_error_t *
1614 tcp_main_enable (vlib_main_t * vm)
1616 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1617 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1618 tcp_connection_t *tc __attribute__ ((unused));
1619 tcp_main_t *tm = vnet_get_tcp_main ();
1620 tcp_worker_ctx_t *wrk;
1621 clib_error_t *error = 0;
1624 if ((error = vlib_call_init_function (vm, ip_main_init)))
1626 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1628 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1635 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1636 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1639 * Initialize data structures
1642 num_threads = 1 /* main thread */ + vtm->n_threads;
1643 vec_validate (tm->wrk_ctx, num_threads - 1);
1644 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1645 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1647 for (thread = 0; thread < num_threads; thread++)
1649 wrk = &tm->wrk_ctx[thread];
1651 vec_validate (wrk->pending_deq_acked, 255);
1652 vec_validate (wrk->pending_disconnects, 255);
1653 vec_validate (wrk->pending_resets, 255);
1654 vec_reset_length (wrk->pending_deq_acked);
1655 vec_reset_length (wrk->pending_disconnects);
1656 vec_reset_length (wrk->pending_resets);
1657 wrk->vm = vlib_mains[thread];
1658 wrk->max_timers_per_loop = 10;
1661 * Preallocate connections. Assume that thread 0 won't
1662 * use preallocated threads when running multi-core
1664 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1665 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1669 * Use a preallocated half-open connection pool?
1671 if (tcp_cfg.preallocated_half_open_connections)
1672 pool_init_fixed (tm->half_open_connections,
1673 tcp_cfg.preallocated_half_open_connections);
1675 /* Initialize clocks per tick for TCP timestamp. Used to compute
1676 * monotonically increasing timestamps. */
1677 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1678 / TCP_TSTAMP_RESOLUTION;
1680 if (num_threads > 1)
1682 clib_spinlock_init (&tm->half_open_lock);
1685 tcp_initialize_timer_wheels (tm);
1686 tcp_initialize_iss_seed (tm);
1688 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1689 tm->cc_last_type = TCP_CC_LAST;
1694 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1698 if (tcp_main.is_enabled)
1701 return tcp_main_enable (vm);
1705 tcp_main.is_enabled = 0;
1712 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1714 tcp_main_t *tm = &tcp_main;
1716 tm->punt_unknown4 = is_add;
1718 tm->punt_unknown6 = is_add;
1722 * Initialize default values for tcp parameters
1725 tcp_configuration_init (void)
1727 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1728 * predefined value. For SYN-ACK we still want the scale to be computed in
1730 tcp_cfg.max_rx_fifo = 32 << 20;
1731 tcp_cfg.min_rx_fifo = 4 << 10;
1733 tcp_cfg.default_mtu = 1500;
1734 tcp_cfg.initial_cwnd_multiplier = 0;
1735 tcp_cfg.enable_tx_pacing = 1;
1736 tcp_cfg.allow_tso = 0;
1737 tcp_cfg.csum_offload = 1;
1738 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1739 tcp_cfg.rwnd_min_update_ack = 1;
1741 /* Time constants defined as timer tick (100ms) multiples */
1742 tcp_cfg.delack_time = 1; /* 0.1s */
1743 tcp_cfg.closewait_time = 20; /* 2s */
1744 tcp_cfg.timewait_time = 100; /* 10s */
1745 tcp_cfg.finwait1_time = 600; /* 60s */
1746 tcp_cfg.lastack_time = 300; /* 30s */
1747 tcp_cfg.finwait2_time = 300; /* 30s */
1748 tcp_cfg.closing_time = 300; /* 30s */
1749 tcp_cfg.cleanup_time = 0.1; /* 100ms */
1752 static clib_error_t *
1753 tcp_init (vlib_main_t * vm)
1755 tcp_main_t *tm = vnet_get_tcp_main ();
1756 ip_main_t *im = &ip_main;
1757 ip_protocol_info_t *pi;
1759 /* Session layer, and by implication tcp, are disabled by default */
1762 /* Register with IP for header parsing */
1763 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1765 return clib_error_return (0, "TCP protocol info AWOL");
1766 pi->format_header = format_tcp_header;
1767 pi->unformat_pg_edit = unformat_pg_tcp_header;
1769 /* Register as transport with session layer */
1770 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1771 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1772 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1773 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1775 tcp_api_reference ();
1776 tcp_configuration_init ();
1778 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1783 VLIB_INIT_FUNCTION (tcp_init);
1786 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1788 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1789 tcp_main_t *tm = &tcp_main;
1794 if (unformat (input, "%s", &cc_algo_name)
1795 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1801 vec_free (cc_algo_name);
1806 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1808 tcp_main_t *tm = vnet_get_tcp_main ();
1809 tcp_cc_algorithm_t *cc_alg;
1810 unformat_input_t sub_input;
1813 vec_foreach (cc_alg, tm->cc_algos)
1815 if (!unformat (input, cc_alg->name))
1818 if (cc_alg->unformat_cfg
1819 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1821 if (cc_alg->unformat_cfg (&sub_input))
1828 static clib_error_t *
1829 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1831 u32 cwnd_multiplier, tmp_time;
1834 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1836 if (unformat (input, "preallocated-connections %d",
1837 &tcp_cfg.preallocated_connections))
1839 else if (unformat (input, "preallocated-half-open-connections %d",
1840 &tcp_cfg.preallocated_half_open_connections))
1842 else if (unformat (input, "buffer-fail-fraction %f",
1843 &tcp_cfg.buffer_fail_fraction))
1845 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1848 if (memory_size >= 0x100000000)
1850 return clib_error_return
1851 (0, "max-rx-fifo %llu (0x%llx) too large", memory_size,
1854 tcp_cfg.max_rx_fifo = memory_size;
1856 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1859 if (memory_size >= 0x100000000)
1861 return clib_error_return
1862 (0, "min-rx-fifo %llu (0x%llx) too large", memory_size,
1865 tcp_cfg.min_rx_fifo = memory_size;
1867 else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1869 else if (unformat (input, "rwnd-min-update-ack %d",
1870 &tcp_cfg.rwnd_min_update_ack))
1872 else if (unformat (input, "initial-cwnd-multiplier %u",
1874 tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1875 else if (unformat (input, "no-tx-pacing"))
1876 tcp_cfg.enable_tx_pacing = 0;
1877 else if (unformat (input, "tso"))
1878 tcp_cfg.allow_tso = 1;
1879 else if (unformat (input, "no-csum-offload"))
1880 tcp_cfg.csum_offload = 0;
1881 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1884 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1886 else if (unformat (input, "closewait-time %u", &tmp_time))
1887 tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1888 else if (unformat (input, "timewait-time %u", &tmp_time))
1889 tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1890 else if (unformat (input, "finwait1-time %u", &tmp_time))
1891 tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1892 else if (unformat (input, "finwait2-time %u", &tmp_time))
1893 tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1894 else if (unformat (input, "lastack-time %u", &tmp_time))
1895 tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1896 else if (unformat (input, "closing-time %u", &tmp_time))
1897 tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1898 else if (unformat (input, "cleanup-time %u", &tmp_time))
1899 tcp_cfg.cleanup_time = tmp_time / 1000.0;
1901 return clib_error_return (0, "unknown input `%U'",
1902 format_unformat_error, input);
1907 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1911 * \brief Configure an ipv4 source address range
1912 * @param vm vlib_main_t pointer
1913 * @param start first ipv4 address in the source address range
1914 * @param end last ipv4 address in the source address range
1915 * @param table_id VRF / table ID, 0 for the default FIB
1916 * @return 0 if all OK, else an error indication from api_errno.h
1920 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1921 ip4_address_t * start,
1922 ip4_address_t * end, u32 table_id)
1924 u32 start_host_byte_order, end_host_byte_order;
1925 fib_prefix_t prefix;
1926 fib_node_index_t fei;
1931 clib_memset (&prefix, 0, sizeof (prefix));
1933 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1935 if (fib_index == ~0)
1936 return VNET_API_ERROR_NO_SUCH_FIB;
1938 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1939 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1941 /* sanity check for reversed args or some such */
1942 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1943 return VNET_API_ERROR_INVALID_ARGUMENT;
1945 /* Lookup the last address, to identify the interface involved */
1947 prefix.fp_proto = FIB_PROTOCOL_IP4;
1948 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1950 fei = fib_table_lookup (fib_index, &prefix);
1952 /* Couldn't find route to destination. Bail out. */
1953 if (fei == FIB_NODE_INDEX_INVALID)
1954 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1956 sw_if_index = fib_entry_get_resolving_interface (fei);
1958 /* Configure proxy arp across the range */
1959 rv = ip4_neighbor_proxy_add (fib_index, start, end);
1964 rv = ip4_neighbor_proxy_enable (sw_if_index);
1971 dpo_id_t dpo = DPO_INVALID;
1973 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1975 /* Add local adjacencies for the range */
1977 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1980 prefix.fp_proto = FIB_PROTOCOL_IP4;
1981 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1983 fib_table_entry_special_dpo_update (fib_index,
1986 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1989 start_host_byte_order++;
1990 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1992 while (start_host_byte_order <= end_host_byte_order);
1998 * \brief Configure an ipv6 source address range
1999 * @param vm vlib_main_t pointer
2000 * @param start first ipv6 address in the source address range
2001 * @param end last ipv6 address in the source address range
2002 * @param table_id VRF / table ID, 0 for the default FIB
2003 * @return 0 if all OK, else an error indication from api_errno.h
2007 tcp_configure_v6_source_address_range (vlib_main_t * vm,
2008 ip6_address_t * start,
2009 ip6_address_t * end, u32 table_id)
2011 fib_prefix_t prefix;
2013 fib_node_index_t fei;
2016 clib_memset (&prefix, 0, sizeof (prefix));
2018 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
2020 if (fib_index == ~0)
2021 return VNET_API_ERROR_NO_SUCH_FIB;
2027 dpo_id_t dpo = DPO_INVALID;
2029 /* Remember this address */
2030 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
2032 /* Lookup the prefix, to identify the interface involved */
2033 prefix.fp_len = 128;
2034 prefix.fp_proto = FIB_PROTOCOL_IP6;
2035 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
2037 fei = fib_table_lookup (fib_index, &prefix);
2039 /* Couldn't find route to destination. Bail out. */
2040 if (fei == FIB_NODE_INDEX_INVALID)
2041 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
2043 sw_if_index = fib_entry_get_resolving_interface (fei);
2045 if (sw_if_index == (u32) ~ 0)
2046 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
2048 /* Add a proxy neighbor discovery entry for this address */
2049 ip6_neighbor_proxy_add (sw_if_index, start);
2051 /* Add a receive adjacency for this address */
2052 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
2055 fib_table_entry_special_dpo_update (fib_index,
2058 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
2061 /* Done with the entire range? */
2062 if (!memcmp (start, end, sizeof (start[0])))
2065 /* Increment the address. DGMS. */
2067 for (i = 15; i >= 0; i--)
2070 if (tmp.as_u8[i] != 0)
2078 static clib_error_t *
2079 tcp_src_address_fn (vlib_main_t * vm,
2080 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
2082 ip4_address_t v4start, v4end;
2083 ip6_address_t v6start, v6end;
2089 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2091 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
2092 unformat_ip4_address, &v4end))
2094 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
2096 memcpy (&v4end, &v4start, sizeof (v4start));
2099 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
2100 unformat_ip6_address, &v6end))
2102 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
2104 memcpy (&v6end, &v6start, sizeof (v6start));
2107 else if (unformat (input, "fib-table %d", &table_id))
2113 if (!v4set && !v6set)
2114 return clib_error_return (0, "at least one v4 or v6 address required");
2118 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
2125 case VNET_API_ERROR_NO_SUCH_FIB:
2126 return clib_error_return (0, "Invalid table-id %d", table_id);
2128 case VNET_API_ERROR_INVALID_ARGUMENT:
2129 return clib_error_return (0, "Invalid address range %U - %U",
2130 format_ip4_address, &v4start,
2131 format_ip4_address, &v4end);
2133 return clib_error_return (0, "error %d", rv);
2139 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
2146 case VNET_API_ERROR_NO_SUCH_FIB:
2147 return clib_error_return (0, "Invalid table-id %d", table_id);
2150 return clib_error_return (0, "error %d", rv);
2158 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2160 .path = "tcp src-address",
2161 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2162 .function = tcp_src_address_fn,
2167 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2169 #if TCP_SCOREBOARD_TRACE
2171 scoreboard_trace_elt_t *block;
2177 s = format (s, "scoreboard trace:");
2178 vec_foreach (block, sb->trace)
2180 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2181 block->ack, block->snd_una_max, block->group);
2183 s = format (s, "\n");
2191 static clib_error_t *
2192 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2193 vlib_cli_command_t * cmd_arg)
2195 transport_connection_t *tconn = 0;
2196 tcp_connection_t *tc;
2198 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2200 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2201 TRANSPORT_PROTO_TCP))
2204 return clib_error_return (0, "unknown input `%U'",
2205 format_unformat_error, input);
2208 if (!TCP_SCOREBOARD_TRACE)
2210 vlib_cli_output (vm, "scoreboard tracing not enabled");
2214 tc = tcp_get_connection_from_transport (tconn);
2215 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2216 vlib_cli_output (vm, "%v", s);
2221 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2223 .path = "show tcp scoreboard trace",
2224 .short_help = "show tcp scoreboard trace <connection>",
2225 .function = tcp_show_scoreboard_trace_fn,
2230 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2233 scoreboard_trace_elt_t *trace;
2234 u32 next_ack, left, group, has_new_ack = 0;
2235 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2236 sack_block_t *block;
2238 if (!TCP_SCOREBOARD_TRACE)
2240 s = format (s, "scoreboard tracing not enabled");
2247 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2248 tcp_connection_timers_init (dummy_tc);
2249 scoreboard_init (&dummy_tc->sack_sb);
2250 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2252 #if TCP_SCOREBOARD_TRACE
2253 trace = tc->sack_sb.trace;
2254 trace_len = vec_len (tc->sack_sb.trace);
2257 for (i = 0; i < trace_len; i++)
2259 if (trace[i].ack != 0)
2261 dummy_tc->snd_una = trace[i].ack - 1448;
2262 dummy_tc->snd_una_max = trace[i].ack;
2267 while (left < trace_len)
2269 group = trace[left].group;
2270 vec_reset_length (dummy_tc->rcv_opts.sacks);
2272 while (trace[left].group == group)
2274 if (trace[left].ack != 0)
2277 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2278 trace[left].ack, trace[left].snd_una_max);
2279 dummy_tc->snd_una_max = trace[left].snd_una_max;
2280 next_ack = trace[left].ack;
2286 s = format (s, "[%u, %u], ", trace[left].start,
2288 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2289 block->start = trace[left].start;
2290 block->end = trace[left].end;
2296 tcp_rcv_sacks (dummy_tc, next_ack);
2298 dummy_tc->snd_una = next_ack;
2301 s = format (s, "result: %U", format_tcp_scoreboard,
2302 &dummy_tc->sack_sb);
2305 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2310 static clib_error_t *
2311 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2312 vlib_cli_command_t * cmd_arg)
2314 transport_connection_t *tconn = 0;
2315 tcp_connection_t *tc = 0;
2317 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2319 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2320 TRANSPORT_PROTO_TCP))
2323 return clib_error_return (0, "unknown input `%U'",
2324 format_unformat_error, input);
2327 if (!TCP_SCOREBOARD_TRACE)
2329 vlib_cli_output (vm, "scoreboard tracing not enabled");
2333 tc = tcp_get_connection_from_transport (tconn);
2336 vlib_cli_output (vm, "connection not found");
2339 str = tcp_scoreboard_replay (str, tc, 1);
2340 vlib_cli_output (vm, "%v", str);
2345 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2347 .path = "tcp replay scoreboard",
2348 .short_help = "tcp replay scoreboard <connection>",
2349 .function = tcp_scoreboard_trace_fn,
2353 static clib_error_t *
2354 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2355 vlib_cli_command_t * cmd_arg)
2357 tcp_main_t *tm = vnet_get_tcp_main ();
2358 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2359 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2361 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2362 tm->punt_unknown4 ? "enabled" : "disabled");
2363 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2364 tm->punt_unknown6 ? "enabled" : "disabled");
2368 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2370 .path = "show tcp punt",
2371 .short_help = "show tcp punt",
2372 .function = show_tcp_punt_fn,
2376 static clib_error_t *
2377 show_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2378 vlib_cli_command_t * cmd)
2380 tcp_main_t *tm = vnet_get_tcp_main ();
2381 tcp_worker_ctx_t *wrk;
2384 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2385 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2387 for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2389 wrk = tcp_get_worker (thread);
2390 vlib_cli_output (vm, "Thread %u:\n", thread);
2392 if (clib_fifo_elts (wrk->pending_timers))
2393 vlib_cli_output (vm, " %lu pending timers",
2394 clib_fifo_elts (wrk->pending_timers));
2396 #define _(name,type,str) \
2397 if (wrk->stats.name) \
2398 vlib_cli_output (vm, " %lu %s", wrk->stats.name, str);
2399 foreach_tcp_wrk_stat
2407 VLIB_CLI_COMMAND (show_tcp_stats_command, static) =
2409 .path = "show tcp stats",
2410 .short_help = "show tcp stats",
2411 .function = show_tcp_stats_fn,
2415 static clib_error_t *
2416 clear_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2417 vlib_cli_command_t * cmd)
2419 tcp_main_t *tm = vnet_get_tcp_main ();
2420 tcp_worker_ctx_t *wrk;
2423 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2424 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2427 for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2429 wrk = tcp_get_worker (thread);
2430 clib_memset (&wrk->stats, 0, sizeof (wrk->stats));
2437 VLIB_CLI_COMMAND (clear_tcp_stats_command, static) =
2439 .path = "clear tcp stats",
2440 .short_help = "clear tcp stats",
2441 .function = clear_tcp_stats_fn,
2446 * fd.io coding-style-patch-verification: ON
2449 * eval: (c-set-style "gnu")