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_init_w_buffer (tcp_connection_t * tc, vlib_buffer_t * b, u8 is_ip4)
713 tcp_header_t *th = tcp_buffer_hdr (b);
715 tc->c_lcl_port = th->dst_port;
716 tc->c_rmt_port = th->src_port;
717 tc->c_is_ip4 = is_ip4;
721 ip4_header_t *ip4 = vlib_buffer_get_current (b);
722 tc->c_lcl_ip4.as_u32 = ip4->dst_address.as_u32;
723 tc->c_rmt_ip4.as_u32 = ip4->src_address.as_u32;
727 ip6_header_t *ip6 = vlib_buffer_get_current (b);
728 clib_memcpy_fast (&tc->c_lcl_ip6, &ip6->dst_address,
729 sizeof (ip6_address_t));
730 clib_memcpy_fast (&tc->c_rmt_ip6, &ip6->src_address,
731 sizeof (ip6_address_t));
734 tc->irs = vnet_buffer (b)->tcp.seq_number;
735 tc->rcv_nxt = vnet_buffer (b)->tcp.seq_number + 1;
736 tc->rcv_las = tc->rcv_nxt;
737 tc->sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
738 tc->snd_wl1 = vnet_buffer (b)->tcp.seq_number;
739 tc->snd_wl2 = vnet_buffer (b)->tcp.ack_number;
741 /* RFC1323: TSval timestamps sent on {SYN} and {SYN,ACK}
742 * segments are used to initialize PAWS. */
743 if (tcp_opts_tstamp (&tc->rcv_opts))
745 tc->tsval_recent = tc->rcv_opts.tsval;
746 tc->tsval_recent_age = tcp_time_now ();
749 if (tcp_opts_wscale (&tc->rcv_opts))
750 tc->snd_wscale = tc->rcv_opts.wscale;
752 tc->snd_wnd = clib_net_to_host_u16 (th->window) << tc->snd_wscale;
756 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
757 u16 * lcl_port, u8 is_ip4)
762 index = tm->last_v4_addr_rotor++;
763 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
764 tm->last_v4_addr_rotor = 0;
765 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
769 index = tm->last_v6_addr_rotor++;
770 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
771 tm->last_v6_addr_rotor = 0;
772 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
773 sizeof (ip6_address_t));
775 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
778 clib_warning ("Failed to allocate src port");
786 tcp_session_open (transport_endpoint_cfg_t * rmt)
788 tcp_main_t *tm = vnet_get_tcp_main ();
789 tcp_connection_t *tc;
790 ip46_address_t lcl_addr;
795 * Allocate local endpoint
797 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
798 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
799 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
802 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
803 rmt, &lcl_addr, &lcl_port);
809 * Create connection and send SYN
811 clib_spinlock_lock_if_init (&tm->half_open_lock);
812 tc = tcp_half_open_connection_new ();
813 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
814 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
815 tc->c_rmt_port = rmt->port;
816 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
817 tc->c_is_ip4 = rmt->is_ip4;
818 tc->c_proto = TRANSPORT_PROTO_TCP;
819 tc->c_fib_index = rmt->fib_index;
820 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
821 /* The other connection vars will be initialized after SYN ACK */
822 tcp_connection_timers_init (tc);
825 TCP_EVT (TCP_EVT_OPEN, tc);
826 tc->state = TCP_STATE_SYN_SENT;
827 tcp_init_snd_vars (tc);
829 clib_spinlock_unlock_if_init (&tm->half_open_lock);
831 return tc->c_c_index;
834 const char *tcp_fsm_states[] = {
835 #define _(sym, str) str,
836 foreach_tcp_fsm_state
841 format_tcp_state (u8 * s, va_list * args)
843 u32 state = va_arg (*args, u32);
845 if (state < TCP_N_STATES)
846 s = format (s, "%s", tcp_fsm_states[state]);
848 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
852 const char *tcp_cfg_flags_str[] = {
853 #define _(sym, str) str,
859 format_tcp_cfg_flags (u8 * s, va_list * args)
861 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
864 for (i = 0; i < TCP_CFG_N_FLAG_BITS; i++)
865 if (tc->cfg_flags & (1 << i))
867 for (i = 0; i < last; i++)
869 if (tc->cfg_flags & (1 << i))
870 s = format (s, "%s, ", tcp_cfg_flags_str[i]);
873 s = format (s, "%s", tcp_cfg_flags_str[last]);
877 const char *tcp_connection_flags_str[] = {
878 #define _(sym, str) str,
879 foreach_tcp_connection_flag
884 format_tcp_connection_flags (u8 * s, va_list * args)
886 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
889 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
890 if (tc->flags & (1 << i))
892 for (i = 0; i < last; i++)
894 if (tc->flags & (1 << i))
895 s = format (s, "%s, ", tcp_connection_flags_str[i]);
898 s = format (s, "%s", tcp_connection_flags_str[last]);
902 const char *tcp_conn_timers[] = {
903 #define _(sym, str) str,
909 format_tcp_timers (u8 * s, va_list * args)
911 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
914 for (i = 0; i < TCP_N_TIMERS; i++)
915 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
918 for (i = 0; i < last; i++)
920 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
921 s = format (s, "%s,", tcp_conn_timers[i]);
925 s = format (s, "%s", tcp_conn_timers[i]);
931 format_tcp_congestion_status (u8 * s, va_list * args)
933 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
934 if (tcp_in_recovery (tc))
935 s = format (s, "recovery");
936 else if (tcp_in_fastrecovery (tc))
937 s = format (s, "fastrecovery");
939 s = format (s, "none");
944 tcp_rcv_wnd_available (tcp_connection_t * tc)
946 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
950 format_tcp_congestion (u8 * s, va_list * args)
952 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
953 u32 indent = format_get_indent (s), prr_space = 0;
955 s = format (s, "%U ", format_tcp_congestion_status, tc);
956 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
957 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
958 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u\n",
959 format_white_space, indent, tcp_available_cc_snd_space (tc),
960 tc->prev_cwnd, tc->prev_ssthresh);
961 s = format (s, "%Usnd_cong %u dupack %u limited_tx %u\n",
962 format_white_space, indent, tc->snd_congestion - tc->iss,
963 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
964 s = format (s, "%Urxt_bytes %u rxt_delivered %u rxt_head %u rxt_ts %u\n",
965 format_white_space, indent, tc->snd_rxt_bytes,
966 tc->rxt_delivered, tc->rxt_head - tc->iss,
967 tcp_time_now_w_thread (tc->c_thread_index) - tc->snd_rxt_ts);
968 if (tcp_in_fastrecovery (tc))
969 prr_space = tcp_fastrecovery_prr_snd_space (tc);
970 s = format (s, "%Uprr_start %u prr_delivered %u prr space %u\n",
971 format_white_space, indent, tc->prr_start - tc->iss,
972 tc->prr_delivered, prr_space);
977 format_tcp_stats (u8 * s, va_list * args)
979 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
980 u32 indent = format_get_indent (s);
981 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
982 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
983 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
984 format_white_space, indent, tc->segs_out,
985 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
986 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
987 format_white_space, indent, tc->fr_occurences,
988 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
989 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
990 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
991 format_white_space, indent, tc->errors.below_data_wnd,
992 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
993 tc->errors.above_ack_wnd);
998 format_tcp_vars (u8 * s, va_list * args)
1000 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1001 s = format (s, " index: %u cfg: %U flags: %U timers: %U\n", tc->c_c_index,
1002 format_tcp_cfg_flags, tc, format_tcp_connection_flags, tc,
1003 format_tcp_timers, tc);
1004 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
1005 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
1006 tc->snd_una_max - tc->iss);
1007 s = format (s, " rcv_nxt %u rcv_las %u\n",
1008 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
1009 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
1010 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
1011 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
1012 tc->snd_wl2 - tc->iss);
1013 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
1014 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
1015 tcp_rcv_wnd_available (tc));
1016 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
1017 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
1018 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
1019 tcp_time_now () - tc->tsval_recent_age);
1020 s = format (s, " snd_mss %u\n", tc->snd_mss);
1021 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
1022 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
1024 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
1025 s = format (s, " next_node %u opaque 0x%x fib_index %u\n",
1026 tc->next_node_index, tc->next_node_opaque, tc->c_fib_index);
1027 s = format (s, " cong: %U", format_tcp_congestion, tc);
1029 if (tc->state >= TCP_STATE_ESTABLISHED)
1031 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
1033 s = format (s, " stats: %U\n", format_tcp_stats, tc);
1035 if (vec_len (tc->snd_sacks))
1036 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
1042 format_tcp_connection_id (u8 * s, va_list * args)
1044 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1049 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1050 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
1051 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
1052 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
1056 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1057 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1058 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1059 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1066 format_tcp_connection (u8 * s, va_list * args)
1068 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1069 u32 verbose = va_arg (*args, u32);
1073 s = format (s, "%-50U", format_tcp_connection_id, tc);
1076 s = format (s, "%-15U", format_tcp_state, tc->state);
1078 s = format (s, "\n%U", format_tcp_vars, tc);
1085 format_tcp_session (u8 * s, va_list * args)
1087 u32 tci = va_arg (*args, u32);
1088 u32 thread_index = va_arg (*args, u32);
1089 u32 verbose = va_arg (*args, u32);
1090 tcp_connection_t *tc;
1092 tc = tcp_connection_get (tci, thread_index);
1094 s = format (s, "%U", format_tcp_connection, tc, verbose);
1096 s = format (s, "empty\n");
1101 format_tcp_listener_session (u8 * s, va_list * args)
1103 u32 tci = va_arg (*args, u32);
1104 u32 __clib_unused thread_index = va_arg (*args, u32);
1105 u32 verbose = va_arg (*args, u32);
1106 tcp_connection_t *tc = tcp_listener_get (tci);
1107 s = format (s, "%-50U", format_tcp_connection_id, tc);
1109 s = format (s, "%-15U", format_tcp_state, tc->state);
1114 format_tcp_half_open_session (u8 * s, va_list * args)
1116 u32 tci = va_arg (*args, u32);
1117 u32 __clib_unused thread_index = va_arg (*args, u32);
1118 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1119 return format (s, "%U", format_tcp_connection_id, tc);
1123 format_tcp_sacks (u8 * s, va_list * args)
1125 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1126 sack_block_t *sacks = tc->snd_sacks;
1127 sack_block_t *block;
1130 len = vec_len (sacks);
1131 for (i = 0; i < len - 1; i++)
1134 s = format (s, " start %u end %u\n", block->start - tc->irs,
1135 block->end - tc->irs);
1139 block = &sacks[len - 1];
1140 s = format (s, " start %u end %u", block->start - tc->irs,
1141 block->end - tc->irs);
1147 format_tcp_rcv_sacks (u8 * s, va_list * args)
1149 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1150 sack_block_t *sacks = tc->rcv_opts.sacks;
1151 sack_block_t *block;
1154 len = vec_len (sacks);
1155 for (i = 0; i < len - 1; i++)
1158 s = format (s, " start %u end %u\n", block->start - tc->iss,
1159 block->end - tc->iss);
1163 block = &sacks[len - 1];
1164 s = format (s, " start %u end %u", block->start - tc->iss,
1165 block->end - tc->iss);
1171 format_tcp_sack_hole (u8 * s, va_list * args)
1173 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1174 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1176 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1178 s = format (s, " [%u, %u]", hole->start, hole->end);
1183 format_tcp_scoreboard (u8 * s, va_list * args)
1185 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1186 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1187 sack_scoreboard_hole_t *hole;
1188 u32 indent = format_get_indent (s);
1190 s = format (s, "sacked %u last_sacked %u lost %u last_lost %u"
1192 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes,
1193 sb->last_lost_bytes, sb->rxt_sacked);
1194 s = format (s, "%Ulast_delivered %u high_sacked %u is_reneging %u\n",
1195 format_white_space, indent, sb->last_bytes_delivered,
1196 sb->high_sacked - tc->iss, sb->is_reneging);
1197 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1198 format_white_space, indent, sb->cur_rxt_hole,
1199 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1201 hole = scoreboard_first_hole (sb);
1203 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1204 indent, sb->head, sb->tail, pool_elts (sb->holes),
1205 format_white_space, indent);
1209 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1210 hole = scoreboard_next_hole (sb, hole);
1216 static transport_connection_t *
1217 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1219 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1220 if (PREDICT_FALSE (!tc))
1222 return &tc->connection;
1225 static transport_connection_t *
1226 tcp_half_open_session_get_transport (u32 conn_index)
1228 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1229 return &tc->connection;
1233 tcp_session_cal_goal_size (tcp_connection_t * tc)
1235 u16 goal_size = tc->snd_mss;
1237 goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1238 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1240 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1244 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1246 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1248 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1251 /* If not snd_wnd constrained and we can't write at least a segment,
1252 * don't try at all */
1253 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1254 return snd_space < tc->cwnd ? 0 : snd_space;
1256 /* round down to mss multiple */
1257 return snd_space - (snd_space % tc->snd_mss);
1261 * Compute tx window session is allowed to fill.
1263 * Takes into account available send space, snd_mss and the congestion
1264 * state of the connection. If possible, the value returned is a multiple
1267 * @param tc tcp connection
1268 * @return number of bytes session is allowed to write
1271 tcp_snd_space_inline (tcp_connection_t * tc)
1275 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1276 || tc->state == TCP_STATE_CLOSED))
1279 snd_space = tcp_available_output_snd_space (tc);
1281 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1282 * to force the peer to send enough dupacks to start retransmitting as
1283 * per Limited Transmit (RFC3042)
1285 if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
1287 if (tc->limited_transmit != tc->snd_nxt
1288 && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
1289 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1290 tc->limited_transmit = tc->snd_nxt;
1292 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1294 int snt_limited = tc->snd_nxt - tc->limited_transmit;
1295 snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
1297 return tcp_round_snd_space (tc, snd_space);
1301 tcp_snd_space (tcp_connection_t * tc)
1303 return tcp_snd_space_inline (tc);
1307 tcp_session_send_params (transport_connection_t * trans_conn,
1308 transport_send_params_t * sp)
1310 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1312 /* Ensure snd_mss does accurately reflect the amount of data we can push
1313 * in a segment. This also makes sure that options are updated according to
1314 * the current state of the connection. */
1315 tcp_update_burst_snd_vars (tc);
1317 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1318 sp->snd_mss = tcp_session_cal_goal_size (tc);
1320 sp->snd_mss = tc->snd_mss;
1322 sp->snd_space = clib_min (tcp_snd_space_inline (tc),
1323 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1325 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1326 /* This still works if fast retransmit is on */
1327 sp->tx_offset = tc->snd_nxt - tc->snd_una;
1329 sp->flags = sp->snd_space ? 0 : TRANSPORT_SND_F_DESCHED;
1335 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1337 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1341 case TCP_STATE_CLOSE_WAIT:
1342 tcp_connection_timers_reset (tc);
1343 /* App never returned with a close */
1344 if (!(tc->flags & TCP_CONN_FINPNDG))
1346 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1347 session_transport_closed_notify (&tc->connection);
1348 tcp_program_cleanup (wrk, tc);
1349 tcp_workerp_stats_inc (wrk, to_closewait, 1);
1353 /* Send FIN either way and switch to LAST_ACK. */
1354 tcp_cong_recovery_off (tc);
1355 /* Make sure we don't try to send unsent data */
1356 tc->snd_nxt = tc->snd_una;
1358 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1359 session_transport_closed_notify (&tc->connection);
1361 /* Make sure we don't wait in LAST ACK forever */
1362 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1363 tcp_workerp_stats_inc (wrk, to_closewait2, 1);
1365 /* Don't delete the connection yet */
1367 case TCP_STATE_FIN_WAIT_1:
1368 tcp_connection_timers_reset (tc);
1369 if (tc->flags & TCP_CONN_FINPNDG)
1371 /* If FIN pending, we haven't sent everything, but we did try.
1372 * Notify session layer that transport is closed. */
1373 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1374 tcp_send_reset (tc);
1375 tcp_program_cleanup (wrk, tc);
1379 /* We've sent the fin but no progress. Close the connection and
1380 * to make sure everything is flushed, setup a cleanup timer */
1381 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1382 tcp_program_cleanup (wrk, tc);
1384 session_transport_closed_notify (&tc->connection);
1385 tcp_workerp_stats_inc (wrk, to_finwait1, 1);
1387 case TCP_STATE_LAST_ACK:
1388 tcp_connection_timers_reset (tc);
1389 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1390 session_transport_closed_notify (&tc->connection);
1391 tcp_program_cleanup (wrk, tc);
1392 tcp_workerp_stats_inc (wrk, to_lastack, 1);
1394 case TCP_STATE_CLOSING:
1395 tcp_connection_timers_reset (tc);
1396 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1397 session_transport_closed_notify (&tc->connection);
1398 tcp_program_cleanup (wrk, tc);
1399 tcp_workerp_stats_inc (wrk, to_closing, 1);
1401 case TCP_STATE_FIN_WAIT_2:
1402 tcp_send_reset (tc);
1403 tcp_connection_timers_reset (tc);
1404 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1405 session_transport_closed_notify (&tc->connection);
1406 tcp_program_cleanup (wrk, tc);
1407 tcp_workerp_stats_inc (wrk, to_finwait2, 1);
1409 case TCP_STATE_TIME_WAIT:
1410 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1411 tcp_program_cleanup (wrk, tc);
1414 clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
1420 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1422 tcp_timer_retransmit_handler,
1423 tcp_timer_delack_handler,
1424 tcp_timer_persist_handler,
1425 tcp_timer_waitclose_handler,
1426 tcp_timer_retransmit_syn_handler,
1431 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1433 u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1434 tcp_connection_t *tc;
1437 if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1440 thread_index = wrk->vm->thread_index;
1441 for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
1443 clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1444 connection_index = timer_handle & 0x0FFFFFFF;
1445 timer_id = timer_handle >> 28;
1447 if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1448 tc = tcp_connection_get (connection_index, thread_index);
1450 tc = tcp_half_open_connection_get (connection_index);
1452 if (PREDICT_FALSE (!tc))
1455 /* Skip timer if it was rearmed while pending dispatch */
1456 if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1459 (*timer_expiration_handlers[timer_id]) (tc);
1462 if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
1463 vlib_process_signal_event_mt (wrk->vm, session_queue_process_node.index,
1464 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1468 * Flush ip lookup tx frames populated by timer pops
1471 tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk)
1473 if (wrk->ip_lookup_tx_frames[0])
1475 vlib_put_frame_to_node (wrk->vm, ip4_lookup_node.index,
1476 wrk->ip_lookup_tx_frames[0]);
1477 wrk->ip_lookup_tx_frames[0] = 0;
1479 if (wrk->ip_lookup_tx_frames[1])
1481 vlib_put_frame_to_node (wrk->vm, ip6_lookup_node.index,
1482 wrk->ip_lookup_tx_frames[1]);
1483 wrk->ip_lookup_tx_frames[1] = 0;
1488 tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1490 u32 thread_index = wrk->vm->thread_index;
1491 tcp_cleanup_req_t *req;
1492 tcp_connection_t *tc;
1494 while (clib_fifo_elts (wrk->pending_cleanups))
1496 req = clib_fifo_head (wrk->pending_cleanups);
1497 if (req->free_time > now)
1499 clib_fifo_sub2 (wrk->pending_cleanups, req);
1500 tc = tcp_connection_get (req->connection_index, thread_index);
1501 if (PREDICT_FALSE (!tc))
1503 session_transport_delete_notify (&tc->connection);
1504 tcp_connection_cleanup (tc);
1509 tcp_update_time (f64 now, u8 thread_index)
1511 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1513 tcp_set_time_now (wrk);
1514 tcp_handle_cleanups (wrk, now);
1515 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1516 tcp_dispatch_pending_timers (wrk);
1517 tcp_flush_frames_to_output (wrk);
1521 tcp_session_flush_data (transport_connection_t * tconn)
1523 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1524 if (tc->flags & TCP_CONN_PSH_PENDING)
1526 tc->flags |= TCP_CONN_PSH_PENDING;
1527 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1531 const static transport_proto_vft_t tcp_proto = {
1532 .enable = vnet_tcp_enable_disable,
1533 .start_listen = tcp_session_bind,
1534 .stop_listen = tcp_session_unbind,
1535 .push_header = tcp_session_push_header,
1536 .get_connection = tcp_session_get_transport,
1537 .get_listener = tcp_session_get_listener,
1538 .get_half_open = tcp_half_open_session_get_transport,
1539 .connect = tcp_session_open,
1540 .close = tcp_session_close,
1541 .cleanup = tcp_session_cleanup,
1542 .reset = tcp_session_reset,
1543 .send_params = tcp_session_send_params,
1544 .update_time = tcp_update_time,
1545 .flush_data = tcp_session_flush_data,
1546 .custom_tx = tcp_session_custom_tx,
1547 .format_connection = format_tcp_session,
1548 .format_listener = format_tcp_listener_session,
1549 .format_half_open = format_tcp_half_open_session,
1550 .transport_options = {
1551 .tx_type = TRANSPORT_TX_PEEK,
1552 .service_type = TRANSPORT_SERVICE_VC,
1558 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1560 if (!transport_connection_is_tx_paced (&tc->connection))
1563 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1565 transport_connection_tx_pacer_update (&tc->connection,
1566 tcp_cc_get_pacing_rate (tc),
1567 srtt * CLIB_US_TIME_FREQ);
1571 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1574 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1575 transport_connection_tx_pacer_reset (&tc->connection,
1576 tcp_cc_get_pacing_rate (tc),
1578 srtt * CLIB_US_TIME_FREQ);
1582 tcp_reschedule (tcp_connection_t * tc)
1584 if (tcp_in_cong_recovery (tc) || tcp_snd_space_inline (tc))
1585 transport_connection_reschedule (&tc->connection);
1589 tcp_expired_timers_dispatch (u32 * expired_timers)
1591 u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1592 u32 connection_index, timer_id, n_expired, max_loops;
1593 tcp_worker_ctx_t *wrk;
1594 tcp_connection_t *tc;
1597 wrk = tcp_get_worker (thread_index);
1598 n_expired = vec_len (expired_timers);
1599 tcp_workerp_stats_inc (wrk, timer_expirations, n_expired);
1600 n_left = clib_fifo_elts (wrk->pending_timers);
1603 * Invalidate all timer handles before dispatching. This avoids dangling
1604 * index references to timer wheel pool entries that have been freed.
1606 for (i = 0; i < n_expired; i++)
1608 connection_index = expired_timers[i] & 0x0FFFFFFF;
1609 timer_id = expired_timers[i] >> 28;
1611 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1612 tc = tcp_connection_get (connection_index, thread_index);
1614 tc = tcp_half_open_connection_get (connection_index);
1616 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1618 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1621 clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1623 max_loops = clib_max (1, 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second);
1624 max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1625 max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1626 wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1629 if (thread_index == 0)
1630 vlib_process_signal_event_mt (wrk->vm, session_queue_process_node.index,
1631 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1635 tcp_initialize_timer_wheels (tcp_main_t * tm)
1637 tw_timer_wheel_16t_2w_512sl_t *tw;
1639 foreach_vlib_main (({
1640 tw = &tm->wrk_ctx[ii].timer_wheel;
1641 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1642 TCP_TIMER_TICK, ~0);
1643 tw->last_run_time = vlib_time_now (this_vlib_main);
1649 tcp_initialize_iss_seed (tcp_main_t * tm)
1651 u32 default_seed = random_default_seed ();
1652 u64 time_now = clib_cpu_time_now ();
1654 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1655 tm->iss_seed.second = random_u64 (&time_now);
1658 static clib_error_t *
1659 tcp_main_enable (vlib_main_t * vm)
1661 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1662 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1663 tcp_connection_t *tc __attribute__ ((unused));
1664 tcp_main_t *tm = vnet_get_tcp_main ();
1665 tcp_worker_ctx_t *wrk;
1666 clib_error_t *error = 0;
1669 if ((error = vlib_call_init_function (vm, ip_main_init)))
1671 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1673 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1680 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1681 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1684 * Initialize data structures
1687 num_threads = 1 /* main thread */ + vtm->n_threads;
1688 vec_validate (tm->wrk_ctx, num_threads - 1);
1689 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1690 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1692 for (thread = 0; thread < num_threads; thread++)
1694 wrk = &tm->wrk_ctx[thread];
1696 vec_validate (wrk->pending_deq_acked, 255);
1697 vec_validate (wrk->pending_disconnects, 255);
1698 vec_validate (wrk->pending_resets, 255);
1699 vec_reset_length (wrk->pending_deq_acked);
1700 vec_reset_length (wrk->pending_disconnects);
1701 vec_reset_length (wrk->pending_resets);
1702 wrk->vm = vlib_mains[thread];
1703 wrk->max_timers_per_loop = 10;
1706 * Preallocate connections. Assume that thread 0 won't
1707 * use preallocated threads when running multi-core
1709 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1710 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1714 * Use a preallocated half-open connection pool?
1716 if (tcp_cfg.preallocated_half_open_connections)
1717 pool_init_fixed (tm->half_open_connections,
1718 tcp_cfg.preallocated_half_open_connections);
1720 /* Initialize clocks per tick for TCP timestamp. Used to compute
1721 * monotonically increasing timestamps. */
1722 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1723 / TCP_TSTAMP_RESOLUTION;
1725 if (num_threads > 1)
1727 clib_spinlock_init (&tm->half_open_lock);
1730 tcp_initialize_timer_wheels (tm);
1731 tcp_initialize_iss_seed (tm);
1733 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1734 tm->cc_last_type = TCP_CC_LAST;
1739 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1743 if (tcp_main.is_enabled)
1746 return tcp_main_enable (vm);
1750 tcp_main.is_enabled = 0;
1757 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1759 tcp_main_t *tm = &tcp_main;
1761 tm->punt_unknown4 = is_add;
1763 tm->punt_unknown6 = is_add;
1767 * Initialize default values for tcp parameters
1770 tcp_configuration_init (void)
1772 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1773 * predefined value. For SYN-ACK we still want the scale to be computed in
1775 tcp_cfg.max_rx_fifo = 32 << 20;
1776 tcp_cfg.min_rx_fifo = 4 << 10;
1778 tcp_cfg.default_mtu = 1500;
1779 tcp_cfg.initial_cwnd_multiplier = 0;
1780 tcp_cfg.enable_tx_pacing = 1;
1781 tcp_cfg.allow_tso = 0;
1782 tcp_cfg.csum_offload = 1;
1783 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1784 tcp_cfg.rwnd_min_update_ack = 1;
1786 /* Time constants defined as timer tick (100ms) multiples */
1787 tcp_cfg.delack_time = 1; /* 0.1s */
1788 tcp_cfg.closewait_time = 20; /* 2s */
1789 tcp_cfg.timewait_time = 100; /* 10s */
1790 tcp_cfg.finwait1_time = 600; /* 60s */
1791 tcp_cfg.lastack_time = 300; /* 30s */
1792 tcp_cfg.finwait2_time = 300; /* 30s */
1793 tcp_cfg.closing_time = 300; /* 30s */
1794 tcp_cfg.cleanup_time = 0.1; /* 100ms */
1797 static clib_error_t *
1798 tcp_init (vlib_main_t * vm)
1800 tcp_main_t *tm = vnet_get_tcp_main ();
1801 ip_main_t *im = &ip_main;
1802 ip_protocol_info_t *pi;
1804 /* Session layer, and by implication tcp, are disabled by default */
1807 /* Register with IP for header parsing */
1808 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1810 return clib_error_return (0, "TCP protocol info AWOL");
1811 pi->format_header = format_tcp_header;
1812 pi->unformat_pg_edit = unformat_pg_tcp_header;
1814 /* Register as transport with session layer */
1815 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1816 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1817 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1818 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1820 tcp_api_reference ();
1821 tcp_configuration_init ();
1823 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1828 VLIB_INIT_FUNCTION (tcp_init);
1831 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1833 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1834 tcp_main_t *tm = &tcp_main;
1839 if (unformat (input, "%s", &cc_algo_name)
1840 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1846 vec_free (cc_algo_name);
1851 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1853 tcp_main_t *tm = vnet_get_tcp_main ();
1854 tcp_cc_algorithm_t *cc_alg;
1855 unformat_input_t sub_input;
1858 vec_foreach (cc_alg, tm->cc_algos)
1860 if (!unformat (input, cc_alg->name))
1863 if (cc_alg->unformat_cfg
1864 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1866 if (cc_alg->unformat_cfg (&sub_input))
1873 static clib_error_t *
1874 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1876 u32 cwnd_multiplier, tmp_time;
1879 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1881 if (unformat (input, "preallocated-connections %d",
1882 &tcp_cfg.preallocated_connections))
1884 else if (unformat (input, "preallocated-half-open-connections %d",
1885 &tcp_cfg.preallocated_half_open_connections))
1887 else if (unformat (input, "buffer-fail-fraction %f",
1888 &tcp_cfg.buffer_fail_fraction))
1890 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1893 if (memory_size >= 0x100000000)
1895 return clib_error_return
1896 (0, "max-rx-fifo %llu (0x%llx) too large", memory_size,
1899 tcp_cfg.max_rx_fifo = memory_size;
1901 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1904 if (memory_size >= 0x100000000)
1906 return clib_error_return
1907 (0, "min-rx-fifo %llu (0x%llx) too large", memory_size,
1910 tcp_cfg.min_rx_fifo = memory_size;
1912 else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1914 else if (unformat (input, "rwnd-min-update-ack %d",
1915 &tcp_cfg.rwnd_min_update_ack))
1917 else if (unformat (input, "initial-cwnd-multiplier %u",
1919 tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1920 else if (unformat (input, "no-tx-pacing"))
1921 tcp_cfg.enable_tx_pacing = 0;
1922 else if (unformat (input, "tso"))
1923 tcp_cfg.allow_tso = 1;
1924 else if (unformat (input, "no-csum-offload"))
1925 tcp_cfg.csum_offload = 0;
1926 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1929 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1931 else if (unformat (input, "closewait-time %u", &tmp_time))
1932 tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1933 else if (unformat (input, "timewait-time %u", &tmp_time))
1934 tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1935 else if (unformat (input, "finwait1-time %u", &tmp_time))
1936 tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1937 else if (unformat (input, "finwait2-time %u", &tmp_time))
1938 tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1939 else if (unformat (input, "lastack-time %u", &tmp_time))
1940 tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1941 else if (unformat (input, "closing-time %u", &tmp_time))
1942 tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1943 else if (unformat (input, "cleanup-time %u", &tmp_time))
1944 tcp_cfg.cleanup_time = tmp_time / 1000.0;
1946 return clib_error_return (0, "unknown input `%U'",
1947 format_unformat_error, input);
1952 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1956 * \brief Configure an ipv4 source address range
1957 * @param vm vlib_main_t pointer
1958 * @param start first ipv4 address in the source address range
1959 * @param end last ipv4 address in the source address range
1960 * @param table_id VRF / table ID, 0 for the default FIB
1961 * @return 0 if all OK, else an error indication from api_errno.h
1965 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1966 ip4_address_t * start,
1967 ip4_address_t * end, u32 table_id)
1969 u32 start_host_byte_order, end_host_byte_order;
1970 fib_prefix_t prefix;
1971 fib_node_index_t fei;
1976 clib_memset (&prefix, 0, sizeof (prefix));
1978 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1980 if (fib_index == ~0)
1981 return VNET_API_ERROR_NO_SUCH_FIB;
1983 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1984 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1986 /* sanity check for reversed args or some such */
1987 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1988 return VNET_API_ERROR_INVALID_ARGUMENT;
1990 /* Lookup the last address, to identify the interface involved */
1992 prefix.fp_proto = FIB_PROTOCOL_IP4;
1993 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1995 fei = fib_table_lookup (fib_index, &prefix);
1997 /* Couldn't find route to destination. Bail out. */
1998 if (fei == FIB_NODE_INDEX_INVALID)
1999 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
2001 sw_if_index = fib_entry_get_resolving_interface (fei);
2003 /* Configure proxy arp across the range */
2004 rv = ip4_neighbor_proxy_add (fib_index, start, end);
2009 rv = ip4_neighbor_proxy_enable (sw_if_index);
2016 dpo_id_t dpo = DPO_INVALID;
2018 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
2020 /* Add local adjacencies for the range */
2022 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
2025 prefix.fp_proto = FIB_PROTOCOL_IP4;
2026 prefix.fp_addr.ip4.as_u32 = start->as_u32;
2028 fib_table_entry_special_dpo_update (fib_index,
2031 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
2034 start_host_byte_order++;
2035 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
2037 while (start_host_byte_order <= end_host_byte_order);
2043 * \brief Configure an ipv6 source address range
2044 * @param vm vlib_main_t pointer
2045 * @param start first ipv6 address in the source address range
2046 * @param end last ipv6 address in the source address range
2047 * @param table_id VRF / table ID, 0 for the default FIB
2048 * @return 0 if all OK, else an error indication from api_errno.h
2052 tcp_configure_v6_source_address_range (vlib_main_t * vm,
2053 ip6_address_t * start,
2054 ip6_address_t * end, u32 table_id)
2056 fib_prefix_t prefix;
2058 fib_node_index_t fei;
2061 clib_memset (&prefix, 0, sizeof (prefix));
2063 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
2065 if (fib_index == ~0)
2066 return VNET_API_ERROR_NO_SUCH_FIB;
2072 dpo_id_t dpo = DPO_INVALID;
2074 /* Remember this address */
2075 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
2077 /* Lookup the prefix, to identify the interface involved */
2078 prefix.fp_len = 128;
2079 prefix.fp_proto = FIB_PROTOCOL_IP6;
2080 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
2082 fei = fib_table_lookup (fib_index, &prefix);
2084 /* Couldn't find route to destination. Bail out. */
2085 if (fei == FIB_NODE_INDEX_INVALID)
2086 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
2088 sw_if_index = fib_entry_get_resolving_interface (fei);
2090 if (sw_if_index == (u32) ~ 0)
2091 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
2093 /* Add a proxy neighbor discovery entry for this address */
2094 ip6_neighbor_proxy_add (sw_if_index, start);
2096 /* Add a receive adjacency for this address */
2097 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
2100 fib_table_entry_special_dpo_update (fib_index,
2103 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
2106 /* Done with the entire range? */
2107 if (!memcmp (start, end, sizeof (start[0])))
2110 /* Increment the address. DGMS. */
2112 for (i = 15; i >= 0; i--)
2115 if (tmp.as_u8[i] != 0)
2123 static clib_error_t *
2124 tcp_src_address_fn (vlib_main_t * vm,
2125 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
2127 ip4_address_t v4start, v4end;
2128 ip6_address_t v6start, v6end;
2134 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2136 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
2137 unformat_ip4_address, &v4end))
2139 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
2141 memcpy (&v4end, &v4start, sizeof (v4start));
2144 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
2145 unformat_ip6_address, &v6end))
2147 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
2149 memcpy (&v6end, &v6start, sizeof (v6start));
2152 else if (unformat (input, "fib-table %d", &table_id))
2158 if (!v4set && !v6set)
2159 return clib_error_return (0, "at least one v4 or v6 address required");
2163 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
2170 case VNET_API_ERROR_NO_SUCH_FIB:
2171 return clib_error_return (0, "Invalid table-id %d", table_id);
2173 case VNET_API_ERROR_INVALID_ARGUMENT:
2174 return clib_error_return (0, "Invalid address range %U - %U",
2175 format_ip4_address, &v4start,
2176 format_ip4_address, &v4end);
2178 return clib_error_return (0, "error %d", rv);
2184 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
2191 case VNET_API_ERROR_NO_SUCH_FIB:
2192 return clib_error_return (0, "Invalid table-id %d", table_id);
2195 return clib_error_return (0, "error %d", rv);
2203 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2205 .path = "tcp src-address",
2206 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2207 .function = tcp_src_address_fn,
2212 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2214 #if TCP_SCOREBOARD_TRACE
2216 scoreboard_trace_elt_t *block;
2222 s = format (s, "scoreboard trace:");
2223 vec_foreach (block, sb->trace)
2225 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2226 block->ack, block->snd_una_max, block->group);
2228 s = format (s, "\n");
2236 static clib_error_t *
2237 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2238 vlib_cli_command_t * cmd_arg)
2240 transport_connection_t *tconn = 0;
2241 tcp_connection_t *tc;
2243 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2245 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2246 TRANSPORT_PROTO_TCP))
2249 return clib_error_return (0, "unknown input `%U'",
2250 format_unformat_error, input);
2253 if (!TCP_SCOREBOARD_TRACE)
2255 vlib_cli_output (vm, "scoreboard tracing not enabled");
2259 tc = tcp_get_connection_from_transport (tconn);
2260 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2261 vlib_cli_output (vm, "%v", s);
2266 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2268 .path = "show tcp scoreboard trace",
2269 .short_help = "show tcp scoreboard trace <connection>",
2270 .function = tcp_show_scoreboard_trace_fn,
2275 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2278 scoreboard_trace_elt_t *trace;
2279 u32 next_ack, left, group, has_new_ack = 0;
2280 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2281 sack_block_t *block;
2283 if (!TCP_SCOREBOARD_TRACE)
2285 s = format (s, "scoreboard tracing not enabled");
2292 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2293 tcp_connection_timers_init (dummy_tc);
2294 scoreboard_init (&dummy_tc->sack_sb);
2295 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2297 #if TCP_SCOREBOARD_TRACE
2298 trace = tc->sack_sb.trace;
2299 trace_len = vec_len (tc->sack_sb.trace);
2302 for (i = 0; i < trace_len; i++)
2304 if (trace[i].ack != 0)
2306 dummy_tc->snd_una = trace[i].ack - 1448;
2307 dummy_tc->snd_una_max = trace[i].ack;
2312 while (left < trace_len)
2314 group = trace[left].group;
2315 vec_reset_length (dummy_tc->rcv_opts.sacks);
2317 while (trace[left].group == group)
2319 if (trace[left].ack != 0)
2322 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2323 trace[left].ack, trace[left].snd_una_max);
2324 dummy_tc->snd_una_max = trace[left].snd_una_max;
2325 next_ack = trace[left].ack;
2331 s = format (s, "[%u, %u], ", trace[left].start,
2333 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2334 block->start = trace[left].start;
2335 block->end = trace[left].end;
2341 tcp_rcv_sacks (dummy_tc, next_ack);
2343 dummy_tc->snd_una = next_ack;
2346 s = format (s, "result: %U", format_tcp_scoreboard,
2347 &dummy_tc->sack_sb);
2350 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2355 static clib_error_t *
2356 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2357 vlib_cli_command_t * cmd_arg)
2359 transport_connection_t *tconn = 0;
2360 tcp_connection_t *tc = 0;
2362 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2364 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2365 TRANSPORT_PROTO_TCP))
2368 return clib_error_return (0, "unknown input `%U'",
2369 format_unformat_error, input);
2372 if (!TCP_SCOREBOARD_TRACE)
2374 vlib_cli_output (vm, "scoreboard tracing not enabled");
2378 tc = tcp_get_connection_from_transport (tconn);
2381 vlib_cli_output (vm, "connection not found");
2384 str = tcp_scoreboard_replay (str, tc, 1);
2385 vlib_cli_output (vm, "%v", str);
2390 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2392 .path = "tcp replay scoreboard",
2393 .short_help = "tcp replay scoreboard <connection>",
2394 .function = tcp_scoreboard_trace_fn,
2398 static clib_error_t *
2399 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2400 vlib_cli_command_t * cmd_arg)
2402 tcp_main_t *tm = vnet_get_tcp_main ();
2403 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2404 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2406 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2407 tm->punt_unknown4 ? "enabled" : "disabled");
2408 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2409 tm->punt_unknown6 ? "enabled" : "disabled");
2413 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2415 .path = "show tcp punt",
2416 .short_help = "show tcp punt",
2417 .function = show_tcp_punt_fn,
2421 static clib_error_t *
2422 show_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2423 vlib_cli_command_t * cmd)
2425 tcp_main_t *tm = vnet_get_tcp_main ();
2426 tcp_worker_ctx_t *wrk;
2429 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2430 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2432 for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2434 wrk = tcp_get_worker (thread);
2435 vlib_cli_output (vm, "Thread %u:\n", thread);
2437 if (clib_fifo_elts (wrk->pending_timers))
2438 vlib_cli_output (vm, " %lu pending timers",
2439 clib_fifo_elts (wrk->pending_timers));
2441 #define _(name,type,str) \
2442 if (wrk->stats.name) \
2443 vlib_cli_output (vm, " %lu %s", wrk->stats.name, str);
2444 foreach_tcp_wrk_stat
2452 VLIB_CLI_COMMAND (show_tcp_stats_command, static) =
2454 .path = "show tcp stats",
2455 .short_help = "show tcp stats",
2456 .function = show_tcp_stats_fn,
2460 static clib_error_t *
2461 clear_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2462 vlib_cli_command_t * cmd)
2464 tcp_main_t *tm = vnet_get_tcp_main ();
2465 tcp_worker_ctx_t *wrk;
2468 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2469 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2472 for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2474 wrk = tcp_get_worker (thread);
2475 clib_memset (&wrk->stats, 0, sizeof (wrk->stats));
2482 VLIB_CLI_COMMAND (clear_tcp_stats_command, static) =
2484 .path = "clear tcp stats",
2485 .short_help = "clear tcp stats",
2486 .function = clear_tcp_stats_fn,
2491 * fd.io coding-style-patch-verification: ON
2494 * eval: (c-set-style "gnu")