2 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 * @brief TCP host stack utilities
21 #include <vnet/tcp/tcp.h>
22 #include <vnet/session/session.h>
23 #include <vnet/fib/fib.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/dpo/receive_dpo.h>
26 #include <vnet/ip/ip6_neighbor.h>
28 #include <vnet/ethernet/arp.h>
34 fib_protocol_t nh_proto;
35 vnet_link_t link_type;
39 } tcp_add_del_adj_args_t;
42 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
47 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
52 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
54 if (ai != ADJ_INDEX_INVALID)
60 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
62 tcp_add_del_adj_args_t args = {
63 .nh_proto = FIB_PROTOCOL_IP6,
64 .link_type = VNET_LINK_IP6,
66 .sw_if_index = tc->sw_if_index,
69 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
74 tcp_cc_init (tcp_connection_t * tc)
76 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
77 tc->cc_algo->init (tc);
81 tcp_cc_cleanup (tcp_connection_t * tc)
83 if (tc->cc_algo->cleanup)
84 tc->cc_algo->cleanup (tc);
88 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
89 const tcp_cc_algorithm_t * vft)
91 tcp_main_t *tm = vnet_get_tcp_main ();
92 vec_validate (tm->cc_algos, type);
94 tm->cc_algos[type] = *vft;
95 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
99 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
101 tcp_main_t *tm = vnet_get_tcp_main ();
102 return &tm->cc_algos[type];
105 tcp_cc_algorithm_type_e
106 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
108 tcp_main_t *tm = vnet_get_tcp_main ();
109 tcp_cc_algo_register (++tm->cc_last_type, vft);
110 return tm->cc_last_type;
114 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
116 tcp_main_t *tm = &tcp_main;
117 tcp_connection_t *listener;
120 pool_get (tm->listener_pool, listener);
121 clib_memset (listener, 0, sizeof (*listener));
123 listener->c_c_index = listener - tm->listener_pool;
124 listener->c_lcl_port = lcl->port;
126 /* If we are provided a sw_if_index, bind using one of its ips */
127 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
129 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
131 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
133 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
134 listener->c_is_ip4 = lcl->is_ip4;
135 listener->c_proto = TRANSPORT_PROTO_TCP;
136 listener->c_s_index = session_index;
137 listener->c_fib_index = lcl->fib_index;
138 listener->state = TCP_STATE_LISTEN;
140 tcp_connection_timers_init (listener);
142 TCP_EVT_DBG (TCP_EVT_BIND, listener);
144 return listener->c_c_index;
148 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
150 return tcp_connection_bind (session_index, tep);
154 tcp_connection_unbind (u32 listener_index)
156 tcp_main_t *tm = vnet_get_tcp_main ();
157 tcp_connection_t *tc;
159 tc = pool_elt_at_index (tm->listener_pool, listener_index);
161 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
163 /* Poison the entry */
165 clib_memset (tc, 0xFA, sizeof (*tc));
167 pool_put_index (tm->listener_pool, listener_index);
171 tcp_session_unbind (u32 listener_index)
173 tcp_connection_unbind (listener_index);
177 static transport_connection_t *
178 tcp_session_get_listener (u32 listener_index)
180 tcp_main_t *tm = vnet_get_tcp_main ();
181 tcp_connection_t *tc;
182 tc = pool_elt_at_index (tm->listener_pool, listener_index);
183 return &tc->connection;
187 * Cleanup half-open connection
191 tcp_half_open_connection_del (tcp_connection_t * tc)
193 tcp_main_t *tm = vnet_get_tcp_main ();
194 clib_spinlock_lock_if_init (&tm->half_open_lock);
195 pool_put_index (tm->half_open_connections, tc->c_c_index);
197 clib_memset (tc, 0xFA, sizeof (*tc));
198 clib_spinlock_unlock_if_init (&tm->half_open_lock);
202 * Try to cleanup half-open connection
204 * If called from a thread that doesn't own tc, the call won't have any
207 * @param tc - connection to be cleaned up
208 * @return non-zero if cleanup failed.
211 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
213 /* Make sure this is the owning thread */
214 if (tc->c_thread_index != vlib_get_thread_index ())
216 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH_AO);
217 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
218 tcp_half_open_connection_del (tc);
222 static tcp_connection_t *
223 tcp_half_open_connection_new (void)
225 tcp_main_t *tm = vnet_get_tcp_main ();
226 tcp_connection_t *tc = 0;
227 ASSERT (vlib_get_thread_index () == 0);
228 pool_get (tm->half_open_connections, tc);
229 clib_memset (tc, 0, sizeof (*tc));
230 tc->c_c_index = tc - tm->half_open_connections;
235 * Cleans up connection state.
240 tcp_connection_cleanup (tcp_connection_t * tc)
242 tcp_main_t *tm = &tcp_main;
244 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
246 /* Cleanup local endpoint if this was an active connect */
247 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
250 /* Check if connection is not yet fully established */
251 if (tc->state == TCP_STATE_SYN_SENT)
253 /* Try to remove the half-open connection. If this is not the owning
254 * thread, tc won't be removed. Retransmit or establish timers will
255 * eventually expire and call again cleanup on the right thread. */
256 if (tcp_half_open_connection_cleanup (tc))
257 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
261 int thread_index = tc->c_thread_index;
263 /* Make sure all timers are cleared */
264 tcp_connection_timers_reset (tc);
266 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
267 tcp_add_del_adjacency (tc, 0);
270 vec_free (tc->snd_sacks);
271 vec_free (tc->snd_sacks_fl);
273 if (tc->flags & TCP_CONN_RATE_SAMPLE)
276 /* Poison the entry */
278 clib_memset (tc, 0xFA, sizeof (*tc));
279 pool_put (tm->connections[thread_index], tc);
284 * Connection removal.
286 * This should be called only once connection enters CLOSED state. Note
287 * that it notifies the session of the removal event, so if the goal is to
288 * just remove the connection, call tcp_connection_cleanup instead.
291 tcp_connection_del (tcp_connection_t * tc)
293 session_transport_delete_notify (&tc->connection);
294 tcp_connection_cleanup (tc);
298 tcp_connection_alloc (u8 thread_index)
300 tcp_main_t *tm = vnet_get_tcp_main ();
301 tcp_connection_t *tc;
303 pool_get (tm->connections[thread_index], tc);
304 clib_memset (tc, 0, sizeof (*tc));
305 tc->c_c_index = tc - tm->connections[thread_index];
306 tc->c_thread_index = thread_index;
311 tcp_connection_free (tcp_connection_t * tc)
313 tcp_main_t *tm = &tcp_main;
316 u8 thread_index = tc->c_thread_index;
317 clib_memset (tc, 0xFA, sizeof (*tc));
318 pool_put (tm->connections[thread_index], tc);
321 pool_put (tm->connections[tc->c_thread_index], tc);
324 /** Notify session that connection has been reset.
326 * Switch state to closed and wait for session to call cleanup.
329 tcp_connection_reset (tcp_connection_t * tc)
331 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
334 case TCP_STATE_SYN_RCVD:
335 /* Cleanup everything. App wasn't notified yet */
336 session_transport_delete_notify (&tc->connection);
337 tcp_connection_cleanup (tc);
339 case TCP_STATE_SYN_SENT:
340 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
341 tcp_connection_cleanup (tc);
343 case TCP_STATE_ESTABLISHED:
344 tcp_connection_timers_reset (tc);
345 /* Set the cleanup timer, in case the session layer/app don't
346 * cleanly close the connection */
347 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
348 session_transport_reset_notify (&tc->connection);
349 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
350 session_transport_closed_notify (&tc->connection);
352 case TCP_STATE_CLOSE_WAIT:
353 case TCP_STATE_FIN_WAIT_1:
354 case TCP_STATE_FIN_WAIT_2:
355 case TCP_STATE_CLOSING:
356 case TCP_STATE_LAST_ACK:
357 tcp_connection_timers_reset (tc);
358 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
359 /* Make sure we mark the session as closed. In some states we may
360 * be still trying to send data */
361 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
362 session_transport_closed_notify (&tc->connection);
364 case TCP_STATE_CLOSED:
365 case TCP_STATE_TIME_WAIT:
368 TCP_DBG ("reset state: %u", tc->state);
373 * Begin connection closing procedure.
375 * If at the end the connection is not in CLOSED state, it is not removed.
376 * Instead, we rely on on TCP to advance through state machine to either
377 * 1) LAST_ACK (passive close) whereby when the last ACK is received
378 * tcp_connection_del is called. This notifies session of the delete and
380 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
381 * and cleanup is called.
383 * N.B. Half-close connections are not supported
386 tcp_connection_close (tcp_connection_t * tc)
388 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
390 /* Send/Program FIN if needed and switch state */
393 case TCP_STATE_SYN_SENT:
394 /* Try to cleanup. If not on the right thread, mark as half-open done.
395 * Connection will be cleaned up when establish timer pops */
396 tcp_connection_cleanup (tc);
398 case TCP_STATE_SYN_RCVD:
399 tcp_connection_timers_reset (tc);
401 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
402 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
404 case TCP_STATE_ESTABLISHED:
405 /* If closing with unread data, reset the connection */
406 if (transport_max_rx_dequeue (&tc->connection))
409 tcp_connection_timers_reset (tc);
410 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
411 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
412 session_transport_closed_notify (&tc->connection);
415 if (!transport_max_tx_dequeue (&tc->connection))
418 tc->flags |= TCP_CONN_FINPNDG;
419 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
420 /* Set a timer in case the peer stops responding. Otherwise the
421 * connection will be stuck here forever. */
422 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
423 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
425 case TCP_STATE_CLOSE_WAIT:
426 if (!transport_max_tx_dequeue (&tc->connection))
429 tcp_connection_timers_reset (tc);
430 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
431 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
434 tc->flags |= TCP_CONN_FINPNDG;
436 case TCP_STATE_FIN_WAIT_1:
437 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
439 case TCP_STATE_CLOSED:
440 tcp_connection_timers_reset (tc);
441 /* Delete connection but instead of doing it now wait until next
442 * dispatch cycle to give the session layer a chance to clear
443 * unhandled events */
444 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
447 TCP_DBG ("state: %u", tc->state);
452 tcp_session_close (u32 conn_index, u32 thread_index)
454 tcp_connection_t *tc;
455 tc = tcp_connection_get (conn_index, thread_index);
456 tcp_connection_close (tc);
460 tcp_session_cleanup (u32 conn_index, u32 thread_index)
462 tcp_connection_t *tc;
463 tc = tcp_connection_get (conn_index, thread_index);
464 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
465 tcp_connection_cleanup (tc);
469 * Initialize all connection timers as invalid
472 tcp_connection_timers_init (tcp_connection_t * tc)
476 /* Set all to invalid */
477 for (i = 0; i < TCP_N_TIMERS; i++)
479 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
482 tc->rto = TCP_RTO_INIT;
486 * Stop all connection timers
489 tcp_connection_timers_reset (tcp_connection_t * tc)
492 for (i = 0; i < TCP_N_TIMERS; i++)
494 tcp_timer_reset (tc, i);
499 typedef struct ip4_tcp_hdr
505 typedef struct ip6_tcp_hdr
512 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
515 const dpo_id_t *choice;
519 lb = load_balance_get (dpo->dpoi_index);
523 clib_memset (&hdr, 0, sizeof (hdr));
524 hdr.ip.protocol = IP_PROTOCOL_TCP;
525 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
526 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
527 hdr.tcp.src_port = tc->c_lcl_port;
528 hdr.tcp.dst_port = tc->c_rmt_port;
529 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
534 clib_memset (&hdr, 0, sizeof (hdr));
535 hdr.ip.protocol = IP_PROTOCOL_TCP;
536 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
537 sizeof (ip6_address_t));
538 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
539 sizeof (ip6_address_t));
540 hdr.tcp.src_port = tc->c_lcl_port;
541 hdr.tcp.dst_port = tc->c_rmt_port;
542 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
544 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
545 dpo_copy (result, choice);
549 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
554 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
555 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
556 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
557 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
558 return fib_table_lookup (fib_index, &prefix);
562 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
564 dpo_id_t choice = DPO_INVALID;
565 u32 output_node_index;
568 fe = fib_entry_get (tc->c_rmt_fei);
569 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
572 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
575 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
576 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
580 /** Stack tcp connection on peer's fib entry.
582 * This ultimately populates the dpo the connection will use to send packets.
585 tcp_connection_fib_attach (tcp_connection_t * tc)
587 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
589 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
591 tcp_connection_stack_on_fib_entry (tc);
596 * Generate random iss as per rfc6528
599 tcp_generate_random_iss (tcp_connection_t * tc)
601 tcp_main_t *tm = &tcp_main;
605 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
607 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
608 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
610 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
611 tmp ^= tm->iss_seed.second;
612 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
613 return ((tmp >> 32) ^ (tmp & 0xffffffff));
617 * Initialize connection send variables.
620 tcp_init_snd_vars (tcp_connection_t * tc)
623 * We use the time to randomize iss and for setting up the initial
624 * timestamp. Make sure it's updated otherwise syn and ack in the
625 * handshake may make it look as if time has flown in the opposite
628 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
630 tc->iss = tcp_generate_random_iss (tc);
631 tc->snd_una = tc->iss;
632 tc->snd_nxt = tc->iss + 1;
633 tc->snd_una_max = tc->snd_nxt;
638 tcp_enable_pacing (tcp_connection_t * tc)
640 u32 initial_bucket, byte_rate;
641 initial_bucket = 16 * tc->snd_mss;
643 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
645 tc->mrtt_us = (u32) ~ 0;
648 /** Initialize tcp connection variables
650 * Should be called after having received a msg from the peer, i.e., a SYN or
651 * a SYNACK, such that connection options have already been exchanged. */
653 tcp_connection_init_vars (tcp_connection_t * tc)
655 tcp_connection_timers_init (tc);
657 scoreboard_init (&tc->sack_sb);
659 if (tc->state == TCP_STATE_SYN_RCVD)
660 tcp_init_snd_vars (tc);
662 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
663 tcp_add_del_adjacency (tc, 1);
665 /* tcp_connection_fib_attach (tc); */
667 if (transport_connection_is_tx_paced (&tc->connection)
668 || tcp_main.tx_pacing)
669 tcp_enable_pacing (tc);
671 if (tc->flags & TCP_CONN_RATE_SAMPLE)
674 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
678 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
679 u16 * lcl_port, u8 is_ip4)
684 index = tm->last_v4_address_rotor++;
685 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
686 tm->last_v4_address_rotor = 0;
687 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
691 index = tm->last_v6_address_rotor++;
692 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
693 tm->last_v6_address_rotor = 0;
694 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
695 sizeof (ip6_address_t));
697 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
700 clib_warning ("Failed to allocate src port");
708 tcp_session_open (transport_endpoint_cfg_t * rmt)
710 tcp_main_t *tm = vnet_get_tcp_main ();
711 tcp_connection_t *tc;
712 ip46_address_t lcl_addr;
717 * Allocate local endpoint
719 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
720 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
721 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
724 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
725 rmt, &lcl_addr, &lcl_port);
731 * Create connection and send SYN
733 clib_spinlock_lock_if_init (&tm->half_open_lock);
734 tc = tcp_half_open_connection_new ();
735 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
736 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
737 tc->c_rmt_port = rmt->port;
738 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
739 tc->c_is_ip4 = rmt->is_ip4;
740 tc->c_proto = TRANSPORT_PROTO_TCP;
741 tc->c_fib_index = rmt->fib_index;
742 /* The other connection vars will be initialized after SYN ACK */
743 tcp_connection_timers_init (tc);
745 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
746 tc->state = TCP_STATE_SYN_SENT;
747 tcp_init_snd_vars (tc);
749 clib_spinlock_unlock_if_init (&tm->half_open_lock);
751 return tc->c_c_index;
754 const char *tcp_dbg_evt_str[] = {
755 #define _(sym, str) str,
760 const char *tcp_fsm_states[] = {
761 #define _(sym, str) str,
762 foreach_tcp_fsm_state
767 format_tcp_state (u8 * s, va_list * args)
769 u32 state = va_arg (*args, u32);
771 if (state < TCP_N_STATES)
772 s = format (s, "%s", tcp_fsm_states[state]);
774 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
778 const char *tcp_connection_flags_str[] = {
779 #define _(sym, str) str,
780 foreach_tcp_connection_flag
785 format_tcp_connection_flags (u8 * s, va_list * args)
787 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
790 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
791 if (tc->flags & (1 << i))
793 for (i = 0; i < last; i++)
795 if (tc->flags & (1 << i))
796 s = format (s, "%s, ", tcp_connection_flags_str[i]);
799 s = format (s, "%s", tcp_connection_flags_str[last]);
803 const char *tcp_conn_timers[] = {
804 #define _(sym, str) str,
810 format_tcp_timers (u8 * s, va_list * args)
812 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
815 for (i = 0; i < TCP_N_TIMERS; i++)
816 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
819 for (i = 0; i < last; i++)
821 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
822 s = format (s, "%s,", tcp_conn_timers[i]);
826 s = format (s, "%s", tcp_conn_timers[i]);
832 format_tcp_congestion_status (u8 * s, va_list * args)
834 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
835 if (tcp_in_recovery (tc))
836 s = format (s, "recovery");
837 else if (tcp_in_fastrecovery (tc))
838 s = format (s, "fastrecovery");
840 s = format (s, "none");
845 tcp_rcv_wnd_available (tcp_connection_t * tc)
847 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
851 format_tcp_congestion (u8 * s, va_list * args)
853 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
854 u32 indent = format_get_indent (s);
856 s = format (s, "%U ", format_tcp_congestion_status, tc);
857 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
858 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
859 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
860 format_white_space, indent, tcp_available_cc_snd_space (tc),
861 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
862 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
863 format_white_space, indent, tc->snd_congestion - tc->iss,
864 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
869 format_tcp_stats (u8 * s, va_list * args)
871 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
872 u32 indent = format_get_indent (s);
873 s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
874 tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
875 s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
876 format_white_space, indent, tc->segs_out,
877 tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
878 s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
879 format_white_space, indent, tc->fr_occurences,
880 tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
881 tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
882 s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
883 format_white_space, indent, tc->errors.below_data_wnd,
884 tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
885 tc->errors.above_ack_wnd);
890 format_tcp_vars (u8 * s, va_list * args)
892 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
893 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
894 format_tcp_connection_flags, tc, format_tcp_timers, tc);
895 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
896 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
897 tc->snd_una_max - tc->iss);
898 s = format (s, " rcv_nxt %u rcv_las %u\n",
899 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
900 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
901 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
902 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
903 tc->snd_wl2 - tc->iss);
904 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
905 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
906 tcp_rcv_wnd_available (tc));
907 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
908 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
909 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
910 tcp_time_now () - tc->tsval_recent_age);
911 s = format (s, " snd_mss %u\n", tc->snd_mss);
912 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
913 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
915 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
916 s = format (s, " cong: %U", format_tcp_congestion, tc);
918 if (tc->state >= TCP_STATE_ESTABLISHED)
920 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
922 s = format (s, " stats: %U\n", format_tcp_stats, tc);
924 if (vec_len (tc->snd_sacks))
925 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
931 format_tcp_connection_id (u8 * s, va_list * args)
933 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
938 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
939 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
940 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
941 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
945 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
946 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
947 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
948 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
955 format_tcp_connection (u8 * s, va_list * args)
957 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
958 u32 verbose = va_arg (*args, u32);
962 s = format (s, "%-50U", format_tcp_connection_id, tc);
965 s = format (s, "%-15U", format_tcp_state, tc->state);
967 s = format (s, "\n%U", format_tcp_vars, tc);
974 format_tcp_session (u8 * s, va_list * args)
976 u32 tci = va_arg (*args, u32);
977 u32 thread_index = va_arg (*args, u32);
978 u32 verbose = va_arg (*args, u32);
979 tcp_connection_t *tc;
981 tc = tcp_connection_get (tci, thread_index);
983 s = format (s, "%U", format_tcp_connection, tc, verbose);
985 s = format (s, "empty\n");
990 format_tcp_listener_session (u8 * s, va_list * args)
992 u32 tci = va_arg (*args, u32);
993 u32 __clib_unused thread_index = va_arg (*args, u32);
994 u32 verbose = va_arg (*args, u32);
995 tcp_connection_t *tc = tcp_listener_get (tci);
996 s = format (s, "%-50U", format_tcp_connection_id, tc);
998 s = format (s, "%-15U", format_tcp_state, tc->state);
1003 format_tcp_half_open_session (u8 * s, va_list * args)
1005 u32 tci = va_arg (*args, u32);
1006 u32 __clib_unused thread_index = va_arg (*args, u32);
1007 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1008 return format (s, "%U", format_tcp_connection_id, tc);
1012 format_tcp_sacks (u8 * s, va_list * args)
1014 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1015 sack_block_t *sacks = tc->snd_sacks;
1016 sack_block_t *block;
1019 len = vec_len (sacks);
1020 for (i = 0; i < len - 1; i++)
1023 s = format (s, " start %u end %u\n", block->start - tc->irs,
1024 block->end - tc->irs);
1028 block = &sacks[len - 1];
1029 s = format (s, " start %u end %u", block->start - tc->irs,
1030 block->end - tc->irs);
1036 format_tcp_rcv_sacks (u8 * s, va_list * args)
1038 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1039 sack_block_t *sacks = tc->rcv_opts.sacks;
1040 sack_block_t *block;
1043 len = vec_len (sacks);
1044 for (i = 0; i < len - 1; i++)
1047 s = format (s, " start %u end %u\n", block->start - tc->iss,
1048 block->end - tc->iss);
1052 block = &sacks[len - 1];
1053 s = format (s, " start %u end %u", block->start - tc->iss,
1054 block->end - tc->iss);
1060 format_tcp_sack_hole (u8 * s, va_list * args)
1062 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1063 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1065 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1067 s = format (s, " [%u, %u]", hole->start, hole->end);
1072 format_tcp_scoreboard (u8 * s, va_list * args)
1074 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1075 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1076 sack_scoreboard_hole_t *hole;
1077 u32 indent = format_get_indent (s);
1079 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1080 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1081 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1082 format_white_space, indent, sb->last_bytes_delivered,
1083 sb->high_sacked - tc->iss, sb->snd_una_adv);
1084 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1085 format_white_space, indent, sb->cur_rxt_hole,
1086 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1088 hole = scoreboard_first_hole (sb);
1090 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1091 indent, sb->head, sb->tail, pool_elts (sb->holes),
1092 format_white_space, indent);
1096 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1097 hole = scoreboard_next_hole (sb, hole);
1103 static transport_connection_t *
1104 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1106 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1107 return &tc->connection;
1110 static transport_connection_t *
1111 tcp_half_open_session_get_transport (u32 conn_index)
1113 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1114 return &tc->connection;
1118 * Compute maximum segment size for session layer.
1120 * Since the result needs to be the actual data length, it first computes
1121 * the tcp options to be used in the next burst and subtracts their
1122 * length from the connection's snd_mss.
1125 tcp_session_send_mss (transport_connection_t * trans_conn)
1127 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1129 /* Ensure snd_mss does accurately reflect the amount of data we can push
1130 * in a segment. This also makes sure that options are updated according to
1131 * the current state of the connection. */
1132 tcp_update_burst_snd_vars (tc);
1138 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1140 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1142 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1145 /* If not snd_wnd constrained and we can't write at least a segment,
1146 * don't try at all */
1147 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1148 return snd_space < tc->cwnd ? 0 : snd_space;
1150 /* round down to mss multiple */
1151 return snd_space - (snd_space % tc->snd_mss);
1155 * Compute tx window session is allowed to fill.
1157 * Takes into account available send space, snd_mss and the congestion
1158 * state of the connection. If possible, the value returned is a multiple
1161 * @param tc tcp connection
1162 * @return number of bytes session is allowed to write
1165 tcp_snd_space_inline (tcp_connection_t * tc)
1167 int snd_space, snt_limited;
1169 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1170 || tc->state == TCP_STATE_CLOSED))
1173 snd_space = tcp_available_output_snd_space (tc);
1175 /* If we haven't gotten dupacks or if we did and have gotten sacked
1176 * bytes then we can still send as per Limited Transmit (RFC3042) */
1177 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1178 && (tcp_opts_sack_permitted (tc)
1179 && tc->sack_sb.last_sacked_bytes == 0)))
1181 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1182 tc->limited_transmit = tc->snd_nxt;
1183 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1185 snt_limited = tc->snd_nxt - tc->limited_transmit;
1186 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1188 return tcp_round_snd_space (tc, snd_space);
1192 tcp_snd_space (tcp_connection_t * tc)
1194 return tcp_snd_space_inline (tc);
1198 tcp_session_send_space (transport_connection_t * trans_conn)
1200 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1201 return clib_min (tcp_snd_space_inline (tc),
1202 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1206 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1208 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1210 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1212 /* This still works if fast retransmit is on */
1213 return (tc->snd_nxt - tc->snd_una);
1217 tcp_update_time (f64 now, u8 thread_index)
1219 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1221 tcp_set_time_now (wrk);
1222 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1223 tcp_flush_frames_to_output (wrk);
1227 tcp_session_flush_data (transport_connection_t * tconn)
1229 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1230 if (tc->flags & TCP_CONN_PSH_PENDING)
1232 tc->flags |= TCP_CONN_PSH_PENDING;
1233 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1237 const static transport_proto_vft_t tcp_proto = {
1238 .enable = vnet_tcp_enable_disable,
1239 .start_listen = tcp_session_bind,
1240 .stop_listen = tcp_session_unbind,
1241 .push_header = tcp_session_push_header,
1242 .get_connection = tcp_session_get_transport,
1243 .get_listener = tcp_session_get_listener,
1244 .get_half_open = tcp_half_open_session_get_transport,
1245 .connect = tcp_session_open,
1246 .close = tcp_session_close,
1247 .cleanup = tcp_session_cleanup,
1248 .send_mss = tcp_session_send_mss,
1249 .send_space = tcp_session_send_space,
1250 .update_time = tcp_update_time,
1251 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1252 .flush_data = tcp_session_flush_data,
1253 .custom_tx = tcp_session_custom_tx,
1254 .format_connection = format_tcp_session,
1255 .format_listener = format_tcp_listener_session,
1256 .format_half_open = format_tcp_half_open_session,
1257 .transport_options = {
1258 .tx_type = TRANSPORT_TX_PEEK,
1259 .service_type = TRANSPORT_SERVICE_VC,
1265 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1270 if (!transport_connection_is_tx_paced (&tc->connection))
1273 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1274 /* TODO should constrain to interface's max throughput but
1275 * we don't have link speeds for sw ifs ..*/
1276 rate = tc->cwnd / srtt;
1277 transport_connection_tx_pacer_update (&tc->connection, rate);
1281 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1284 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1285 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1286 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1287 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1288 start_bucket, last_time);
1292 tcp_timer_keep_handler (u32 conn_index)
1294 u32 thread_index = vlib_get_thread_index ();
1295 tcp_connection_t *tc;
1297 tc = tcp_connection_get (conn_index, thread_index);
1298 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1300 tcp_connection_close (tc);
1304 tcp_timer_establish_handler (u32 conn_index)
1306 tcp_connection_t *tc;
1308 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1309 /* note: the connection may have already disappeared */
1310 if (PREDICT_FALSE (tc == 0))
1312 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1313 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1314 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1315 tcp_connection_timers_reset (tc);
1316 /* Start cleanup. Do NOT delete the session until we do the connection
1317 * cleanup. Otherwise, we end up with a dangling session index in the
1318 * tcp connection. */
1319 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1323 tcp_timer_establish_ao_handler (u32 conn_index)
1325 tcp_connection_t *tc;
1327 tc = tcp_half_open_connection_get (conn_index);
1331 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1332 /* Notify app if we haven't tried to clean this up already */
1333 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1334 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1336 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1337 tcp_connection_cleanup (tc);
1341 tcp_timer_waitclose_handler (u32 conn_index)
1343 u32 thread_index = vlib_get_thread_index ();
1344 tcp_connection_t *tc;
1346 tc = tcp_connection_get (conn_index, thread_index);
1349 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1353 case TCP_STATE_CLOSE_WAIT:
1354 tcp_connection_timers_reset (tc);
1355 session_transport_closed_notify (&tc->connection);
1357 if (!(tc->flags & TCP_CONN_FINPNDG))
1359 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1360 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1364 /* Session didn't come back with a close. Send FIN either way
1365 * and switch to LAST_ACK. */
1366 tcp_cong_recovery_off (tc);
1367 /* Make sure we don't try to send unsent data */
1368 tc->snd_nxt = tc->snd_una;
1370 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1372 /* Make sure we don't wait in LAST ACK forever */
1373 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1375 /* Don't delete the connection yet */
1377 case TCP_STATE_FIN_WAIT_1:
1378 tcp_connection_timers_reset (tc);
1379 session_transport_closed_notify (&tc->connection);
1380 if (tc->flags & TCP_CONN_FINPNDG)
1382 /* If FIN pending, we haven't sent everything, but we did try.
1383 * Notify session layer that transport is closed. */
1384 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1385 tcp_send_reset (tc);
1386 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1390 /* We've sent the fin but no progress. Close the connection and
1391 * to make sure everything is flushed, setup a cleanup timer */
1392 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1393 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1396 case TCP_STATE_LAST_ACK:
1397 case TCP_STATE_CLOSING:
1398 tcp_connection_timers_reset (tc);
1399 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1400 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1401 session_transport_closed_notify (&tc->connection);
1404 tcp_connection_del (tc);
1410 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1412 tcp_timer_retransmit_handler,
1413 tcp_timer_delack_handler,
1414 tcp_timer_persist_handler,
1415 tcp_timer_keep_handler,
1416 tcp_timer_waitclose_handler,
1417 tcp_timer_retransmit_syn_handler,
1418 tcp_timer_establish_handler,
1419 tcp_timer_establish_ao_handler,
1424 tcp_expired_timers_dispatch (u32 * expired_timers)
1427 u32 connection_index, timer_id;
1429 for (i = 0; i < vec_len (expired_timers); i++)
1431 /* Get session index and timer id */
1432 connection_index = expired_timers[i] & 0x0FFFFFFF;
1433 timer_id = expired_timers[i] >> 28;
1435 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1437 /* Handle expiration */
1438 (*timer_expiration_handlers[timer_id]) (connection_index);
1443 tcp_initialize_timer_wheels (tcp_main_t * tm)
1445 tw_timer_wheel_16t_2w_512sl_t *tw;
1447 foreach_vlib_main (({
1448 tw = &tm->wrk_ctx[ii].timer_wheel;
1449 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1450 100e-3 /* timer period 100ms */ , ~0);
1451 tw->last_run_time = vlib_time_now (this_vlib_main);
1457 tcp_initialize_iss_seed (tcp_main_t * tm)
1459 u32 default_seed = random_default_seed ();
1460 u64 time_now = clib_cpu_time_now ();
1462 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1463 tm->iss_seed.second = random_u64 (&time_now);
1466 static clib_error_t *
1467 tcp_main_enable (vlib_main_t * vm)
1469 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1470 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1471 tcp_connection_t *tc __attribute__ ((unused));
1472 tcp_main_t *tm = vnet_get_tcp_main ();
1473 clib_error_t *error = 0;
1476 if ((error = vlib_call_init_function (vm, ip_main_init)))
1478 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1480 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1487 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1488 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1491 * Initialize data structures
1494 num_threads = 1 /* main thread */ + vtm->n_threads;
1495 vec_validate (tm->connections, num_threads - 1);
1496 vec_validate (tm->wrk_ctx, num_threads - 1);
1497 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1498 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1500 for (thread = 0; thread < num_threads; thread++)
1502 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1503 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1504 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1505 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1506 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1509 * Preallocate connections. Assume that thread 0 won't
1510 * use preallocated threads when running multi-core
1512 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1513 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1517 * Use a preallocated half-open connection pool?
1519 if (tm->preallocated_half_open_connections)
1520 pool_init_fixed (tm->half_open_connections,
1521 tm->preallocated_half_open_connections);
1523 /* Initialize clocks per tick for TCP timestamp. Used to compute
1524 * monotonically increasing timestamps. */
1525 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1526 / TCP_TSTAMP_RESOLUTION;
1528 if (num_threads > 1)
1530 clib_spinlock_init (&tm->half_open_lock);
1533 tcp_initialize_timer_wheels (tm);
1534 tcp_initialize_iss_seed (tm);
1536 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1537 tm->cc_last_type = TCP_CC_LAST;
1542 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1546 if (tcp_main.is_enabled)
1549 return tcp_main_enable (vm);
1553 tcp_main.is_enabled = 0;
1560 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1562 tcp_main_t *tm = &tcp_main;
1564 tm->punt_unknown4 = is_add;
1566 tm->punt_unknown6 = is_add;
1569 static clib_error_t *
1570 tcp_init (vlib_main_t * vm)
1572 tcp_main_t *tm = vnet_get_tcp_main ();
1573 ip_main_t *im = &ip_main;
1574 ip_protocol_info_t *pi;
1576 /* Session layer, and by implication tcp, are disabled by default */
1579 /* Register with IP for header parsing */
1580 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1582 return clib_error_return (0, "TCP protocol info AWOL");
1583 pi->format_header = format_tcp_header;
1584 pi->unformat_pg_edit = unformat_pg_tcp_header;
1586 /* Register as transport with session layer */
1587 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1588 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1589 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1590 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1592 tcp_api_reference ();
1593 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1595 tm->cc_algo = TCP_CC_NEWRENO;
1596 tm->default_mtu = 1460;
1597 tm->initial_cwnd_multiplier = 0;
1601 VLIB_INIT_FUNCTION (tcp_init);
1604 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1606 uword *result = va_arg (*va, uword *);
1607 tcp_main_t *tm = &tcp_main;
1612 if (unformat (input, "%s", &cc_algo_name)
1613 && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1619 vec_free (cc_algo_name);
1624 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1626 tcp_main_t *tm = vnet_get_tcp_main ();
1627 tcp_cc_algorithm_t *cc_alg;
1628 unformat_input_t sub_input;
1631 vec_foreach (cc_alg, tm->cc_algos)
1633 if (!unformat (input, cc_alg->name))
1636 if (cc_alg->unformat_cfg
1637 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1639 if (cc_alg->unformat_cfg (&sub_input))
1646 static clib_error_t *
1647 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1649 tcp_main_t *tm = vnet_get_tcp_main ();
1651 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1653 if (unformat (input, "preallocated-connections %d",
1654 &tm->preallocated_connections))
1656 else if (unformat (input, "preallocated-half-open-connections %d",
1657 &tm->preallocated_half_open_connections))
1659 else if (unformat (input, "buffer-fail-fraction %f",
1660 &tm->buffer_fail_fraction))
1662 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1665 else if (unformat (input, "mtu %d", &tm->default_mtu))
1667 else if (unformat (input, "initial-cwnd-multiplier %d",
1668 &tm->initial_cwnd_multiplier))
1670 else if (unformat (input, "no-tx-pacing"))
1672 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1675 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1678 return clib_error_return (0, "unknown input `%U'",
1679 format_unformat_error, input);
1684 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1688 * \brief Configure an ipv4 source address range
1689 * @param vm vlib_main_t pointer
1690 * @param start first ipv4 address in the source address range
1691 * @param end last ipv4 address in the source address range
1692 * @param table_id VRF / table ID, 0 for the default FIB
1693 * @return 0 if all OK, else an error indication from api_errno.h
1697 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1698 ip4_address_t * start,
1699 ip4_address_t * end, u32 table_id)
1701 tcp_main_t *tm = vnet_get_tcp_main ();
1702 vnet_main_t *vnm = vnet_get_main ();
1703 u32 start_host_byte_order, end_host_byte_order;
1704 fib_prefix_t prefix;
1705 fib_node_index_t fei;
1710 clib_memset (&prefix, 0, sizeof (prefix));
1712 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1714 if (fib_index == ~0)
1715 return VNET_API_ERROR_NO_SUCH_FIB;
1717 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1718 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1720 /* sanity check for reversed args or some such */
1721 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1722 return VNET_API_ERROR_INVALID_ARGUMENT;
1724 /* Lookup the last address, to identify the interface involved */
1726 prefix.fp_proto = FIB_PROTOCOL_IP4;
1727 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1729 fei = fib_table_lookup (fib_index, &prefix);
1731 /* Couldn't find route to destination. Bail out. */
1732 if (fei == FIB_NODE_INDEX_INVALID)
1733 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1735 sw_if_index = fib_entry_get_resolving_interface (fei);
1737 /* Configure proxy arp across the range */
1738 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1743 rv = vnet_proxy_arp_enable_disable (vnm, sw_if_index, 1);
1750 dpo_id_t dpo = DPO_INVALID;
1752 vec_add1 (tm->ip4_src_addresses, start[0]);
1754 /* Add local adjacencies for the range */
1756 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1759 prefix.fp_proto = FIB_PROTOCOL_IP4;
1760 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1762 fib_table_entry_special_dpo_update (fib_index,
1765 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1768 start_host_byte_order++;
1769 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1771 while (start_host_byte_order <= end_host_byte_order);
1777 * \brief Configure an ipv6 source address range
1778 * @param vm vlib_main_t pointer
1779 * @param start first ipv6 address in the source address range
1780 * @param end last ipv6 address in the source address range
1781 * @param table_id VRF / table ID, 0 for the default FIB
1782 * @return 0 if all OK, else an error indication from api_errno.h
1786 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1787 ip6_address_t * start,
1788 ip6_address_t * end, u32 table_id)
1790 tcp_main_t *tm = vnet_get_tcp_main ();
1791 fib_prefix_t prefix;
1793 fib_node_index_t fei;
1796 clib_memset (&prefix, 0, sizeof (prefix));
1798 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1800 if (fib_index == ~0)
1801 return VNET_API_ERROR_NO_SUCH_FIB;
1807 dpo_id_t dpo = DPO_INVALID;
1809 /* Remember this address */
1810 vec_add1 (tm->ip6_src_addresses, start[0]);
1812 /* Lookup the prefix, to identify the interface involved */
1813 prefix.fp_len = 128;
1814 prefix.fp_proto = FIB_PROTOCOL_IP6;
1815 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1817 fei = fib_table_lookup (fib_index, &prefix);
1819 /* Couldn't find route to destination. Bail out. */
1820 if (fei == FIB_NODE_INDEX_INVALID)
1821 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1823 sw_if_index = fib_entry_get_resolving_interface (fei);
1825 if (sw_if_index == (u32) ~ 0)
1826 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1828 /* Add a proxy neighbor discovery entry for this address */
1829 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1831 /* Add a receive adjacency for this address */
1832 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1835 fib_table_entry_special_dpo_update (fib_index,
1838 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1841 /* Done with the entire range? */
1842 if (!memcmp (start, end, sizeof (start[0])))
1845 /* Increment the address. DGMS. */
1847 for (i = 15; i >= 0; i--)
1850 if (tmp.as_u8[i] != 0)
1858 static clib_error_t *
1859 tcp_src_address (vlib_main_t * vm,
1860 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1862 ip4_address_t v4start, v4end;
1863 ip6_address_t v6start, v6end;
1869 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1871 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1872 unformat_ip4_address, &v4end))
1874 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1876 memcpy (&v4end, &v4start, sizeof (v4start));
1879 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1880 unformat_ip6_address, &v6end))
1882 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1884 memcpy (&v6end, &v6start, sizeof (v6start));
1887 else if (unformat (input, "fib-table %d", &table_id))
1893 if (!v4set && !v6set)
1894 return clib_error_return (0, "at least one v4 or v6 address required");
1898 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1905 case VNET_API_ERROR_NO_SUCH_FIB:
1906 return clib_error_return (0, "Invalid table-id %d", table_id);
1908 case VNET_API_ERROR_INVALID_ARGUMENT:
1909 return clib_error_return (0, "Invalid address range %U - %U",
1910 format_ip4_address, &v4start,
1911 format_ip4_address, &v4end);
1913 return clib_error_return (0, "error %d", rv);
1919 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1926 case VNET_API_ERROR_NO_SUCH_FIB:
1927 return clib_error_return (0, "Invalid table-id %d", table_id);
1930 return clib_error_return (0, "error %d", rv);
1938 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1940 .path = "tcp src-address",
1941 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1942 .function = tcp_src_address,
1947 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1949 #if TCP_SCOREBOARD_TRACE
1951 scoreboard_trace_elt_t *block;
1957 s = format (s, "scoreboard trace:");
1958 vec_foreach (block, sb->trace)
1960 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1961 block->ack, block->snd_una_max, block->group);
1963 s = format (s, "\n");
1971 static clib_error_t *
1972 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1973 vlib_cli_command_t * cmd_arg)
1975 transport_connection_t *tconn = 0;
1976 tcp_connection_t *tc;
1978 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1980 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1981 TRANSPORT_PROTO_TCP))
1984 return clib_error_return (0, "unknown input `%U'",
1985 format_unformat_error, input);
1988 if (!TCP_SCOREBOARD_TRACE)
1990 vlib_cli_output (vm, "scoreboard tracing not enabled");
1994 tc = tcp_get_connection_from_transport (tconn);
1995 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1996 vlib_cli_output (vm, "%v", s);
2001 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2003 .path = "show tcp scoreboard trace",
2004 .short_help = "show tcp scoreboard trace <connection>",
2005 .function = tcp_show_scoreboard_trace_fn,
2010 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2013 scoreboard_trace_elt_t *trace;
2014 u32 next_ack, left, group, has_new_ack = 0;
2015 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2016 sack_block_t *block;
2018 if (!TCP_SCOREBOARD_TRACE)
2020 s = format (s, "scoreboard tracing not enabled");
2027 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2028 tcp_connection_timers_init (dummy_tc);
2029 scoreboard_init (&dummy_tc->sack_sb);
2030 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2032 #if TCP_SCOREBOARD_TRACE
2033 trace = tc->sack_sb.trace;
2034 trace_len = vec_len (tc->sack_sb.trace);
2037 for (i = 0; i < trace_len; i++)
2039 if (trace[i].ack != 0)
2041 dummy_tc->snd_una = trace[i].ack - 1448;
2042 dummy_tc->snd_una_max = trace[i].ack;
2047 while (left < trace_len)
2049 group = trace[left].group;
2050 vec_reset_length (dummy_tc->rcv_opts.sacks);
2052 while (trace[left].group == group)
2054 if (trace[left].ack != 0)
2057 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2058 trace[left].ack, trace[left].snd_una_max);
2059 dummy_tc->snd_una_max = trace[left].snd_una_max;
2060 next_ack = trace[left].ack;
2066 s = format (s, "[%u, %u], ", trace[left].start,
2068 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2069 block->start = trace[left].start;
2070 block->end = trace[left].end;
2076 tcp_rcv_sacks (dummy_tc, next_ack);
2078 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2081 s = format (s, "result: %U", format_tcp_scoreboard,
2082 &dummy_tc->sack_sb);
2085 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2090 static clib_error_t *
2091 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2092 vlib_cli_command_t * cmd_arg)
2094 transport_connection_t *tconn = 0;
2095 tcp_connection_t *tc = 0;
2097 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2099 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2100 TRANSPORT_PROTO_TCP))
2103 return clib_error_return (0, "unknown input `%U'",
2104 format_unformat_error, input);
2107 if (!TCP_SCOREBOARD_TRACE)
2109 vlib_cli_output (vm, "scoreboard tracing not enabled");
2113 tc = tcp_get_connection_from_transport (tconn);
2116 vlib_cli_output (vm, "connection not found");
2119 str = tcp_scoreboard_replay (str, tc, 1);
2120 vlib_cli_output (vm, "%v", str);
2125 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2127 .path = "tcp replay scoreboard",
2128 .short_help = "tcp replay scoreboard <connection>",
2129 .function = tcp_scoreboard_trace_fn,
2133 static clib_error_t *
2134 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2135 vlib_cli_command_t * cmd_arg)
2137 tcp_main_t *tm = vnet_get_tcp_main ();
2138 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2139 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2141 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2142 tm->punt_unknown4 ? "enabled" : "disabled");
2143 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2144 tm->punt_unknown6 ? "enabled" : "disabled");
2148 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2150 .path = "show tcp punt",
2151 .short_help = "show tcp punt",
2152 .function = show_tcp_punt_fn,
2157 * fd.io coding-style-patch-verification: ON
2160 * eval: (c-set-style "gnu")