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];
106 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
108 tcp_main_t *tm = &tcp_main;
109 tcp_connection_t *listener;
112 pool_get (tm->listener_pool, listener);
113 clib_memset (listener, 0, sizeof (*listener));
115 listener->c_c_index = listener - tm->listener_pool;
116 listener->c_lcl_port = lcl->port;
118 /* If we are provided a sw_if_index, bind using one of its ips */
119 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
121 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
123 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
125 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
126 listener->c_is_ip4 = lcl->is_ip4;
127 listener->c_proto = TRANSPORT_PROTO_TCP;
128 listener->c_s_index = session_index;
129 listener->c_fib_index = lcl->fib_index;
130 listener->state = TCP_STATE_LISTEN;
132 tcp_connection_timers_init (listener);
134 TCP_EVT_DBG (TCP_EVT_BIND, listener);
136 return listener->c_c_index;
140 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
142 return tcp_connection_bind (session_index, tep);
146 tcp_connection_unbind (u32 listener_index)
148 tcp_main_t *tm = vnet_get_tcp_main ();
149 tcp_connection_t *tc;
151 tc = pool_elt_at_index (tm->listener_pool, listener_index);
153 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
155 /* Poison the entry */
157 clib_memset (tc, 0xFA, sizeof (*tc));
159 pool_put_index (tm->listener_pool, listener_index);
163 tcp_session_unbind (u32 listener_index)
165 tcp_connection_unbind (listener_index);
169 static transport_connection_t *
170 tcp_session_get_listener (u32 listener_index)
172 tcp_main_t *tm = vnet_get_tcp_main ();
173 tcp_connection_t *tc;
174 tc = pool_elt_at_index (tm->listener_pool, listener_index);
175 return &tc->connection;
179 * Cleanup half-open connection
183 tcp_half_open_connection_del (tcp_connection_t * tc)
185 tcp_main_t *tm = vnet_get_tcp_main ();
186 clib_spinlock_lock_if_init (&tm->half_open_lock);
187 pool_put_index (tm->half_open_connections, tc->c_c_index);
189 clib_memset (tc, 0xFA, sizeof (*tc));
190 clib_spinlock_unlock_if_init (&tm->half_open_lock);
194 * Try to cleanup half-open connection
196 * If called from a thread that doesn't own tc, the call won't have any
199 * @param tc - connection to be cleaned up
200 * @return non-zero if cleanup failed.
203 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
205 /* Make sure this is the owning thread */
206 if (tc->c_thread_index != vlib_get_thread_index ())
208 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH_AO);
209 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
210 tcp_half_open_connection_del (tc);
214 static tcp_connection_t *
215 tcp_half_open_connection_new (void)
217 tcp_main_t *tm = vnet_get_tcp_main ();
218 tcp_connection_t *tc = 0;
219 ASSERT (vlib_get_thread_index () == 0);
220 pool_get (tm->half_open_connections, tc);
221 clib_memset (tc, 0, sizeof (*tc));
222 tc->c_c_index = tc - tm->half_open_connections;
227 * Cleans up connection state.
232 tcp_connection_cleanup (tcp_connection_t * tc)
234 tcp_main_t *tm = &tcp_main;
236 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
238 /* Cleanup local endpoint if this was an active connect */
239 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
242 /* Check if connection is not yet fully established */
243 if (tc->state == TCP_STATE_SYN_SENT)
245 /* Try to remove the half-open connection. If this is not the owning
246 * thread, tc won't be removed. Retransmit or establish timers will
247 * eventually expire and call again cleanup on the right thread. */
248 if (tcp_half_open_connection_cleanup (tc))
249 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
253 int thread_index = tc->c_thread_index;
255 /* Make sure all timers are cleared */
256 tcp_connection_timers_reset (tc);
258 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
259 tcp_add_del_adjacency (tc, 0);
262 vec_free (tc->snd_sacks);
263 vec_free (tc->snd_sacks_fl);
265 /* Poison the entry */
267 clib_memset (tc, 0xFA, sizeof (*tc));
268 pool_put (tm->connections[thread_index], tc);
273 * Connection removal.
275 * This should be called only once connection enters CLOSED state. Note
276 * that it notifies the session of the removal event, so if the goal is to
277 * just remove the connection, call tcp_connection_cleanup instead.
280 tcp_connection_del (tcp_connection_t * tc)
282 session_transport_delete_notify (&tc->connection);
283 tcp_connection_cleanup (tc);
287 tcp_connection_alloc (u8 thread_index)
289 tcp_main_t *tm = vnet_get_tcp_main ();
290 tcp_connection_t *tc;
292 pool_get (tm->connections[thread_index], tc);
293 clib_memset (tc, 0, sizeof (*tc));
294 tc->c_c_index = tc - tm->connections[thread_index];
295 tc->c_thread_index = thread_index;
300 tcp_connection_free (tcp_connection_t * tc)
302 tcp_main_t *tm = &tcp_main;
305 u8 thread_index = tc->c_thread_index;
306 clib_memset (tc, 0xFA, sizeof (*tc));
307 pool_put (tm->connections[thread_index], tc);
310 pool_put (tm->connections[tc->c_thread_index], tc);
313 /** Notify session that connection has been reset.
315 * Switch state to closed and wait for session to call cleanup.
318 tcp_connection_reset (tcp_connection_t * tc)
320 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
323 case TCP_STATE_SYN_RCVD:
324 /* Cleanup everything. App wasn't notified yet */
325 session_transport_delete_notify (&tc->connection);
326 tcp_connection_cleanup (tc);
328 case TCP_STATE_SYN_SENT:
329 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
330 tcp_connection_cleanup (tc);
332 case TCP_STATE_ESTABLISHED:
333 tcp_connection_timers_reset (tc);
334 /* Set the cleanup timer, in case the session layer/app don't
335 * cleanly close the connection */
336 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
337 session_transport_reset_notify (&tc->connection);
338 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
340 case TCP_STATE_CLOSE_WAIT:
341 case TCP_STATE_FIN_WAIT_1:
342 case TCP_STATE_FIN_WAIT_2:
343 case TCP_STATE_CLOSING:
344 case TCP_STATE_LAST_ACK:
345 tcp_connection_timers_reset (tc);
346 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
347 /* Make sure we mark the session as closed. In some states we may
348 * be still trying to send data */
349 session_transport_closed_notify (&tc->connection);
350 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
352 case TCP_STATE_CLOSED:
353 case TCP_STATE_TIME_WAIT:
356 TCP_DBG ("reset state: %u", tc->state);
361 * Begin connection closing procedure.
363 * If at the end the connection is not in CLOSED state, it is not removed.
364 * Instead, we rely on on TCP to advance through state machine to either
365 * 1) LAST_ACK (passive close) whereby when the last ACK is received
366 * tcp_connection_del is called. This notifies session of the delete and
368 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
369 * and cleanup is called.
371 * N.B. Half-close connections are not supported
374 tcp_connection_close (tcp_connection_t * tc)
376 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
378 /* Send/Program FIN if needed and switch state */
381 case TCP_STATE_SYN_SENT:
382 /* Try to cleanup. If not on the right thread, mark as half-open done.
383 * Connection will be cleaned up when establish timer pops */
384 tcp_connection_cleanup (tc);
386 case TCP_STATE_SYN_RCVD:
387 tcp_connection_timers_reset (tc);
389 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
390 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
392 case TCP_STATE_ESTABLISHED:
393 /* If closing with unread data, reset the connection */
394 if (transport_max_rx_dequeue (&tc->connection))
397 tcp_connection_timers_reset (tc);
398 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
399 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
402 if (!transport_max_tx_dequeue (&tc->connection))
405 tc->flags |= TCP_CONN_FINPNDG;
406 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
407 /* Set a timer in case the peer stops responding. Otherwise the
408 * connection will be stuck here forever. */
409 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
410 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
412 case TCP_STATE_CLOSE_WAIT:
413 if (!transport_max_tx_dequeue (&tc->connection))
416 tcp_connection_timers_reset (tc);
417 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
418 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
421 tc->flags |= TCP_CONN_FINPNDG;
423 case TCP_STATE_FIN_WAIT_1:
424 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
426 case TCP_STATE_CLOSED:
427 tcp_connection_timers_reset (tc);
428 /* Delete connection but instead of doing it now wait until next
429 * dispatch cycle to give the session layer a chance to clear
430 * unhandled events */
431 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
434 TCP_DBG ("state: %u", tc->state);
439 tcp_session_close (u32 conn_index, u32 thread_index)
441 tcp_connection_t *tc;
442 tc = tcp_connection_get (conn_index, thread_index);
443 tcp_connection_close (tc);
447 tcp_session_cleanup (u32 conn_index, u32 thread_index)
449 tcp_connection_t *tc;
450 tc = tcp_connection_get (conn_index, thread_index);
451 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
452 tcp_connection_cleanup (tc);
456 * Initialize all connection timers as invalid
459 tcp_connection_timers_init (tcp_connection_t * tc)
463 /* Set all to invalid */
464 for (i = 0; i < TCP_N_TIMERS; i++)
466 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
469 tc->rto = TCP_RTO_INIT;
473 * Stop all connection timers
476 tcp_connection_timers_reset (tcp_connection_t * tc)
479 for (i = 0; i < TCP_N_TIMERS; i++)
481 tcp_timer_reset (tc, i);
486 typedef struct ip4_tcp_hdr
492 typedef struct ip6_tcp_hdr
499 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
502 const dpo_id_t *choice;
506 lb = load_balance_get (dpo->dpoi_index);
510 clib_memset (&hdr, 0, sizeof (hdr));
511 hdr.ip.protocol = IP_PROTOCOL_TCP;
512 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
513 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
514 hdr.tcp.src_port = tc->c_lcl_port;
515 hdr.tcp.dst_port = tc->c_rmt_port;
516 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
521 clib_memset (&hdr, 0, sizeof (hdr));
522 hdr.ip.protocol = IP_PROTOCOL_TCP;
523 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
524 sizeof (ip6_address_t));
525 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
526 sizeof (ip6_address_t));
527 hdr.tcp.src_port = tc->c_lcl_port;
528 hdr.tcp.dst_port = tc->c_rmt_port;
529 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
531 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
532 dpo_copy (result, choice);
536 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
541 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
542 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
543 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
544 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
545 return fib_table_lookup (fib_index, &prefix);
549 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
551 dpo_id_t choice = DPO_INVALID;
552 u32 output_node_index;
555 fe = fib_entry_get (tc->c_rmt_fei);
556 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
559 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
562 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
563 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
567 /** Stack tcp connection on peer's fib entry.
569 * This ultimately populates the dpo the connection will use to send packets.
572 tcp_connection_fib_attach (tcp_connection_t * tc)
574 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
576 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
578 tcp_connection_stack_on_fib_entry (tc);
583 * Generate random iss as per rfc6528
586 tcp_generate_random_iss (tcp_connection_t * tc)
588 tcp_main_t *tm = &tcp_main;
592 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
594 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
595 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
597 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
598 tmp ^= tm->iss_seed.second;
599 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
600 return ((tmp >> 32) ^ (tmp & 0xffffffff));
604 * Initialize connection send variables.
607 tcp_init_snd_vars (tcp_connection_t * tc)
610 * We use the time to randomize iss and for setting up the initial
611 * timestamp. Make sure it's updated otherwise syn and ack in the
612 * handshake may make it look as if time has flown in the opposite
615 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
617 tc->iss = tcp_generate_random_iss (tc);
618 tc->snd_una = tc->iss;
619 tc->snd_nxt = tc->iss + 1;
620 tc->snd_una_max = tc->snd_nxt;
625 tcp_enable_pacing (tcp_connection_t * tc)
627 u32 initial_bucket, byte_rate;
628 initial_bucket = 16 * tc->snd_mss;
630 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
632 tc->mrtt_us = (u32) ~ 0;
635 /** Initialize tcp connection variables
637 * Should be called after having received a msg from the peer, i.e., a SYN or
638 * a SYNACK, such that connection options have already been exchanged. */
640 tcp_connection_init_vars (tcp_connection_t * tc)
642 tcp_connection_timers_init (tc);
644 scoreboard_init (&tc->sack_sb);
646 if (tc->state == TCP_STATE_SYN_RCVD)
647 tcp_init_snd_vars (tc);
649 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
650 tcp_add_del_adjacency (tc, 1);
652 /* tcp_connection_fib_attach (tc); */
654 if (transport_connection_is_tx_paced (&tc->connection)
655 || tcp_main.tx_pacing)
656 tcp_enable_pacing (tc);
660 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
661 u16 * lcl_port, u8 is_ip4)
666 index = tm->last_v4_address_rotor++;
667 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
668 tm->last_v4_address_rotor = 0;
669 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
673 index = tm->last_v6_address_rotor++;
674 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
675 tm->last_v6_address_rotor = 0;
676 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
677 sizeof (ip6_address_t));
679 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
682 clib_warning ("Failed to allocate src port");
690 tcp_session_open (transport_endpoint_cfg_t * rmt)
692 tcp_main_t *tm = vnet_get_tcp_main ();
693 tcp_connection_t *tc;
694 ip46_address_t lcl_addr;
699 * Allocate local endpoint
701 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
702 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
703 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
706 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
707 rmt, &lcl_addr, &lcl_port);
713 * Create connection and send SYN
715 clib_spinlock_lock_if_init (&tm->half_open_lock);
716 tc = tcp_half_open_connection_new ();
717 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
718 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
719 tc->c_rmt_port = rmt->port;
720 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
721 tc->c_is_ip4 = rmt->is_ip4;
722 tc->c_proto = TRANSPORT_PROTO_TCP;
723 tc->c_fib_index = rmt->fib_index;
724 /* The other connection vars will be initialized after SYN ACK */
725 tcp_connection_timers_init (tc);
727 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
728 tc->state = TCP_STATE_SYN_SENT;
729 tcp_init_snd_vars (tc);
731 clib_spinlock_unlock_if_init (&tm->half_open_lock);
733 return tc->c_c_index;
736 const char *tcp_dbg_evt_str[] = {
737 #define _(sym, str) str,
742 const char *tcp_fsm_states[] = {
743 #define _(sym, str) str,
744 foreach_tcp_fsm_state
749 format_tcp_state (u8 * s, va_list * args)
751 u32 state = va_arg (*args, u32);
753 if (state < TCP_N_STATES)
754 s = format (s, "%s", tcp_fsm_states[state]);
756 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
760 const char *tcp_connection_flags_str[] = {
761 #define _(sym, str) str,
762 foreach_tcp_connection_flag
767 format_tcp_connection_flags (u8 * s, va_list * args)
769 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
772 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
773 if (tc->flags & (1 << i))
775 for (i = 0; i < last; i++)
777 if (tc->flags & (1 << i))
778 s = format (s, "%s, ", tcp_connection_flags_str[i]);
781 s = format (s, "%s", tcp_connection_flags_str[last]);
785 const char *tcp_conn_timers[] = {
786 #define _(sym, str) str,
792 format_tcp_timers (u8 * s, va_list * args)
794 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
797 for (i = 0; i < TCP_N_TIMERS; i++)
798 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
801 for (i = 0; i < last; i++)
803 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
804 s = format (s, "%s,", tcp_conn_timers[i]);
808 s = format (s, "%s", tcp_conn_timers[i]);
814 format_tcp_congestion_status (u8 * s, va_list * args)
816 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
817 if (tcp_in_recovery (tc))
818 s = format (s, "recovery");
819 else if (tcp_in_fastrecovery (tc))
820 s = format (s, "fastrecovery");
822 s = format (s, "none");
827 tcp_rcv_wnd_available (tcp_connection_t * tc)
829 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
833 format_tcp_congestion (u8 * s, va_list * args)
835 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
836 u32 indent = format_get_indent (s);
838 s = format (s, "%U ", format_tcp_congestion_status, tc);
839 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
840 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
841 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
842 format_white_space, indent, tcp_available_cc_snd_space (tc),
843 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
844 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
845 format_white_space, indent, tc->snd_congestion - tc->iss,
846 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
851 format_tcp_vars (u8 * s, va_list * args)
853 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
854 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
855 format_tcp_connection_flags, tc, format_tcp_timers, tc);
856 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
857 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
858 tc->snd_una_max - tc->iss);
859 s = format (s, " rcv_nxt %u rcv_las %u\n",
860 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
861 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
862 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
863 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
864 tc->snd_wl2 - tc->iss);
865 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
866 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
867 tcp_rcv_wnd_available (tc));
868 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
869 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
870 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
871 tcp_time_now () - tc->tsval_recent_age);
872 s = format (s, " snd_mss %u\n", tc->snd_mss);
873 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
874 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
876 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
877 s = format (s, " cong: %U", format_tcp_congestion, tc);
879 if (tc->state >= TCP_STATE_ESTABLISHED)
881 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
884 if (vec_len (tc->snd_sacks))
885 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
891 format_tcp_connection_id (u8 * s, va_list * args)
893 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
898 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
899 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
900 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
901 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
905 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
906 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
907 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
908 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
915 format_tcp_connection (u8 * s, va_list * args)
917 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
918 u32 verbose = va_arg (*args, u32);
922 s = format (s, "%-50U", format_tcp_connection_id, tc);
925 s = format (s, "%-15U", format_tcp_state, tc->state);
927 s = format (s, "\n%U", format_tcp_vars, tc);
934 format_tcp_session (u8 * s, va_list * args)
936 u32 tci = va_arg (*args, u32);
937 u32 thread_index = va_arg (*args, u32);
938 u32 verbose = va_arg (*args, u32);
939 tcp_connection_t *tc;
941 tc = tcp_connection_get (tci, thread_index);
943 s = format (s, "%U", format_tcp_connection, tc, verbose);
945 s = format (s, "empty\n");
950 format_tcp_listener_session (u8 * s, va_list * args)
952 u32 tci = va_arg (*args, u32);
953 u32 verbose = va_arg (*args, u32);
954 tcp_connection_t *tc = tcp_listener_get (tci);
955 s = format (s, "%-50U", format_tcp_connection_id, tc);
957 s = format (s, "%-15U", format_tcp_state, tc->state);
962 format_tcp_half_open_session (u8 * s, va_list * args)
964 u32 tci = va_arg (*args, u32);
965 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
966 return format (s, "%U", format_tcp_connection_id, tc);
970 format_tcp_sacks (u8 * s, va_list * args)
972 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
973 sack_block_t *sacks = tc->snd_sacks;
977 len = vec_len (sacks);
978 for (i = 0; i < len - 1; i++)
981 s = format (s, " start %u end %u\n", block->start - tc->irs,
982 block->end - tc->irs);
986 block = &sacks[len - 1];
987 s = format (s, " start %u end %u", block->start - tc->irs,
988 block->end - tc->irs);
994 format_tcp_rcv_sacks (u8 * s, va_list * args)
996 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
997 sack_block_t *sacks = tc->rcv_opts.sacks;
1001 len = vec_len (sacks);
1002 for (i = 0; i < len - 1; i++)
1005 s = format (s, " start %u end %u\n", block->start - tc->iss,
1006 block->end - tc->iss);
1010 block = &sacks[len - 1];
1011 s = format (s, " start %u end %u", block->start - tc->iss,
1012 block->end - tc->iss);
1018 format_tcp_sack_hole (u8 * s, va_list * args)
1020 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1021 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1023 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1025 s = format (s, " [%u, %u]", hole->start, hole->end);
1030 format_tcp_scoreboard (u8 * s, va_list * args)
1032 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1033 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1034 sack_scoreboard_hole_t *hole;
1035 u32 indent = format_get_indent (s);
1037 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1038 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1039 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1040 format_white_space, indent, sb->last_bytes_delivered,
1041 sb->high_sacked - tc->iss, sb->snd_una_adv);
1042 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1043 format_white_space, indent, sb->cur_rxt_hole,
1044 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1046 hole = scoreboard_first_hole (sb);
1048 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1049 indent, sb->head, sb->tail, pool_elts (sb->holes),
1050 format_white_space, indent);
1054 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1055 hole = scoreboard_next_hole (sb, hole);
1061 static transport_connection_t *
1062 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1064 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1065 return &tc->connection;
1068 static transport_connection_t *
1069 tcp_half_open_session_get_transport (u32 conn_index)
1071 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1072 return &tc->connection;
1076 * Compute maximum segment size for session layer.
1078 * Since the result needs to be the actual data length, it first computes
1079 * the tcp options to be used in the next burst and subtracts their
1080 * length from the connection's snd_mss.
1083 tcp_session_send_mss (transport_connection_t * trans_conn)
1085 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1087 /* Ensure snd_mss does accurately reflect the amount of data we can push
1088 * in a segment. This also makes sure that options are updated according to
1089 * the current state of the connection. */
1090 tcp_update_burst_snd_vars (tc);
1096 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1098 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1100 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1103 /* If not snd_wnd constrained and we can't write at least a segment,
1104 * don't try at all */
1105 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1106 return snd_space < tc->cwnd ? 0 : snd_space;
1108 /* round down to mss multiple */
1109 return snd_space - (snd_space % tc->snd_mss);
1113 * Compute tx window session is allowed to fill.
1115 * Takes into account available send space, snd_mss and the congestion
1116 * state of the connection. If possible, the value returned is a multiple
1119 * @param tc tcp connection
1120 * @return number of bytes session is allowed to write
1123 tcp_snd_space_inline (tcp_connection_t * tc)
1125 int snd_space, snt_limited;
1127 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1128 || tc->state == TCP_STATE_CLOSED))
1131 snd_space = tcp_available_output_snd_space (tc);
1133 /* If we haven't gotten dupacks or if we did and have gotten sacked
1134 * bytes then we can still send as per Limited Transmit (RFC3042) */
1135 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1136 && (tcp_opts_sack_permitted (tc)
1137 && tc->sack_sb.last_sacked_bytes == 0)))
1139 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1140 tc->limited_transmit = tc->snd_nxt;
1141 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1143 snt_limited = tc->snd_nxt - tc->limited_transmit;
1144 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1146 return tcp_round_snd_space (tc, snd_space);
1150 tcp_snd_space (tcp_connection_t * tc)
1152 return tcp_snd_space_inline (tc);
1156 tcp_session_send_space (transport_connection_t * trans_conn)
1158 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1159 return clib_min (tcp_snd_space_inline (tc),
1160 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1164 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1166 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1168 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1170 /* This still works if fast retransmit is on */
1171 return (tc->snd_nxt - tc->snd_una);
1175 tcp_update_time (f64 now, u8 thread_index)
1177 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1179 tcp_set_time_now (wrk);
1180 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1181 tcp_do_fastretransmits (wrk);
1182 tcp_send_acks (wrk);
1183 tcp_flush_frames_to_output (wrk);
1187 tcp_session_flush_data (transport_connection_t * tconn)
1189 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1190 if (tc->flags & TCP_CONN_PSH_PENDING)
1192 tc->flags |= TCP_CONN_PSH_PENDING;
1193 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1197 const static transport_proto_vft_t tcp_proto = {
1198 .enable = vnet_tcp_enable_disable,
1199 .start_listen = tcp_session_bind,
1200 .stop_listen = tcp_session_unbind,
1201 .push_header = tcp_session_push_header,
1202 .get_connection = tcp_session_get_transport,
1203 .get_listener = tcp_session_get_listener,
1204 .get_half_open = tcp_half_open_session_get_transport,
1205 .connect = tcp_session_open,
1206 .close = tcp_session_close,
1207 .cleanup = tcp_session_cleanup,
1208 .send_mss = tcp_session_send_mss,
1209 .send_space = tcp_session_send_space,
1210 .update_time = tcp_update_time,
1211 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1212 .flush_data = tcp_session_flush_data,
1213 .format_connection = format_tcp_session,
1214 .format_listener = format_tcp_listener_session,
1215 .format_half_open = format_tcp_half_open_session,
1216 .tx_type = TRANSPORT_TX_PEEK,
1217 .service_type = TRANSPORT_SERVICE_VC,
1222 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1227 if (!transport_connection_is_tx_paced (&tc->connection))
1230 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1231 /* TODO should constrain to interface's max throughput but
1232 * we don't have link speeds for sw ifs ..*/
1233 rate = tc->cwnd / srtt;
1234 transport_connection_tx_pacer_update (&tc->connection, rate);
1238 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1241 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1242 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1243 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1244 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1245 start_bucket, last_time);
1249 tcp_timer_keep_handler (u32 conn_index)
1251 u32 thread_index = vlib_get_thread_index ();
1252 tcp_connection_t *tc;
1254 tc = tcp_connection_get (conn_index, thread_index);
1255 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1257 tcp_connection_close (tc);
1261 tcp_timer_establish_handler (u32 conn_index)
1263 tcp_connection_t *tc;
1265 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1266 /* note: the connection may have already disappeared */
1267 if (PREDICT_FALSE (tc == 0))
1269 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1270 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1271 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1272 tcp_connection_timers_reset (tc);
1273 /* Start cleanup. Do NOT delete the session until we do the connection
1274 * cleanup. Otherwise, we end up with a dangling session index in the
1275 * tcp connection. */
1276 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1280 tcp_timer_establish_ao_handler (u32 conn_index)
1282 tcp_connection_t *tc;
1284 tc = tcp_half_open_connection_get (conn_index);
1288 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1289 /* Notify app if we haven't tried to clean this up already */
1290 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1291 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1293 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1294 tcp_connection_cleanup (tc);
1298 tcp_timer_waitclose_handler (u32 conn_index)
1300 u32 thread_index = vlib_get_thread_index ();
1301 tcp_connection_t *tc;
1303 tc = tcp_connection_get (conn_index, thread_index);
1306 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1310 case TCP_STATE_CLOSE_WAIT:
1311 tcp_connection_timers_reset (tc);
1312 session_transport_closed_notify (&tc->connection);
1314 if (!(tc->flags & TCP_CONN_FINPNDG))
1316 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1317 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1321 /* Session didn't come back with a close. Send FIN either way
1322 * and switch to LAST_ACK. */
1323 tcp_cong_recovery_off (tc);
1324 /* Make sure we don't try to send unsent data */
1325 tc->snd_nxt = tc->snd_una;
1327 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1329 /* Make sure we don't wait in LAST ACK forever */
1330 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1332 /* Don't delete the connection yet */
1334 case TCP_STATE_FIN_WAIT_1:
1335 tcp_connection_timers_reset (tc);
1336 if (tc->flags & TCP_CONN_FINPNDG)
1338 /* If FIN pending, we haven't sent everything, but we did try.
1339 * Notify session layer that transport is closed. */
1340 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1341 session_transport_closed_notify (&tc->connection);
1342 tcp_send_reset (tc);
1343 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1347 /* We've sent the fin but no progress. Close the connection and
1348 * to make sure everything is flushed, setup a cleanup timer */
1349 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1350 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1353 case TCP_STATE_LAST_ACK:
1354 case TCP_STATE_CLOSING:
1355 tcp_connection_timers_reset (tc);
1356 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1357 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1358 session_transport_closed_notify (&tc->connection);
1361 tcp_connection_del (tc);
1367 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1369 tcp_timer_retransmit_handler,
1370 tcp_timer_delack_handler,
1371 tcp_timer_persist_handler,
1372 tcp_timer_keep_handler,
1373 tcp_timer_waitclose_handler,
1374 tcp_timer_retransmit_syn_handler,
1375 tcp_timer_establish_handler,
1376 tcp_timer_establish_ao_handler,
1381 tcp_expired_timers_dispatch (u32 * expired_timers)
1384 u32 connection_index, timer_id;
1386 for (i = 0; i < vec_len (expired_timers); i++)
1388 /* Get session index and timer id */
1389 connection_index = expired_timers[i] & 0x0FFFFFFF;
1390 timer_id = expired_timers[i] >> 28;
1392 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1394 /* Handle expiration */
1395 (*timer_expiration_handlers[timer_id]) (connection_index);
1400 tcp_initialize_timer_wheels (tcp_main_t * tm)
1402 tw_timer_wheel_16t_2w_512sl_t *tw;
1404 foreach_vlib_main (({
1405 tw = &tm->wrk_ctx[ii].timer_wheel;
1406 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1407 100e-3 /* timer period 100ms */ , ~0);
1408 tw->last_run_time = vlib_time_now (this_vlib_main);
1414 tcp_initialize_iss_seed (tcp_main_t * tm)
1416 u32 default_seed = random_default_seed ();
1417 u64 time_now = clib_cpu_time_now ();
1419 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1420 tm->iss_seed.second = random_u64 (&time_now);
1423 static clib_error_t *
1424 tcp_main_enable (vlib_main_t * vm)
1426 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1427 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1428 tcp_connection_t *tc __attribute__ ((unused));
1429 tcp_main_t *tm = vnet_get_tcp_main ();
1430 clib_error_t *error = 0;
1433 if ((error = vlib_call_init_function (vm, ip_main_init)))
1435 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1437 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1444 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1445 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1448 * Initialize data structures
1451 num_threads = 1 /* main thread */ + vtm->n_threads;
1452 vec_validate (tm->connections, num_threads - 1);
1453 vec_validate (tm->wrk_ctx, num_threads - 1);
1454 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1455 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1457 for (thread = 0; thread < num_threads; thread++)
1459 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1460 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1461 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1462 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1463 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1464 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1465 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1466 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1467 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1468 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1469 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1470 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1471 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1474 * Preallocate connections. Assume that thread 0 won't
1475 * use preallocated threads when running multi-core
1477 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1478 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1482 * Use a preallocated half-open connection pool?
1484 if (tm->preallocated_half_open_connections)
1485 pool_init_fixed (tm->half_open_connections,
1486 tm->preallocated_half_open_connections);
1488 /* Initialize clocks per tick for TCP timestamp. Used to compute
1489 * monotonically increasing timestamps. */
1490 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1491 / TCP_TSTAMP_RESOLUTION;
1493 if (num_threads > 1)
1495 clib_spinlock_init (&tm->half_open_lock);
1498 tcp_initialize_timer_wheels (tm);
1499 tcp_initialize_iss_seed (tm);
1501 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1507 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1511 if (tcp_main.is_enabled)
1514 return tcp_main_enable (vm);
1518 tcp_main.is_enabled = 0;
1525 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1527 tcp_main_t *tm = &tcp_main;
1529 tm->punt_unknown4 = is_add;
1531 tm->punt_unknown6 = is_add;
1534 static clib_error_t *
1535 tcp_init (vlib_main_t * vm)
1537 tcp_main_t *tm = vnet_get_tcp_main ();
1538 ip_main_t *im = &ip_main;
1539 ip_protocol_info_t *pi;
1541 /* Session layer, and by implication tcp, are disabled by default */
1544 /* Register with IP for header parsing */
1545 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1547 return clib_error_return (0, "TCP protocol info AWOL");
1548 pi->format_header = format_tcp_header;
1549 pi->unformat_pg_edit = unformat_pg_tcp_header;
1551 /* Register as transport with session layer */
1552 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1553 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1554 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1555 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1557 tcp_api_reference ();
1558 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1560 tm->cc_algo = TCP_CC_NEWRENO;
1561 tm->default_mtu = 1460;
1565 VLIB_INIT_FUNCTION (tcp_init);
1568 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1570 uword *result = va_arg (*va, uword *);
1571 tcp_main_t *tm = &tcp_main;
1576 if (unformat (input, "%s", &cc_algo_name)
1577 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1583 vec_free (cc_algo_name);
1588 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1590 tcp_main_t *tm = vnet_get_tcp_main ();
1591 tcp_cc_algorithm_t *cc_alg;
1592 unformat_input_t sub_input;
1595 vec_foreach (cc_alg, tm->cc_algos)
1597 if (!unformat (input, cc_alg->name))
1600 if (cc_alg->unformat_cfg
1601 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1603 if (cc_alg->unformat_cfg (&sub_input))
1610 static clib_error_t *
1611 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1613 tcp_main_t *tm = vnet_get_tcp_main ();
1615 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1617 if (unformat (input, "preallocated-connections %d",
1618 &tm->preallocated_connections))
1620 else if (unformat (input, "preallocated-half-open-connections %d",
1621 &tm->preallocated_half_open_connections))
1623 else if (unformat (input, "buffer-fail-fraction %f",
1624 &tm->buffer_fail_fraction))
1626 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1629 else if (unformat (input, "mtu %d", &tm->default_mtu))
1631 else if (unformat (input, "no-tx-pacing"))
1633 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1636 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1639 return clib_error_return (0, "unknown input `%U'",
1640 format_unformat_error, input);
1645 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1649 * \brief Configure an ipv4 source address range
1650 * @param vm vlib_main_t pointer
1651 * @param start first ipv4 address in the source address range
1652 * @param end last ipv4 address in the source address range
1653 * @param table_id VRF / table ID, 0 for the default FIB
1654 * @return 0 if all OK, else an error indication from api_errno.h
1658 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1659 ip4_address_t * start,
1660 ip4_address_t * end, u32 table_id)
1662 tcp_main_t *tm = vnet_get_tcp_main ();
1663 vnet_main_t *vnm = vnet_get_main ();
1664 u32 start_host_byte_order, end_host_byte_order;
1665 fib_prefix_t prefix;
1666 fib_node_index_t fei;
1671 clib_memset (&prefix, 0, sizeof (prefix));
1673 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1675 if (fib_index == ~0)
1676 return VNET_API_ERROR_NO_SUCH_FIB;
1678 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1679 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1681 /* sanity check for reversed args or some such */
1682 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1683 return VNET_API_ERROR_INVALID_ARGUMENT;
1685 /* Lookup the last address, to identify the interface involved */
1687 prefix.fp_proto = FIB_PROTOCOL_IP4;
1688 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1690 fei = fib_table_lookup (fib_index, &prefix);
1692 /* Couldn't find route to destination. Bail out. */
1693 if (fei == FIB_NODE_INDEX_INVALID)
1694 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1696 sw_if_index = fib_entry_get_resolving_interface (fei);
1698 /* Configure proxy arp across the range */
1699 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1704 rv = vnet_proxy_arp_enable_disable (vnm, sw_if_index, 1);
1711 dpo_id_t dpo = DPO_INVALID;
1713 vec_add1 (tm->ip4_src_addresses, start[0]);
1715 /* Add local adjacencies for the range */
1717 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1720 prefix.fp_proto = FIB_PROTOCOL_IP4;
1721 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1723 fib_table_entry_special_dpo_update (fib_index,
1726 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1729 start_host_byte_order++;
1730 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1732 while (start_host_byte_order <= end_host_byte_order);
1738 * \brief Configure an ipv6 source address range
1739 * @param vm vlib_main_t pointer
1740 * @param start first ipv6 address in the source address range
1741 * @param end last ipv6 address in the source address range
1742 * @param table_id VRF / table ID, 0 for the default FIB
1743 * @return 0 if all OK, else an error indication from api_errno.h
1747 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1748 ip6_address_t * start,
1749 ip6_address_t * end, u32 table_id)
1751 tcp_main_t *tm = vnet_get_tcp_main ();
1752 fib_prefix_t prefix;
1754 fib_node_index_t fei;
1757 clib_memset (&prefix, 0, sizeof (prefix));
1759 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1761 if (fib_index == ~0)
1762 return VNET_API_ERROR_NO_SUCH_FIB;
1768 dpo_id_t dpo = DPO_INVALID;
1770 /* Remember this address */
1771 vec_add1 (tm->ip6_src_addresses, start[0]);
1773 /* Lookup the prefix, to identify the interface involved */
1774 prefix.fp_len = 128;
1775 prefix.fp_proto = FIB_PROTOCOL_IP6;
1776 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1778 fei = fib_table_lookup (fib_index, &prefix);
1780 /* Couldn't find route to destination. Bail out. */
1781 if (fei == FIB_NODE_INDEX_INVALID)
1782 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1784 sw_if_index = fib_entry_get_resolving_interface (fei);
1786 if (sw_if_index == (u32) ~ 0)
1787 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1789 /* Add a proxy neighbor discovery entry for this address */
1790 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1792 /* Add a receive adjacency for this address */
1793 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1796 fib_table_entry_special_dpo_update (fib_index,
1799 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1802 /* Done with the entire range? */
1803 if (!memcmp (start, end, sizeof (start[0])))
1806 /* Increment the address. DGMS. */
1808 for (i = 15; i >= 0; i--)
1811 if (tmp.as_u8[i] != 0)
1819 static clib_error_t *
1820 tcp_src_address (vlib_main_t * vm,
1821 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1823 ip4_address_t v4start, v4end;
1824 ip6_address_t v6start, v6end;
1830 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1832 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1833 unformat_ip4_address, &v4end))
1835 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1837 memcpy (&v4end, &v4start, sizeof (v4start));
1840 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1841 unformat_ip6_address, &v6end))
1843 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1845 memcpy (&v6end, &v6start, sizeof (v6start));
1848 else if (unformat (input, "fib-table %d", &table_id))
1854 if (!v4set && !v6set)
1855 return clib_error_return (0, "at least one v4 or v6 address required");
1859 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1866 case VNET_API_ERROR_NO_SUCH_FIB:
1867 return clib_error_return (0, "Invalid table-id %d", table_id);
1869 case VNET_API_ERROR_INVALID_ARGUMENT:
1870 return clib_error_return (0, "Invalid address range %U - %U",
1871 format_ip4_address, &v4start,
1872 format_ip4_address, &v4end);
1874 return clib_error_return (0, "error %d", rv);
1880 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1887 case VNET_API_ERROR_NO_SUCH_FIB:
1888 return clib_error_return (0, "Invalid table-id %d", table_id);
1891 return clib_error_return (0, "error %d", rv);
1899 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1901 .path = "tcp src-address",
1902 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1903 .function = tcp_src_address,
1908 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1910 #if TCP_SCOREBOARD_TRACE
1912 scoreboard_trace_elt_t *block;
1918 s = format (s, "scoreboard trace:");
1919 vec_foreach (block, sb->trace)
1921 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1922 block->ack, block->snd_una_max, block->group);
1924 s = format (s, "\n");
1932 static clib_error_t *
1933 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1934 vlib_cli_command_t * cmd_arg)
1936 transport_connection_t *tconn = 0;
1937 tcp_connection_t *tc;
1939 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1941 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1942 TRANSPORT_PROTO_TCP))
1945 return clib_error_return (0, "unknown input `%U'",
1946 format_unformat_error, input);
1949 if (!TCP_SCOREBOARD_TRACE)
1951 vlib_cli_output (vm, "scoreboard tracing not enabled");
1955 tc = tcp_get_connection_from_transport (tconn);
1956 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1957 vlib_cli_output (vm, "%v", s);
1962 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1964 .path = "show tcp scoreboard trace",
1965 .short_help = "show tcp scoreboard trace <connection>",
1966 .function = tcp_show_scoreboard_trace_fn,
1971 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1974 scoreboard_trace_elt_t *trace;
1975 u32 next_ack, left, group, has_new_ack = 0;
1976 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1977 sack_block_t *block;
1979 if (!TCP_SCOREBOARD_TRACE)
1981 s = format (s, "scoreboard tracing not enabled");
1988 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1989 tcp_connection_timers_init (dummy_tc);
1990 scoreboard_init (&dummy_tc->sack_sb);
1991 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1993 #if TCP_SCOREBOARD_TRACE
1994 trace = tc->sack_sb.trace;
1995 trace_len = vec_len (tc->sack_sb.trace);
1998 for (i = 0; i < trace_len; i++)
2000 if (trace[i].ack != 0)
2002 dummy_tc->snd_una = trace[i].ack - 1448;
2003 dummy_tc->snd_una_max = trace[i].ack;
2008 while (left < trace_len)
2010 group = trace[left].group;
2011 vec_reset_length (dummy_tc->rcv_opts.sacks);
2013 while (trace[left].group == group)
2015 if (trace[left].ack != 0)
2018 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2019 trace[left].ack, trace[left].snd_una_max);
2020 dummy_tc->snd_una_max = trace[left].snd_una_max;
2021 next_ack = trace[left].ack;
2027 s = format (s, "[%u, %u], ", trace[left].start,
2029 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2030 block->start = trace[left].start;
2031 block->end = trace[left].end;
2037 tcp_rcv_sacks (dummy_tc, next_ack);
2039 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2042 s = format (s, "result: %U", format_tcp_scoreboard,
2043 &dummy_tc->sack_sb);
2046 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2051 static clib_error_t *
2052 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2053 vlib_cli_command_t * cmd_arg)
2055 transport_connection_t *tconn = 0;
2056 tcp_connection_t *tc = 0;
2058 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2060 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2061 TRANSPORT_PROTO_TCP))
2064 return clib_error_return (0, "unknown input `%U'",
2065 format_unformat_error, input);
2068 if (!TCP_SCOREBOARD_TRACE)
2070 vlib_cli_output (vm, "scoreboard tracing not enabled");
2074 tc = tcp_get_connection_from_transport (tconn);
2077 vlib_cli_output (vm, "connection not found");
2080 str = tcp_scoreboard_replay (str, tc, 1);
2081 vlib_cli_output (vm, "%v", str);
2086 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2088 .path = "tcp replay scoreboard",
2089 .short_help = "tcp replay scoreboard <connection>",
2090 .function = tcp_scoreboard_trace_fn,
2094 static clib_error_t *
2095 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2096 vlib_cli_command_t * cmd_arg)
2098 tcp_main_t *tm = vnet_get_tcp_main ();
2099 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2100 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2102 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2103 tm->punt_unknown4 ? "enabled" : "disabled");
2104 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2105 tm->punt_unknown6 ? "enabled" : "disabled");
2109 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2111 .path = "show tcp punt",
2112 .short_help = "show tcp punt",
2113 .function = show_tcp_punt_fn,
2118 * fd.io coding-style-patch-verification: ON
2121 * eval: (c-set-style "gnu")