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/ip6_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_connection_bind (u32 session_index, transport_endpoint_t * lcl)
75 tcp_main_t *tm = &tcp_main;
76 tcp_connection_t *listener;
79 pool_get (tm->listener_pool, listener);
80 clib_memset (listener, 0, sizeof (*listener));
82 listener->c_c_index = listener - tm->listener_pool;
83 listener->c_lcl_port = lcl->port;
85 /* If we are provided a sw_if_index, bind using one of its ips */
86 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
88 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
90 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
92 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
93 listener->c_is_ip4 = lcl->is_ip4;
94 listener->c_proto = TRANSPORT_PROTO_TCP;
95 listener->c_s_index = session_index;
96 listener->c_fib_index = lcl->fib_index;
97 listener->state = TCP_STATE_LISTEN;
99 tcp_connection_timers_init (listener);
101 TCP_EVT_DBG (TCP_EVT_BIND, listener);
103 return listener->c_c_index;
107 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
109 return tcp_connection_bind (session_index, tep);
113 tcp_connection_unbind (u32 listener_index)
115 tcp_main_t *tm = vnet_get_tcp_main ();
116 tcp_connection_t *tc;
118 tc = pool_elt_at_index (tm->listener_pool, listener_index);
120 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
122 /* Poison the entry */
124 clib_memset (tc, 0xFA, sizeof (*tc));
126 pool_put_index (tm->listener_pool, listener_index);
130 tcp_session_unbind (u32 listener_index)
132 tcp_connection_unbind (listener_index);
136 static transport_connection_t *
137 tcp_session_get_listener (u32 listener_index)
139 tcp_main_t *tm = vnet_get_tcp_main ();
140 tcp_connection_t *tc;
141 tc = pool_elt_at_index (tm->listener_pool, listener_index);
142 return &tc->connection;
146 * Cleanup half-open connection
150 tcp_half_open_connection_del (tcp_connection_t * tc)
152 tcp_main_t *tm = vnet_get_tcp_main ();
153 clib_spinlock_lock_if_init (&tm->half_open_lock);
154 pool_put_index (tm->half_open_connections, tc->c_c_index);
156 clib_memset (tc, 0xFA, sizeof (*tc));
157 clib_spinlock_unlock_if_init (&tm->half_open_lock);
161 * Try to cleanup half-open connection
163 * If called from a thread that doesn't own tc, the call won't have any
166 * @param tc - connection to be cleaned up
167 * @return non-zero if cleanup failed.
170 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
172 /* Make sure this is the owning thread */
173 if (tc->c_thread_index != vlib_get_thread_index ())
175 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH_AO);
176 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
177 tcp_half_open_connection_del (tc);
181 static tcp_connection_t *
182 tcp_half_open_connection_new (void)
184 tcp_main_t *tm = vnet_get_tcp_main ();
185 tcp_connection_t *tc = 0;
186 ASSERT (vlib_get_thread_index () == 0);
187 pool_get (tm->half_open_connections, tc);
188 clib_memset (tc, 0, sizeof (*tc));
189 tc->c_c_index = tc - tm->half_open_connections;
194 * Cleans up connection state.
199 tcp_connection_cleanup (tcp_connection_t * tc)
201 tcp_main_t *tm = &tcp_main;
203 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
205 /* Cleanup local endpoint if this was an active connect */
206 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
209 /* Check if connection is not yet fully established */
210 if (tc->state == TCP_STATE_SYN_SENT)
212 /* Try to remove the half-open connection. If this is not the owning
213 * thread, tc won't be removed. Retransmit or establish timers will
214 * eventually expire and call again cleanup on the right thread. */
215 if (tcp_half_open_connection_cleanup (tc))
216 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
220 int thread_index = tc->c_thread_index;
222 /* Make sure all timers are cleared */
223 tcp_connection_timers_reset (tc);
225 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
226 tcp_add_del_adjacency (tc, 0);
228 vec_free (tc->snd_sacks);
229 vec_free (tc->snd_sacks_fl);
231 /* Poison the entry */
233 clib_memset (tc, 0xFA, sizeof (*tc));
234 pool_put (tm->connections[thread_index], tc);
239 * Connection removal.
241 * This should be called only once connection enters CLOSED state. Note
242 * that it notifies the session of the removal event, so if the goal is to
243 * just remove the connection, call tcp_connection_cleanup instead.
246 tcp_connection_del (tcp_connection_t * tc)
248 session_transport_delete_notify (&tc->connection);
249 tcp_connection_cleanup (tc);
253 tcp_connection_alloc (u8 thread_index)
255 tcp_main_t *tm = vnet_get_tcp_main ();
256 tcp_connection_t *tc;
258 pool_get (tm->connections[thread_index], tc);
259 clib_memset (tc, 0, sizeof (*tc));
260 tc->c_c_index = tc - tm->connections[thread_index];
261 tc->c_thread_index = thread_index;
266 tcp_connection_free (tcp_connection_t * tc)
268 tcp_main_t *tm = &tcp_main;
271 u8 thread_index = tc->c_thread_index;
272 clib_memset (tc, 0xFA, sizeof (*tc));
273 pool_put (tm->connections[thread_index], tc);
276 pool_put (tm->connections[tc->c_thread_index], tc);
279 /** Notify session that connection has been reset.
281 * Switch state to closed and wait for session to call cleanup.
284 tcp_connection_reset (tcp_connection_t * tc)
286 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
289 case TCP_STATE_SYN_RCVD:
290 /* Cleanup everything. App wasn't notified yet */
291 session_transport_delete_notify (&tc->connection);
292 tcp_connection_cleanup (tc);
294 case TCP_STATE_SYN_SENT:
295 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
296 tcp_connection_cleanup (tc);
298 case TCP_STATE_ESTABLISHED:
299 tcp_connection_timers_reset (tc);
300 /* Set the cleanup timer, in case the session layer/app don't
301 * cleanly close the connection */
302 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
303 session_transport_reset_notify (&tc->connection);
304 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
306 case TCP_STATE_CLOSE_WAIT:
307 case TCP_STATE_FIN_WAIT_1:
308 case TCP_STATE_FIN_WAIT_2:
309 case TCP_STATE_CLOSING:
310 case TCP_STATE_LAST_ACK:
311 tcp_connection_timers_reset (tc);
312 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
313 /* Make sure we mark the session as closed. In some states we may
314 * be still trying to send data */
315 session_transport_closed_notify (&tc->connection);
316 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
318 case TCP_STATE_CLOSED:
319 case TCP_STATE_TIME_WAIT:
322 TCP_DBG ("reset state: %u", tc->state);
327 * Begin connection closing procedure.
329 * If at the end the connection is not in CLOSED state, it is not removed.
330 * Instead, we rely on on TCP to advance through state machine to either
331 * 1) LAST_ACK (passive close) whereby when the last ACK is received
332 * tcp_connection_del is called. This notifies session of the delete and
334 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
335 * and cleanup is called.
337 * N.B. Half-close connections are not supported
340 tcp_connection_close (tcp_connection_t * tc)
342 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
344 /* Send/Program FIN if needed and switch state */
347 case TCP_STATE_SYN_SENT:
348 /* Try to cleanup. If not on the right thread, mark as half-open done.
349 * Connection will be cleaned up when establish timer pops */
350 tcp_connection_cleanup (tc);
352 case TCP_STATE_SYN_RCVD:
353 tcp_connection_timers_reset (tc);
355 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
356 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
358 case TCP_STATE_ESTABLISHED:
359 /* If closing with unread data, reset the connection */
360 if (transport_max_rx_dequeue (&tc->connection))
363 tcp_connection_timers_reset (tc);
364 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
365 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
368 if (!transport_max_tx_dequeue (&tc->connection))
371 tc->flags |= TCP_CONN_FINPNDG;
372 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
373 /* Set a timer in case the peer stops responding. Otherwise the
374 * connection will be stuck here forever. */
375 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
376 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
378 case TCP_STATE_CLOSE_WAIT:
379 if (!transport_max_tx_dequeue (&tc->connection))
382 tcp_connection_timers_reset (tc);
383 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
384 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
387 tc->flags |= TCP_CONN_FINPNDG;
389 case TCP_STATE_FIN_WAIT_1:
390 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
392 case TCP_STATE_CLOSED:
393 tcp_connection_timers_reset (tc);
394 /* Delete connection but instead of doing it now wait until next
395 * dispatch cycle to give the session layer a chance to clear
396 * unhandled events */
397 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
400 TCP_DBG ("state: %u", tc->state);
405 tcp_session_close (u32 conn_index, u32 thread_index)
407 tcp_connection_t *tc;
408 tc = tcp_connection_get (conn_index, thread_index);
409 tcp_connection_close (tc);
413 tcp_session_cleanup (u32 conn_index, u32 thread_index)
415 tcp_connection_t *tc;
416 tc = tcp_connection_get (conn_index, thread_index);
417 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
418 tcp_connection_cleanup (tc);
422 * Initialize all connection timers as invalid
425 tcp_connection_timers_init (tcp_connection_t * tc)
429 /* Set all to invalid */
430 for (i = 0; i < TCP_N_TIMERS; i++)
432 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
435 tc->rto = TCP_RTO_INIT;
439 * Stop all connection timers
442 tcp_connection_timers_reset (tcp_connection_t * tc)
445 for (i = 0; i < TCP_N_TIMERS; i++)
447 tcp_timer_reset (tc, i);
452 typedef struct ip4_tcp_hdr
458 typedef struct ip6_tcp_hdr
465 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
468 const dpo_id_t *choice;
472 lb = load_balance_get (dpo->dpoi_index);
476 clib_memset (&hdr, 0, sizeof (hdr));
477 hdr.ip.protocol = IP_PROTOCOL_TCP;
478 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
479 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
480 hdr.tcp.src_port = tc->c_lcl_port;
481 hdr.tcp.dst_port = tc->c_rmt_port;
482 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
487 clib_memset (&hdr, 0, sizeof (hdr));
488 hdr.ip.protocol = IP_PROTOCOL_TCP;
489 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
490 sizeof (ip6_address_t));
491 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
492 sizeof (ip6_address_t));
493 hdr.tcp.src_port = tc->c_lcl_port;
494 hdr.tcp.dst_port = tc->c_rmt_port;
495 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
497 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
498 dpo_copy (result, choice);
502 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
507 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
508 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
509 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
510 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
511 return fib_table_lookup (fib_index, &prefix);
515 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
517 dpo_id_t choice = DPO_INVALID;
518 u32 output_node_index;
521 fe = fib_entry_get (tc->c_rmt_fei);
522 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
525 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
528 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
529 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
533 /** Stack tcp connection on peer's fib entry.
535 * This ultimately populates the dpo the connection will use to send packets.
538 tcp_connection_fib_attach (tcp_connection_t * tc)
540 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
542 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
544 tcp_connection_stack_on_fib_entry (tc);
549 tcp_cc_init (tcp_connection_t * tc)
551 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
552 tc->cc_algo->init (tc);
556 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
557 const tcp_cc_algorithm_t * vft)
559 tcp_main_t *tm = vnet_get_tcp_main ();
560 vec_validate (tm->cc_algos, type);
562 tm->cc_algos[type] = *vft;
563 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
567 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
569 tcp_main_t *tm = vnet_get_tcp_main ();
570 return &tm->cc_algos[type];
574 * Generate random iss as per rfc6528
577 tcp_generate_random_iss (tcp_connection_t * tc)
579 tcp_main_t *tm = &tcp_main;
583 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
585 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
586 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
588 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
589 tmp ^= tm->iss_seed.second;
590 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
591 return ((tmp >> 32) ^ (tmp & 0xffffffff));
595 * Initialize connection send variables.
598 tcp_init_snd_vars (tcp_connection_t * tc)
601 * We use the time to randomize iss and for setting up the initial
602 * timestamp. Make sure it's updated otherwise syn and ack in the
603 * handshake may make it look as if time has flown in the opposite
606 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
608 tc->iss = tcp_generate_random_iss (tc);
609 tc->snd_una = tc->iss;
610 tc->snd_nxt = tc->iss + 1;
611 tc->snd_una_max = tc->snd_nxt;
616 tcp_enable_pacing (tcp_connection_t * tc)
618 u32 initial_bucket, byte_rate;
619 initial_bucket = 16 * tc->snd_mss;
621 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
623 tc->mrtt_us = (u32) ~ 0;
626 /** Initialize tcp connection variables
628 * Should be called after having received a msg from the peer, i.e., a SYN or
629 * a SYNACK, such that connection options have already been exchanged. */
631 tcp_connection_init_vars (tcp_connection_t * tc)
633 tcp_connection_timers_init (tc);
635 scoreboard_init (&tc->sack_sb);
637 if (tc->state == TCP_STATE_SYN_RCVD)
638 tcp_init_snd_vars (tc);
640 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
641 tcp_add_del_adjacency (tc, 1);
643 /* tcp_connection_fib_attach (tc); */
645 if (transport_connection_is_tx_paced (&tc->connection)
646 || tcp_main.tx_pacing)
647 tcp_enable_pacing (tc);
651 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
652 u16 * lcl_port, u8 is_ip4)
657 index = tm->last_v4_address_rotor++;
658 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
659 tm->last_v4_address_rotor = 0;
660 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
664 index = tm->last_v6_address_rotor++;
665 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
666 tm->last_v6_address_rotor = 0;
667 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
668 sizeof (ip6_address_t));
670 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
673 clib_warning ("Failed to allocate src port");
681 tcp_session_open (transport_endpoint_cfg_t * rmt)
683 tcp_main_t *tm = vnet_get_tcp_main ();
684 tcp_connection_t *tc;
685 ip46_address_t lcl_addr;
690 * Allocate local endpoint
692 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
693 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
694 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
697 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
698 rmt, &lcl_addr, &lcl_port);
704 * Create connection and send SYN
706 clib_spinlock_lock_if_init (&tm->half_open_lock);
707 tc = tcp_half_open_connection_new ();
708 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
709 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
710 tc->c_rmt_port = rmt->port;
711 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
712 tc->c_is_ip4 = rmt->is_ip4;
713 tc->c_proto = TRANSPORT_PROTO_TCP;
714 tc->c_fib_index = rmt->fib_index;
715 /* The other connection vars will be initialized after SYN ACK */
716 tcp_connection_timers_init (tc);
718 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
719 tc->state = TCP_STATE_SYN_SENT;
720 tcp_init_snd_vars (tc);
722 clib_spinlock_unlock_if_init (&tm->half_open_lock);
724 return tc->c_c_index;
727 const char *tcp_dbg_evt_str[] = {
728 #define _(sym, str) str,
733 const char *tcp_fsm_states[] = {
734 #define _(sym, str) str,
735 foreach_tcp_fsm_state
740 format_tcp_state (u8 * s, va_list * args)
742 u32 state = va_arg (*args, u32);
744 if (state < TCP_N_STATES)
745 s = format (s, "%s", tcp_fsm_states[state]);
747 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
751 const char *tcp_connection_flags_str[] = {
752 #define _(sym, str) str,
753 foreach_tcp_connection_flag
758 format_tcp_connection_flags (u8 * s, va_list * args)
760 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
763 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
764 if (tc->flags & (1 << i))
766 for (i = 0; i < last; i++)
768 if (tc->flags & (1 << i))
769 s = format (s, "%s, ", tcp_connection_flags_str[i]);
772 s = format (s, "%s", tcp_connection_flags_str[last]);
776 const char *tcp_conn_timers[] = {
777 #define _(sym, str) str,
783 format_tcp_timers (u8 * s, va_list * args)
785 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
788 for (i = 0; i < TCP_N_TIMERS; i++)
789 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
792 for (i = 0; i < last; i++)
794 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
795 s = format (s, "%s,", tcp_conn_timers[i]);
799 s = format (s, "%s", tcp_conn_timers[i]);
805 format_tcp_congestion_status (u8 * s, va_list * args)
807 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
808 if (tcp_in_recovery (tc))
809 s = format (s, "recovery");
810 else if (tcp_in_fastrecovery (tc))
811 s = format (s, "fastrecovery");
813 s = format (s, "none");
818 tcp_rcv_wnd_available (tcp_connection_t * tc)
820 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
824 format_tcp_congestion (u8 * s, va_list * args)
826 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
827 u32 indent = format_get_indent (s);
829 s = format (s, "%U ", format_tcp_congestion_status, tc);
830 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
831 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
832 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
833 format_white_space, indent, tcp_available_cc_snd_space (tc),
834 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
835 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
836 format_white_space, indent, tc->snd_congestion - tc->iss,
837 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
842 format_tcp_vars (u8 * s, va_list * args)
844 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
845 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
846 format_tcp_connection_flags, tc, format_tcp_timers, tc);
847 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
848 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
849 tc->snd_una_max - tc->iss);
850 s = format (s, " rcv_nxt %u rcv_las %u\n",
851 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
852 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
853 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
854 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
855 tc->snd_wl2 - tc->iss);
856 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
857 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
858 tcp_rcv_wnd_available (tc));
859 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
860 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
861 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
862 tcp_time_now () - tc->tsval_recent_age);
863 s = format (s, " snd_mss %u\n", tc->snd_mss);
864 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
865 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
867 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
868 s = format (s, " cong: %U", format_tcp_congestion, tc);
870 if (tc->state >= TCP_STATE_ESTABLISHED)
872 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
875 if (vec_len (tc->snd_sacks))
876 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
882 format_tcp_connection_id (u8 * s, va_list * args)
884 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
889 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
890 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
891 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
892 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
896 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
897 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
898 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
899 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
906 format_tcp_connection (u8 * s, va_list * args)
908 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
909 u32 verbose = va_arg (*args, u32);
913 s = format (s, "%-50U", format_tcp_connection_id, tc);
916 s = format (s, "%-15U", format_tcp_state, tc->state);
918 s = format (s, "\n%U", format_tcp_vars, tc);
925 format_tcp_session (u8 * s, va_list * args)
927 u32 tci = va_arg (*args, u32);
928 u32 thread_index = va_arg (*args, u32);
929 u32 verbose = va_arg (*args, u32);
930 tcp_connection_t *tc;
932 tc = tcp_connection_get (tci, thread_index);
934 s = format (s, "%U", format_tcp_connection, tc, verbose);
936 s = format (s, "empty\n");
941 format_tcp_listener_session (u8 * s, va_list * args)
943 u32 tci = va_arg (*args, u32);
944 u32 verbose = va_arg (*args, u32);
945 tcp_connection_t *tc = tcp_listener_get (tci);
946 s = format (s, "%-50U", format_tcp_connection_id, tc);
948 s = format (s, "%-15U", format_tcp_state, tc->state);
953 format_tcp_half_open_session (u8 * s, va_list * args)
955 u32 tci = va_arg (*args, u32);
956 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
957 return format (s, "%U", format_tcp_connection_id, tc);
961 format_tcp_sacks (u8 * s, va_list * args)
963 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
964 sack_block_t *sacks = tc->snd_sacks;
968 len = vec_len (sacks);
969 for (i = 0; i < len - 1; i++)
972 s = format (s, " start %u end %u\n", block->start - tc->irs,
973 block->end - tc->irs);
977 block = &sacks[len - 1];
978 s = format (s, " start %u end %u", block->start - tc->irs,
979 block->end - tc->irs);
985 format_tcp_rcv_sacks (u8 * s, va_list * args)
987 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
988 sack_block_t *sacks = tc->rcv_opts.sacks;
992 len = vec_len (sacks);
993 for (i = 0; i < len - 1; i++)
996 s = format (s, " start %u end %u\n", block->start - tc->iss,
997 block->end - tc->iss);
1001 block = &sacks[len - 1];
1002 s = format (s, " start %u end %u", block->start - tc->iss,
1003 block->end - tc->iss);
1009 format_tcp_sack_hole (u8 * s, va_list * args)
1011 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1012 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1014 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1016 s = format (s, " [%u, %u]", hole->start, hole->end);
1021 format_tcp_scoreboard (u8 * s, va_list * args)
1023 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1024 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1025 sack_scoreboard_hole_t *hole;
1026 u32 indent = format_get_indent (s);
1028 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1029 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1030 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1031 format_white_space, indent, sb->last_bytes_delivered,
1032 sb->high_sacked - tc->iss, sb->snd_una_adv);
1033 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1034 format_white_space, indent, sb->cur_rxt_hole,
1035 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1037 hole = scoreboard_first_hole (sb);
1039 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1040 indent, sb->head, sb->tail, pool_elts (sb->holes),
1041 format_white_space, indent);
1045 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1046 hole = scoreboard_next_hole (sb, hole);
1052 static transport_connection_t *
1053 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1055 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1056 return &tc->connection;
1059 static transport_connection_t *
1060 tcp_half_open_session_get_transport (u32 conn_index)
1062 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1063 return &tc->connection;
1067 * Compute maximum segment size for session layer.
1069 * Since the result needs to be the actual data length, it first computes
1070 * the tcp options to be used in the next burst and subtracts their
1071 * length from the connection's snd_mss.
1074 tcp_session_send_mss (transport_connection_t * trans_conn)
1076 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1078 /* Ensure snd_mss does accurately reflect the amount of data we can push
1079 * in a segment. This also makes sure that options are updated according to
1080 * the current state of the connection. */
1081 tcp_update_burst_snd_vars (tc);
1087 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1089 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1091 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1094 /* If not snd_wnd constrained and we can't write at least a segment,
1095 * don't try at all */
1096 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1097 return snd_space < tc->cwnd ? 0 : snd_space;
1099 /* round down to mss multiple */
1100 return snd_space - (snd_space % tc->snd_mss);
1104 * Compute tx window session is allowed to fill.
1106 * Takes into account available send space, snd_mss and the congestion
1107 * state of the connection. If possible, the value returned is a multiple
1110 * @param tc tcp connection
1111 * @return number of bytes session is allowed to write
1114 tcp_snd_space_inline (tcp_connection_t * tc)
1116 int snd_space, snt_limited;
1118 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1119 || tc->state == TCP_STATE_CLOSED))
1122 snd_space = tcp_available_output_snd_space (tc);
1124 /* If we haven't gotten dupacks or if we did and have gotten sacked
1125 * bytes then we can still send as per Limited Transmit (RFC3042) */
1126 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1127 && (tcp_opts_sack_permitted (tc)
1128 && tc->sack_sb.last_sacked_bytes == 0)))
1130 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1131 tc->limited_transmit = tc->snd_nxt;
1132 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1134 snt_limited = tc->snd_nxt - tc->limited_transmit;
1135 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1137 return tcp_round_snd_space (tc, snd_space);
1141 tcp_snd_space (tcp_connection_t * tc)
1143 return tcp_snd_space_inline (tc);
1147 tcp_session_send_space (transport_connection_t * trans_conn)
1149 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1150 return clib_min (tcp_snd_space_inline (tc),
1151 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1155 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1157 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1159 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1161 /* This still works if fast retransmit is on */
1162 return (tc->snd_nxt - tc->snd_una);
1166 tcp_update_time (f64 now, u8 thread_index)
1168 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1170 tcp_set_time_now (wrk);
1171 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1172 tcp_do_fastretransmits (wrk);
1173 tcp_send_acks (wrk);
1174 tcp_flush_frames_to_output (wrk);
1178 tcp_session_flush_data (transport_connection_t * tconn)
1180 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1181 if (tc->flags & TCP_CONN_PSH_PENDING)
1183 tc->flags |= TCP_CONN_PSH_PENDING;
1184 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1188 const static transport_proto_vft_t tcp_proto = {
1189 .enable = vnet_tcp_enable_disable,
1190 .start_listen = tcp_session_bind,
1191 .stop_listen = tcp_session_unbind,
1192 .push_header = tcp_session_push_header,
1193 .get_connection = tcp_session_get_transport,
1194 .get_listener = tcp_session_get_listener,
1195 .get_half_open = tcp_half_open_session_get_transport,
1196 .connect = tcp_session_open,
1197 .close = tcp_session_close,
1198 .cleanup = tcp_session_cleanup,
1199 .send_mss = tcp_session_send_mss,
1200 .send_space = tcp_session_send_space,
1201 .update_time = tcp_update_time,
1202 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1203 .flush_data = tcp_session_flush_data,
1204 .format_connection = format_tcp_session,
1205 .format_listener = format_tcp_listener_session,
1206 .format_half_open = format_tcp_half_open_session,
1207 .tx_type = TRANSPORT_TX_PEEK,
1208 .service_type = TRANSPORT_SERVICE_VC,
1213 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1218 if (!transport_connection_is_tx_paced (&tc->connection))
1221 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1222 /* TODO should constrain to interface's max throughput but
1223 * we don't have link speeds for sw ifs ..*/
1224 rate = tc->cwnd / srtt;
1225 transport_connection_tx_pacer_update (&tc->connection, rate);
1229 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1232 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1233 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1234 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1235 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1236 start_bucket, last_time);
1240 tcp_timer_keep_handler (u32 conn_index)
1242 u32 thread_index = vlib_get_thread_index ();
1243 tcp_connection_t *tc;
1245 tc = tcp_connection_get (conn_index, thread_index);
1246 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1248 tcp_connection_close (tc);
1252 tcp_timer_establish_handler (u32 conn_index)
1254 tcp_connection_t *tc;
1256 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1257 /* note: the connection may have already disappeared */
1258 if (PREDICT_FALSE (tc == 0))
1260 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1261 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1262 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1263 tcp_connection_timers_reset (tc);
1264 /* Start cleanup. Do NOT delete the session until we do the connection
1265 * cleanup. Otherwise, we end up with a dangling session index in the
1266 * tcp connection. */
1267 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1271 tcp_timer_establish_ao_handler (u32 conn_index)
1273 tcp_connection_t *tc;
1275 tc = tcp_half_open_connection_get (conn_index);
1279 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1280 /* Notify app if we haven't tried to clean this up already */
1281 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1282 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1284 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1285 tcp_connection_cleanup (tc);
1289 tcp_timer_waitclose_handler (u32 conn_index)
1291 u32 thread_index = vlib_get_thread_index ();
1292 tcp_connection_t *tc;
1294 tc = tcp_connection_get (conn_index, thread_index);
1297 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1301 case TCP_STATE_CLOSE_WAIT:
1302 tcp_connection_timers_reset (tc);
1303 session_transport_closed_notify (&tc->connection);
1305 if (!(tc->flags & TCP_CONN_FINPNDG))
1307 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1308 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1312 /* Session didn't come back with a close. Send FIN either way
1313 * and switch to LAST_ACK. */
1314 tcp_cong_recovery_off (tc);
1315 /* Make sure we don't try to send unsent data */
1316 tc->snd_nxt = tc->snd_una;
1318 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1320 /* Make sure we don't wait in LAST ACK forever */
1321 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1323 /* Don't delete the connection yet */
1325 case TCP_STATE_FIN_WAIT_1:
1326 tcp_connection_timers_reset (tc);
1327 if (tc->flags & TCP_CONN_FINPNDG)
1329 /* If FIN pending, we haven't sent everything, but we did try.
1330 * Notify session layer that transport is closed. */
1331 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1332 session_transport_closed_notify (&tc->connection);
1333 tcp_send_reset (tc);
1334 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1338 /* We've sent the fin but no progress. Close the connection and
1339 * to make sure everything is flushed, setup a cleanup timer */
1340 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1341 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1344 case TCP_STATE_LAST_ACK:
1345 case TCP_STATE_CLOSING:
1346 tcp_connection_timers_reset (tc);
1347 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1348 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1349 session_transport_closed_notify (&tc->connection);
1352 tcp_connection_del (tc);
1358 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1360 tcp_timer_retransmit_handler,
1361 tcp_timer_delack_handler,
1362 tcp_timer_persist_handler,
1363 tcp_timer_keep_handler,
1364 tcp_timer_waitclose_handler,
1365 tcp_timer_retransmit_syn_handler,
1366 tcp_timer_establish_handler,
1367 tcp_timer_establish_ao_handler,
1372 tcp_expired_timers_dispatch (u32 * expired_timers)
1375 u32 connection_index, timer_id;
1377 for (i = 0; i < vec_len (expired_timers); i++)
1379 /* Get session index and timer id */
1380 connection_index = expired_timers[i] & 0x0FFFFFFF;
1381 timer_id = expired_timers[i] >> 28;
1383 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1385 /* Handle expiration */
1386 (*timer_expiration_handlers[timer_id]) (connection_index);
1391 tcp_initialize_timer_wheels (tcp_main_t * tm)
1393 tw_timer_wheel_16t_2w_512sl_t *tw;
1395 foreach_vlib_main (({
1396 tw = &tm->wrk_ctx[ii].timer_wheel;
1397 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1398 100e-3 /* timer period 100ms */ , ~0);
1399 tw->last_run_time = vlib_time_now (this_vlib_main);
1405 tcp_initialize_iss_seed (tcp_main_t * tm)
1407 u32 default_seed = random_default_seed ();
1408 u64 time_now = clib_cpu_time_now ();
1410 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1411 tm->iss_seed.second = random_u64 (&time_now);
1414 static clib_error_t *
1415 tcp_main_enable (vlib_main_t * vm)
1417 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1418 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1419 tcp_connection_t *tc __attribute__ ((unused));
1420 tcp_main_t *tm = vnet_get_tcp_main ();
1421 clib_error_t *error = 0;
1424 if ((error = vlib_call_init_function (vm, ip_main_init)))
1426 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1428 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1435 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1436 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1439 * Initialize data structures
1442 num_threads = 1 /* main thread */ + vtm->n_threads;
1443 vec_validate (tm->connections, num_threads - 1);
1444 vec_validate (tm->wrk_ctx, num_threads - 1);
1445 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1446 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1448 for (thread = 0; thread < num_threads; thread++)
1450 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1451 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1452 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1453 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1454 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1455 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1456 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1457 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1458 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1459 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1460 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1461 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1462 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1465 * Preallocate connections. Assume that thread 0 won't
1466 * use preallocated threads when running multi-core
1468 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1469 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1473 * Use a preallocated half-open connection pool?
1475 if (tm->preallocated_half_open_connections)
1476 pool_init_fixed (tm->half_open_connections,
1477 tm->preallocated_half_open_connections);
1479 /* Initialize clocks per tick for TCP timestamp. Used to compute
1480 * monotonically increasing timestamps. */
1481 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1482 / TCP_TSTAMP_RESOLUTION;
1484 if (num_threads > 1)
1486 clib_spinlock_init (&tm->half_open_lock);
1489 tcp_initialize_timer_wheels (tm);
1490 tcp_initialize_iss_seed (tm);
1492 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1498 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1502 if (tcp_main.is_enabled)
1505 return tcp_main_enable (vm);
1509 tcp_main.is_enabled = 0;
1516 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1518 tcp_main_t *tm = &tcp_main;
1520 tm->punt_unknown4 = is_add;
1522 tm->punt_unknown6 = is_add;
1525 static clib_error_t *
1526 tcp_init (vlib_main_t * vm)
1528 tcp_main_t *tm = vnet_get_tcp_main ();
1529 ip_main_t *im = &ip_main;
1530 ip_protocol_info_t *pi;
1532 /* Session layer, and by implication tcp, are disabled by default */
1535 /* Register with IP for header parsing */
1536 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1538 return clib_error_return (0, "TCP protocol info AWOL");
1539 pi->format_header = format_tcp_header;
1540 pi->unformat_pg_edit = unformat_pg_tcp_header;
1542 /* Register as transport with session layer */
1543 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1544 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1545 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1546 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1548 tcp_api_reference ();
1549 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1551 tm->cc_algo = TCP_CC_NEWRENO;
1552 tm->default_mtu = 1460;
1556 VLIB_INIT_FUNCTION (tcp_init);
1559 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1561 uword *result = va_arg (*va, uword *);
1562 tcp_main_t *tm = &tcp_main;
1567 if (unformat (input, "%s", &cc_algo_name)
1568 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1574 vec_free (cc_algo_name);
1579 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1581 tcp_main_t *tm = vnet_get_tcp_main ();
1582 tcp_cc_algorithm_t *cc_alg;
1583 unformat_input_t sub_input;
1586 vec_foreach (cc_alg, tm->cc_algos)
1588 if (!unformat (input, cc_alg->name))
1591 if (cc_alg->unformat_cfg
1592 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1594 if (cc_alg->unformat_cfg (&sub_input))
1601 static clib_error_t *
1602 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1604 tcp_main_t *tm = vnet_get_tcp_main ();
1606 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1608 if (unformat (input, "preallocated-connections %d",
1609 &tm->preallocated_connections))
1611 else if (unformat (input, "preallocated-half-open-connections %d",
1612 &tm->preallocated_half_open_connections))
1614 else if (unformat (input, "buffer-fail-fraction %f",
1615 &tm->buffer_fail_fraction))
1617 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1620 else if (unformat (input, "mtu %d", &tm->default_mtu))
1622 else if (unformat (input, "no-tx-pacing"))
1624 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1627 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1630 return clib_error_return (0, "unknown input `%U'",
1631 format_unformat_error, input);
1636 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1640 * \brief Configure an ipv4 source address range
1641 * @param vm vlib_main_t pointer
1642 * @param start first ipv4 address in the source address range
1643 * @param end last ipv4 address in the source address range
1644 * @param table_id VRF / table ID, 0 for the default FIB
1645 * @return 0 if all OK, else an error indication from api_errno.h
1649 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1650 ip4_address_t * start,
1651 ip4_address_t * end, u32 table_id)
1653 tcp_main_t *tm = vnet_get_tcp_main ();
1654 vnet_main_t *vnm = vnet_get_main ();
1655 u32 start_host_byte_order, end_host_byte_order;
1656 fib_prefix_t prefix;
1657 vnet_sw_interface_t *si;
1658 fib_node_index_t fei;
1662 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1663 ip4_address_t * hi_addr, u32 fib_index,
1666 clib_memset (&prefix, 0, sizeof (prefix));
1668 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1670 if (fib_index == ~0)
1671 return VNET_API_ERROR_NO_SUCH_FIB;
1673 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1674 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1676 /* sanity check for reversed args or some such */
1677 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1678 return VNET_API_ERROR_INVALID_ARGUMENT;
1680 /* Lookup the last address, to identify the interface involved */
1682 prefix.fp_proto = FIB_PROTOCOL_IP4;
1683 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1685 fei = fib_table_lookup (fib_index, &prefix);
1687 /* Couldn't find route to destination. Bail out. */
1688 if (fei == FIB_NODE_INDEX_INVALID)
1689 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1691 sw_if_index = fib_entry_get_resolving_interface (fei);
1693 /* Enable proxy arp on the interface */
1694 si = vnet_get_sw_interface (vnm, sw_if_index);
1695 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1697 /* Configure proxy arp across the range */
1698 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1705 dpo_id_t dpo = DPO_INVALID;
1707 vec_add1 (tm->ip4_src_addresses, start[0]);
1709 /* Add local adjacencies for the range */
1711 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1714 prefix.fp_proto = FIB_PROTOCOL_IP4;
1715 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1717 fib_table_entry_special_dpo_update (fib_index,
1720 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1723 start_host_byte_order++;
1724 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1726 while (start_host_byte_order <= end_host_byte_order);
1732 * \brief Configure an ipv6 source address range
1733 * @param vm vlib_main_t pointer
1734 * @param start first ipv6 address in the source address range
1735 * @param end last ipv6 address in the source address range
1736 * @param table_id VRF / table ID, 0 for the default FIB
1737 * @return 0 if all OK, else an error indication from api_errno.h
1741 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1742 ip6_address_t * start,
1743 ip6_address_t * end, u32 table_id)
1745 tcp_main_t *tm = vnet_get_tcp_main ();
1746 fib_prefix_t prefix;
1748 fib_node_index_t fei;
1751 clib_memset (&prefix, 0, sizeof (prefix));
1753 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1755 if (fib_index == ~0)
1756 return VNET_API_ERROR_NO_SUCH_FIB;
1762 dpo_id_t dpo = DPO_INVALID;
1764 /* Remember this address */
1765 vec_add1 (tm->ip6_src_addresses, start[0]);
1767 /* Lookup the prefix, to identify the interface involved */
1768 prefix.fp_len = 128;
1769 prefix.fp_proto = FIB_PROTOCOL_IP6;
1770 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1772 fei = fib_table_lookup (fib_index, &prefix);
1774 /* Couldn't find route to destination. Bail out. */
1775 if (fei == FIB_NODE_INDEX_INVALID)
1776 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1778 sw_if_index = fib_entry_get_resolving_interface (fei);
1780 if (sw_if_index == (u32) ~ 0)
1781 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1783 /* Add a proxy neighbor discovery entry for this address */
1784 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1786 /* Add a receive adjacency for this address */
1787 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1790 fib_table_entry_special_dpo_update (fib_index,
1793 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1796 /* Done with the entire range? */
1797 if (!memcmp (start, end, sizeof (start[0])))
1800 /* Increment the address. DGMS. */
1802 for (i = 15; i >= 0; i--)
1805 if (tmp.as_u8[i] != 0)
1813 static clib_error_t *
1814 tcp_src_address (vlib_main_t * vm,
1815 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1817 ip4_address_t v4start, v4end;
1818 ip6_address_t v6start, v6end;
1824 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1826 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1827 unformat_ip4_address, &v4end))
1829 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1831 memcpy (&v4end, &v4start, sizeof (v4start));
1834 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1835 unformat_ip6_address, &v6end))
1837 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1839 memcpy (&v6end, &v6start, sizeof (v6start));
1842 else if (unformat (input, "fib-table %d", &table_id))
1848 if (!v4set && !v6set)
1849 return clib_error_return (0, "at least one v4 or v6 address required");
1853 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1860 case VNET_API_ERROR_NO_SUCH_FIB:
1861 return clib_error_return (0, "Invalid table-id %d", table_id);
1863 case VNET_API_ERROR_INVALID_ARGUMENT:
1864 return clib_error_return (0, "Invalid address range %U - %U",
1865 format_ip4_address, &v4start,
1866 format_ip4_address, &v4end);
1868 return clib_error_return (0, "error %d", rv);
1874 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1881 case VNET_API_ERROR_NO_SUCH_FIB:
1882 return clib_error_return (0, "Invalid table-id %d", table_id);
1885 return clib_error_return (0, "error %d", rv);
1893 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1895 .path = "tcp src-address",
1896 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1897 .function = tcp_src_address,
1902 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1904 #if TCP_SCOREBOARD_TRACE
1906 scoreboard_trace_elt_t *block;
1912 s = format (s, "scoreboard trace:");
1913 vec_foreach (block, sb->trace)
1915 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1916 block->ack, block->snd_una_max, block->group);
1918 s = format (s, "\n");
1926 static clib_error_t *
1927 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1928 vlib_cli_command_t * cmd_arg)
1930 transport_connection_t *tconn = 0;
1931 tcp_connection_t *tc;
1933 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1935 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1936 TRANSPORT_PROTO_TCP))
1939 return clib_error_return (0, "unknown input `%U'",
1940 format_unformat_error, input);
1943 if (!TCP_SCOREBOARD_TRACE)
1945 vlib_cli_output (vm, "scoreboard tracing not enabled");
1949 tc = tcp_get_connection_from_transport (tconn);
1950 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1951 vlib_cli_output (vm, "%v", s);
1956 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1958 .path = "show tcp scoreboard trace",
1959 .short_help = "show tcp scoreboard trace <connection>",
1960 .function = tcp_show_scoreboard_trace_fn,
1965 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1968 scoreboard_trace_elt_t *trace;
1969 u32 next_ack, left, group, has_new_ack = 0;
1970 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1971 sack_block_t *block;
1973 if (!TCP_SCOREBOARD_TRACE)
1975 s = format (s, "scoreboard tracing not enabled");
1982 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1983 tcp_connection_timers_init (dummy_tc);
1984 scoreboard_init (&dummy_tc->sack_sb);
1985 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1987 #if TCP_SCOREBOARD_TRACE
1988 trace = tc->sack_sb.trace;
1989 trace_len = vec_len (tc->sack_sb.trace);
1992 for (i = 0; i < trace_len; i++)
1994 if (trace[i].ack != 0)
1996 dummy_tc->snd_una = trace[i].ack - 1448;
1997 dummy_tc->snd_una_max = trace[i].ack;
2002 while (left < trace_len)
2004 group = trace[left].group;
2005 vec_reset_length (dummy_tc->rcv_opts.sacks);
2007 while (trace[left].group == group)
2009 if (trace[left].ack != 0)
2012 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2013 trace[left].ack, trace[left].snd_una_max);
2014 dummy_tc->snd_una_max = trace[left].snd_una_max;
2015 next_ack = trace[left].ack;
2021 s = format (s, "[%u, %u], ", trace[left].start,
2023 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2024 block->start = trace[left].start;
2025 block->end = trace[left].end;
2031 tcp_rcv_sacks (dummy_tc, next_ack);
2033 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2036 s = format (s, "result: %U", format_tcp_scoreboard,
2037 &dummy_tc->sack_sb);
2040 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2045 static clib_error_t *
2046 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2047 vlib_cli_command_t * cmd_arg)
2049 transport_connection_t *tconn = 0;
2050 tcp_connection_t *tc = 0;
2052 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2054 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2055 TRANSPORT_PROTO_TCP))
2058 return clib_error_return (0, "unknown input `%U'",
2059 format_unformat_error, input);
2062 if (!TCP_SCOREBOARD_TRACE)
2064 vlib_cli_output (vm, "scoreboard tracing not enabled");
2068 tc = tcp_get_connection_from_transport (tconn);
2071 vlib_cli_output (vm, "connection not found");
2074 str = tcp_scoreboard_replay (str, tc, 1);
2075 vlib_cli_output (vm, "%v", str);
2080 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2082 .path = "tcp replay scoreboard",
2083 .short_help = "tcp replay scoreboard <connection>",
2084 .function = tcp_scoreboard_trace_fn,
2088 static clib_error_t *
2089 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2090 vlib_cli_command_t * cmd_arg)
2092 tcp_main_t *tm = vnet_get_tcp_main ();
2093 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2094 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2096 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2097 tm->punt_unknown4 ? "enabled" : "disabled");
2098 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2099 tm->punt_unknown6 ? "enabled" : "disabled");
2103 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2105 .path = "show tcp punt",
2106 .short_help = "show tcp punt",
2107 .function = show_tcp_punt_fn,
2112 * fd.io coding-style-patch-verification: ON
2115 * eval: (c-set-style "gnu")