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->init (tc);
80 tcp_cc_cleanup (tcp_connection_t * tc)
82 if (tc->cc_algo->cleanup)
83 tc->cc_algo->cleanup (tc);
87 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
88 const tcp_cc_algorithm_t * vft)
90 tcp_main_t *tm = vnet_get_tcp_main ();
91 vec_validate (tm->cc_algos, type);
93 tm->cc_algos[type] = *vft;
94 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
98 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
100 tcp_main_t *tm = vnet_get_tcp_main ();
101 return &tm->cc_algos[type];
104 tcp_cc_algorithm_type_e
105 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
107 tcp_main_t *tm = vnet_get_tcp_main ();
108 tcp_cc_algo_register (++tm->cc_last_type, vft);
109 return tm->cc_last_type;
113 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
115 tcp_main_t *tm = &tcp_main;
116 tcp_connection_t *listener;
119 pool_get (tm->listener_pool, listener);
120 clib_memset (listener, 0, sizeof (*listener));
122 listener->c_c_index = listener - tm->listener_pool;
123 listener->c_lcl_port = lcl->port;
125 /* If we are provided a sw_if_index, bind using one of its ips */
126 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
128 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
130 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
132 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
133 listener->c_is_ip4 = lcl->is_ip4;
134 listener->c_proto = TRANSPORT_PROTO_TCP;
135 listener->c_s_index = session_index;
136 listener->c_fib_index = lcl->fib_index;
137 listener->state = TCP_STATE_LISTEN;
138 listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
140 tcp_connection_timers_init (listener);
142 TCP_EVT (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 (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 (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);
271 vec_free (tc->rcv_opts.sacks);
272 pool_free (tc->sack_sb.holes);
274 if (tc->flags & TCP_CONN_RATE_SAMPLE)
277 /* Poison the entry */
279 clib_memset (tc, 0xFA, sizeof (*tc));
280 pool_put (tm->connections[thread_index], tc);
285 * Connection removal.
287 * This should be called only once connection enters CLOSED state. Note
288 * that it notifies the session of the removal event, so if the goal is to
289 * just remove the connection, call tcp_connection_cleanup instead.
292 tcp_connection_del (tcp_connection_t * tc)
294 session_transport_delete_notify (&tc->connection);
295 tcp_connection_cleanup (tc);
299 tcp_connection_alloc (u8 thread_index)
301 tcp_main_t *tm = vnet_get_tcp_main ();
302 tcp_connection_t *tc;
304 pool_get (tm->connections[thread_index], tc);
305 clib_memset (tc, 0, sizeof (*tc));
306 tc->c_c_index = tc - tm->connections[thread_index];
307 tc->c_thread_index = thread_index;
312 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
314 tcp_main_t *tm = vnet_get_tcp_main ();
315 tcp_connection_t *tc;
317 pool_get (tm->connections[thread_index], tc);
318 clib_memcpy_fast (tc, base, sizeof (*tc));
319 tc->c_c_index = tc - tm->connections[thread_index];
320 tc->c_thread_index = thread_index;
325 tcp_connection_free (tcp_connection_t * tc)
327 tcp_main_t *tm = &tcp_main;
330 u8 thread_index = tc->c_thread_index;
331 clib_memset (tc, 0xFA, sizeof (*tc));
332 pool_put (tm->connections[thread_index], tc);
335 pool_put (tm->connections[tc->c_thread_index], tc);
338 /** Notify session that connection has been reset.
340 * Switch state to closed and wait for session to call cleanup.
343 tcp_connection_reset (tcp_connection_t * tc)
345 TCP_EVT (TCP_EVT_RST_RCVD, tc);
348 case TCP_STATE_SYN_RCVD:
349 /* Cleanup everything. App wasn't notified yet */
350 session_transport_delete_notify (&tc->connection);
351 tcp_connection_cleanup (tc);
353 case TCP_STATE_SYN_SENT:
354 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
355 tcp_connection_cleanup (tc);
357 case TCP_STATE_ESTABLISHED:
358 tcp_connection_timers_reset (tc);
359 /* Set the cleanup timer, in case the session layer/app don't
360 * cleanly close the connection */
361 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
362 session_transport_reset_notify (&tc->connection);
363 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
364 session_transport_closed_notify (&tc->connection);
366 case TCP_STATE_CLOSE_WAIT:
367 case TCP_STATE_FIN_WAIT_1:
368 case TCP_STATE_FIN_WAIT_2:
369 case TCP_STATE_CLOSING:
370 case TCP_STATE_LAST_ACK:
371 tcp_connection_timers_reset (tc);
372 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
373 /* Make sure we mark the session as closed. In some states we may
374 * be still trying to send data */
375 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
376 session_transport_closed_notify (&tc->connection);
378 case TCP_STATE_CLOSED:
379 case TCP_STATE_TIME_WAIT:
382 TCP_DBG ("reset state: %u", tc->state);
387 * Begin connection closing procedure.
389 * If at the end the connection is not in CLOSED state, it is not removed.
390 * Instead, we rely on on TCP to advance through state machine to either
391 * 1) LAST_ACK (passive close) whereby when the last ACK is received
392 * tcp_connection_del is called. This notifies session of the delete and
394 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
395 * and cleanup is called.
397 * N.B. Half-close connections are not supported
400 tcp_connection_close (tcp_connection_t * tc)
402 TCP_EVT (TCP_EVT_CLOSE, tc);
404 /* Send/Program FIN if needed and switch state */
407 case TCP_STATE_SYN_SENT:
408 /* Try to cleanup. If not on the right thread, mark as half-open done.
409 * Connection will be cleaned up when establish timer pops */
410 tcp_connection_cleanup (tc);
412 case TCP_STATE_SYN_RCVD:
413 tcp_connection_timers_reset (tc);
415 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
416 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
418 case TCP_STATE_ESTABLISHED:
419 /* If closing with unread data, reset the connection */
420 if (transport_max_rx_dequeue (&tc->connection))
423 tcp_connection_timers_reset (tc);
424 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
425 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
426 session_transport_closed_notify (&tc->connection);
429 if (!transport_max_tx_dequeue (&tc->connection))
432 tc->flags |= TCP_CONN_FINPNDG;
433 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
434 /* Set a timer in case the peer stops responding. Otherwise the
435 * connection will be stuck here forever. */
436 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
437 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
439 case TCP_STATE_CLOSE_WAIT:
440 if (!transport_max_tx_dequeue (&tc->connection))
443 tcp_connection_timers_reset (tc);
444 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
445 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
448 tc->flags |= TCP_CONN_FINPNDG;
450 case TCP_STATE_FIN_WAIT_1:
451 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
453 case TCP_STATE_CLOSED:
454 tcp_connection_timers_reset (tc);
455 /* Delete connection but instead of doing it now wait until next
456 * dispatch cycle to give the session layer a chance to clear
457 * unhandled events */
458 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
461 TCP_DBG ("state: %u", tc->state);
466 tcp_session_close (u32 conn_index, u32 thread_index)
468 tcp_connection_t *tc;
469 tc = tcp_connection_get (conn_index, thread_index);
470 tcp_connection_close (tc);
474 tcp_session_cleanup (u32 conn_index, u32 thread_index)
476 tcp_connection_t *tc;
477 tc = tcp_connection_get (conn_index, thread_index);
478 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
479 tcp_connection_cleanup (tc);
483 tcp_session_reset (u32 conn_index, u32 thread_index)
485 tcp_connection_t *tc;
486 tc = tcp_connection_get (conn_index, thread_index);
487 session_transport_closed_notify (&tc->connection);
489 tcp_connection_timers_reset (tc);
490 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
491 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
495 * Initialize all connection timers as invalid
498 tcp_connection_timers_init (tcp_connection_t * tc)
502 /* Set all to invalid */
503 for (i = 0; i < TCP_N_TIMERS; i++)
505 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
508 tc->rto = TCP_RTO_INIT;
512 * Stop all connection timers
515 tcp_connection_timers_reset (tcp_connection_t * tc)
518 for (i = 0; i < TCP_N_TIMERS; i++)
520 tcp_timer_reset (tc, i);
525 typedef struct ip4_tcp_hdr
531 typedef struct ip6_tcp_hdr
538 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
541 const dpo_id_t *choice;
545 lb = load_balance_get (dpo->dpoi_index);
549 clib_memset (&hdr, 0, sizeof (hdr));
550 hdr.ip.protocol = IP_PROTOCOL_TCP;
551 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
552 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
553 hdr.tcp.src_port = tc->c_lcl_port;
554 hdr.tcp.dst_port = tc->c_rmt_port;
555 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
560 clib_memset (&hdr, 0, sizeof (hdr));
561 hdr.ip.protocol = IP_PROTOCOL_TCP;
562 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
563 sizeof (ip6_address_t));
564 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
565 sizeof (ip6_address_t));
566 hdr.tcp.src_port = tc->c_lcl_port;
567 hdr.tcp.dst_port = tc->c_rmt_port;
568 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
570 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
571 dpo_copy (result, choice);
575 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
580 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
581 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
582 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
583 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
584 return fib_table_lookup (fib_index, &prefix);
588 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
590 dpo_id_t choice = DPO_INVALID;
591 u32 output_node_index;
594 fe = fib_entry_get (tc->c_rmt_fei);
595 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
598 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
601 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
602 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
606 /** Stack tcp connection on peer's fib entry.
608 * This ultimately populates the dpo the connection will use to send packets.
611 tcp_connection_fib_attach (tcp_connection_t * tc)
613 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
615 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
617 tcp_connection_stack_on_fib_entry (tc);
622 * Generate random iss as per rfc6528
625 tcp_generate_random_iss (tcp_connection_t * tc)
627 tcp_main_t *tm = &tcp_main;
631 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
633 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
634 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
636 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
637 tmp ^= tm->iss_seed.second;
638 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
639 return ((tmp >> 32) ^ (tmp & 0xffffffff));
643 * Initialize max segment size we're able to process.
645 * The value is constrained by the output interface's MTU and by the size
646 * of the IP and TCP headers (see RFC6691). It is also what we advertise
650 tcp_init_rcv_mss (tcp_connection_t * tc)
654 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
655 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
659 tcp_init_mss (tcp_connection_t * tc)
661 u16 default_min_mss = 536;
663 tcp_init_rcv_mss (tc);
665 /* TODO consider PMTU discovery */
666 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
668 if (tc->snd_mss < 45)
670 /* Assume that at least the min default mss works */
671 tc->snd_mss = default_min_mss;
672 tc->rcv_opts.mss = default_min_mss;
675 /* We should have enough space for 40 bytes of options */
676 ASSERT (tc->snd_mss > 45);
678 /* If we use timestamp option, account for it */
679 if (tcp_opts_tstamp (&tc->rcv_opts))
680 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
684 * Initialize connection send variables.
687 tcp_init_snd_vars (tcp_connection_t * tc)
690 * We use the time to randomize iss and for setting up the initial
691 * timestamp. Make sure it's updated otherwise syn and ack in the
692 * handshake may make it look as if time has flown in the opposite
695 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
697 tcp_init_rcv_mss (tc);
698 tc->iss = tcp_generate_random_iss (tc);
699 tc->snd_una = tc->iss;
700 tc->snd_nxt = tc->iss + 1;
701 tc->snd_una_max = tc->snd_nxt;
706 tcp_enable_pacing (tcp_connection_t * tc)
708 u32 initial_bucket, byte_rate;
709 initial_bucket = 16 * tc->snd_mss;
711 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
713 tc->mrtt_us = (u32) ~ 0;
716 /** Initialize tcp connection variables
718 * Should be called after having received a msg from the peer, i.e., a SYN or
719 * a SYNACK, such that connection options have already been exchanged. */
721 tcp_connection_init_vars (tcp_connection_t * tc)
723 tcp_connection_timers_init (tc);
725 scoreboard_init (&tc->sack_sb);
727 if (tc->state == TCP_STATE_SYN_RCVD)
728 tcp_init_snd_vars (tc);
730 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
731 tcp_add_del_adjacency (tc, 1);
733 /* tcp_connection_fib_attach (tc); */
735 if (transport_connection_is_tx_paced (&tc->connection)
736 || tcp_cfg.enable_tx_pacing)
737 tcp_enable_pacing (tc);
739 if (tc->flags & TCP_CONN_RATE_SAMPLE)
742 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
746 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
747 u16 * lcl_port, u8 is_ip4)
752 index = tm->last_v4_addr_rotor++;
753 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
754 tm->last_v4_addr_rotor = 0;
755 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
759 index = tm->last_v6_addr_rotor++;
760 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
761 tm->last_v6_addr_rotor = 0;
762 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
763 sizeof (ip6_address_t));
765 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
768 clib_warning ("Failed to allocate src port");
776 tcp_session_open (transport_endpoint_cfg_t * rmt)
778 tcp_main_t *tm = vnet_get_tcp_main ();
779 tcp_connection_t *tc;
780 ip46_address_t lcl_addr;
785 * Allocate local endpoint
787 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
788 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
789 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
792 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
793 rmt, &lcl_addr, &lcl_port);
799 * Create connection and send SYN
801 clib_spinlock_lock_if_init (&tm->half_open_lock);
802 tc = tcp_half_open_connection_new ();
803 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
804 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
805 tc->c_rmt_port = rmt->port;
806 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
807 tc->c_is_ip4 = rmt->is_ip4;
808 tc->c_proto = TRANSPORT_PROTO_TCP;
809 tc->c_fib_index = rmt->fib_index;
810 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
811 /* The other connection vars will be initialized after SYN ACK */
812 tcp_connection_timers_init (tc);
814 TCP_EVT (TCP_EVT_OPEN, tc);
815 tc->state = TCP_STATE_SYN_SENT;
816 tcp_init_snd_vars (tc);
818 clib_spinlock_unlock_if_init (&tm->half_open_lock);
820 return tc->c_c_index;
823 const char *tcp_fsm_states[] = {
824 #define _(sym, str) str,
825 foreach_tcp_fsm_state
830 format_tcp_state (u8 * s, va_list * args)
832 u32 state = va_arg (*args, u32);
834 if (state < TCP_N_STATES)
835 s = format (s, "%s", tcp_fsm_states[state]);
837 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
841 const char *tcp_connection_flags_str[] = {
842 #define _(sym, str) str,
843 foreach_tcp_connection_flag
848 format_tcp_connection_flags (u8 * s, va_list * args)
850 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
853 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
854 if (tc->flags & (1 << i))
856 for (i = 0; i < last; i++)
858 if (tc->flags & (1 << i))
859 s = format (s, "%s, ", tcp_connection_flags_str[i]);
862 s = format (s, "%s", tcp_connection_flags_str[last]);
866 const char *tcp_conn_timers[] = {
867 #define _(sym, str) str,
873 format_tcp_timers (u8 * s, va_list * args)
875 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
878 for (i = 0; i < TCP_N_TIMERS; i++)
879 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
882 for (i = 0; i < last; i++)
884 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
885 s = format (s, "%s,", tcp_conn_timers[i]);
889 s = format (s, "%s", tcp_conn_timers[i]);
895 format_tcp_congestion_status (u8 * s, va_list * args)
897 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
898 if (tcp_in_recovery (tc))
899 s = format (s, "recovery");
900 else if (tcp_in_fastrecovery (tc))
901 s = format (s, "fastrecovery");
903 s = format (s, "none");
908 tcp_rcv_wnd_available (tcp_connection_t * tc)
910 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
914 format_tcp_congestion (u8 * s, va_list * args)
916 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
917 u32 indent = format_get_indent (s);
919 s = format (s, "%U ", format_tcp_congestion_status, tc);
920 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
921 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
922 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
923 format_white_space, indent, tcp_available_cc_snd_space (tc),
924 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
925 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
926 format_white_space, indent, tc->snd_congestion - tc->iss,
927 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
932 format_tcp_stats (u8 * s, va_list * args)
934 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
935 u32 indent = format_get_indent (s);
936 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
937 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
938 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
939 format_white_space, indent, tc->segs_out,
940 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
941 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
942 format_white_space, indent, tc->fr_occurences,
943 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
944 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
945 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
946 format_white_space, indent, tc->errors.below_data_wnd,
947 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
948 tc->errors.above_ack_wnd);
953 format_tcp_vars (u8 * s, va_list * args)
955 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
956 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
957 format_tcp_connection_flags, tc, format_tcp_timers, tc);
958 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
959 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
960 tc->snd_una_max - tc->iss);
961 s = format (s, " rcv_nxt %u rcv_las %u\n",
962 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
963 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
964 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
965 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
966 tc->snd_wl2 - tc->iss);
967 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
968 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
969 tcp_rcv_wnd_available (tc));
970 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
971 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
972 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
973 tcp_time_now () - tc->tsval_recent_age);
974 s = format (s, " snd_mss %u\n", tc->snd_mss);
975 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
976 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
978 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
979 s = format (s, " cong: %U", format_tcp_congestion, tc);
981 if (tc->state >= TCP_STATE_ESTABLISHED)
983 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
985 s = format (s, " stats: %U\n", format_tcp_stats, tc);
987 if (vec_len (tc->snd_sacks))
988 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
994 format_tcp_connection_id (u8 * s, va_list * args)
996 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1001 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1002 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
1003 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
1004 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
1008 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1009 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1010 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1011 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1018 format_tcp_connection (u8 * s, va_list * args)
1020 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1021 u32 verbose = va_arg (*args, u32);
1025 s = format (s, "%-50U", format_tcp_connection_id, tc);
1028 s = format (s, "%-15U", format_tcp_state, tc->state);
1030 s = format (s, "\n%U", format_tcp_vars, tc);
1037 format_tcp_session (u8 * s, va_list * args)
1039 u32 tci = va_arg (*args, u32);
1040 u32 thread_index = va_arg (*args, u32);
1041 u32 verbose = va_arg (*args, u32);
1042 tcp_connection_t *tc;
1044 tc = tcp_connection_get (tci, thread_index);
1046 s = format (s, "%U", format_tcp_connection, tc, verbose);
1048 s = format (s, "empty\n");
1053 format_tcp_listener_session (u8 * s, va_list * args)
1055 u32 tci = va_arg (*args, u32);
1056 u32 __clib_unused thread_index = va_arg (*args, u32);
1057 u32 verbose = va_arg (*args, u32);
1058 tcp_connection_t *tc = tcp_listener_get (tci);
1059 s = format (s, "%-50U", format_tcp_connection_id, tc);
1061 s = format (s, "%-15U", format_tcp_state, tc->state);
1066 format_tcp_half_open_session (u8 * s, va_list * args)
1068 u32 tci = va_arg (*args, u32);
1069 u32 __clib_unused thread_index = va_arg (*args, u32);
1070 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1071 return format (s, "%U", format_tcp_connection_id, tc);
1075 format_tcp_sacks (u8 * s, va_list * args)
1077 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1078 sack_block_t *sacks = tc->snd_sacks;
1079 sack_block_t *block;
1082 len = vec_len (sacks);
1083 for (i = 0; i < len - 1; i++)
1086 s = format (s, " start %u end %u\n", block->start - tc->irs,
1087 block->end - tc->irs);
1091 block = &sacks[len - 1];
1092 s = format (s, " start %u end %u", block->start - tc->irs,
1093 block->end - tc->irs);
1099 format_tcp_rcv_sacks (u8 * s, va_list * args)
1101 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1102 sack_block_t *sacks = tc->rcv_opts.sacks;
1103 sack_block_t *block;
1106 len = vec_len (sacks);
1107 for (i = 0; i < len - 1; i++)
1110 s = format (s, " start %u end %u\n", block->start - tc->iss,
1111 block->end - tc->iss);
1115 block = &sacks[len - 1];
1116 s = format (s, " start %u end %u", block->start - tc->iss,
1117 block->end - tc->iss);
1123 format_tcp_sack_hole (u8 * s, va_list * args)
1125 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1126 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1128 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1130 s = format (s, " [%u, %u]", hole->start, hole->end);
1135 format_tcp_scoreboard (u8 * s, va_list * args)
1137 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1138 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1139 sack_scoreboard_hole_t *hole;
1140 u32 indent = format_get_indent (s);
1142 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1143 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1144 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u is_reneging %u\n",
1145 format_white_space, indent, sb->last_bytes_delivered,
1146 sb->high_sacked - tc->iss, sb->is_reneging);
1147 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1148 format_white_space, indent, sb->cur_rxt_hole,
1149 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1151 hole = scoreboard_first_hole (sb);
1153 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1154 indent, sb->head, sb->tail, pool_elts (sb->holes),
1155 format_white_space, indent);
1159 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1160 hole = scoreboard_next_hole (sb, hole);
1166 static transport_connection_t *
1167 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1169 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1170 if (PREDICT_FALSE (!tc))
1172 return &tc->connection;
1175 static transport_connection_t *
1176 tcp_half_open_session_get_transport (u32 conn_index)
1178 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1179 return &tc->connection;
1183 tcp_session_cal_goal_size (tcp_connection_t * tc)
1185 u16 goal_size = tc->snd_mss;
1187 goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1188 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1194 * Compute maximum segment size for session layer.
1196 * Since the result needs to be the actual data length, it first computes
1197 * the tcp options to be used in the next burst and subtracts their
1198 * length from the connection's snd_mss.
1201 tcp_session_send_mss (transport_connection_t * trans_conn)
1203 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1205 /* Ensure snd_mss does accurately reflect the amount of data we can push
1206 * in a segment. This also makes sure that options are updated according to
1207 * the current state of the connection. */
1208 tcp_update_burst_snd_vars (tc);
1210 if (PREDICT_FALSE (tc->is_tso))
1212 return tcp_session_cal_goal_size (tc);
1219 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1221 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1223 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1226 /* If not snd_wnd constrained and we can't write at least a segment,
1227 * don't try at all */
1228 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1229 return snd_space < tc->cwnd ? 0 : snd_space;
1231 /* round down to mss multiple */
1232 return snd_space - (snd_space % tc->snd_mss);
1236 * Compute tx window session is allowed to fill.
1238 * Takes into account available send space, snd_mss and the congestion
1239 * state of the connection. If possible, the value returned is a multiple
1242 * @param tc tcp connection
1243 * @return number of bytes session is allowed to write
1246 tcp_snd_space_inline (tcp_connection_t * tc)
1248 int snd_space, snt_limited;
1250 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1251 || tc->state == TCP_STATE_CLOSED))
1254 snd_space = tcp_available_output_snd_space (tc);
1256 /* If we haven't gotten dupacks or if we did and have gotten sacked
1257 * bytes then we can still send as per Limited Transmit (RFC3042) */
1258 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1259 && (tcp_opts_sack_permitted (tc)
1260 && tc->sack_sb.last_sacked_bytes == 0)))
1262 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1263 tc->limited_transmit = tc->snd_nxt;
1264 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1266 snt_limited = tc->snd_nxt - tc->limited_transmit;
1267 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1269 return tcp_round_snd_space (tc, snd_space);
1273 tcp_snd_space (tcp_connection_t * tc)
1275 return tcp_snd_space_inline (tc);
1279 tcp_session_send_space (transport_connection_t * trans_conn)
1281 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1282 return clib_min (tcp_snd_space_inline (tc),
1283 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1287 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1289 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1291 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1293 /* This still works if fast retransmit is on */
1294 return (tc->snd_nxt - tc->snd_una);
1298 tcp_update_time (f64 now, u8 thread_index)
1300 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1302 tcp_set_time_now (wrk);
1303 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1304 tcp_flush_frames_to_output (wrk);
1308 tcp_session_flush_data (transport_connection_t * tconn)
1310 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1311 if (tc->flags & TCP_CONN_PSH_PENDING)
1313 tc->flags |= TCP_CONN_PSH_PENDING;
1314 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1318 const static transport_proto_vft_t tcp_proto = {
1319 .enable = vnet_tcp_enable_disable,
1320 .start_listen = tcp_session_bind,
1321 .stop_listen = tcp_session_unbind,
1322 .push_header = tcp_session_push_header,
1323 .get_connection = tcp_session_get_transport,
1324 .get_listener = tcp_session_get_listener,
1325 .get_half_open = tcp_half_open_session_get_transport,
1326 .connect = tcp_session_open,
1327 .close = tcp_session_close,
1328 .cleanup = tcp_session_cleanup,
1329 .reset = tcp_session_reset,
1330 .send_mss = tcp_session_send_mss,
1331 .send_space = tcp_session_send_space,
1332 .update_time = tcp_update_time,
1333 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1334 .flush_data = tcp_session_flush_data,
1335 .custom_tx = tcp_session_custom_tx,
1336 .format_connection = format_tcp_session,
1337 .format_listener = format_tcp_listener_session,
1338 .format_half_open = format_tcp_half_open_session,
1339 .transport_options = {
1340 .tx_type = TRANSPORT_TX_PEEK,
1341 .service_type = TRANSPORT_SERVICE_VC,
1347 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1349 if (!transport_connection_is_tx_paced (&tc->connection))
1352 transport_connection_tx_pacer_update (&tc->connection,
1353 tcp_cc_get_pacing_rate (tc));
1357 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1360 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1361 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1362 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1363 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1364 start_bucket, last_time);
1368 tcp_timer_waitclose_handler (u32 conn_index)
1370 u32 thread_index = vlib_get_thread_index ();
1371 tcp_connection_t *tc;
1373 tc = tcp_connection_get (conn_index, thread_index);
1377 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1381 case TCP_STATE_CLOSE_WAIT:
1382 tcp_connection_timers_reset (tc);
1383 session_transport_closed_notify (&tc->connection);
1385 if (!(tc->flags & TCP_CONN_FINPNDG))
1387 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1388 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1392 /* Session didn't come back with a close. Send FIN either way
1393 * and switch to LAST_ACK. */
1394 tcp_cong_recovery_off (tc);
1395 /* Make sure we don't try to send unsent data */
1396 tc->snd_nxt = tc->snd_una;
1398 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1400 /* Make sure we don't wait in LAST ACK forever */
1401 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1403 /* Don't delete the connection yet */
1405 case TCP_STATE_FIN_WAIT_1:
1406 tcp_connection_timers_reset (tc);
1407 session_transport_closed_notify (&tc->connection);
1408 if (tc->flags & TCP_CONN_FINPNDG)
1410 /* If FIN pending, we haven't sent everything, but we did try.
1411 * Notify session layer that transport is closed. */
1412 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1413 tcp_send_reset (tc);
1414 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1418 /* We've sent the fin but no progress. Close the connection and
1419 * to make sure everything is flushed, setup a cleanup timer */
1420 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1421 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1424 case TCP_STATE_LAST_ACK:
1425 case TCP_STATE_CLOSING:
1426 tcp_connection_timers_reset (tc);
1427 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1428 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1429 session_transport_closed_notify (&tc->connection);
1432 tcp_connection_del (tc);
1438 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1440 tcp_timer_retransmit_handler,
1441 tcp_timer_delack_handler,
1442 tcp_timer_persist_handler,
1443 tcp_timer_waitclose_handler,
1444 tcp_timer_retransmit_syn_handler,
1449 tcp_expired_timers_dispatch (u32 * expired_timers)
1452 u32 connection_index, timer_id;
1454 for (i = 0; i < vec_len (expired_timers); i++)
1456 /* Get session index and timer id */
1457 connection_index = expired_timers[i] & 0x0FFFFFFF;
1458 timer_id = expired_timers[i] >> 28;
1460 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1462 /* Handle expiration */
1463 (*timer_expiration_handlers[timer_id]) (connection_index);
1468 tcp_initialize_timer_wheels (tcp_main_t * tm)
1470 tw_timer_wheel_16t_2w_512sl_t *tw;
1472 foreach_vlib_main (({
1473 tw = &tm->wrk_ctx[ii].timer_wheel;
1474 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1475 TCP_TIMER_TICK, ~0);
1476 tw->last_run_time = vlib_time_now (this_vlib_main);
1482 tcp_initialize_iss_seed (tcp_main_t * tm)
1484 u32 default_seed = random_default_seed ();
1485 u64 time_now = clib_cpu_time_now ();
1487 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1488 tm->iss_seed.second = random_u64 (&time_now);
1491 static clib_error_t *
1492 tcp_main_enable (vlib_main_t * vm)
1494 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1495 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1496 tcp_connection_t *tc __attribute__ ((unused));
1497 tcp_main_t *tm = vnet_get_tcp_main ();
1498 clib_error_t *error = 0;
1501 if ((error = vlib_call_init_function (vm, ip_main_init)))
1503 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1505 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1512 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1513 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1516 * Initialize data structures
1519 num_threads = 1 /* main thread */ + vtm->n_threads;
1520 vec_validate (tm->connections, num_threads - 1);
1521 vec_validate (tm->wrk_ctx, num_threads - 1);
1522 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1523 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1525 for (thread = 0; thread < num_threads; thread++)
1527 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1528 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1529 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1530 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1531 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1534 * Preallocate connections. Assume that thread 0 won't
1535 * use preallocated threads when running multi-core
1537 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1538 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1542 * Use a preallocated half-open connection pool?
1544 if (tcp_cfg.preallocated_half_open_connections)
1545 pool_init_fixed (tm->half_open_connections,
1546 tcp_cfg.preallocated_half_open_connections);
1548 /* Initialize clocks per tick for TCP timestamp. Used to compute
1549 * monotonically increasing timestamps. */
1550 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1551 / TCP_TSTAMP_RESOLUTION;
1553 if (num_threads > 1)
1555 clib_spinlock_init (&tm->half_open_lock);
1558 tcp_initialize_timer_wheels (tm);
1559 tcp_initialize_iss_seed (tm);
1561 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1562 tm->cc_last_type = TCP_CC_LAST;
1567 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1571 if (tcp_main.is_enabled)
1574 return tcp_main_enable (vm);
1578 tcp_main.is_enabled = 0;
1585 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1587 tcp_main_t *tm = &tcp_main;
1589 tm->punt_unknown4 = is_add;
1591 tm->punt_unknown6 = is_add;
1595 * Initialize default values for tcp parameters
1598 tcp_configuration_init (void)
1600 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1601 * predefined value. For SYN-ACK we still want the scale to be computed in
1603 tcp_cfg.max_rx_fifo = 32 << 20;
1604 tcp_cfg.min_rx_fifo = 4 << 10;
1606 tcp_cfg.default_mtu = 1500;
1607 tcp_cfg.initial_cwnd_multiplier = 0;
1608 tcp_cfg.enable_tx_pacing = 1;
1609 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1610 tcp_cfg.rwnd_min_update_ack = 1;
1612 /* Time constants defined as timer tick (100ms) multiples */
1613 tcp_cfg.delack_time = 1; /* 0.1s */
1614 tcp_cfg.closewait_time = 20; /* 2s */
1615 tcp_cfg.timewait_time = 100; /* 10s */
1616 tcp_cfg.finwait1_time = 600; /* 60s */
1617 tcp_cfg.lastack_time = 300; /* 30s */
1618 tcp_cfg.finwait2_time = 300; /* 30s */
1619 tcp_cfg.closing_time = 300; /* 30s */
1620 tcp_cfg.cleanup_time = 1; /* 0.1s */
1623 static clib_error_t *
1624 tcp_init (vlib_main_t * vm)
1626 tcp_main_t *tm = vnet_get_tcp_main ();
1627 ip_main_t *im = &ip_main;
1628 ip_protocol_info_t *pi;
1630 /* Session layer, and by implication tcp, are disabled by default */
1633 /* Register with IP for header parsing */
1634 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1636 return clib_error_return (0, "TCP protocol info AWOL");
1637 pi->format_header = format_tcp_header;
1638 pi->unformat_pg_edit = unformat_pg_tcp_header;
1640 /* Register as transport with session layer */
1641 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1642 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1643 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1644 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1646 tcp_api_reference ();
1647 tcp_configuration_init ();
1649 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1654 VLIB_INIT_FUNCTION (tcp_init);
1657 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1659 tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1660 tcp_main_t *tm = &tcp_main;
1665 if (unformat (input, "%s", &cc_algo_name)
1666 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1672 vec_free (cc_algo_name);
1677 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1679 tcp_main_t *tm = vnet_get_tcp_main ();
1680 tcp_cc_algorithm_t *cc_alg;
1681 unformat_input_t sub_input;
1684 vec_foreach (cc_alg, tm->cc_algos)
1686 if (!unformat (input, cc_alg->name))
1689 if (cc_alg->unformat_cfg
1690 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1692 if (cc_alg->unformat_cfg (&sub_input))
1699 static clib_error_t *
1700 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1702 u32 cwnd_multiplier, tmp_time;
1705 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1707 if (unformat (input, "preallocated-connections %d",
1708 &tcp_cfg.preallocated_connections))
1710 else if (unformat (input, "preallocated-half-open-connections %d",
1711 &tcp_cfg.preallocated_half_open_connections))
1713 else if (unformat (input, "buffer-fail-fraction %f",
1714 &tcp_cfg.buffer_fail_fraction))
1716 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1718 tcp_cfg.max_rx_fifo = memory_size;
1719 else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1721 tcp_cfg.min_rx_fifo = memory_size;
1722 else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1724 else if (unformat (input, "rwnd-min-update-ack %d",
1725 &tcp_cfg.rwnd_min_update_ack))
1727 else if (unformat (input, "initial-cwnd-multiplier %u",
1729 tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1730 else if (unformat (input, "no-tx-pacing"))
1731 tcp_cfg.enable_tx_pacing = 0;
1732 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1735 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1737 else if (unformat (input, "closewait-time %u", &tmp_time))
1738 tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1739 else if (unformat (input, "timewait-time %u", &tmp_time))
1740 tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1741 else if (unformat (input, "finwait1-time %u", &tmp_time))
1742 tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1743 else if (unformat (input, "finwait2-time %u", &tmp_time))
1744 tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1745 else if (unformat (input, "lastack-time %u", &tmp_time))
1746 tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1747 else if (unformat (input, "closing-time %u", &tmp_time))
1748 tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1749 else if (unformat (input, "cleanup-time %u", &tmp_time))
1750 tcp_cfg.cleanup_time = tmp_time / TCP_TIMER_TICK;
1752 return clib_error_return (0, "unknown input `%U'",
1753 format_unformat_error, input);
1758 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1762 * \brief Configure an ipv4 source address range
1763 * @param vm vlib_main_t pointer
1764 * @param start first ipv4 address in the source address range
1765 * @param end last ipv4 address in the source address range
1766 * @param table_id VRF / table ID, 0 for the default FIB
1767 * @return 0 if all OK, else an error indication from api_errno.h
1771 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1772 ip4_address_t * start,
1773 ip4_address_t * end, u32 table_id)
1775 vnet_main_t *vnm = vnet_get_main ();
1776 u32 start_host_byte_order, end_host_byte_order;
1777 fib_prefix_t prefix;
1778 fib_node_index_t fei;
1783 clib_memset (&prefix, 0, sizeof (prefix));
1785 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1787 if (fib_index == ~0)
1788 return VNET_API_ERROR_NO_SUCH_FIB;
1790 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1791 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1793 /* sanity check for reversed args or some such */
1794 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1795 return VNET_API_ERROR_INVALID_ARGUMENT;
1797 /* Lookup the last address, to identify the interface involved */
1799 prefix.fp_proto = FIB_PROTOCOL_IP4;
1800 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1802 fei = fib_table_lookup (fib_index, &prefix);
1804 /* Couldn't find route to destination. Bail out. */
1805 if (fei == FIB_NODE_INDEX_INVALID)
1806 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1808 sw_if_index = fib_entry_get_resolving_interface (fei);
1810 /* Configure proxy arp across the range */
1811 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1816 rv = vnet_proxy_arp_enable_disable (vnm, sw_if_index, 1);
1823 dpo_id_t dpo = DPO_INVALID;
1825 vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1827 /* Add local adjacencies for the range */
1829 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1832 prefix.fp_proto = FIB_PROTOCOL_IP4;
1833 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1835 fib_table_entry_special_dpo_update (fib_index,
1838 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1841 start_host_byte_order++;
1842 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1844 while (start_host_byte_order <= end_host_byte_order);
1850 * \brief Configure an ipv6 source address range
1851 * @param vm vlib_main_t pointer
1852 * @param start first ipv6 address in the source address range
1853 * @param end last ipv6 address in the source address range
1854 * @param table_id VRF / table ID, 0 for the default FIB
1855 * @return 0 if all OK, else an error indication from api_errno.h
1859 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1860 ip6_address_t * start,
1861 ip6_address_t * end, u32 table_id)
1863 fib_prefix_t prefix;
1865 fib_node_index_t fei;
1868 clib_memset (&prefix, 0, sizeof (prefix));
1870 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1872 if (fib_index == ~0)
1873 return VNET_API_ERROR_NO_SUCH_FIB;
1879 dpo_id_t dpo = DPO_INVALID;
1881 /* Remember this address */
1882 vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1884 /* Lookup the prefix, to identify the interface involved */
1885 prefix.fp_len = 128;
1886 prefix.fp_proto = FIB_PROTOCOL_IP6;
1887 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1889 fei = fib_table_lookup (fib_index, &prefix);
1891 /* Couldn't find route to destination. Bail out. */
1892 if (fei == FIB_NODE_INDEX_INVALID)
1893 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1895 sw_if_index = fib_entry_get_resolving_interface (fei);
1897 if (sw_if_index == (u32) ~ 0)
1898 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1900 /* Add a proxy neighbor discovery entry for this address */
1901 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1903 /* Add a receive adjacency for this address */
1904 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1907 fib_table_entry_special_dpo_update (fib_index,
1910 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1913 /* Done with the entire range? */
1914 if (!memcmp (start, end, sizeof (start[0])))
1917 /* Increment the address. DGMS. */
1919 for (i = 15; i >= 0; i--)
1922 if (tmp.as_u8[i] != 0)
1930 static clib_error_t *
1931 tcp_src_address (vlib_main_t * vm,
1932 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1934 ip4_address_t v4start, v4end;
1935 ip6_address_t v6start, v6end;
1941 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1943 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1944 unformat_ip4_address, &v4end))
1946 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1948 memcpy (&v4end, &v4start, sizeof (v4start));
1951 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1952 unformat_ip6_address, &v6end))
1954 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1956 memcpy (&v6end, &v6start, sizeof (v6start));
1959 else if (unformat (input, "fib-table %d", &table_id))
1965 if (!v4set && !v6set)
1966 return clib_error_return (0, "at least one v4 or v6 address required");
1970 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1977 case VNET_API_ERROR_NO_SUCH_FIB:
1978 return clib_error_return (0, "Invalid table-id %d", table_id);
1980 case VNET_API_ERROR_INVALID_ARGUMENT:
1981 return clib_error_return (0, "Invalid address range %U - %U",
1982 format_ip4_address, &v4start,
1983 format_ip4_address, &v4end);
1985 return clib_error_return (0, "error %d", rv);
1991 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1998 case VNET_API_ERROR_NO_SUCH_FIB:
1999 return clib_error_return (0, "Invalid table-id %d", table_id);
2002 return clib_error_return (0, "error %d", rv);
2010 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2012 .path = "tcp src-address",
2013 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2014 .function = tcp_src_address,
2019 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2021 #if TCP_SCOREBOARD_TRACE
2023 scoreboard_trace_elt_t *block;
2029 s = format (s, "scoreboard trace:");
2030 vec_foreach (block, sb->trace)
2032 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2033 block->ack, block->snd_una_max, block->group);
2035 s = format (s, "\n");
2043 static clib_error_t *
2044 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2045 vlib_cli_command_t * cmd_arg)
2047 transport_connection_t *tconn = 0;
2048 tcp_connection_t *tc;
2050 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2052 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2053 TRANSPORT_PROTO_TCP))
2056 return clib_error_return (0, "unknown input `%U'",
2057 format_unformat_error, input);
2060 if (!TCP_SCOREBOARD_TRACE)
2062 vlib_cli_output (vm, "scoreboard tracing not enabled");
2066 tc = tcp_get_connection_from_transport (tconn);
2067 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2068 vlib_cli_output (vm, "%v", s);
2073 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2075 .path = "show tcp scoreboard trace",
2076 .short_help = "show tcp scoreboard trace <connection>",
2077 .function = tcp_show_scoreboard_trace_fn,
2082 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2085 scoreboard_trace_elt_t *trace;
2086 u32 next_ack, left, group, has_new_ack = 0;
2087 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2088 sack_block_t *block;
2090 if (!TCP_SCOREBOARD_TRACE)
2092 s = format (s, "scoreboard tracing not enabled");
2099 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2100 tcp_connection_timers_init (dummy_tc);
2101 scoreboard_init (&dummy_tc->sack_sb);
2102 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2104 #if TCP_SCOREBOARD_TRACE
2105 trace = tc->sack_sb.trace;
2106 trace_len = vec_len (tc->sack_sb.trace);
2109 for (i = 0; i < trace_len; i++)
2111 if (trace[i].ack != 0)
2113 dummy_tc->snd_una = trace[i].ack - 1448;
2114 dummy_tc->snd_una_max = trace[i].ack;
2119 while (left < trace_len)
2121 group = trace[left].group;
2122 vec_reset_length (dummy_tc->rcv_opts.sacks);
2124 while (trace[left].group == group)
2126 if (trace[left].ack != 0)
2129 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2130 trace[left].ack, trace[left].snd_una_max);
2131 dummy_tc->snd_una_max = trace[left].snd_una_max;
2132 next_ack = trace[left].ack;
2138 s = format (s, "[%u, %u], ", trace[left].start,
2140 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2141 block->start = trace[left].start;
2142 block->end = trace[left].end;
2148 tcp_rcv_sacks (dummy_tc, next_ack);
2150 dummy_tc->snd_una = next_ack;
2153 s = format (s, "result: %U", format_tcp_scoreboard,
2154 &dummy_tc->sack_sb);
2157 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2162 static clib_error_t *
2163 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2164 vlib_cli_command_t * cmd_arg)
2166 transport_connection_t *tconn = 0;
2167 tcp_connection_t *tc = 0;
2169 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2171 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2172 TRANSPORT_PROTO_TCP))
2175 return clib_error_return (0, "unknown input `%U'",
2176 format_unformat_error, input);
2179 if (!TCP_SCOREBOARD_TRACE)
2181 vlib_cli_output (vm, "scoreboard tracing not enabled");
2185 tc = tcp_get_connection_from_transport (tconn);
2188 vlib_cli_output (vm, "connection not found");
2191 str = tcp_scoreboard_replay (str, tc, 1);
2192 vlib_cli_output (vm, "%v", str);
2197 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2199 .path = "tcp replay scoreboard",
2200 .short_help = "tcp replay scoreboard <connection>",
2201 .function = tcp_scoreboard_trace_fn,
2205 static clib_error_t *
2206 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2207 vlib_cli_command_t * cmd_arg)
2209 tcp_main_t *tm = vnet_get_tcp_main ();
2210 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2211 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2213 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2214 tm->punt_unknown4 ? "enabled" : "disabled");
2215 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2216 tm->punt_unknown6 ? "enabled" : "disabled");
2220 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2222 .path = "show tcp punt",
2223 .short_help = "show tcp punt",
2224 .function = show_tcp_punt_fn,
2229 * fd.io coding-style-patch-verification: ON
2232 * eval: (c-set-style "gnu")