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_main.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_ESTABLISH_AO);
217 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
218 tcp_half_open_connection_del (tc);
222 static tcp_connection_t *
223 tcp_half_open_connection_new (void)
225 tcp_main_t *tm = vnet_get_tcp_main ();
226 tcp_connection_t *tc = 0;
227 ASSERT (vlib_get_thread_index () == 0);
228 pool_get (tm->half_open_connections, tc);
229 clib_memset (tc, 0, sizeof (*tc));
230 tc->c_c_index = tc - tm->half_open_connections;
235 * Cleans up connection state.
240 tcp_connection_cleanup (tcp_connection_t * tc)
242 tcp_main_t *tm = &tcp_main;
244 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
246 /* Cleanup local endpoint if this was an active connect */
247 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
250 /* Check if connection is not yet fully established */
251 if (tc->state == TCP_STATE_SYN_SENT)
253 /* Try to remove the half-open connection. If this is not the owning
254 * thread, tc won't be removed. Retransmit or establish timers will
255 * eventually expire and call again cleanup on the right thread. */
256 if (tcp_half_open_connection_cleanup (tc))
257 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
261 int thread_index = tc->c_thread_index;
263 /* Make sure all timers are cleared */
264 tcp_connection_timers_reset (tc);
266 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
267 tcp_add_del_adjacency (tc, 0);
270 vec_free (tc->snd_sacks);
271 vec_free (tc->snd_sacks_fl);
273 /* Poison the entry */
275 clib_memset (tc, 0xFA, sizeof (*tc));
276 pool_put (tm->connections[thread_index], tc);
281 * Connection removal.
283 * This should be called only once connection enters CLOSED state. Note
284 * that it notifies the session of the removal event, so if the goal is to
285 * just remove the connection, call tcp_connection_cleanup instead.
288 tcp_connection_del (tcp_connection_t * tc)
290 session_transport_delete_notify (&tc->connection);
291 tcp_connection_cleanup (tc);
295 tcp_connection_alloc (u8 thread_index)
297 tcp_main_t *tm = vnet_get_tcp_main ();
298 tcp_connection_t *tc;
300 pool_get (tm->connections[thread_index], tc);
301 clib_memset (tc, 0, sizeof (*tc));
302 tc->c_c_index = tc - tm->connections[thread_index];
303 tc->c_thread_index = thread_index;
308 tcp_connection_free (tcp_connection_t * tc)
310 tcp_main_t *tm = &tcp_main;
313 u8 thread_index = tc->c_thread_index;
314 clib_memset (tc, 0xFA, sizeof (*tc));
315 pool_put (tm->connections[thread_index], tc);
318 pool_put (tm->connections[tc->c_thread_index], tc);
321 /** Notify session that connection has been reset.
323 * Switch state to closed and wait for session to call cleanup.
326 tcp_connection_reset (tcp_connection_t * tc)
328 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
331 case TCP_STATE_SYN_RCVD:
332 /* Cleanup everything. App wasn't notified yet */
333 session_transport_delete_notify (&tc->connection);
334 tcp_connection_cleanup (tc);
336 case TCP_STATE_SYN_SENT:
337 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
338 tcp_connection_cleanup (tc);
340 case TCP_STATE_ESTABLISHED:
341 tcp_connection_timers_reset (tc);
342 /* Set the cleanup timer, in case the session layer/app don't
343 * cleanly close the connection */
344 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
345 session_transport_reset_notify (&tc->connection);
346 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
348 case TCP_STATE_CLOSE_WAIT:
349 case TCP_STATE_FIN_WAIT_1:
350 case TCP_STATE_FIN_WAIT_2:
351 case TCP_STATE_CLOSING:
352 case TCP_STATE_LAST_ACK:
353 tcp_connection_timers_reset (tc);
354 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
355 /* Make sure we mark the session as closed. In some states we may
356 * be still trying to send data */
357 session_transport_closed_notify (&tc->connection);
358 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
360 case TCP_STATE_CLOSED:
361 case TCP_STATE_TIME_WAIT:
364 TCP_DBG ("reset state: %u", tc->state);
369 * Begin connection closing procedure.
371 * If at the end the connection is not in CLOSED state, it is not removed.
372 * Instead, we rely on on TCP to advance through state machine to either
373 * 1) LAST_ACK (passive close) whereby when the last ACK is received
374 * tcp_connection_del is called. This notifies session of the delete and
376 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
377 * and cleanup is called.
379 * N.B. Half-close connections are not supported
382 tcp_connection_close (tcp_connection_t * tc)
384 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
386 /* Send/Program FIN if needed and switch state */
389 case TCP_STATE_SYN_SENT:
390 /* Try to cleanup. If not on the right thread, mark as half-open done.
391 * Connection will be cleaned up when establish timer pops */
392 tcp_connection_cleanup (tc);
394 case TCP_STATE_SYN_RCVD:
395 tcp_connection_timers_reset (tc);
397 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
398 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
400 case TCP_STATE_ESTABLISHED:
401 /* If closing with unread data, reset the connection */
402 if (transport_max_rx_dequeue (&tc->connection))
405 tcp_connection_timers_reset (tc);
406 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
407 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
410 if (!transport_max_tx_dequeue (&tc->connection))
413 tc->flags |= TCP_CONN_FINPNDG;
414 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
415 /* Set a timer in case the peer stops responding. Otherwise the
416 * connection will be stuck here forever. */
417 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
418 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
420 case TCP_STATE_CLOSE_WAIT:
421 if (!transport_max_tx_dequeue (&tc->connection))
424 tcp_connection_timers_reset (tc);
425 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
426 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
429 tc->flags |= TCP_CONN_FINPNDG;
431 case TCP_STATE_FIN_WAIT_1:
432 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
434 case TCP_STATE_CLOSED:
435 tcp_connection_timers_reset (tc);
436 /* Delete connection but instead of doing it now wait until next
437 * dispatch cycle to give the session layer a chance to clear
438 * unhandled events */
439 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
442 TCP_DBG ("state: %u", tc->state);
447 tcp_session_close (u32 conn_index, u32 thread_index)
449 tcp_connection_t *tc;
450 tc = tcp_connection_get (conn_index, thread_index);
451 tcp_connection_close (tc);
455 tcp_session_cleanup (u32 conn_index, u32 thread_index)
457 tcp_connection_t *tc;
458 tc = tcp_connection_get (conn_index, thread_index);
459 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
460 tcp_connection_cleanup (tc);
464 * Initialize all connection timers as invalid
467 tcp_connection_timers_init (tcp_connection_t * tc)
471 /* Set all to invalid */
472 for (i = 0; i < TCP_N_TIMERS; i++)
474 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
477 tc->rto = TCP_RTO_INIT;
481 * Stop all connection timers
484 tcp_connection_timers_reset (tcp_connection_t * tc)
487 for (i = 0; i < TCP_N_TIMERS; i++)
489 tcp_timer_reset (tc, i);
494 typedef struct ip4_tcp_hdr
500 typedef struct ip6_tcp_hdr
507 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
510 const dpo_id_t *choice;
514 lb = load_balance_get (dpo->dpoi_index);
518 clib_memset (&hdr, 0, sizeof (hdr));
519 hdr.ip.protocol = IP_PROTOCOL_TCP;
520 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
521 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
522 hdr.tcp.src_port = tc->c_lcl_port;
523 hdr.tcp.dst_port = tc->c_rmt_port;
524 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
529 clib_memset (&hdr, 0, sizeof (hdr));
530 hdr.ip.protocol = IP_PROTOCOL_TCP;
531 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
532 sizeof (ip6_address_t));
533 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
534 sizeof (ip6_address_t));
535 hdr.tcp.src_port = tc->c_lcl_port;
536 hdr.tcp.dst_port = tc->c_rmt_port;
537 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
539 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
540 dpo_copy (result, choice);
544 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
549 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
550 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
551 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
552 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
553 return fib_table_lookup (fib_index, &prefix);
557 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
559 dpo_id_t choice = DPO_INVALID;
560 u32 output_node_index;
563 fe = fib_entry_get (tc->c_rmt_fei);
564 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
567 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
570 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
571 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
575 /** Stack tcp connection on peer's fib entry.
577 * This ultimately populates the dpo the connection will use to send packets.
580 tcp_connection_fib_attach (tcp_connection_t * tc)
582 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
584 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
586 tcp_connection_stack_on_fib_entry (tc);
591 * Generate random iss as per rfc6528
594 tcp_generate_random_iss (tcp_connection_t * tc)
596 tcp_main_t *tm = &tcp_main;
600 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
602 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
603 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
605 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
606 tmp ^= tm->iss_seed.second;
607 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
608 return ((tmp >> 32) ^ (tmp & 0xffffffff));
612 * Initialize connection send variables.
615 tcp_init_snd_vars (tcp_connection_t * tc)
618 * We use the time to randomize iss and for setting up the initial
619 * timestamp. Make sure it's updated otherwise syn and ack in the
620 * handshake may make it look as if time has flown in the opposite
623 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
625 tc->iss = tcp_generate_random_iss (tc);
626 tc->snd_una = tc->iss;
627 tc->snd_nxt = tc->iss + 1;
628 tc->snd_una_max = tc->snd_nxt;
633 tcp_enable_pacing (tcp_connection_t * tc)
635 u32 initial_bucket, byte_rate;
636 initial_bucket = 16 * tc->snd_mss;
638 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
640 tc->mrtt_us = (u32) ~ 0;
643 /** Initialize tcp connection variables
645 * Should be called after having received a msg from the peer, i.e., a SYN or
646 * a SYNACK, such that connection options have already been exchanged. */
648 tcp_connection_init_vars (tcp_connection_t * tc)
650 tcp_connection_timers_init (tc);
652 scoreboard_init (&tc->sack_sb);
654 if (tc->state == TCP_STATE_SYN_RCVD)
655 tcp_init_snd_vars (tc);
657 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
658 tcp_add_del_adjacency (tc, 1);
660 /* tcp_connection_fib_attach (tc); */
662 if (transport_connection_is_tx_paced (&tc->connection)
663 || tcp_main.tx_pacing)
664 tcp_enable_pacing (tc);
668 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
669 u16 * lcl_port, u8 is_ip4)
674 index = tm->last_v4_address_rotor++;
675 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
676 tm->last_v4_address_rotor = 0;
677 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
681 index = tm->last_v6_address_rotor++;
682 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
683 tm->last_v6_address_rotor = 0;
684 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
685 sizeof (ip6_address_t));
687 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
690 clib_warning ("Failed to allocate src port");
698 tcp_session_open (transport_endpoint_cfg_t * rmt)
700 tcp_main_t *tm = vnet_get_tcp_main ();
701 tcp_connection_t *tc;
702 ip46_address_t lcl_addr;
707 * Allocate local endpoint
709 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
710 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
711 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
714 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
715 rmt, &lcl_addr, &lcl_port);
721 * Create connection and send SYN
723 clib_spinlock_lock_if_init (&tm->half_open_lock);
724 tc = tcp_half_open_connection_new ();
725 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
726 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
727 tc->c_rmt_port = rmt->port;
728 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
729 tc->c_is_ip4 = rmt->is_ip4;
730 tc->c_proto = TRANSPORT_PROTO_TCP;
731 tc->c_fib_index = rmt->fib_index;
732 /* The other connection vars will be initialized after SYN ACK */
733 tcp_connection_timers_init (tc);
735 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
736 tc->state = TCP_STATE_SYN_SENT;
737 tcp_init_snd_vars (tc);
739 clib_spinlock_unlock_if_init (&tm->half_open_lock);
741 return tc->c_c_index;
744 const char *tcp_dbg_evt_str[] = {
745 #define _(sym, str) str,
750 const char *tcp_fsm_states[] = {
751 #define _(sym, str) str,
752 foreach_tcp_fsm_state
757 format_tcp_state (u8 * s, va_list * args)
759 u32 state = va_arg (*args, u32);
761 if (state < TCP_N_STATES)
762 s = format (s, "%s", tcp_fsm_states[state]);
764 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
768 const char *tcp_connection_flags_str[] = {
769 #define _(sym, str) str,
770 foreach_tcp_connection_flag
775 format_tcp_connection_flags (u8 * s, va_list * args)
777 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
780 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
781 if (tc->flags & (1 << i))
783 for (i = 0; i < last; i++)
785 if (tc->flags & (1 << i))
786 s = format (s, "%s, ", tcp_connection_flags_str[i]);
789 s = format (s, "%s", tcp_connection_flags_str[last]);
793 const char *tcp_conn_timers[] = {
794 #define _(sym, str) str,
800 format_tcp_timers (u8 * s, va_list * args)
802 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
805 for (i = 0; i < TCP_N_TIMERS; i++)
806 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
809 for (i = 0; i < last; i++)
811 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
812 s = format (s, "%s,", tcp_conn_timers[i]);
816 s = format (s, "%s", tcp_conn_timers[i]);
822 format_tcp_congestion_status (u8 * s, va_list * args)
824 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
825 if (tcp_in_recovery (tc))
826 s = format (s, "recovery");
827 else if (tcp_in_fastrecovery (tc))
828 s = format (s, "fastrecovery");
830 s = format (s, "none");
835 tcp_rcv_wnd_available (tcp_connection_t * tc)
837 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
841 format_tcp_congestion (u8 * s, va_list * args)
843 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
844 u32 indent = format_get_indent (s);
846 s = format (s, "%U ", format_tcp_congestion_status, tc);
847 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
848 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
849 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
850 format_white_space, indent, tcp_available_cc_snd_space (tc),
851 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
852 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
853 format_white_space, indent, tc->snd_congestion - tc->iss,
854 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
859 format_tcp_vars (u8 * s, va_list * args)
861 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
862 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
863 format_tcp_connection_flags, tc, format_tcp_timers, tc);
864 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
865 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
866 tc->snd_una_max - tc->iss);
867 s = format (s, " rcv_nxt %u rcv_las %u\n",
868 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
869 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
870 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
871 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
872 tc->snd_wl2 - tc->iss);
873 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
874 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
875 tcp_rcv_wnd_available (tc));
876 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
877 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
878 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
879 tcp_time_now () - tc->tsval_recent_age);
880 s = format (s, " snd_mss %u\n", tc->snd_mss);
881 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
882 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
884 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
885 s = format (s, " cong: %U", format_tcp_congestion, tc);
887 if (tc->state >= TCP_STATE_ESTABLISHED)
889 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
892 if (vec_len (tc->snd_sacks))
893 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
899 format_tcp_connection_id (u8 * s, va_list * args)
901 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
906 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
907 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
908 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
909 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
913 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
914 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
915 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
916 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
923 format_tcp_connection (u8 * s, va_list * args)
925 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
926 u32 verbose = va_arg (*args, u32);
930 s = format (s, "%-50U", format_tcp_connection_id, tc);
933 s = format (s, "%-15U", format_tcp_state, tc->state);
935 s = format (s, "\n%U", format_tcp_vars, tc);
942 format_tcp_session (u8 * s, va_list * args)
944 u32 tci = va_arg (*args, u32);
945 u32 thread_index = va_arg (*args, u32);
946 u32 verbose = va_arg (*args, u32);
947 tcp_connection_t *tc;
949 tc = tcp_connection_get (tci, thread_index);
951 s = format (s, "%U", format_tcp_connection, tc, verbose);
953 s = format (s, "empty\n");
958 format_tcp_listener_session (u8 * s, va_list * args)
960 u32 tci = va_arg (*args, u32);
961 u32 verbose = va_arg (*args, u32);
962 tcp_connection_t *tc = tcp_listener_get (tci);
963 s = format (s, "%-50U", format_tcp_connection_id, tc);
965 s = format (s, "%-15U", format_tcp_state, tc->state);
970 format_tcp_half_open_session (u8 * s, va_list * args)
972 u32 tci = va_arg (*args, u32);
973 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
974 return format (s, "%U", format_tcp_connection_id, tc);
978 format_tcp_sacks (u8 * s, va_list * args)
980 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
981 sack_block_t *sacks = tc->snd_sacks;
985 len = vec_len (sacks);
986 for (i = 0; i < len - 1; i++)
989 s = format (s, " start %u end %u\n", block->start - tc->irs,
990 block->end - tc->irs);
994 block = &sacks[len - 1];
995 s = format (s, " start %u end %u", block->start - tc->irs,
996 block->end - tc->irs);
1002 format_tcp_rcv_sacks (u8 * s, va_list * args)
1004 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1005 sack_block_t *sacks = tc->rcv_opts.sacks;
1006 sack_block_t *block;
1009 len = vec_len (sacks);
1010 for (i = 0; i < len - 1; i++)
1013 s = format (s, " start %u end %u\n", block->start - tc->iss,
1014 block->end - tc->iss);
1018 block = &sacks[len - 1];
1019 s = format (s, " start %u end %u", block->start - tc->iss,
1020 block->end - tc->iss);
1026 format_tcp_sack_hole (u8 * s, va_list * args)
1028 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1029 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1031 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1033 s = format (s, " [%u, %u]", hole->start, hole->end);
1038 format_tcp_scoreboard (u8 * s, va_list * args)
1040 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1041 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1042 sack_scoreboard_hole_t *hole;
1043 u32 indent = format_get_indent (s);
1045 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1046 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1047 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1048 format_white_space, indent, sb->last_bytes_delivered,
1049 sb->high_sacked - tc->iss, sb->snd_una_adv);
1050 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1051 format_white_space, indent, sb->cur_rxt_hole,
1052 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1054 hole = scoreboard_first_hole (sb);
1056 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1057 indent, sb->head, sb->tail, pool_elts (sb->holes),
1058 format_white_space, indent);
1062 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1063 hole = scoreboard_next_hole (sb, hole);
1069 static transport_connection_t *
1070 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1072 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1073 return &tc->connection;
1076 static transport_connection_t *
1077 tcp_half_open_session_get_transport (u32 conn_index)
1079 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1080 return &tc->connection;
1084 * Compute maximum segment size for session layer.
1086 * Since the result needs to be the actual data length, it first computes
1087 * the tcp options to be used in the next burst and subtracts their
1088 * length from the connection's snd_mss.
1091 tcp_session_send_mss (transport_connection_t * trans_conn)
1093 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1095 /* Ensure snd_mss does accurately reflect the amount of data we can push
1096 * in a segment. This also makes sure that options are updated according to
1097 * the current state of the connection. */
1098 tcp_update_burst_snd_vars (tc);
1104 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1106 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1108 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1111 /* If not snd_wnd constrained and we can't write at least a segment,
1112 * don't try at all */
1113 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1114 return snd_space < tc->cwnd ? 0 : snd_space;
1116 /* round down to mss multiple */
1117 return snd_space - (snd_space % tc->snd_mss);
1121 * Compute tx window session is allowed to fill.
1123 * Takes into account available send space, snd_mss and the congestion
1124 * state of the connection. If possible, the value returned is a multiple
1127 * @param tc tcp connection
1128 * @return number of bytes session is allowed to write
1131 tcp_snd_space_inline (tcp_connection_t * tc)
1133 int snd_space, snt_limited;
1135 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1136 || tc->state == TCP_STATE_CLOSED))
1139 snd_space = tcp_available_output_snd_space (tc);
1141 /* If we haven't gotten dupacks or if we did and have gotten sacked
1142 * bytes then we can still send as per Limited Transmit (RFC3042) */
1143 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1144 && (tcp_opts_sack_permitted (tc)
1145 && tc->sack_sb.last_sacked_bytes == 0)))
1147 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1148 tc->limited_transmit = tc->snd_nxt;
1149 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1151 snt_limited = tc->snd_nxt - tc->limited_transmit;
1152 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1154 return tcp_round_snd_space (tc, snd_space);
1158 tcp_snd_space (tcp_connection_t * tc)
1160 return tcp_snd_space_inline (tc);
1164 tcp_session_send_space (transport_connection_t * trans_conn)
1166 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1167 return clib_min (tcp_snd_space_inline (tc),
1168 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1172 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1174 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1176 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1178 /* This still works if fast retransmit is on */
1179 return (tc->snd_nxt - tc->snd_una);
1183 tcp_update_time (f64 now, u8 thread_index)
1185 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1187 tcp_set_time_now (wrk);
1188 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1189 tcp_do_fastretransmits (wrk);
1190 tcp_send_acks (wrk);
1191 tcp_flush_frames_to_output (wrk);
1195 tcp_session_flush_data (transport_connection_t * tconn)
1197 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1198 if (tc->flags & TCP_CONN_PSH_PENDING)
1200 tc->flags |= TCP_CONN_PSH_PENDING;
1201 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1205 const static transport_proto_vft_t tcp_proto = {
1206 .enable = vnet_tcp_enable_disable,
1207 .start_listen = tcp_session_bind,
1208 .stop_listen = tcp_session_unbind,
1209 .push_header = tcp_session_push_header,
1210 .get_connection = tcp_session_get_transport,
1211 .get_listener = tcp_session_get_listener,
1212 .get_half_open = tcp_half_open_session_get_transport,
1213 .connect = tcp_session_open,
1214 .close = tcp_session_close,
1215 .cleanup = tcp_session_cleanup,
1216 .send_mss = tcp_session_send_mss,
1217 .send_space = tcp_session_send_space,
1218 .update_time = tcp_update_time,
1219 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1220 .flush_data = tcp_session_flush_data,
1221 .format_connection = format_tcp_session,
1222 .format_listener = format_tcp_listener_session,
1223 .format_half_open = format_tcp_half_open_session,
1224 .tx_type = TRANSPORT_TX_PEEK,
1225 .service_type = TRANSPORT_SERVICE_VC,
1230 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1235 if (!transport_connection_is_tx_paced (&tc->connection))
1238 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1239 /* TODO should constrain to interface's max throughput but
1240 * we don't have link speeds for sw ifs ..*/
1241 rate = tc->cwnd / srtt;
1242 transport_connection_tx_pacer_update (&tc->connection, rate);
1246 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1249 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1250 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1251 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1252 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1253 start_bucket, last_time);
1257 tcp_timer_keep_handler (u32 conn_index)
1259 u32 thread_index = vlib_get_thread_index ();
1260 tcp_connection_t *tc;
1262 tc = tcp_connection_get (conn_index, thread_index);
1263 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1265 tcp_connection_close (tc);
1269 tcp_timer_establish_handler (u32 conn_index)
1271 tcp_connection_t *tc;
1273 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1274 /* note: the connection may have already disappeared */
1275 if (PREDICT_FALSE (tc == 0))
1277 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1278 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1279 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1280 tcp_connection_timers_reset (tc);
1281 /* Start cleanup. Do NOT delete the session until we do the connection
1282 * cleanup. Otherwise, we end up with a dangling session index in the
1283 * tcp connection. */
1284 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1288 tcp_timer_establish_ao_handler (u32 conn_index)
1290 tcp_connection_t *tc;
1292 tc = tcp_half_open_connection_get (conn_index);
1296 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1297 /* Notify app if we haven't tried to clean this up already */
1298 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1299 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1301 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1302 tcp_connection_cleanup (tc);
1306 tcp_timer_waitclose_handler (u32 conn_index)
1308 u32 thread_index = vlib_get_thread_index ();
1309 tcp_connection_t *tc;
1311 tc = tcp_connection_get (conn_index, thread_index);
1314 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1318 case TCP_STATE_CLOSE_WAIT:
1319 tcp_connection_timers_reset (tc);
1320 session_transport_closed_notify (&tc->connection);
1322 if (!(tc->flags & TCP_CONN_FINPNDG))
1324 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1325 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1329 /* Session didn't come back with a close. Send FIN either way
1330 * and switch to LAST_ACK. */
1331 tcp_cong_recovery_off (tc);
1332 /* Make sure we don't try to send unsent data */
1333 tc->snd_nxt = tc->snd_una;
1335 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1337 /* Make sure we don't wait in LAST ACK forever */
1338 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1340 /* Don't delete the connection yet */
1342 case TCP_STATE_FIN_WAIT_1:
1343 tcp_connection_timers_reset (tc);
1344 if (tc->flags & TCP_CONN_FINPNDG)
1346 /* If FIN pending, we haven't sent everything, but we did try.
1347 * Notify session layer that transport is closed. */
1348 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1349 session_transport_closed_notify (&tc->connection);
1350 tcp_send_reset (tc);
1351 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1355 /* We've sent the fin but no progress. Close the connection and
1356 * to make sure everything is flushed, setup a cleanup timer */
1357 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1358 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1361 case TCP_STATE_LAST_ACK:
1362 case TCP_STATE_CLOSING:
1363 tcp_connection_timers_reset (tc);
1364 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1365 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1366 session_transport_closed_notify (&tc->connection);
1369 tcp_connection_del (tc);
1375 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1377 tcp_timer_retransmit_handler,
1378 tcp_timer_delack_handler,
1379 tcp_timer_persist_handler,
1380 tcp_timer_keep_handler,
1381 tcp_timer_waitclose_handler,
1382 tcp_timer_retransmit_syn_handler,
1383 tcp_timer_establish_handler,
1384 tcp_timer_establish_ao_handler,
1389 tcp_expired_timers_dispatch (u32 * expired_timers)
1392 u32 connection_index, timer_id;
1394 for (i = 0; i < vec_len (expired_timers); i++)
1396 /* Get session index and timer id */
1397 connection_index = expired_timers[i] & 0x0FFFFFFF;
1398 timer_id = expired_timers[i] >> 28;
1400 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1402 /* Handle expiration */
1403 (*timer_expiration_handlers[timer_id]) (connection_index);
1408 tcp_initialize_timer_wheels (tcp_main_t * tm)
1410 tw_timer_wheel_16t_2w_512sl_t *tw;
1412 foreach_vlib_main (({
1413 tw = &tm->wrk_ctx[ii].timer_wheel;
1414 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1415 100e-3 /* timer period 100ms */ , ~0);
1416 tw->last_run_time = vlib_time_now (this_vlib_main);
1422 tcp_initialize_iss_seed (tcp_main_t * tm)
1424 u32 default_seed = random_default_seed ();
1425 u64 time_now = clib_cpu_time_now ();
1427 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1428 tm->iss_seed.second = random_u64 (&time_now);
1431 static clib_error_t *
1432 tcp_main_enable (vlib_main_t * vm)
1434 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1435 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1436 tcp_connection_t *tc __attribute__ ((unused));
1437 tcp_main_t *tm = vnet_get_tcp_main ();
1438 clib_error_t *error = 0;
1441 if ((error = vlib_call_init_function (vm, ip_main_init)))
1443 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1445 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1452 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1453 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1456 * Initialize data structures
1459 num_threads = 1 /* main thread */ + vtm->n_threads;
1460 vec_validate (tm->connections, num_threads - 1);
1461 vec_validate (tm->wrk_ctx, num_threads - 1);
1462 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1463 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1465 for (thread = 0; thread < num_threads; thread++)
1467 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1468 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1469 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1470 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1471 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1472 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1473 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1474 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1475 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1476 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1477 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1478 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1479 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1482 * Preallocate connections. Assume that thread 0 won't
1483 * use preallocated threads when running multi-core
1485 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1486 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1490 * Use a preallocated half-open connection pool?
1492 if (tm->preallocated_half_open_connections)
1493 pool_init_fixed (tm->half_open_connections,
1494 tm->preallocated_half_open_connections);
1496 /* Initialize clocks per tick for TCP timestamp. Used to compute
1497 * monotonically increasing timestamps. */
1498 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1499 / TCP_TSTAMP_RESOLUTION;
1501 if (num_threads > 1)
1503 clib_spinlock_init (&tm->half_open_lock);
1506 tcp_initialize_timer_wheels (tm);
1507 tcp_initialize_iss_seed (tm);
1509 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1510 tm->cc_last_type = TCP_CC_LAST;
1515 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1519 if (tcp_main.is_enabled)
1522 return tcp_main_enable (vm);
1526 tcp_main.is_enabled = 0;
1533 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1535 tcp_main_t *tm = &tcp_main;
1537 tm->punt_unknown4 = is_add;
1539 tm->punt_unknown6 = is_add;
1542 static clib_error_t *
1543 tcp_init (vlib_main_t * vm)
1545 tcp_main_t *tm = vnet_get_tcp_main ();
1546 ip_main_t *im = &ip_main;
1547 ip_protocol_info_t *pi;
1549 /* Session layer, and by implication tcp, are disabled by default */
1552 /* Register with IP for header parsing */
1553 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1555 return clib_error_return (0, "TCP protocol info AWOL");
1556 pi->format_header = format_tcp_header;
1557 pi->unformat_pg_edit = unformat_pg_tcp_header;
1559 /* Register as transport with session layer */
1560 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1561 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1562 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1563 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1565 tcp_api_reference ();
1566 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1568 tm->cc_algo = TCP_CC_NEWRENO;
1569 tm->default_mtu = 1460;
1573 VLIB_INIT_FUNCTION (tcp_init);
1576 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1578 uword *result = va_arg (*va, uword *);
1579 tcp_main_t *tm = &tcp_main;
1584 if (unformat (input, "%s", &cc_algo_name)
1585 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1591 vec_free (cc_algo_name);
1596 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1598 tcp_main_t *tm = vnet_get_tcp_main ();
1599 tcp_cc_algorithm_t *cc_alg;
1600 unformat_input_t sub_input;
1603 vec_foreach (cc_alg, tm->cc_algos)
1605 if (!unformat (input, cc_alg->name))
1608 if (cc_alg->unformat_cfg
1609 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1611 if (cc_alg->unformat_cfg (&sub_input))
1618 static clib_error_t *
1619 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1621 tcp_main_t *tm = vnet_get_tcp_main ();
1623 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1625 if (unformat (input, "preallocated-connections %d",
1626 &tm->preallocated_connections))
1628 else if (unformat (input, "preallocated-half-open-connections %d",
1629 &tm->preallocated_half_open_connections))
1631 else if (unformat (input, "buffer-fail-fraction %f",
1632 &tm->buffer_fail_fraction))
1634 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1637 else if (unformat (input, "mtu %d", &tm->default_mtu))
1639 else if (unformat (input, "no-tx-pacing"))
1641 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1644 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1647 return clib_error_return (0, "unknown input `%U'",
1648 format_unformat_error, input);
1653 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1657 * \brief Configure an ipv4 source address range
1658 * @param vm vlib_main_t pointer
1659 * @param start first ipv4 address in the source address range
1660 * @param end last ipv4 address in the source address range
1661 * @param table_id VRF / table ID, 0 for the default FIB
1662 * @return 0 if all OK, else an error indication from api_errno.h
1666 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1667 ip4_address_t * start,
1668 ip4_address_t * end, u32 table_id)
1670 tcp_main_t *tm = vnet_get_tcp_main ();
1671 vnet_main_t *vnm = vnet_get_main ();
1672 u32 start_host_byte_order, end_host_byte_order;
1673 fib_prefix_t prefix;
1674 fib_node_index_t fei;
1679 clib_memset (&prefix, 0, sizeof (prefix));
1681 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1683 if (fib_index == ~0)
1684 return VNET_API_ERROR_NO_SUCH_FIB;
1686 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1687 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1689 /* sanity check for reversed args or some such */
1690 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1691 return VNET_API_ERROR_INVALID_ARGUMENT;
1693 /* Lookup the last address, to identify the interface involved */
1695 prefix.fp_proto = FIB_PROTOCOL_IP4;
1696 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1698 fei = fib_table_lookup (fib_index, &prefix);
1700 /* Couldn't find route to destination. Bail out. */
1701 if (fei == FIB_NODE_INDEX_INVALID)
1702 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1704 sw_if_index = fib_entry_get_resolving_interface (fei);
1706 /* Configure proxy arp across the range */
1707 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1712 rv = vnet_proxy_arp_enable_disable (vnm, sw_if_index, 1);
1719 dpo_id_t dpo = DPO_INVALID;
1721 vec_add1 (tm->ip4_src_addresses, start[0]);
1723 /* Add local adjacencies for the range */
1725 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1728 prefix.fp_proto = FIB_PROTOCOL_IP4;
1729 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1731 fib_table_entry_special_dpo_update (fib_index,
1734 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1737 start_host_byte_order++;
1738 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1740 while (start_host_byte_order <= end_host_byte_order);
1746 * \brief Configure an ipv6 source address range
1747 * @param vm vlib_main_t pointer
1748 * @param start first ipv6 address in the source address range
1749 * @param end last ipv6 address in the source address range
1750 * @param table_id VRF / table ID, 0 for the default FIB
1751 * @return 0 if all OK, else an error indication from api_errno.h
1755 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1756 ip6_address_t * start,
1757 ip6_address_t * end, u32 table_id)
1759 tcp_main_t *tm = vnet_get_tcp_main ();
1760 fib_prefix_t prefix;
1762 fib_node_index_t fei;
1765 clib_memset (&prefix, 0, sizeof (prefix));
1767 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1769 if (fib_index == ~0)
1770 return VNET_API_ERROR_NO_SUCH_FIB;
1776 dpo_id_t dpo = DPO_INVALID;
1778 /* Remember this address */
1779 vec_add1 (tm->ip6_src_addresses, start[0]);
1781 /* Lookup the prefix, to identify the interface involved */
1782 prefix.fp_len = 128;
1783 prefix.fp_proto = FIB_PROTOCOL_IP6;
1784 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1786 fei = fib_table_lookup (fib_index, &prefix);
1788 /* Couldn't find route to destination. Bail out. */
1789 if (fei == FIB_NODE_INDEX_INVALID)
1790 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1792 sw_if_index = fib_entry_get_resolving_interface (fei);
1794 if (sw_if_index == (u32) ~ 0)
1795 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1797 /* Add a proxy neighbor discovery entry for this address */
1798 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1800 /* Add a receive adjacency for this address */
1801 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1804 fib_table_entry_special_dpo_update (fib_index,
1807 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1810 /* Done with the entire range? */
1811 if (!memcmp (start, end, sizeof (start[0])))
1814 /* Increment the address. DGMS. */
1816 for (i = 15; i >= 0; i--)
1819 if (tmp.as_u8[i] != 0)
1827 static clib_error_t *
1828 tcp_src_address (vlib_main_t * vm,
1829 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1831 ip4_address_t v4start, v4end;
1832 ip6_address_t v6start, v6end;
1838 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1840 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1841 unformat_ip4_address, &v4end))
1843 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1845 memcpy (&v4end, &v4start, sizeof (v4start));
1848 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1849 unformat_ip6_address, &v6end))
1851 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1853 memcpy (&v6end, &v6start, sizeof (v6start));
1856 else if (unformat (input, "fib-table %d", &table_id))
1862 if (!v4set && !v6set)
1863 return clib_error_return (0, "at least one v4 or v6 address required");
1867 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1874 case VNET_API_ERROR_NO_SUCH_FIB:
1875 return clib_error_return (0, "Invalid table-id %d", table_id);
1877 case VNET_API_ERROR_INVALID_ARGUMENT:
1878 return clib_error_return (0, "Invalid address range %U - %U",
1879 format_ip4_address, &v4start,
1880 format_ip4_address, &v4end);
1882 return clib_error_return (0, "error %d", rv);
1888 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1895 case VNET_API_ERROR_NO_SUCH_FIB:
1896 return clib_error_return (0, "Invalid table-id %d", table_id);
1899 return clib_error_return (0, "error %d", rv);
1907 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1909 .path = "tcp src-address",
1910 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1911 .function = tcp_src_address,
1916 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1918 #if TCP_SCOREBOARD_TRACE
1920 scoreboard_trace_elt_t *block;
1926 s = format (s, "scoreboard trace:");
1927 vec_foreach (block, sb->trace)
1929 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1930 block->ack, block->snd_una_max, block->group);
1932 s = format (s, "\n");
1940 static clib_error_t *
1941 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1942 vlib_cli_command_t * cmd_arg)
1944 transport_connection_t *tconn = 0;
1945 tcp_connection_t *tc;
1947 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1949 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1950 TRANSPORT_PROTO_TCP))
1953 return clib_error_return (0, "unknown input `%U'",
1954 format_unformat_error, input);
1957 if (!TCP_SCOREBOARD_TRACE)
1959 vlib_cli_output (vm, "scoreboard tracing not enabled");
1963 tc = tcp_get_connection_from_transport (tconn);
1964 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1965 vlib_cli_output (vm, "%v", s);
1970 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1972 .path = "show tcp scoreboard trace",
1973 .short_help = "show tcp scoreboard trace <connection>",
1974 .function = tcp_show_scoreboard_trace_fn,
1979 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1982 scoreboard_trace_elt_t *trace;
1983 u32 next_ack, left, group, has_new_ack = 0;
1984 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1985 sack_block_t *block;
1987 if (!TCP_SCOREBOARD_TRACE)
1989 s = format (s, "scoreboard tracing not enabled");
1996 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1997 tcp_connection_timers_init (dummy_tc);
1998 scoreboard_init (&dummy_tc->sack_sb);
1999 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2001 #if TCP_SCOREBOARD_TRACE
2002 trace = tc->sack_sb.trace;
2003 trace_len = vec_len (tc->sack_sb.trace);
2006 for (i = 0; i < trace_len; i++)
2008 if (trace[i].ack != 0)
2010 dummy_tc->snd_una = trace[i].ack - 1448;
2011 dummy_tc->snd_una_max = trace[i].ack;
2016 while (left < trace_len)
2018 group = trace[left].group;
2019 vec_reset_length (dummy_tc->rcv_opts.sacks);
2021 while (trace[left].group == group)
2023 if (trace[left].ack != 0)
2026 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2027 trace[left].ack, trace[left].snd_una_max);
2028 dummy_tc->snd_una_max = trace[left].snd_una_max;
2029 next_ack = trace[left].ack;
2035 s = format (s, "[%u, %u], ", trace[left].start,
2037 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2038 block->start = trace[left].start;
2039 block->end = trace[left].end;
2045 tcp_rcv_sacks (dummy_tc, next_ack);
2047 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2050 s = format (s, "result: %U", format_tcp_scoreboard,
2051 &dummy_tc->sack_sb);
2054 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2059 static clib_error_t *
2060 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2061 vlib_cli_command_t * cmd_arg)
2063 transport_connection_t *tconn = 0;
2064 tcp_connection_t *tc = 0;
2066 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2068 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2069 TRANSPORT_PROTO_TCP))
2072 return clib_error_return (0, "unknown input `%U'",
2073 format_unformat_error, input);
2076 if (!TCP_SCOREBOARD_TRACE)
2078 vlib_cli_output (vm, "scoreboard tracing not enabled");
2082 tc = tcp_get_connection_from_transport (tconn);
2085 vlib_cli_output (vm, "connection not found");
2088 str = tcp_scoreboard_replay (str, tc, 1);
2089 vlib_cli_output (vm, "%v", str);
2094 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2096 .path = "tcp replay scoreboard",
2097 .short_help = "tcp replay scoreboard <connection>",
2098 .function = tcp_scoreboard_trace_fn,
2102 static clib_error_t *
2103 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2104 vlib_cli_command_t * cmd_arg)
2106 tcp_main_t *tm = vnet_get_tcp_main ();
2107 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2108 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2110 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2111 tm->punt_unknown4 ? "enabled" : "disabled");
2112 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2113 tm->punt_unknown6 ? "enabled" : "disabled");
2117 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2119 .path = "show tcp punt",
2120 .short_help = "show tcp punt",
2121 .function = show_tcp_punt_fn,
2126 * fd.io coding-style-patch-verification: ON
2129 * eval: (c-set-style "gnu")