2 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 * @brief TCP host stack utilities
21 #include <vnet/tcp/tcp.h>
22 #include <vnet/session/session.h>
23 #include <vnet/fib/fib.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/dpo/receive_dpo.h>
26 #include <vnet/ip/ip6_neighbor.h>
33 fib_protocol_t nh_proto;
34 vnet_link_t link_type;
38 } tcp_add_del_adj_args_t;
41 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
46 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
51 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
53 if (ai != ADJ_INDEX_INVALID)
59 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
61 tcp_add_del_adj_args_t args = {
62 .nh_proto = FIB_PROTOCOL_IP6,
63 .link_type = VNET_LINK_IP6,
65 .sw_if_index = tc->sw_if_index,
68 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
73 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
75 tcp_main_t *tm = &tcp_main;
76 tcp_connection_t *listener;
79 pool_get (tm->listener_pool, listener);
80 clib_memset (listener, 0, sizeof (*listener));
82 listener->c_c_index = listener - tm->listener_pool;
83 listener->c_lcl_port = lcl->port;
85 /* If we are provided a sw_if_index, bind using one of its ips */
86 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
88 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
90 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
92 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
93 listener->c_is_ip4 = lcl->is_ip4;
94 listener->c_proto = TRANSPORT_PROTO_TCP;
95 listener->c_s_index = session_index;
96 listener->c_fib_index = lcl->fib_index;
97 listener->state = TCP_STATE_LISTEN;
99 tcp_connection_timers_init (listener);
101 TCP_EVT_DBG (TCP_EVT_BIND, listener);
103 return listener->c_c_index;
107 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
109 return tcp_connection_bind (session_index, tep);
113 tcp_connection_unbind (u32 listener_index)
115 tcp_main_t *tm = vnet_get_tcp_main ();
116 tcp_connection_t *tc;
118 tc = pool_elt_at_index (tm->listener_pool, listener_index);
120 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
122 /* Poison the entry */
124 clib_memset (tc, 0xFA, sizeof (*tc));
126 pool_put_index (tm->listener_pool, listener_index);
130 tcp_session_unbind (u32 listener_index)
132 tcp_connection_unbind (listener_index);
136 static transport_connection_t *
137 tcp_session_get_listener (u32 listener_index)
139 tcp_main_t *tm = vnet_get_tcp_main ();
140 tcp_connection_t *tc;
141 tc = pool_elt_at_index (tm->listener_pool, listener_index);
142 return &tc->connection;
146 * Cleanup half-open connection
150 tcp_half_open_connection_del (tcp_connection_t * tc)
152 tcp_main_t *tm = vnet_get_tcp_main ();
153 clib_spinlock_lock_if_init (&tm->half_open_lock);
154 pool_put_index (tm->half_open_connections, tc->c_c_index);
156 clib_memset (tc, 0xFA, sizeof (*tc));
157 clib_spinlock_unlock_if_init (&tm->half_open_lock);
161 * Try to cleanup half-open connection
163 * If called from a thread that doesn't own tc, the call won't have any
166 * @param tc - connection to be cleaned up
167 * @return non-zero if cleanup failed.
170 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
172 /* Make sure this is the owning thread */
173 if (tc->c_thread_index != vlib_get_thread_index ())
175 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH_AO);
176 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
177 tcp_half_open_connection_del (tc);
181 static tcp_connection_t *
182 tcp_half_open_connection_new (void)
184 tcp_main_t *tm = vnet_get_tcp_main ();
185 tcp_connection_t *tc = 0;
186 ASSERT (vlib_get_thread_index () == 0);
187 pool_get (tm->half_open_connections, tc);
188 clib_memset (tc, 0, sizeof (*tc));
189 tc->c_c_index = tc - tm->half_open_connections;
194 * Cleans up connection state.
199 tcp_connection_cleanup (tcp_connection_t * tc)
201 tcp_main_t *tm = &tcp_main;
203 /* Cleanup local endpoint if this was an active connect */
204 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
207 /* Check if connection is not yet fully established */
208 if (tc->state == TCP_STATE_SYN_SENT)
210 /* Try to remove the half-open connection. If this is not the owning
211 * thread, tc won't be removed. Retransmit or establish timers will
212 * eventually expire and call again cleanup on the right thread. */
213 if (tcp_half_open_connection_cleanup (tc))
214 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
218 int thread_index = tc->c_thread_index;
220 /* Make sure all timers are cleared */
221 tcp_connection_timers_reset (tc);
223 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
224 tcp_add_del_adjacency (tc, 0);
226 vec_free (tc->snd_sacks);
227 vec_free (tc->snd_sacks_fl);
229 /* Poison the entry */
231 clib_memset (tc, 0xFA, sizeof (*tc));
232 pool_put (tm->connections[thread_index], tc);
237 * Connection removal.
239 * This should be called only once connection enters CLOSED state. Note
240 * that it notifies the session of the removal event, so if the goal is to
241 * just remove the connection, call tcp_connection_cleanup instead.
244 tcp_connection_del (tcp_connection_t * tc)
246 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
247 session_transport_delete_notify (&tc->connection);
248 tcp_connection_cleanup (tc);
252 tcp_connection_alloc (u8 thread_index)
254 tcp_main_t *tm = vnet_get_tcp_main ();
255 tcp_connection_t *tc;
257 pool_get (tm->connections[thread_index], tc);
258 clib_memset (tc, 0, sizeof (*tc));
259 tc->c_c_index = tc - tm->connections[thread_index];
260 tc->c_thread_index = thread_index;
265 tcp_connection_free (tcp_connection_t * tc)
267 tcp_main_t *tm = &tcp_main;
268 pool_put (tm->connections[tc->c_thread_index], tc);
270 clib_memset (tc, 0xFA, sizeof (*tc));
273 /** Notify session that connection has been reset.
275 * Switch state to closed and wait for session to call cleanup.
278 tcp_connection_reset (tcp_connection_t * tc)
280 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
283 case TCP_STATE_SYN_RCVD:
284 /* Cleanup everything. App wasn't notified yet */
285 session_transport_delete_notify (&tc->connection);
286 tcp_connection_cleanup (tc);
288 case TCP_STATE_SYN_SENT:
289 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
290 tcp_connection_cleanup (tc);
292 case TCP_STATE_ESTABLISHED:
293 tcp_connection_timers_reset (tc);
294 /* Set the cleanup timer, in case the session layer/app don't
295 * cleanly close the connection */
296 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
297 session_transport_reset_notify (&tc->connection);
298 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
300 case TCP_STATE_CLOSE_WAIT:
301 case TCP_STATE_FIN_WAIT_1:
302 case TCP_STATE_FIN_WAIT_2:
303 case TCP_STATE_CLOSING:
304 case TCP_STATE_LAST_ACK:
305 tcp_connection_timers_reset (tc);
306 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
307 /* Make sure we mark the session as closed. In some states we may
308 * be still trying to send data */
309 session_transport_closed_notify (&tc->connection);
310 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
312 case TCP_STATE_CLOSED:
313 case TCP_STATE_TIME_WAIT:
316 TCP_DBG ("reset state: %u", tc->state);
321 * Begin connection closing procedure.
323 * If at the end the connection is not in CLOSED state, it is not removed.
324 * Instead, we rely on on TCP to advance through state machine to either
325 * 1) LAST_ACK (passive close) whereby when the last ACK is received
326 * tcp_connection_del is called. This notifies session of the delete and
328 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
329 * and cleanup is called.
331 * N.B. Half-close connections are not supported
334 tcp_connection_close (tcp_connection_t * tc)
336 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
338 /* Send/Program FIN if needed and switch state */
341 case TCP_STATE_SYN_SENT:
342 /* Try to cleanup. If not on the right thread, mark as half-open done.
343 * Connection will be cleaned up when establish timer pops */
344 tcp_connection_cleanup (tc);
346 case TCP_STATE_SYN_RCVD:
347 tcp_connection_timers_reset (tc);
349 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
350 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
352 case TCP_STATE_ESTABLISHED:
353 /* If closing with unread data, reset the connection */
354 if (transport_max_rx_dequeue (&tc->connection))
357 tcp_connection_timers_reset (tc);
358 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
359 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
362 if (!transport_max_tx_dequeue (&tc->connection))
365 tc->flags |= TCP_CONN_FINPNDG;
366 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
367 /* Set a timer in case the peer stops responding. Otherwise the
368 * connection will be stuck here forever. */
369 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
370 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
372 case TCP_STATE_CLOSE_WAIT:
373 if (!transport_max_tx_dequeue (&tc->connection))
376 tcp_connection_timers_reset (tc);
377 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
378 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
381 tc->flags |= TCP_CONN_FINPNDG;
383 case TCP_STATE_FIN_WAIT_1:
384 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
386 case TCP_STATE_CLOSED:
387 tcp_connection_timers_reset (tc);
388 /* Delete connection but instead of doing it now wait until next
389 * dispatch cycle to give the session layer a chance to clear
390 * unhandled events */
391 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
394 TCP_DBG ("state: %u", tc->state);
399 tcp_session_close (u32 conn_index, u32 thread_index)
401 tcp_connection_t *tc;
402 tc = tcp_connection_get (conn_index, thread_index);
403 tcp_connection_close (tc);
407 tcp_session_cleanup (u32 conn_index, u32 thread_index)
409 tcp_connection_t *tc;
410 tc = tcp_connection_get (conn_index, thread_index);
411 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
412 tcp_connection_cleanup (tc);
416 * Initialize all connection timers as invalid
419 tcp_connection_timers_init (tcp_connection_t * tc)
423 /* Set all to invalid */
424 for (i = 0; i < TCP_N_TIMERS; i++)
426 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
429 tc->rto = TCP_RTO_INIT;
433 * Stop all connection timers
436 tcp_connection_timers_reset (tcp_connection_t * tc)
439 for (i = 0; i < TCP_N_TIMERS; i++)
441 tcp_timer_reset (tc, i);
446 typedef struct ip4_tcp_hdr
452 typedef struct ip6_tcp_hdr
459 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
462 const dpo_id_t *choice;
466 lb = load_balance_get (dpo->dpoi_index);
470 clib_memset (&hdr, 0, sizeof (hdr));
471 hdr.ip.protocol = IP_PROTOCOL_TCP;
472 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
473 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
474 hdr.tcp.src_port = tc->c_lcl_port;
475 hdr.tcp.dst_port = tc->c_rmt_port;
476 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
481 clib_memset (&hdr, 0, sizeof (hdr));
482 hdr.ip.protocol = IP_PROTOCOL_TCP;
483 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
484 sizeof (ip6_address_t));
485 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
486 sizeof (ip6_address_t));
487 hdr.tcp.src_port = tc->c_lcl_port;
488 hdr.tcp.dst_port = tc->c_rmt_port;
489 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
491 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
492 dpo_copy (result, choice);
496 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
501 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
502 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
503 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
504 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
505 return fib_table_lookup (fib_index, &prefix);
509 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
511 dpo_id_t choice = DPO_INVALID;
512 u32 output_node_index;
515 fe = fib_entry_get (tc->c_rmt_fei);
516 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
519 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
522 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
523 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
527 /** Stack tcp connection on peer's fib entry.
529 * This ultimately populates the dpo the connection will use to send packets.
532 tcp_connection_fib_attach (tcp_connection_t * tc)
534 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
536 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
538 tcp_connection_stack_on_fib_entry (tc);
543 tcp_cc_init (tcp_connection_t * tc)
545 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
546 tc->cc_algo->init (tc);
550 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
551 const tcp_cc_algorithm_t * vft)
553 tcp_main_t *tm = vnet_get_tcp_main ();
554 vec_validate (tm->cc_algos, type);
556 tm->cc_algos[type] = *vft;
557 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
561 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
563 tcp_main_t *tm = vnet_get_tcp_main ();
564 return &tm->cc_algos[type];
568 * Generate random iss as per rfc6528
571 tcp_generate_random_iss (tcp_connection_t * tc)
573 tcp_main_t *tm = &tcp_main;
577 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
579 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
580 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
582 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
583 tmp ^= tm->iss_seed.second;
584 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
585 return ((tmp >> 32) ^ (tmp & 0xffffffff));
589 * Initialize connection send variables.
592 tcp_init_snd_vars (tcp_connection_t * tc)
595 * We use the time to randomize iss and for setting up the initial
596 * timestamp. Make sure it's updated otherwise syn and ack in the
597 * handshake may make it look as if time has flown in the opposite
600 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
602 tc->iss = tcp_generate_random_iss (tc);
603 tc->snd_una = tc->iss;
604 tc->snd_nxt = tc->iss + 1;
605 tc->snd_una_max = tc->snd_nxt;
610 tcp_enable_pacing (tcp_connection_t * tc)
612 u32 initial_bucket, byte_rate;
613 initial_bucket = 16 * tc->snd_mss;
615 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
617 tc->mrtt_us = (u32) ~ 0;
620 /** Initialize tcp connection variables
622 * Should be called after having received a msg from the peer, i.e., a SYN or
623 * a SYNACK, such that connection options have already been exchanged. */
625 tcp_connection_init_vars (tcp_connection_t * tc)
627 tcp_connection_timers_init (tc);
629 scoreboard_init (&tc->sack_sb);
631 if (tc->state == TCP_STATE_SYN_RCVD)
632 tcp_init_snd_vars (tc);
634 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
635 tcp_add_del_adjacency (tc, 1);
637 /* tcp_connection_fib_attach (tc); */
639 if (transport_connection_is_tx_paced (&tc->connection)
640 || tcp_main.tx_pacing)
641 tcp_enable_pacing (tc);
645 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
646 u16 * lcl_port, u8 is_ip4)
651 index = tm->last_v4_address_rotor++;
652 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
653 tm->last_v4_address_rotor = 0;
654 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
658 index = tm->last_v6_address_rotor++;
659 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
660 tm->last_v6_address_rotor = 0;
661 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
662 sizeof (ip6_address_t));
664 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
667 clib_warning ("Failed to allocate src port");
675 tcp_session_open (transport_endpoint_cfg_t * rmt)
677 tcp_main_t *tm = vnet_get_tcp_main ();
678 tcp_connection_t *tc;
679 ip46_address_t lcl_addr;
684 * Allocate local endpoint
686 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
687 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
688 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
691 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
692 rmt, &lcl_addr, &lcl_port);
698 * Create connection and send SYN
700 clib_spinlock_lock_if_init (&tm->half_open_lock);
701 tc = tcp_half_open_connection_new ();
702 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
703 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
704 tc->c_rmt_port = rmt->port;
705 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
706 tc->c_is_ip4 = rmt->is_ip4;
707 tc->c_proto = TRANSPORT_PROTO_TCP;
708 tc->c_fib_index = rmt->fib_index;
709 /* The other connection vars will be initialized after SYN ACK */
710 tcp_connection_timers_init (tc);
712 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
713 tc->state = TCP_STATE_SYN_SENT;
714 tcp_init_snd_vars (tc);
716 clib_spinlock_unlock_if_init (&tm->half_open_lock);
718 return tc->c_c_index;
721 const char *tcp_dbg_evt_str[] = {
722 #define _(sym, str) str,
727 const char *tcp_fsm_states[] = {
728 #define _(sym, str) str,
729 foreach_tcp_fsm_state
734 format_tcp_state (u8 * s, va_list * args)
736 u32 state = va_arg (*args, u32);
738 if (state < TCP_N_STATES)
739 s = format (s, "%s", tcp_fsm_states[state]);
741 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
745 const char *tcp_connection_flags_str[] = {
746 #define _(sym, str) str,
747 foreach_tcp_connection_flag
752 format_tcp_connection_flags (u8 * s, va_list * args)
754 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
757 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
758 if (tc->flags & (1 << i))
760 for (i = 0; i < last; i++)
762 if (tc->flags & (1 << i))
763 s = format (s, "%s, ", tcp_connection_flags_str[i]);
766 s = format (s, "%s", tcp_connection_flags_str[last]);
770 const char *tcp_conn_timers[] = {
771 #define _(sym, str) str,
777 format_tcp_timers (u8 * s, va_list * args)
779 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
782 for (i = 0; i < TCP_N_TIMERS; i++)
783 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
786 for (i = 0; i < last; i++)
788 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
789 s = format (s, "%s,", tcp_conn_timers[i]);
793 s = format (s, "%s", tcp_conn_timers[i]);
799 format_tcp_congestion_status (u8 * s, va_list * args)
801 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
802 if (tcp_in_recovery (tc))
803 s = format (s, "recovery");
804 else if (tcp_in_fastrecovery (tc))
805 s = format (s, "fastrecovery");
807 s = format (s, "none");
812 tcp_rcv_wnd_available (tcp_connection_t * tc)
814 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
818 format_tcp_congestion (u8 * s, va_list * args)
820 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
821 u32 indent = format_get_indent (s);
823 s = format (s, "%U ", format_tcp_congestion_status, tc);
824 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
825 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
826 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
827 format_white_space, indent, tcp_available_cc_snd_space (tc),
828 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
829 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
830 format_white_space, indent, tc->snd_congestion - tc->iss,
831 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
836 format_tcp_vars (u8 * s, va_list * args)
838 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
839 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
840 format_tcp_connection_flags, tc, format_tcp_timers, tc);
841 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
842 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
843 tc->snd_una_max - tc->iss);
844 s = format (s, " rcv_nxt %u rcv_las %u\n",
845 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
846 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
847 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
848 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
849 tc->snd_wl2 - tc->iss);
850 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
851 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
852 tcp_rcv_wnd_available (tc));
853 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
854 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
855 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
856 tcp_time_now () - tc->tsval_recent_age);
857 s = format (s, " snd_mss %u\n", tc->snd_mss);
858 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
859 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
861 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
862 s = format (s, " cong: %U", format_tcp_congestion, tc);
864 if (tc->state >= TCP_STATE_ESTABLISHED)
866 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
869 if (vec_len (tc->snd_sacks))
870 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
876 format_tcp_connection_id (u8 * s, va_list * args)
878 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
883 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
884 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
885 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
886 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
890 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
891 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
892 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
893 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
900 format_tcp_connection (u8 * s, va_list * args)
902 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
903 u32 verbose = va_arg (*args, u32);
907 s = format (s, "%-50U", format_tcp_connection_id, tc);
910 s = format (s, "%-15U", format_tcp_state, tc->state);
912 s = format (s, "\n%U", format_tcp_vars, tc);
919 format_tcp_session (u8 * s, va_list * args)
921 u32 tci = va_arg (*args, u32);
922 u32 thread_index = va_arg (*args, u32);
923 u32 verbose = va_arg (*args, u32);
924 tcp_connection_t *tc;
926 tc = tcp_connection_get (tci, thread_index);
928 s = format (s, "%U", format_tcp_connection, tc, verbose);
930 s = format (s, "empty\n");
935 format_tcp_listener_session (u8 * s, va_list * args)
937 u32 tci = va_arg (*args, u32);
938 u32 verbose = va_arg (*args, u32);
939 tcp_connection_t *tc = tcp_listener_get (tci);
940 s = format (s, "%-50U", format_tcp_connection_id, tc);
942 s = format (s, "%-15U", format_tcp_state, tc->state);
947 format_tcp_half_open_session (u8 * s, va_list * args)
949 u32 tci = va_arg (*args, u32);
950 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
951 return format (s, "%U", format_tcp_connection_id, tc);
955 format_tcp_sacks (u8 * s, va_list * args)
957 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
958 sack_block_t *sacks = tc->snd_sacks;
962 len = vec_len (sacks);
963 for (i = 0; i < len - 1; i++)
966 s = format (s, " start %u end %u\n", block->start - tc->irs,
967 block->end - tc->irs);
971 block = &sacks[len - 1];
972 s = format (s, " start %u end %u", block->start - tc->irs,
973 block->end - tc->irs);
979 format_tcp_rcv_sacks (u8 * s, va_list * args)
981 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
982 sack_block_t *sacks = tc->rcv_opts.sacks;
986 len = vec_len (sacks);
987 for (i = 0; i < len - 1; i++)
990 s = format (s, " start %u end %u\n", block->start - tc->iss,
991 block->end - tc->iss);
995 block = &sacks[len - 1];
996 s = format (s, " start %u end %u", block->start - tc->iss,
997 block->end - tc->iss);
1003 format_tcp_sack_hole (u8 * s, va_list * args)
1005 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1006 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1008 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1010 s = format (s, " [%u, %u]", hole->start, hole->end);
1015 format_tcp_scoreboard (u8 * s, va_list * args)
1017 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1018 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1019 sack_scoreboard_hole_t *hole;
1020 u32 indent = format_get_indent (s);
1022 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1023 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1024 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1025 format_white_space, indent, sb->last_bytes_delivered,
1026 sb->high_sacked - tc->iss, sb->snd_una_adv);
1027 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1028 format_white_space, indent, sb->cur_rxt_hole,
1029 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1031 hole = scoreboard_first_hole (sb);
1033 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1034 indent, sb->head, sb->tail, pool_elts (sb->holes),
1035 format_white_space, indent);
1039 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1040 hole = scoreboard_next_hole (sb, hole);
1046 static transport_connection_t *
1047 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1049 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1050 return &tc->connection;
1053 static transport_connection_t *
1054 tcp_half_open_session_get_transport (u32 conn_index)
1056 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1057 return &tc->connection;
1061 * Compute maximum segment size for session layer.
1063 * Since the result needs to be the actual data length, it first computes
1064 * the tcp options to be used in the next burst and subtracts their
1065 * length from the connection's snd_mss.
1068 tcp_session_send_mss (transport_connection_t * trans_conn)
1070 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1072 /* Ensure snd_mss does accurately reflect the amount of data we can push
1073 * in a segment. This also makes sure that options are updated according to
1074 * the current state of the connection. */
1075 tcp_update_burst_snd_vars (tc);
1081 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1083 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1085 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1088 /* If not snd_wnd constrained and we can't write at least a segment,
1089 * don't try at all */
1090 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1091 return snd_space < tc->cwnd ? 0 : snd_space;
1093 /* round down to mss multiple */
1094 return snd_space - (snd_space % tc->snd_mss);
1098 * Compute tx window session is allowed to fill.
1100 * Takes into account available send space, snd_mss and the congestion
1101 * state of the connection. If possible, the value returned is a multiple
1104 * @param tc tcp connection
1105 * @return number of bytes session is allowed to write
1108 tcp_snd_space_inline (tcp_connection_t * tc)
1110 int snd_space, snt_limited;
1112 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1113 || tc->state == TCP_STATE_CLOSED))
1116 snd_space = tcp_available_output_snd_space (tc);
1118 /* If we haven't gotten dupacks or if we did and have gotten sacked
1119 * bytes then we can still send as per Limited Transmit (RFC3042) */
1120 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1121 && (tcp_opts_sack_permitted (tc)
1122 && tc->sack_sb.last_sacked_bytes == 0)))
1124 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1125 tc->limited_transmit = tc->snd_nxt;
1126 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1128 snt_limited = tc->snd_nxt - tc->limited_transmit;
1129 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1131 return tcp_round_snd_space (tc, snd_space);
1135 tcp_snd_space (tcp_connection_t * tc)
1137 return tcp_snd_space_inline (tc);
1141 tcp_session_send_space (transport_connection_t * trans_conn)
1143 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1144 return clib_min (tcp_snd_space_inline (tc),
1145 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1149 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1151 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1153 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1155 /* This still works if fast retransmit is on */
1156 return (tc->snd_nxt - tc->snd_una);
1160 tcp_update_time (f64 now, u8 thread_index)
1162 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1164 tcp_set_time_now (wrk);
1165 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1166 tcp_do_fastretransmits (wrk);
1167 tcp_send_acks (wrk);
1168 tcp_flush_frames_to_output (wrk);
1172 tcp_session_flush_data (transport_connection_t * tconn)
1174 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1175 if (tc->flags & TCP_CONN_PSH_PENDING)
1177 tc->flags |= TCP_CONN_PSH_PENDING;
1178 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1182 const static transport_proto_vft_t tcp_proto = {
1183 .enable = vnet_tcp_enable_disable,
1184 .start_listen = tcp_session_bind,
1185 .stop_listen = tcp_session_unbind,
1186 .push_header = tcp_session_push_header,
1187 .get_connection = tcp_session_get_transport,
1188 .get_listener = tcp_session_get_listener,
1189 .get_half_open = tcp_half_open_session_get_transport,
1190 .connect = tcp_session_open,
1191 .close = tcp_session_close,
1192 .cleanup = tcp_session_cleanup,
1193 .send_mss = tcp_session_send_mss,
1194 .send_space = tcp_session_send_space,
1195 .update_time = tcp_update_time,
1196 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1197 .flush_data = tcp_session_flush_data,
1198 .format_connection = format_tcp_session,
1199 .format_listener = format_tcp_listener_session,
1200 .format_half_open = format_tcp_half_open_session,
1201 .tx_type = TRANSPORT_TX_PEEK,
1202 .service_type = TRANSPORT_SERVICE_VC,
1207 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1212 if (!transport_connection_is_tx_paced (&tc->connection))
1215 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1216 /* TODO should constrain to interface's max throughput but
1217 * we don't have link speeds for sw ifs ..*/
1218 rate = tc->cwnd / srtt;
1219 transport_connection_tx_pacer_update (&tc->connection, rate);
1223 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1226 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1227 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1228 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1229 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1230 start_bucket, last_time);
1234 tcp_timer_keep_handler (u32 conn_index)
1236 u32 thread_index = vlib_get_thread_index ();
1237 tcp_connection_t *tc;
1239 tc = tcp_connection_get (conn_index, thread_index);
1240 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1242 tcp_connection_close (tc);
1246 tcp_timer_establish_handler (u32 conn_index)
1248 tcp_connection_t *tc;
1250 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1251 /* note: the connection may have already disappeared */
1252 if (PREDICT_FALSE (tc == 0))
1254 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1255 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1256 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1257 /* Start cleanup. App wasn't notified yet so use delete notify as
1258 * opposed to delete to cleanup session layer state. */
1259 tcp_connection_timers_reset (tc);
1260 session_transport_delete_notify (&tc->connection);
1261 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1265 tcp_timer_establish_ao_handler (u32 conn_index)
1267 tcp_connection_t *tc;
1269 tc = tcp_half_open_connection_get (conn_index);
1273 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1274 /* Notify app if we haven't tried to clean this up already */
1275 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1276 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1278 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1279 tcp_connection_cleanup (tc);
1283 tcp_timer_waitclose_handler (u32 conn_index)
1285 u32 thread_index = vlib_get_thread_index (), rto;
1286 tcp_connection_t *tc;
1288 tc = tcp_connection_get (conn_index, thread_index);
1291 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1295 case TCP_STATE_CLOSE_WAIT:
1296 tcp_connection_timers_reset (tc);
1297 session_transport_closed_notify (&tc->connection);
1299 if (!(tc->flags & TCP_CONN_FINPNDG))
1301 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1302 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1306 /* Session didn't come back with a close. Send FIN either way
1307 * and switch to LAST_ACK. */
1308 tcp_cong_recovery_off (tc);
1309 /* Make sure we don't try to send unsent data */
1310 tc->snd_nxt = tc->snd_una;
1312 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1314 /* Make sure we don't wait in LAST ACK forever */
1315 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1317 /* Don't delete the connection yet */
1319 case TCP_STATE_FIN_WAIT_1:
1320 tcp_connection_timers_reset (tc);
1321 if (tc->flags & TCP_CONN_FINPNDG)
1323 /* If FIN pending send it before closing and wait as long as
1324 * the rto timeout would wait. Notify session layer that transport
1325 * is closed. We haven't sent everything but we did try. */
1326 tcp_cong_recovery_off (tc);
1328 rto = clib_max ((tc->rto >> tc->rto_boff) * TCP_TO_TIMER_TICK, 1);
1329 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE,
1330 clib_min (rto, TCP_2MSL_TIME));
1331 session_transport_closed_notify (&tc->connection);
1335 /* We've sent the fin but no progress. Close the connection and
1336 * to make sure everything is flushed, setup a cleanup timer */
1337 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1338 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1341 case TCP_STATE_LAST_ACK:
1342 case TCP_STATE_CLOSING:
1343 tcp_connection_timers_reset (tc);
1344 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1345 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1346 session_transport_closed_notify (&tc->connection);
1349 tcp_connection_del (tc);
1355 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1357 tcp_timer_retransmit_handler,
1358 tcp_timer_delack_handler,
1359 tcp_timer_persist_handler,
1360 tcp_timer_keep_handler,
1361 tcp_timer_waitclose_handler,
1362 tcp_timer_retransmit_syn_handler,
1363 tcp_timer_establish_handler,
1364 tcp_timer_establish_ao_handler,
1369 tcp_expired_timers_dispatch (u32 * expired_timers)
1372 u32 connection_index, timer_id;
1374 for (i = 0; i < vec_len (expired_timers); i++)
1376 /* Get session index and timer id */
1377 connection_index = expired_timers[i] & 0x0FFFFFFF;
1378 timer_id = expired_timers[i] >> 28;
1380 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1382 /* Handle expiration */
1383 (*timer_expiration_handlers[timer_id]) (connection_index);
1388 tcp_initialize_timer_wheels (tcp_main_t * tm)
1390 tw_timer_wheel_16t_2w_512sl_t *tw;
1392 foreach_vlib_main (({
1393 tw = &tm->wrk_ctx[ii].timer_wheel;
1394 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1395 100e-3 /* timer period 100ms */ , ~0);
1396 tw->last_run_time = vlib_time_now (this_vlib_main);
1402 tcp_initialize_iss_seed (tcp_main_t * tm)
1404 u32 default_seed = random_default_seed ();
1405 u64 time_now = clib_cpu_time_now ();
1407 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1408 tm->iss_seed.second = random_u64 (&time_now);
1411 static clib_error_t *
1412 tcp_main_enable (vlib_main_t * vm)
1414 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1415 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1416 tcp_connection_t *tc __attribute__ ((unused));
1417 tcp_main_t *tm = vnet_get_tcp_main ();
1418 clib_error_t *error = 0;
1421 if ((error = vlib_call_init_function (vm, ip_main_init)))
1423 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1425 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1432 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1433 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1436 * Initialize data structures
1439 num_threads = 1 /* main thread */ + vtm->n_threads;
1440 vec_validate (tm->connections, num_threads - 1);
1441 vec_validate (tm->wrk_ctx, num_threads - 1);
1442 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1443 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1445 for (thread = 0; thread < num_threads; thread++)
1447 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1448 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1449 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1450 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1451 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1452 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1453 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1454 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1455 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1456 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1457 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1458 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1459 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1462 * Preallocate connections. Assume that thread 0 won't
1463 * use preallocated threads when running multi-core
1465 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1466 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1470 * Use a preallocated half-open connection pool?
1472 if (tm->preallocated_half_open_connections)
1473 pool_init_fixed (tm->half_open_connections,
1474 tm->preallocated_half_open_connections);
1476 /* Initialize clocks per tick for TCP timestamp. Used to compute
1477 * monotonically increasing timestamps. */
1478 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1479 / TCP_TSTAMP_RESOLUTION;
1481 if (num_threads > 1)
1483 clib_spinlock_init (&tm->half_open_lock);
1486 tcp_initialize_timer_wheels (tm);
1487 tcp_initialize_iss_seed (tm);
1489 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1495 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1499 if (tcp_main.is_enabled)
1502 return tcp_main_enable (vm);
1506 tcp_main.is_enabled = 0;
1513 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1515 tcp_main_t *tm = &tcp_main;
1517 tm->punt_unknown4 = is_add;
1519 tm->punt_unknown6 = is_add;
1522 static clib_error_t *
1523 tcp_init (vlib_main_t * vm)
1525 tcp_main_t *tm = vnet_get_tcp_main ();
1526 ip_main_t *im = &ip_main;
1527 ip_protocol_info_t *pi;
1529 /* Session layer, and by implication tcp, are disabled by default */
1532 /* Register with IP for header parsing */
1533 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1535 return clib_error_return (0, "TCP protocol info AWOL");
1536 pi->format_header = format_tcp_header;
1537 pi->unformat_pg_edit = unformat_pg_tcp_header;
1539 /* Register as transport with session layer */
1540 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1541 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1542 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1543 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1545 tcp_api_reference ();
1546 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1548 tm->cc_algo = TCP_CC_NEWRENO;
1549 tm->default_mtu = 1460;
1553 VLIB_INIT_FUNCTION (tcp_init);
1556 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1558 uword *result = va_arg (*va, uword *);
1559 tcp_main_t *tm = &tcp_main;
1564 if (unformat (input, "%s", &cc_algo_name)
1565 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1571 vec_free (cc_algo_name);
1576 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1578 tcp_main_t *tm = vnet_get_tcp_main ();
1579 tcp_cc_algorithm_t *cc_alg;
1580 unformat_input_t sub_input;
1583 vec_foreach (cc_alg, tm->cc_algos)
1585 if (!unformat (input, cc_alg->name))
1588 if (cc_alg->unformat_cfg
1589 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1591 if (cc_alg->unformat_cfg (&sub_input))
1598 static clib_error_t *
1599 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1601 tcp_main_t *tm = vnet_get_tcp_main ();
1603 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1605 if (unformat (input, "preallocated-connections %d",
1606 &tm->preallocated_connections))
1608 else if (unformat (input, "preallocated-half-open-connections %d",
1609 &tm->preallocated_half_open_connections))
1611 else if (unformat (input, "buffer-fail-fraction %f",
1612 &tm->buffer_fail_fraction))
1614 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1617 else if (unformat (input, "mtu %d", &tm->default_mtu))
1619 else if (unformat (input, "no-tx-pacing"))
1621 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1624 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1627 return clib_error_return (0, "unknown input `%U'",
1628 format_unformat_error, input);
1633 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1637 * \brief Configure an ipv4 source address range
1638 * @param vm vlib_main_t pointer
1639 * @param start first ipv4 address in the source address range
1640 * @param end last ipv4 address in the source address range
1641 * @param table_id VRF / table ID, 0 for the default FIB
1642 * @return 0 if all OK, else an error indication from api_errno.h
1646 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1647 ip4_address_t * start,
1648 ip4_address_t * end, u32 table_id)
1650 tcp_main_t *tm = vnet_get_tcp_main ();
1651 vnet_main_t *vnm = vnet_get_main ();
1652 u32 start_host_byte_order, end_host_byte_order;
1653 fib_prefix_t prefix;
1654 vnet_sw_interface_t *si;
1655 fib_node_index_t fei;
1659 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1660 ip4_address_t * hi_addr, u32 fib_index,
1663 clib_memset (&prefix, 0, sizeof (prefix));
1665 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1667 if (fib_index == ~0)
1668 return VNET_API_ERROR_NO_SUCH_FIB;
1670 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1671 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1673 /* sanity check for reversed args or some such */
1674 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1675 return VNET_API_ERROR_INVALID_ARGUMENT;
1677 /* Lookup the last address, to identify the interface involved */
1679 prefix.fp_proto = FIB_PROTOCOL_IP4;
1680 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1682 fei = fib_table_lookup (fib_index, &prefix);
1684 /* Couldn't find route to destination. Bail out. */
1685 if (fei == FIB_NODE_INDEX_INVALID)
1686 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1688 sw_if_index = fib_entry_get_resolving_interface (fei);
1690 /* Enable proxy arp on the interface */
1691 si = vnet_get_sw_interface (vnm, sw_if_index);
1692 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1694 /* Configure proxy arp across the range */
1695 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1702 dpo_id_t dpo = DPO_INVALID;
1704 vec_add1 (tm->ip4_src_addresses, start[0]);
1706 /* Add local adjacencies for the range */
1708 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1711 prefix.fp_proto = FIB_PROTOCOL_IP4;
1712 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1714 fib_table_entry_special_dpo_update (fib_index,
1717 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1720 start_host_byte_order++;
1721 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1723 while (start_host_byte_order <= end_host_byte_order);
1729 * \brief Configure an ipv6 source address range
1730 * @param vm vlib_main_t pointer
1731 * @param start first ipv6 address in the source address range
1732 * @param end last ipv6 address in the source address range
1733 * @param table_id VRF / table ID, 0 for the default FIB
1734 * @return 0 if all OK, else an error indication from api_errno.h
1738 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1739 ip6_address_t * start,
1740 ip6_address_t * end, u32 table_id)
1742 tcp_main_t *tm = vnet_get_tcp_main ();
1743 fib_prefix_t prefix;
1745 fib_node_index_t fei;
1748 clib_memset (&prefix, 0, sizeof (prefix));
1750 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1752 if (fib_index == ~0)
1753 return VNET_API_ERROR_NO_SUCH_FIB;
1759 dpo_id_t dpo = DPO_INVALID;
1761 /* Remember this address */
1762 vec_add1 (tm->ip6_src_addresses, start[0]);
1764 /* Lookup the prefix, to identify the interface involved */
1765 prefix.fp_len = 128;
1766 prefix.fp_proto = FIB_PROTOCOL_IP6;
1767 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1769 fei = fib_table_lookup (fib_index, &prefix);
1771 /* Couldn't find route to destination. Bail out. */
1772 if (fei == FIB_NODE_INDEX_INVALID)
1773 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1775 sw_if_index = fib_entry_get_resolving_interface (fei);
1777 if (sw_if_index == (u32) ~ 0)
1778 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1780 /* Add a proxy neighbor discovery entry for this address */
1781 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1783 /* Add a receive adjacency for this address */
1784 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1787 fib_table_entry_special_dpo_update (fib_index,
1790 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1793 /* Done with the entire range? */
1794 if (!memcmp (start, end, sizeof (start[0])))
1797 /* Increment the address. DGMS. */
1799 for (i = 15; i >= 0; i--)
1802 if (tmp.as_u8[i] != 0)
1810 static clib_error_t *
1811 tcp_src_address (vlib_main_t * vm,
1812 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1814 ip4_address_t v4start, v4end;
1815 ip6_address_t v6start, v6end;
1821 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1823 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1824 unformat_ip4_address, &v4end))
1826 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1828 memcpy (&v4end, &v4start, sizeof (v4start));
1831 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1832 unformat_ip6_address, &v6end))
1834 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1836 memcpy (&v6end, &v6start, sizeof (v6start));
1839 else if (unformat (input, "fib-table %d", &table_id))
1845 if (!v4set && !v6set)
1846 return clib_error_return (0, "at least one v4 or v6 address required");
1850 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1857 case VNET_API_ERROR_NO_SUCH_FIB:
1858 return clib_error_return (0, "Invalid table-id %d", table_id);
1860 case VNET_API_ERROR_INVALID_ARGUMENT:
1861 return clib_error_return (0, "Invalid address range %U - %U",
1862 format_ip4_address, &v4start,
1863 format_ip4_address, &v4end);
1865 return clib_error_return (0, "error %d", rv);
1871 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1878 case VNET_API_ERROR_NO_SUCH_FIB:
1879 return clib_error_return (0, "Invalid table-id %d", table_id);
1882 return clib_error_return (0, "error %d", rv);
1890 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1892 .path = "tcp src-address",
1893 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1894 .function = tcp_src_address,
1899 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1901 #if TCP_SCOREBOARD_TRACE
1903 scoreboard_trace_elt_t *block;
1909 s = format (s, "scoreboard trace:");
1910 vec_foreach (block, sb->trace)
1912 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1913 block->ack, block->snd_una_max, block->group);
1915 s = format (s, "\n");
1923 static clib_error_t *
1924 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1925 vlib_cli_command_t * cmd_arg)
1927 transport_connection_t *tconn = 0;
1928 tcp_connection_t *tc;
1930 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1932 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1933 TRANSPORT_PROTO_TCP))
1936 return clib_error_return (0, "unknown input `%U'",
1937 format_unformat_error, input);
1940 if (!TCP_SCOREBOARD_TRACE)
1942 vlib_cli_output (vm, "scoreboard tracing not enabled");
1946 tc = tcp_get_connection_from_transport (tconn);
1947 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1948 vlib_cli_output (vm, "%v", s);
1953 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1955 .path = "show tcp scoreboard trace",
1956 .short_help = "show tcp scoreboard trace <connection>",
1957 .function = tcp_show_scoreboard_trace_fn,
1962 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1965 scoreboard_trace_elt_t *trace;
1966 u32 next_ack, left, group, has_new_ack = 0;
1967 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1968 sack_block_t *block;
1970 if (!TCP_SCOREBOARD_TRACE)
1972 s = format (s, "scoreboard tracing not enabled");
1979 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1980 tcp_connection_timers_init (dummy_tc);
1981 scoreboard_init (&dummy_tc->sack_sb);
1982 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1984 #if TCP_SCOREBOARD_TRACE
1985 trace = tc->sack_sb.trace;
1986 trace_len = vec_len (tc->sack_sb.trace);
1989 for (i = 0; i < trace_len; i++)
1991 if (trace[i].ack != 0)
1993 dummy_tc->snd_una = trace[i].ack - 1448;
1994 dummy_tc->snd_una_max = trace[i].ack;
1999 while (left < trace_len)
2001 group = trace[left].group;
2002 vec_reset_length (dummy_tc->rcv_opts.sacks);
2004 while (trace[left].group == group)
2006 if (trace[left].ack != 0)
2009 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2010 trace[left].ack, trace[left].snd_una_max);
2011 dummy_tc->snd_una_max = trace[left].snd_una_max;
2012 next_ack = trace[left].ack;
2018 s = format (s, "[%u, %u], ", trace[left].start,
2020 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2021 block->start = trace[left].start;
2022 block->end = trace[left].end;
2028 tcp_rcv_sacks (dummy_tc, next_ack);
2030 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2033 s = format (s, "result: %U", format_tcp_scoreboard,
2034 &dummy_tc->sack_sb);
2037 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2042 static clib_error_t *
2043 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2044 vlib_cli_command_t * cmd_arg)
2046 transport_connection_t *tconn = 0;
2047 tcp_connection_t *tc = 0;
2049 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2051 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2052 TRANSPORT_PROTO_TCP))
2055 return clib_error_return (0, "unknown input `%U'",
2056 format_unformat_error, input);
2059 if (!TCP_SCOREBOARD_TRACE)
2061 vlib_cli_output (vm, "scoreboard tracing not enabled");
2065 tc = tcp_get_connection_from_transport (tconn);
2068 vlib_cli_output (vm, "connection not found");
2071 str = tcp_scoreboard_replay (str, tc, 1);
2072 vlib_cli_output (vm, "%v", str);
2077 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2079 .path = "tcp replay scoreboard",
2080 .short_help = "tcp replay scoreboard <connection>",
2081 .function = tcp_scoreboard_trace_fn,
2085 static clib_error_t *
2086 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2087 vlib_cli_command_t * cmd_arg)
2089 tcp_main_t *tm = vnet_get_tcp_main ();
2090 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2091 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2093 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2094 tm->punt_unknown4 ? "enabled" : "disabled");
2095 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2096 tm->punt_unknown6 ? "enabled" : "disabled");
2100 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2102 .path = "show tcp punt",
2103 .short_help = "show tcp punt",
2104 .function = show_tcp_punt_fn,
2109 * fd.io coding-style-patch-verification: ON
2112 * eval: (c-set-style "gnu")