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>
28 #include <vnet/ethernet/arp.h>
34 fib_protocol_t nh_proto;
35 vnet_link_t link_type;
39 } tcp_add_del_adj_args_t;
42 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
47 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
52 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
54 if (ai != ADJ_INDEX_INVALID)
60 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
62 tcp_add_del_adj_args_t args = {
63 .nh_proto = FIB_PROTOCOL_IP6,
64 .link_type = VNET_LINK_IP6,
66 .sw_if_index = tc->sw_if_index,
69 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
74 tcp_cc_init (tcp_connection_t * tc)
76 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
77 tc->cc_algo->init (tc);
81 tcp_cc_cleanup (tcp_connection_t * tc)
83 if (tc->cc_algo->cleanup)
84 tc->cc_algo->cleanup (tc);
88 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
89 const tcp_cc_algorithm_t * vft)
91 tcp_main_t *tm = vnet_get_tcp_main ();
92 vec_validate (tm->cc_algos, type);
94 tm->cc_algos[type] = *vft;
95 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
99 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
101 tcp_main_t *tm = vnet_get_tcp_main ();
102 return &tm->cc_algos[type];
105 tcp_cc_algorithm_type_e
106 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
108 tcp_main_t *tm = vnet_get_tcp_main ();
109 tcp_cc_algo_register (++tm->cc_last_type, vft);
110 return tm->cc_last_type;
114 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
116 tcp_main_t *tm = &tcp_main;
117 tcp_connection_t *listener;
120 pool_get (tm->listener_pool, listener);
121 clib_memset (listener, 0, sizeof (*listener));
123 listener->c_c_index = listener - tm->listener_pool;
124 listener->c_lcl_port = lcl->port;
126 /* If we are provided a sw_if_index, bind using one of its ips */
127 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
129 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
131 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
133 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
134 listener->c_is_ip4 = lcl->is_ip4;
135 listener->c_proto = TRANSPORT_PROTO_TCP;
136 listener->c_s_index = session_index;
137 listener->c_fib_index = lcl->fib_index;
138 listener->state = TCP_STATE_LISTEN;
140 tcp_connection_timers_init (listener);
142 TCP_EVT_DBG (TCP_EVT_BIND, listener);
144 return listener->c_c_index;
148 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
150 return tcp_connection_bind (session_index, tep);
154 tcp_connection_unbind (u32 listener_index)
156 tcp_main_t *tm = vnet_get_tcp_main ();
157 tcp_connection_t *tc;
159 tc = pool_elt_at_index (tm->listener_pool, listener_index);
161 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
163 /* Poison the entry */
165 clib_memset (tc, 0xFA, sizeof (*tc));
167 pool_put_index (tm->listener_pool, listener_index);
171 tcp_session_unbind (u32 listener_index)
173 tcp_connection_unbind (listener_index);
177 static transport_connection_t *
178 tcp_session_get_listener (u32 listener_index)
180 tcp_main_t *tm = vnet_get_tcp_main ();
181 tcp_connection_t *tc;
182 tc = pool_elt_at_index (tm->listener_pool, listener_index);
183 return &tc->connection;
187 * Cleanup half-open connection
191 tcp_half_open_connection_del (tcp_connection_t * tc)
193 tcp_main_t *tm = vnet_get_tcp_main ();
194 clib_spinlock_lock_if_init (&tm->half_open_lock);
195 pool_put_index (tm->half_open_connections, tc->c_c_index);
197 clib_memset (tc, 0xFA, sizeof (*tc));
198 clib_spinlock_unlock_if_init (&tm->half_open_lock);
202 * Try to cleanup half-open connection
204 * If called from a thread that doesn't own tc, the call won't have any
207 * @param tc - connection to be cleaned up
208 * @return non-zero if cleanup failed.
211 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
213 /* Make sure this is the owning thread */
214 if (tc->c_thread_index != vlib_get_thread_index ())
216 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
217 tcp_half_open_connection_del (tc);
221 static tcp_connection_t *
222 tcp_half_open_connection_new (void)
224 tcp_main_t *tm = vnet_get_tcp_main ();
225 tcp_connection_t *tc = 0;
226 ASSERT (vlib_get_thread_index () == 0);
227 pool_get (tm->half_open_connections, tc);
228 clib_memset (tc, 0, sizeof (*tc));
229 tc->c_c_index = tc - tm->half_open_connections;
234 * Cleans up connection state.
239 tcp_connection_cleanup (tcp_connection_t * tc)
241 tcp_main_t *tm = &tcp_main;
243 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
245 /* Cleanup local endpoint if this was an active connect */
246 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
249 /* Check if connection is not yet fully established */
250 if (tc->state == TCP_STATE_SYN_SENT)
252 /* Try to remove the half-open connection. If this is not the owning
253 * thread, tc won't be removed. Retransmit or establish timers will
254 * eventually expire and call again cleanup on the right thread. */
255 if (tcp_half_open_connection_cleanup (tc))
256 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
260 int thread_index = tc->c_thread_index;
262 /* Make sure all timers are cleared */
263 tcp_connection_timers_reset (tc);
265 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
266 tcp_add_del_adjacency (tc, 0);
269 vec_free (tc->snd_sacks);
270 vec_free (tc->snd_sacks_fl);
272 if (tc->flags & TCP_CONN_RATE_SAMPLE)
275 /* Poison the entry */
277 clib_memset (tc, 0xFA, sizeof (*tc));
278 pool_put (tm->connections[thread_index], tc);
283 * Connection removal.
285 * This should be called only once connection enters CLOSED state. Note
286 * that it notifies the session of the removal event, so if the goal is to
287 * just remove the connection, call tcp_connection_cleanup instead.
290 tcp_connection_del (tcp_connection_t * tc)
292 session_transport_delete_notify (&tc->connection);
293 tcp_connection_cleanup (tc);
297 tcp_connection_alloc (u8 thread_index)
299 tcp_main_t *tm = vnet_get_tcp_main ();
300 tcp_connection_t *tc;
302 pool_get (tm->connections[thread_index], tc);
303 clib_memset (tc, 0, sizeof (*tc));
304 tc->c_c_index = tc - tm->connections[thread_index];
305 tc->c_thread_index = thread_index;
310 tcp_connection_free (tcp_connection_t * tc)
312 tcp_main_t *tm = &tcp_main;
315 u8 thread_index = tc->c_thread_index;
316 clib_memset (tc, 0xFA, sizeof (*tc));
317 pool_put (tm->connections[thread_index], tc);
320 pool_put (tm->connections[tc->c_thread_index], tc);
323 /** Notify session that connection has been reset.
325 * Switch state to closed and wait for session to call cleanup.
328 tcp_connection_reset (tcp_connection_t * tc)
330 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
333 case TCP_STATE_SYN_RCVD:
334 /* Cleanup everything. App wasn't notified yet */
335 session_transport_delete_notify (&tc->connection);
336 tcp_connection_cleanup (tc);
338 case TCP_STATE_SYN_SENT:
339 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
340 tcp_connection_cleanup (tc);
342 case TCP_STATE_ESTABLISHED:
343 tcp_connection_timers_reset (tc);
344 /* Set the cleanup timer, in case the session layer/app don't
345 * cleanly close the connection */
346 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
347 session_transport_reset_notify (&tc->connection);
348 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
349 session_transport_closed_notify (&tc->connection);
351 case TCP_STATE_CLOSE_WAIT:
352 case TCP_STATE_FIN_WAIT_1:
353 case TCP_STATE_FIN_WAIT_2:
354 case TCP_STATE_CLOSING:
355 case TCP_STATE_LAST_ACK:
356 tcp_connection_timers_reset (tc);
357 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
358 /* Make sure we mark the session as closed. In some states we may
359 * be still trying to send data */
360 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
361 session_transport_closed_notify (&tc->connection);
363 case TCP_STATE_CLOSED:
364 case TCP_STATE_TIME_WAIT:
367 TCP_DBG ("reset state: %u", tc->state);
372 * Begin connection closing procedure.
374 * If at the end the connection is not in CLOSED state, it is not removed.
375 * Instead, we rely on on TCP to advance through state machine to either
376 * 1) LAST_ACK (passive close) whereby when the last ACK is received
377 * tcp_connection_del is called. This notifies session of the delete and
379 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
380 * and cleanup is called.
382 * N.B. Half-close connections are not supported
385 tcp_connection_close (tcp_connection_t * tc)
387 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
389 /* Send/Program FIN if needed and switch state */
392 case TCP_STATE_SYN_SENT:
393 /* Try to cleanup. If not on the right thread, mark as half-open done.
394 * Connection will be cleaned up when establish timer pops */
395 tcp_connection_cleanup (tc);
397 case TCP_STATE_SYN_RCVD:
398 tcp_connection_timers_reset (tc);
400 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
401 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
403 case TCP_STATE_ESTABLISHED:
404 /* If closing with unread data, reset the connection */
405 if (transport_max_rx_dequeue (&tc->connection))
408 tcp_connection_timers_reset (tc);
409 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
410 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
411 session_transport_closed_notify (&tc->connection);
414 if (!transport_max_tx_dequeue (&tc->connection))
417 tc->flags |= TCP_CONN_FINPNDG;
418 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
419 /* Set a timer in case the peer stops responding. Otherwise the
420 * connection will be stuck here forever. */
421 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
422 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
424 case TCP_STATE_CLOSE_WAIT:
425 if (!transport_max_tx_dequeue (&tc->connection))
428 tcp_connection_timers_reset (tc);
429 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
430 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
433 tc->flags |= TCP_CONN_FINPNDG;
435 case TCP_STATE_FIN_WAIT_1:
436 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
438 case TCP_STATE_CLOSED:
439 tcp_connection_timers_reset (tc);
440 /* Delete connection but instead of doing it now wait until next
441 * dispatch cycle to give the session layer a chance to clear
442 * unhandled events */
443 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
446 TCP_DBG ("state: %u", tc->state);
451 tcp_session_close (u32 conn_index, u32 thread_index)
453 tcp_connection_t *tc;
454 tc = tcp_connection_get (conn_index, thread_index);
455 tcp_connection_close (tc);
459 tcp_session_cleanup (u32 conn_index, u32 thread_index)
461 tcp_connection_t *tc;
462 tc = tcp_connection_get (conn_index, thread_index);
463 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
464 tcp_connection_cleanup (tc);
468 * Initialize all connection timers as invalid
471 tcp_connection_timers_init (tcp_connection_t * tc)
475 /* Set all to invalid */
476 for (i = 0; i < TCP_N_TIMERS; i++)
478 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
481 tc->rto = TCP_RTO_INIT;
485 * Stop all connection timers
488 tcp_connection_timers_reset (tcp_connection_t * tc)
491 for (i = 0; i < TCP_N_TIMERS; i++)
493 tcp_timer_reset (tc, i);
498 typedef struct ip4_tcp_hdr
504 typedef struct ip6_tcp_hdr
511 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
514 const dpo_id_t *choice;
518 lb = load_balance_get (dpo->dpoi_index);
522 clib_memset (&hdr, 0, sizeof (hdr));
523 hdr.ip.protocol = IP_PROTOCOL_TCP;
524 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
525 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
526 hdr.tcp.src_port = tc->c_lcl_port;
527 hdr.tcp.dst_port = tc->c_rmt_port;
528 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
533 clib_memset (&hdr, 0, sizeof (hdr));
534 hdr.ip.protocol = IP_PROTOCOL_TCP;
535 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
536 sizeof (ip6_address_t));
537 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
538 sizeof (ip6_address_t));
539 hdr.tcp.src_port = tc->c_lcl_port;
540 hdr.tcp.dst_port = tc->c_rmt_port;
541 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
543 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
544 dpo_copy (result, choice);
548 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
553 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
554 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
555 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
556 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
557 return fib_table_lookup (fib_index, &prefix);
561 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
563 dpo_id_t choice = DPO_INVALID;
564 u32 output_node_index;
567 fe = fib_entry_get (tc->c_rmt_fei);
568 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
571 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
574 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
575 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
579 /** Stack tcp connection on peer's fib entry.
581 * This ultimately populates the dpo the connection will use to send packets.
584 tcp_connection_fib_attach (tcp_connection_t * tc)
586 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
588 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
590 tcp_connection_stack_on_fib_entry (tc);
595 * Generate random iss as per rfc6528
598 tcp_generate_random_iss (tcp_connection_t * tc)
600 tcp_main_t *tm = &tcp_main;
604 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
606 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
607 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
609 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
610 tmp ^= tm->iss_seed.second;
611 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
612 return ((tmp >> 32) ^ (tmp & 0xffffffff));
616 * Initialize connection send variables.
619 tcp_init_snd_vars (tcp_connection_t * tc)
622 * We use the time to randomize iss and for setting up the initial
623 * timestamp. Make sure it's updated otherwise syn and ack in the
624 * handshake may make it look as if time has flown in the opposite
627 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
629 tc->iss = tcp_generate_random_iss (tc);
630 tc->snd_una = tc->iss;
631 tc->snd_nxt = tc->iss + 1;
632 tc->snd_una_max = tc->snd_nxt;
637 tcp_enable_pacing (tcp_connection_t * tc)
639 u32 initial_bucket, byte_rate;
640 initial_bucket = 16 * tc->snd_mss;
642 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
644 tc->mrtt_us = (u32) ~ 0;
647 /** Initialize tcp connection variables
649 * Should be called after having received a msg from the peer, i.e., a SYN or
650 * a SYNACK, such that connection options have already been exchanged. */
652 tcp_connection_init_vars (tcp_connection_t * tc)
654 tcp_connection_timers_init (tc);
656 scoreboard_init (&tc->sack_sb);
658 if (tc->state == TCP_STATE_SYN_RCVD)
659 tcp_init_snd_vars (tc);
661 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
662 tcp_add_del_adjacency (tc, 1);
664 /* tcp_connection_fib_attach (tc); */
666 if (transport_connection_is_tx_paced (&tc->connection)
667 || tcp_cfg.enable_tx_pacing)
668 tcp_enable_pacing (tc);
670 if (tc->flags & TCP_CONN_RATE_SAMPLE)
673 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
677 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
678 u16 * lcl_port, u8 is_ip4)
683 index = tm->last_v4_addr_rotor++;
684 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
685 tm->last_v4_addr_rotor = 0;
686 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
690 index = tm->last_v6_addr_rotor++;
691 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
692 tm->last_v6_addr_rotor = 0;
693 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
694 sizeof (ip6_address_t));
696 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
699 clib_warning ("Failed to allocate src port");
707 tcp_session_open (transport_endpoint_cfg_t * rmt)
709 tcp_main_t *tm = vnet_get_tcp_main ();
710 tcp_connection_t *tc;
711 ip46_address_t lcl_addr;
716 * Allocate local endpoint
718 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
719 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
720 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
723 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
724 rmt, &lcl_addr, &lcl_port);
730 * Create connection and send SYN
732 clib_spinlock_lock_if_init (&tm->half_open_lock);
733 tc = tcp_half_open_connection_new ();
734 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
735 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
736 tc->c_rmt_port = rmt->port;
737 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
738 tc->c_is_ip4 = rmt->is_ip4;
739 tc->c_proto = TRANSPORT_PROTO_TCP;
740 tc->c_fib_index = rmt->fib_index;
741 /* The other connection vars will be initialized after SYN ACK */
742 tcp_connection_timers_init (tc);
744 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
745 tc->state = TCP_STATE_SYN_SENT;
746 tcp_init_snd_vars (tc);
748 clib_spinlock_unlock_if_init (&tm->half_open_lock);
750 return tc->c_c_index;
753 const char *tcp_dbg_evt_str[] = {
754 #define _(sym, str) str,
759 const char *tcp_fsm_states[] = {
760 #define _(sym, str) str,
761 foreach_tcp_fsm_state
766 format_tcp_state (u8 * s, va_list * args)
768 u32 state = va_arg (*args, u32);
770 if (state < TCP_N_STATES)
771 s = format (s, "%s", tcp_fsm_states[state]);
773 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
777 const char *tcp_connection_flags_str[] = {
778 #define _(sym, str) str,
779 foreach_tcp_connection_flag
784 format_tcp_connection_flags (u8 * s, va_list * args)
786 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
789 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
790 if (tc->flags & (1 << i))
792 for (i = 0; i < last; i++)
794 if (tc->flags & (1 << i))
795 s = format (s, "%s, ", tcp_connection_flags_str[i]);
798 s = format (s, "%s", tcp_connection_flags_str[last]);
802 const char *tcp_conn_timers[] = {
803 #define _(sym, str) str,
809 format_tcp_timers (u8 * s, va_list * args)
811 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
814 for (i = 0; i < TCP_N_TIMERS; i++)
815 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
818 for (i = 0; i < last; i++)
820 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
821 s = format (s, "%s,", tcp_conn_timers[i]);
825 s = format (s, "%s", tcp_conn_timers[i]);
831 format_tcp_congestion_status (u8 * s, va_list * args)
833 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
834 if (tcp_in_recovery (tc))
835 s = format (s, "recovery");
836 else if (tcp_in_fastrecovery (tc))
837 s = format (s, "fastrecovery");
839 s = format (s, "none");
844 tcp_rcv_wnd_available (tcp_connection_t * tc)
846 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
850 format_tcp_congestion (u8 * s, va_list * args)
852 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
853 u32 indent = format_get_indent (s);
855 s = format (s, "%U ", format_tcp_congestion_status, tc);
856 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
857 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
858 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
859 format_white_space, indent, tcp_available_cc_snd_space (tc),
860 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
861 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
862 format_white_space, indent, tc->snd_congestion - tc->iss,
863 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
868 format_tcp_stats (u8 * s, va_list * args)
870 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
871 u32 indent = format_get_indent (s);
872 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
873 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
874 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
875 format_white_space, indent, tc->segs_out,
876 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
877 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
878 format_white_space, indent, tc->fr_occurences,
879 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
880 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
881 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
882 format_white_space, indent, tc->errors.below_data_wnd,
883 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
884 tc->errors.above_ack_wnd);
889 format_tcp_vars (u8 * s, va_list * args)
891 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
892 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
893 format_tcp_connection_flags, tc, format_tcp_timers, tc);
894 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
895 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
896 tc->snd_una_max - tc->iss);
897 s = format (s, " rcv_nxt %u rcv_las %u\n",
898 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
899 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
900 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
901 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
902 tc->snd_wl2 - tc->iss);
903 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
904 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
905 tcp_rcv_wnd_available (tc));
906 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
907 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
908 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
909 tcp_time_now () - tc->tsval_recent_age);
910 s = format (s, " snd_mss %u\n", tc->snd_mss);
911 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
912 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
914 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
915 s = format (s, " cong: %U", format_tcp_congestion, tc);
917 if (tc->state >= TCP_STATE_ESTABLISHED)
919 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
921 s = format (s, " stats: %U\n", format_tcp_stats, tc);
923 if (vec_len (tc->snd_sacks))
924 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
930 format_tcp_connection_id (u8 * s, va_list * args)
932 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
937 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
938 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
939 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
940 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
944 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
945 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
946 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
947 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
954 format_tcp_connection (u8 * s, va_list * args)
956 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
957 u32 verbose = va_arg (*args, u32);
961 s = format (s, "%-50U", format_tcp_connection_id, tc);
964 s = format (s, "%-15U", format_tcp_state, tc->state);
966 s = format (s, "\n%U", format_tcp_vars, tc);
973 format_tcp_session (u8 * s, va_list * args)
975 u32 tci = va_arg (*args, u32);
976 u32 thread_index = va_arg (*args, u32);
977 u32 verbose = va_arg (*args, u32);
978 tcp_connection_t *tc;
980 tc = tcp_connection_get (tci, thread_index);
982 s = format (s, "%U", format_tcp_connection, tc, verbose);
984 s = format (s, "empty\n");
989 format_tcp_listener_session (u8 * s, va_list * args)
991 u32 tci = va_arg (*args, u32);
992 u32 __clib_unused thread_index = va_arg (*args, u32);
993 u32 verbose = va_arg (*args, u32);
994 tcp_connection_t *tc = tcp_listener_get (tci);
995 s = format (s, "%-50U", format_tcp_connection_id, tc);
997 s = format (s, "%-15U", format_tcp_state, tc->state);
1002 format_tcp_half_open_session (u8 * s, va_list * args)
1004 u32 tci = va_arg (*args, u32);
1005 u32 __clib_unused thread_index = va_arg (*args, u32);
1006 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1007 return format (s, "%U", format_tcp_connection_id, tc);
1011 format_tcp_sacks (u8 * s, va_list * args)
1013 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1014 sack_block_t *sacks = tc->snd_sacks;
1015 sack_block_t *block;
1018 len = vec_len (sacks);
1019 for (i = 0; i < len - 1; i++)
1022 s = format (s, " start %u end %u\n", block->start - tc->irs,
1023 block->end - tc->irs);
1027 block = &sacks[len - 1];
1028 s = format (s, " start %u end %u", block->start - tc->irs,
1029 block->end - tc->irs);
1035 format_tcp_rcv_sacks (u8 * s, va_list * args)
1037 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1038 sack_block_t *sacks = tc->rcv_opts.sacks;
1039 sack_block_t *block;
1042 len = vec_len (sacks);
1043 for (i = 0; i < len - 1; i++)
1046 s = format (s, " start %u end %u\n", block->start - tc->iss,
1047 block->end - tc->iss);
1051 block = &sacks[len - 1];
1052 s = format (s, " start %u end %u", block->start - tc->iss,
1053 block->end - tc->iss);
1059 format_tcp_sack_hole (u8 * s, va_list * args)
1061 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1062 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1064 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1066 s = format (s, " [%u, %u]", hole->start, hole->end);
1071 format_tcp_scoreboard (u8 * s, va_list * args)
1073 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1074 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1075 sack_scoreboard_hole_t *hole;
1076 u32 indent = format_get_indent (s);
1078 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1079 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1080 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1081 format_white_space, indent, sb->last_bytes_delivered,
1082 sb->high_sacked - tc->iss, sb->snd_una_adv);
1083 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1084 format_white_space, indent, sb->cur_rxt_hole,
1085 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1087 hole = scoreboard_first_hole (sb);
1089 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1090 indent, sb->head, sb->tail, pool_elts (sb->holes),
1091 format_white_space, indent);
1095 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1096 hole = scoreboard_next_hole (sb, hole);
1102 static transport_connection_t *
1103 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1105 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1106 return &tc->connection;
1109 static transport_connection_t *
1110 tcp_half_open_session_get_transport (u32 conn_index)
1112 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1113 return &tc->connection;
1117 * Compute maximum segment size for session layer.
1119 * Since the result needs to be the actual data length, it first computes
1120 * the tcp options to be used in the next burst and subtracts their
1121 * length from the connection's snd_mss.
1124 tcp_session_send_mss (transport_connection_t * trans_conn)
1126 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1128 /* Ensure snd_mss does accurately reflect the amount of data we can push
1129 * in a segment. This also makes sure that options are updated according to
1130 * the current state of the connection. */
1131 tcp_update_burst_snd_vars (tc);
1137 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1139 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1141 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1144 /* If not snd_wnd constrained and we can't write at least a segment,
1145 * don't try at all */
1146 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1147 return snd_space < tc->cwnd ? 0 : snd_space;
1149 /* round down to mss multiple */
1150 return snd_space - (snd_space % tc->snd_mss);
1154 * Compute tx window session is allowed to fill.
1156 * Takes into account available send space, snd_mss and the congestion
1157 * state of the connection. If possible, the value returned is a multiple
1160 * @param tc tcp connection
1161 * @return number of bytes session is allowed to write
1164 tcp_snd_space_inline (tcp_connection_t * tc)
1166 int snd_space, snt_limited;
1168 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1169 || tc->state == TCP_STATE_CLOSED))
1172 snd_space = tcp_available_output_snd_space (tc);
1174 /* If we haven't gotten dupacks or if we did and have gotten sacked
1175 * bytes then we can still send as per Limited Transmit (RFC3042) */
1176 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1177 && (tcp_opts_sack_permitted (tc)
1178 && tc->sack_sb.last_sacked_bytes == 0)))
1180 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1181 tc->limited_transmit = tc->snd_nxt;
1182 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1184 snt_limited = tc->snd_nxt - tc->limited_transmit;
1185 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1187 return tcp_round_snd_space (tc, snd_space);
1191 tcp_snd_space (tcp_connection_t * tc)
1193 return tcp_snd_space_inline (tc);
1197 tcp_session_send_space (transport_connection_t * trans_conn)
1199 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1200 return clib_min (tcp_snd_space_inline (tc),
1201 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1205 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1207 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1209 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1211 /* This still works if fast retransmit is on */
1212 return (tc->snd_nxt - tc->snd_una);
1216 tcp_update_time (f64 now, u8 thread_index)
1218 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1220 tcp_set_time_now (wrk);
1221 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1222 tcp_flush_frames_to_output (wrk);
1226 tcp_session_flush_data (transport_connection_t * tconn)
1228 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1229 if (tc->flags & TCP_CONN_PSH_PENDING)
1231 tc->flags |= TCP_CONN_PSH_PENDING;
1232 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1236 const static transport_proto_vft_t tcp_proto = {
1237 .enable = vnet_tcp_enable_disable,
1238 .start_listen = tcp_session_bind,
1239 .stop_listen = tcp_session_unbind,
1240 .push_header = tcp_session_push_header,
1241 .get_connection = tcp_session_get_transport,
1242 .get_listener = tcp_session_get_listener,
1243 .get_half_open = tcp_half_open_session_get_transport,
1244 .connect = tcp_session_open,
1245 .close = tcp_session_close,
1246 .cleanup = tcp_session_cleanup,
1247 .send_mss = tcp_session_send_mss,
1248 .send_space = tcp_session_send_space,
1249 .update_time = tcp_update_time,
1250 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1251 .flush_data = tcp_session_flush_data,
1252 .custom_tx = tcp_session_custom_tx,
1253 .format_connection = format_tcp_session,
1254 .format_listener = format_tcp_listener_session,
1255 .format_half_open = format_tcp_half_open_session,
1256 .transport_options = {
1257 .tx_type = TRANSPORT_TX_PEEK,
1258 .service_type = TRANSPORT_SERVICE_VC,
1264 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1266 if (!transport_connection_is_tx_paced (&tc->connection))
1269 transport_connection_tx_pacer_update (&tc->connection,
1270 tcp_cc_get_pacing_rate (tc));
1274 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1277 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1278 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1279 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1280 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1281 start_bucket, last_time);
1285 tcp_timer_waitclose_handler (u32 conn_index)
1287 u32 thread_index = vlib_get_thread_index ();
1288 tcp_connection_t *tc;
1290 tc = tcp_connection_get (conn_index, thread_index);
1294 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1298 case TCP_STATE_CLOSE_WAIT:
1299 tcp_connection_timers_reset (tc);
1300 session_transport_closed_notify (&tc->connection);
1302 if (!(tc->flags & TCP_CONN_FINPNDG))
1304 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1305 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1309 /* Session didn't come back with a close. Send FIN either way
1310 * and switch to LAST_ACK. */
1311 tcp_cong_recovery_off (tc);
1312 /* Make sure we don't try to send unsent data */
1313 tc->snd_nxt = tc->snd_una;
1315 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1317 /* Make sure we don't wait in LAST ACK forever */
1318 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1320 /* Don't delete the connection yet */
1322 case TCP_STATE_FIN_WAIT_1:
1323 tcp_connection_timers_reset (tc);
1324 session_transport_closed_notify (&tc->connection);
1325 if (tc->flags & TCP_CONN_FINPNDG)
1327 /* If FIN pending, we haven't sent everything, but we did try.
1328 * Notify session layer that transport is closed. */
1329 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1330 tcp_send_reset (tc);
1331 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1335 /* We've sent the fin but no progress. Close the connection and
1336 * to make sure everything is flushed, setup a cleanup timer */
1337 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1338 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1341 case TCP_STATE_LAST_ACK:
1342 case TCP_STATE_CLOSING:
1343 tcp_connection_timers_reset (tc);
1344 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1345 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1346 session_transport_closed_notify (&tc->connection);
1349 tcp_connection_del (tc);
1355 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1357 tcp_timer_retransmit_handler,
1358 tcp_timer_delack_handler,
1359 tcp_timer_persist_handler,
1360 tcp_timer_waitclose_handler,
1361 tcp_timer_retransmit_syn_handler,
1366 tcp_expired_timers_dispatch (u32 * expired_timers)
1369 u32 connection_index, timer_id;
1371 for (i = 0; i < vec_len (expired_timers); i++)
1373 /* Get session index and timer id */
1374 connection_index = expired_timers[i] & 0x0FFFFFFF;
1375 timer_id = expired_timers[i] >> 28;
1377 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1379 /* Handle expiration */
1380 (*timer_expiration_handlers[timer_id]) (connection_index);
1385 tcp_initialize_timer_wheels (tcp_main_t * tm)
1387 tw_timer_wheel_16t_2w_512sl_t *tw;
1389 foreach_vlib_main (({
1390 tw = &tm->wrk_ctx[ii].timer_wheel;
1391 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1392 TCP_TIMER_TICK, ~0);
1393 tw->last_run_time = vlib_time_now (this_vlib_main);
1399 tcp_initialize_iss_seed (tcp_main_t * tm)
1401 u32 default_seed = random_default_seed ();
1402 u64 time_now = clib_cpu_time_now ();
1404 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1405 tm->iss_seed.second = random_u64 (&time_now);
1408 static clib_error_t *
1409 tcp_main_enable (vlib_main_t * vm)
1411 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1412 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1413 tcp_connection_t *tc __attribute__ ((unused));
1414 tcp_main_t *tm = vnet_get_tcp_main ();
1415 clib_error_t *error = 0;
1418 if ((error = vlib_call_init_function (vm, ip_main_init)))
1420 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1422 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1429 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1430 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1433 * Initialize data structures
1436 num_threads = 1 /* main thread */ + vtm->n_threads;
1437 vec_validate (tm->connections, num_threads - 1);
1438 vec_validate (tm->wrk_ctx, num_threads - 1);
1439 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1440 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1442 for (thread = 0; thread < num_threads; thread++)
1444 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1445 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1446 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1447 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1448 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1451 * Preallocate connections. Assume that thread 0 won't
1452 * use preallocated threads when running multi-core
1454 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1455 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1459 * Use a preallocated half-open connection pool?
1461 if (tcp_cfg.preallocated_half_open_connections)
1462 pool_init_fixed (tm->half_open_connections,
1463 tcp_cfg.preallocated_half_open_connections);
1465 /* Initialize clocks per tick for TCP timestamp. Used to compute
1466 * monotonically increasing timestamps. */
1467 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1468 / TCP_TSTAMP_RESOLUTION;
1470 if (num_threads > 1)
1472 clib_spinlock_init (&tm->half_open_lock);
1475 tcp_initialize_timer_wheels (tm);
1476 tcp_initialize_iss_seed (tm);
1478 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1479 tm->cc_last_type = TCP_CC_LAST;
1484 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1488 if (tcp_main.is_enabled)
1491 return tcp_main_enable (vm);
1495 tcp_main.is_enabled = 0;
1502 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1504 tcp_main_t *tm = &tcp_main;
1506 tm->punt_unknown4 = is_add;
1508 tm->punt_unknown6 = is_add;
1512 * Initialize default values for tcp parameters
1515 tcp_configuration_init (void)
1517 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1518 * predefined value. For SYN-ACK we still want the scale to be computed in
1520 tcp_cfg.max_rx_fifo = 32 << 20;
1521 tcp_cfg.min_rx_fifo = 4 << 10;
1523 tcp_cfg.default_mtu = 1460;
1524 tcp_cfg.initial_cwnd_multiplier = 0;
1525 tcp_cfg.enable_tx_pacing = 1;
1526 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1528 /* Time constants defined as timer tick (100ms) multiples */
1529 tcp_cfg.delack_time = 1; /* 0.1s */
1530 tcp_cfg.closewait_time = 20; /* 2s */
1531 tcp_cfg.timewait_time = 100; /* 10s */
1532 tcp_cfg.finwait1_time = 600; /* 60s */
1533 tcp_cfg.lastack_time = 300; /* 30s */
1534 tcp_cfg.finwait2_time = 300; /* 30s */
1535 tcp_cfg.closing_time = 300; /* 30s */
1536 tcp_cfg.cleanup_time = 1; /* 0.1s */
1539 static clib_error_t *
1540 tcp_init (vlib_main_t * vm)
1542 tcp_main_t *tm = vnet_get_tcp_main ();
1543 ip_main_t *im = &ip_main;
1544 ip_protocol_info_t *pi;
1546 /* Session layer, and by implication tcp, are disabled by default */
1549 /* Register with IP for header parsing */
1550 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1552 return clib_error_return (0, "TCP protocol info AWOL");
1553 pi->format_header = format_tcp_header;
1554 pi->unformat_pg_edit = unformat_pg_tcp_header;
1556 /* Register as transport with session layer */
1557 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1558 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1559 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1560 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1562 tcp_api_reference ();
1563 tcp_configuration_init ();
1565 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1570 VLIB_INIT_FUNCTION (tcp_init);
1573 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1575 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1576 tcp_main_t *tm = &tcp_main;
1581 if (unformat (input, "%s", &cc_algo_name)
1582 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1588 vec_free (cc_algo_name);
1593 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1595 tcp_main_t *tm = vnet_get_tcp_main ();
1596 tcp_cc_algorithm_t *cc_alg;
1597 unformat_input_t sub_input;
1600 vec_foreach (cc_alg, tm->cc_algos)
1602 if (!unformat (input, cc_alg->name))
1605 if (cc_alg->unformat_cfg
1606 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1608 if (cc_alg->unformat_cfg (&sub_input))
1615 static clib_error_t *
1616 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1618 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1620 if (unformat (input, "preallocated-connections %d",
1621 &tcp_cfg.preallocated_connections))
1623 else if (unformat (input, "preallocated-half-open-connections %d",
1624 &tcp_cfg.preallocated_half_open_connections))
1626 else if (unformat (input, "buffer-fail-fraction %f",
1627 &tcp_cfg.buffer_fail_fraction))
1629 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1630 &tcp_cfg.max_rx_fifo))
1632 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1633 &tcp_cfg.min_rx_fifo))
1635 else if (unformat (input, "mtu %d", &tcp_cfg.default_mtu))
1637 else if (unformat (input, "initial-cwnd-multiplier %d",
1638 &tcp_cfg.initial_cwnd_multiplier))
1640 else if (unformat (input, "no-tx-pacing"))
1641 tcp_cfg.enable_tx_pacing = 0;
1642 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1645 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1647 else if (unformat (input, "closewait-time %d", &tcp_cfg.closewait_time))
1648 tcp_cfg.closewait_time /= TCP_TIMER_TICK;
1649 else if (unformat (input, "timewait-time %d", &tcp_cfg.timewait_time))
1650 tcp_cfg.timewait_time /= TCP_TIMER_TICK;
1651 else if (unformat (input, "finwait1-time %d", &tcp_cfg.finwait1_time))
1652 tcp_cfg.finwait1_time /= TCP_TIMER_TICK;
1653 else if (unformat (input, "finwait2-time %d", &tcp_cfg.finwait2_time))
1654 tcp_cfg.finwait2_time /= TCP_TIMER_TICK;
1655 else if (unformat (input, "lastack-time %d", &tcp_cfg.lastack_time))
1656 tcp_cfg.lastack_time /= TCP_TIMER_TICK;
1657 else if (unformat (input, "closing-time %d", &tcp_cfg.closing_time))
1658 tcp_cfg.closing_time /= TCP_TIMER_TICK;
1659 else if (unformat (input, "cleanup-time %d", &tcp_cfg.cleanup_time))
1660 tcp_cfg.cleanup_time /= TCP_TIMER_TICK;
1662 return clib_error_return (0, "unknown input `%U'",
1663 format_unformat_error, input);
1668 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1672 * \brief Configure an ipv4 source address range
1673 * @param vm vlib_main_t pointer
1674 * @param start first ipv4 address in the source address range
1675 * @param end last ipv4 address in the source address range
1676 * @param table_id VRF / table ID, 0 for the default FIB
1677 * @return 0 if all OK, else an error indication from api_errno.h
1681 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1682 ip4_address_t * start,
1683 ip4_address_t * end, u32 table_id)
1685 vnet_main_t *vnm = vnet_get_main ();
1686 u32 start_host_byte_order, end_host_byte_order;
1687 fib_prefix_t prefix;
1688 fib_node_index_t fei;
1693 clib_memset (&prefix, 0, sizeof (prefix));
1695 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1697 if (fib_index == ~0)
1698 return VNET_API_ERROR_NO_SUCH_FIB;
1700 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1701 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1703 /* sanity check for reversed args or some such */
1704 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1705 return VNET_API_ERROR_INVALID_ARGUMENT;
1707 /* Lookup the last address, to identify the interface involved */
1709 prefix.fp_proto = FIB_PROTOCOL_IP4;
1710 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1712 fei = fib_table_lookup (fib_index, &prefix);
1714 /* Couldn't find route to destination. Bail out. */
1715 if (fei == FIB_NODE_INDEX_INVALID)
1716 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1718 sw_if_index = fib_entry_get_resolving_interface (fei);
1720 /* Configure proxy arp across the range */
1721 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1726 rv = vnet_proxy_arp_enable_disable (vnm, sw_if_index, 1);
1733 dpo_id_t dpo = DPO_INVALID;
1735 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1737 /* Add local adjacencies for the range */
1739 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1742 prefix.fp_proto = FIB_PROTOCOL_IP4;
1743 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1745 fib_table_entry_special_dpo_update (fib_index,
1748 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1751 start_host_byte_order++;
1752 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1754 while (start_host_byte_order <= end_host_byte_order);
1760 * \brief Configure an ipv6 source address range
1761 * @param vm vlib_main_t pointer
1762 * @param start first ipv6 address in the source address range
1763 * @param end last ipv6 address in the source address range
1764 * @param table_id VRF / table ID, 0 for the default FIB
1765 * @return 0 if all OK, else an error indication from api_errno.h
1769 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1770 ip6_address_t * start,
1771 ip6_address_t * end, u32 table_id)
1773 fib_prefix_t prefix;
1775 fib_node_index_t fei;
1778 clib_memset (&prefix, 0, sizeof (prefix));
1780 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1782 if (fib_index == ~0)
1783 return VNET_API_ERROR_NO_SUCH_FIB;
1789 dpo_id_t dpo = DPO_INVALID;
1791 /* Remember this address */
1792 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1794 /* Lookup the prefix, to identify the interface involved */
1795 prefix.fp_len = 128;
1796 prefix.fp_proto = FIB_PROTOCOL_IP6;
1797 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1799 fei = fib_table_lookup (fib_index, &prefix);
1801 /* Couldn't find route to destination. Bail out. */
1802 if (fei == FIB_NODE_INDEX_INVALID)
1803 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1805 sw_if_index = fib_entry_get_resolving_interface (fei);
1807 if (sw_if_index == (u32) ~ 0)
1808 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1810 /* Add a proxy neighbor discovery entry for this address */
1811 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1813 /* Add a receive adjacency for this address */
1814 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1817 fib_table_entry_special_dpo_update (fib_index,
1820 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1823 /* Done with the entire range? */
1824 if (!memcmp (start, end, sizeof (start[0])))
1827 /* Increment the address. DGMS. */
1829 for (i = 15; i >= 0; i--)
1832 if (tmp.as_u8[i] != 0)
1840 static clib_error_t *
1841 tcp_src_address (vlib_main_t * vm,
1842 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1844 ip4_address_t v4start, v4end;
1845 ip6_address_t v6start, v6end;
1851 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1853 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1854 unformat_ip4_address, &v4end))
1856 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1858 memcpy (&v4end, &v4start, sizeof (v4start));
1861 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1862 unformat_ip6_address, &v6end))
1864 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1866 memcpy (&v6end, &v6start, sizeof (v6start));
1869 else if (unformat (input, "fib-table %d", &table_id))
1875 if (!v4set && !v6set)
1876 return clib_error_return (0, "at least one v4 or v6 address required");
1880 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1887 case VNET_API_ERROR_NO_SUCH_FIB:
1888 return clib_error_return (0, "Invalid table-id %d", table_id);
1890 case VNET_API_ERROR_INVALID_ARGUMENT:
1891 return clib_error_return (0, "Invalid address range %U - %U",
1892 format_ip4_address, &v4start,
1893 format_ip4_address, &v4end);
1895 return clib_error_return (0, "error %d", rv);
1901 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1908 case VNET_API_ERROR_NO_SUCH_FIB:
1909 return clib_error_return (0, "Invalid table-id %d", table_id);
1912 return clib_error_return (0, "error %d", rv);
1920 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1922 .path = "tcp src-address",
1923 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1924 .function = tcp_src_address,
1929 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1931 #if TCP_SCOREBOARD_TRACE
1933 scoreboard_trace_elt_t *block;
1939 s = format (s, "scoreboard trace:");
1940 vec_foreach (block, sb->trace)
1942 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1943 block->ack, block->snd_una_max, block->group);
1945 s = format (s, "\n");
1953 static clib_error_t *
1954 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1955 vlib_cli_command_t * cmd_arg)
1957 transport_connection_t *tconn = 0;
1958 tcp_connection_t *tc;
1960 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1962 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1963 TRANSPORT_PROTO_TCP))
1966 return clib_error_return (0, "unknown input `%U'",
1967 format_unformat_error, input);
1970 if (!TCP_SCOREBOARD_TRACE)
1972 vlib_cli_output (vm, "scoreboard tracing not enabled");
1976 tc = tcp_get_connection_from_transport (tconn);
1977 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1978 vlib_cli_output (vm, "%v", s);
1983 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1985 .path = "show tcp scoreboard trace",
1986 .short_help = "show tcp scoreboard trace <connection>",
1987 .function = tcp_show_scoreboard_trace_fn,
1992 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1995 scoreboard_trace_elt_t *trace;
1996 u32 next_ack, left, group, has_new_ack = 0;
1997 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1998 sack_block_t *block;
2000 if (!TCP_SCOREBOARD_TRACE)
2002 s = format (s, "scoreboard tracing not enabled");
2009 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2010 tcp_connection_timers_init (dummy_tc);
2011 scoreboard_init (&dummy_tc->sack_sb);
2012 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2014 #if TCP_SCOREBOARD_TRACE
2015 trace = tc->sack_sb.trace;
2016 trace_len = vec_len (tc->sack_sb.trace);
2019 for (i = 0; i < trace_len; i++)
2021 if (trace[i].ack != 0)
2023 dummy_tc->snd_una = trace[i].ack - 1448;
2024 dummy_tc->snd_una_max = trace[i].ack;
2029 while (left < trace_len)
2031 group = trace[left].group;
2032 vec_reset_length (dummy_tc->rcv_opts.sacks);
2034 while (trace[left].group == group)
2036 if (trace[left].ack != 0)
2039 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2040 trace[left].ack, trace[left].snd_una_max);
2041 dummy_tc->snd_una_max = trace[left].snd_una_max;
2042 next_ack = trace[left].ack;
2048 s = format (s, "[%u, %u], ", trace[left].start,
2050 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2051 block->start = trace[left].start;
2052 block->end = trace[left].end;
2058 tcp_rcv_sacks (dummy_tc, next_ack);
2060 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2063 s = format (s, "result: %U", format_tcp_scoreboard,
2064 &dummy_tc->sack_sb);
2067 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2072 static clib_error_t *
2073 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2074 vlib_cli_command_t * cmd_arg)
2076 transport_connection_t *tconn = 0;
2077 tcp_connection_t *tc = 0;
2079 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2081 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2082 TRANSPORT_PROTO_TCP))
2085 return clib_error_return (0, "unknown input `%U'",
2086 format_unformat_error, input);
2089 if (!TCP_SCOREBOARD_TRACE)
2091 vlib_cli_output (vm, "scoreboard tracing not enabled");
2095 tc = tcp_get_connection_from_transport (tconn);
2098 vlib_cli_output (vm, "connection not found");
2101 str = tcp_scoreboard_replay (str, tc, 1);
2102 vlib_cli_output (vm, "%v", str);
2107 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2109 .path = "tcp replay scoreboard",
2110 .short_help = "tcp replay scoreboard <connection>",
2111 .function = tcp_scoreboard_trace_fn,
2115 static clib_error_t *
2116 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2117 vlib_cli_command_t * cmd_arg)
2119 tcp_main_t *tm = vnet_get_tcp_main ();
2120 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2121 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2123 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2124 tm->punt_unknown4 ? "enabled" : "disabled");
2125 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2126 tm->punt_unknown6 ? "enabled" : "disabled");
2130 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2132 .path = "show tcp punt",
2133 .short_help = "show tcp punt",
2134 .function = show_tcp_punt_fn,
2139 * fd.io coding-style-patch-verification: ON
2142 * eval: (c-set-style "gnu")