2 * Copyright (c) 2016 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 /* Poison the entry */
228 clib_memset (tc, 0xFA, sizeof (*tc));
229 pool_put (tm->connections[thread_index], tc);
234 * Connection removal.
236 * This should be called only once connection enters CLOSED state. Note
237 * that it notifies the session of the removal event, so if the goal is to
238 * just remove the connection, call tcp_connection_cleanup instead.
241 tcp_connection_del (tcp_connection_t * tc)
243 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
244 session_transport_delete_notify (&tc->connection);
245 tcp_connection_cleanup (tc);
249 tcp_connection_alloc (u8 thread_index)
251 tcp_main_t *tm = vnet_get_tcp_main ();
252 tcp_connection_t *tc;
254 pool_get (tm->connections[thread_index], tc);
255 clib_memset (tc, 0, sizeof (*tc));
256 tc->c_c_index = tc - tm->connections[thread_index];
257 tc->c_thread_index = thread_index;
262 tcp_connection_free (tcp_connection_t * tc)
264 tcp_main_t *tm = &tcp_main;
265 pool_put (tm->connections[tc->c_thread_index], tc);
267 clib_memset (tc, 0xFA, sizeof (*tc));
270 /** Notify session that connection has been reset.
272 * Switch state to closed and wait for session to call cleanup.
275 tcp_connection_reset (tcp_connection_t * tc)
277 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
280 case TCP_STATE_SYN_RCVD:
281 /* Cleanup everything. App wasn't notified yet */
282 session_transport_delete_notify (&tc->connection);
283 tcp_connection_cleanup (tc);
285 case TCP_STATE_SYN_SENT:
286 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
287 tcp_connection_cleanup (tc);
289 case TCP_STATE_ESTABLISHED:
290 tcp_connection_timers_reset (tc);
291 /* Set the cleanup timer, in case the session layer/app don't
292 * cleanly close the connection */
293 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
294 session_transport_reset_notify (&tc->connection);
295 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
297 case TCP_STATE_CLOSE_WAIT:
298 case TCP_STATE_FIN_WAIT_1:
299 case TCP_STATE_FIN_WAIT_2:
300 case TCP_STATE_CLOSING:
301 case TCP_STATE_LAST_ACK:
302 tcp_connection_timers_reset (tc);
303 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
304 /* Make sure we mark the session as closed. In some states we may
305 * be still trying to send data */
306 session_transport_closed_notify (&tc->connection);
307 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
309 case TCP_STATE_CLOSED:
310 case TCP_STATE_TIME_WAIT:
313 TCP_DBG ("reset state: %u", tc->state);
318 * Begin connection closing procedure.
320 * If at the end the connection is not in CLOSED state, it is not removed.
321 * Instead, we rely on on TCP to advance through state machine to either
322 * 1) LAST_ACK (passive close) whereby when the last ACK is received
323 * tcp_connection_del is called. This notifies session of the delete and
325 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
326 * and cleanup is called.
328 * N.B. Half-close connections are not supported
331 tcp_connection_close (tcp_connection_t * tc)
333 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
335 /* Send/Program FIN if needed and switch state */
338 case TCP_STATE_SYN_SENT:
339 /* Try to cleanup. If not on the right thread, mark as half-open done.
340 * Connection will be cleaned up when establish timer pops */
341 tcp_connection_cleanup (tc);
343 case TCP_STATE_SYN_RCVD:
344 tcp_connection_timers_reset (tc);
346 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
347 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
349 case TCP_STATE_ESTABLISHED:
350 if (!session_tx_fifo_max_dequeue (&tc->connection))
353 tc->flags |= TCP_CONN_FINPNDG;
354 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
355 /* Set a timer in case the peer stops responding. Otherwise the
356 * connection will be stuck here forever. */
357 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
358 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
360 case TCP_STATE_CLOSE_WAIT:
361 if (!session_tx_fifo_max_dequeue (&tc->connection))
364 tcp_connection_timers_reset (tc);
365 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
366 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
369 tc->flags |= TCP_CONN_FINPNDG;
371 case TCP_STATE_FIN_WAIT_1:
372 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
374 case TCP_STATE_CLOSED:
375 tcp_connection_timers_reset (tc);
376 /* Delete connection but instead of doing it now wait until next
377 * dispatch cycle to give the session layer a chance to clear
378 * unhandled events */
379 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
382 TCP_DBG ("state: %u", tc->state);
387 tcp_session_close (u32 conn_index, u32 thread_index)
389 tcp_connection_t *tc;
390 tc = tcp_connection_get (conn_index, thread_index);
391 tcp_connection_close (tc);
395 tcp_session_cleanup (u32 conn_index, u32 thread_index)
397 tcp_connection_t *tc;
398 tc = tcp_connection_get (conn_index, thread_index);
399 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
400 tcp_connection_cleanup (tc);
404 * Initialize all connection timers as invalid
407 tcp_connection_timers_init (tcp_connection_t * tc)
411 /* Set all to invalid */
412 for (i = 0; i < TCP_N_TIMERS; i++)
414 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
417 tc->rto = TCP_RTO_INIT;
421 * Stop all connection timers
424 tcp_connection_timers_reset (tcp_connection_t * tc)
427 for (i = 0; i < TCP_N_TIMERS; i++)
429 tcp_timer_reset (tc, i);
434 typedef struct ip4_tcp_hdr
440 typedef struct ip6_tcp_hdr
447 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
450 const dpo_id_t *choice;
454 lb = load_balance_get (dpo->dpoi_index);
458 clib_memset (&hdr, 0, sizeof (hdr));
459 hdr.ip.protocol = IP_PROTOCOL_TCP;
460 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
461 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
462 hdr.tcp.src_port = tc->c_lcl_port;
463 hdr.tcp.dst_port = tc->c_rmt_port;
464 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
469 clib_memset (&hdr, 0, sizeof (hdr));
470 hdr.ip.protocol = IP_PROTOCOL_TCP;
471 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
472 sizeof (ip6_address_t));
473 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
474 sizeof (ip6_address_t));
475 hdr.tcp.src_port = tc->c_lcl_port;
476 hdr.tcp.dst_port = tc->c_rmt_port;
477 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
479 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
480 dpo_copy (result, choice);
484 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
489 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
490 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
491 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
492 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
493 return fib_table_lookup (fib_index, &prefix);
497 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
499 dpo_id_t choice = DPO_INVALID;
500 u32 output_node_index;
503 fe = fib_entry_get (tc->c_rmt_fei);
504 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
507 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
510 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
511 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
515 /** Stack tcp connection on peer's fib entry.
517 * This ultimately populates the dpo the connection will use to send packets.
520 tcp_connection_fib_attach (tcp_connection_t * tc)
522 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
524 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
526 tcp_connection_stack_on_fib_entry (tc);
531 tcp_cc_init (tcp_connection_t * tc)
533 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
534 tc->cc_algo->init (tc);
538 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
539 const tcp_cc_algorithm_t * vft)
541 tcp_main_t *tm = vnet_get_tcp_main ();
542 vec_validate (tm->cc_algos, type);
544 tm->cc_algos[type] = *vft;
548 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
550 tcp_main_t *tm = vnet_get_tcp_main ();
551 return &tm->cc_algos[type];
555 * Generate random iss as per rfc6528
558 tcp_generate_random_iss (tcp_connection_t * tc)
560 tcp_main_t *tm = &tcp_main;
564 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
566 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
567 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
569 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
570 tmp ^= tm->iss_seed.second;
571 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
572 return ((tmp >> 32) ^ (tmp & 0xffffffff));
576 * Initialize connection send variables.
579 tcp_init_snd_vars (tcp_connection_t * tc)
582 * We use the time to randomize iss and for setting up the initial
583 * timestamp. Make sure it's updated otherwise syn and ack in the
584 * handshake may make it look as if time has flown in the opposite
587 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
589 tc->iss = tcp_generate_random_iss (tc);
590 tc->snd_una = tc->iss;
591 tc->snd_nxt = tc->iss + 1;
592 tc->snd_una_max = tc->snd_nxt;
597 tcp_enable_pacing (tcp_connection_t * tc)
599 u32 initial_bucket, byte_rate;
600 initial_bucket = 16 * tc->snd_mss;
602 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
604 tc->mrtt_us = (u32) ~ 0;
607 /** Initialize tcp connection variables
609 * Should be called after having received a msg from the peer, i.e., a SYN or
610 * a SYNACK, such that connection options have already been exchanged. */
612 tcp_connection_init_vars (tcp_connection_t * tc)
614 tcp_connection_timers_init (tc);
616 scoreboard_init (&tc->sack_sb);
618 if (tc->state == TCP_STATE_SYN_RCVD)
619 tcp_init_snd_vars (tc);
621 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
622 tcp_add_del_adjacency (tc, 1);
624 /* tcp_connection_fib_attach (tc); */
626 if (transport_connection_is_tx_paced (&tc->connection)
627 || tcp_main.tx_pacing)
628 tcp_enable_pacing (tc);
632 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
633 u16 * lcl_port, u8 is_ip4)
638 index = tm->last_v4_address_rotor++;
639 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
640 tm->last_v4_address_rotor = 0;
641 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
645 index = tm->last_v6_address_rotor++;
646 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
647 tm->last_v6_address_rotor = 0;
648 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
649 sizeof (ip6_address_t));
651 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
654 clib_warning ("Failed to allocate src port");
662 tcp_session_open (transport_endpoint_cfg_t * rmt)
664 tcp_main_t *tm = vnet_get_tcp_main ();
665 tcp_connection_t *tc;
666 ip46_address_t lcl_addr;
671 * Allocate local endpoint
673 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
674 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
675 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
678 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
679 rmt, &lcl_addr, &lcl_port);
685 * Create connection and send SYN
687 clib_spinlock_lock_if_init (&tm->half_open_lock);
688 tc = tcp_half_open_connection_new ();
689 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
690 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
691 tc->c_rmt_port = rmt->port;
692 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
693 tc->c_is_ip4 = rmt->is_ip4;
694 tc->c_proto = TRANSPORT_PROTO_TCP;
695 tc->c_fib_index = rmt->fib_index;
696 /* The other connection vars will be initialized after SYN ACK */
697 tcp_connection_timers_init (tc);
699 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
700 tc->state = TCP_STATE_SYN_SENT;
701 tcp_init_snd_vars (tc);
703 clib_spinlock_unlock_if_init (&tm->half_open_lock);
705 return tc->c_c_index;
708 const char *tcp_dbg_evt_str[] = {
709 #define _(sym, str) str,
714 const char *tcp_fsm_states[] = {
715 #define _(sym, str) str,
716 foreach_tcp_fsm_state
721 format_tcp_state (u8 * s, va_list * args)
723 u32 state = va_arg (*args, u32);
725 if (state < TCP_N_STATES)
726 s = format (s, "%s", tcp_fsm_states[state]);
728 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
732 const char *tcp_connection_flags_str[] = {
733 #define _(sym, str) str,
734 foreach_tcp_connection_flag
739 format_tcp_connection_flags (u8 * s, va_list * args)
741 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
744 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
745 if (tc->flags & (1 << i))
747 for (i = 0; i < last; i++)
749 if (tc->flags & (1 << i))
750 s = format (s, "%s, ", tcp_connection_flags_str[i]);
753 s = format (s, "%s", tcp_connection_flags_str[last]);
757 const char *tcp_conn_timers[] = {
758 #define _(sym, str) str,
764 format_tcp_timers (u8 * s, va_list * args)
766 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
769 for (i = 0; i < TCP_N_TIMERS; i++)
770 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
773 for (i = 0; i < last; i++)
775 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
776 s = format (s, "%s,", tcp_conn_timers[i]);
780 s = format (s, "%s", tcp_conn_timers[i]);
786 format_tcp_congestion_status (u8 * s, va_list * args)
788 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
789 if (tcp_in_recovery (tc))
790 s = format (s, "recovery");
791 else if (tcp_in_fastrecovery (tc))
792 s = format (s, "fastrecovery");
794 s = format (s, "none");
799 tcp_rcv_wnd_available (tcp_connection_t * tc)
801 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
805 format_tcp_congestion (u8 * s, va_list * args)
807 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
808 u32 indent = format_get_indent (s);
810 s = format (s, "%U ", format_tcp_congestion_status, tc);
811 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
812 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
813 s = format (s, "%Ucc space %u prev_ssthresh %u snd_congestion %u"
814 " dupack %u\n", format_white_space, indent,
815 tcp_available_cc_snd_space (tc), tc->prev_ssthresh,
816 tc->snd_congestion - tc->iss, tc->rcv_dupacks);
817 s = format (s, "%Utsecr %u tsecr_last_ack %u limited_transmit %u\n",
818 format_white_space, indent, tc->rcv_opts.tsecr,
819 tc->tsecr_last_ack, tc->limited_transmit - tc->iss);
824 format_tcp_vars (u8 * s, va_list * args)
826 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
827 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
828 format_tcp_connection_flags, tc, format_tcp_timers, tc);
829 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
830 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
831 tc->snd_una_max - tc->iss);
832 s = format (s, " rcv_nxt %u rcv_las %u\n",
833 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
834 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
835 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
836 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
837 tc->snd_wl2 - tc->iss);
838 s = format (s, " flight size %u out space %u rcv_wnd_av %u\n",
839 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
840 tcp_rcv_wnd_available (tc));
841 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
842 tcp_time_now () - tc->tsval_recent_age);
843 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %x",
844 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
846 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
847 s = format (s, " cong: %U", format_tcp_congestion, tc);
849 if (tc->state >= TCP_STATE_ESTABLISHED)
851 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
854 if (vec_len (tc->snd_sacks))
855 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
861 format_tcp_connection_id (u8 * s, va_list * args)
863 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
868 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
869 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
870 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
871 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
875 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
876 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
877 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
878 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
885 format_tcp_connection (u8 * s, va_list * args)
887 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
888 u32 verbose = va_arg (*args, u32);
892 s = format (s, "%-50U", format_tcp_connection_id, tc);
895 s = format (s, "%-15U", format_tcp_state, tc->state);
897 s = format (s, "\n%U", format_tcp_vars, tc);
904 format_tcp_session (u8 * s, va_list * args)
906 u32 tci = va_arg (*args, u32);
907 u32 thread_index = va_arg (*args, u32);
908 u32 verbose = va_arg (*args, u32);
909 tcp_connection_t *tc;
911 tc = tcp_connection_get (tci, thread_index);
913 s = format (s, "%U", format_tcp_connection, tc, verbose);
915 s = format (s, "empty\n");
920 format_tcp_listener_session (u8 * s, va_list * args)
922 u32 tci = va_arg (*args, u32);
923 tcp_connection_t *tc = tcp_listener_get (tci);
924 return format (s, "%U", format_tcp_connection_id, tc);
928 format_tcp_half_open_session (u8 * s, va_list * args)
930 u32 tci = va_arg (*args, u32);
931 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
932 return format (s, "%U", format_tcp_connection_id, tc);
936 format_tcp_sacks (u8 * s, va_list * args)
938 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
939 sack_block_t *sacks = tc->snd_sacks;
943 len = vec_len (sacks);
944 for (i = 0; i < len - 1; i++)
947 s = format (s, " start %u end %u\n", block->start - tc->irs,
948 block->end - tc->irs);
952 block = &sacks[len - 1];
953 s = format (s, " start %u end %u", block->start - tc->irs,
954 block->end - tc->irs);
960 format_tcp_rcv_sacks (u8 * s, va_list * args)
962 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
963 sack_block_t *sacks = tc->rcv_opts.sacks;
967 len = vec_len (sacks);
968 for (i = 0; i < len - 1; i++)
971 s = format (s, " start %u end %u\n", block->start - tc->iss,
972 block->end - tc->iss);
976 block = &sacks[len - 1];
977 s = format (s, " start %u end %u", block->start - tc->iss,
978 block->end - tc->iss);
984 format_tcp_sack_hole (u8 * s, va_list * args)
986 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
987 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
989 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
991 s = format (s, " [%u, %u]", hole->start, hole->end);
996 format_tcp_scoreboard (u8 * s, va_list * args)
998 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
999 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1000 sack_scoreboard_hole_t *hole;
1001 u32 indent = format_get_indent (s);
1003 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1004 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1005 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1006 format_white_space, indent, sb->last_bytes_delivered,
1007 sb->high_sacked - tc->iss, sb->snd_una_adv);
1008 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1009 format_white_space, indent, sb->cur_rxt_hole,
1010 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1012 hole = scoreboard_first_hole (sb);
1014 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1015 indent, sb->head, sb->tail, pool_elts (sb->holes),
1016 format_white_space, indent);
1020 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1021 hole = scoreboard_next_hole (sb, hole);
1027 static transport_connection_t *
1028 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1030 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1031 return &tc->connection;
1034 static transport_connection_t *
1035 tcp_half_open_session_get_transport (u32 conn_index)
1037 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1038 return &tc->connection;
1042 * Compute maximum segment size for session layer.
1044 * Since the result needs to be the actual data length, it first computes
1045 * the tcp options to be used in the next burst and subtracts their
1046 * length from the connection's snd_mss.
1049 tcp_session_send_mss (transport_connection_t * trans_conn)
1051 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1053 /* Ensure snd_mss does accurately reflect the amount of data we can push
1054 * in a segment. This also makes sure that options are updated according to
1055 * the current state of the connection. */
1056 tcp_update_burst_snd_vars (tc);
1062 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1064 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1066 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1069 /* If not snd_wnd constrained and we can't write at least a segment,
1070 * don't try at all */
1071 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1072 return snd_space < tc->cwnd ? 0 : snd_space;
1074 /* round down to mss multiple */
1075 return snd_space - (snd_space % tc->snd_mss);
1079 * Compute tx window session is allowed to fill.
1081 * Takes into account available send space, snd_mss and the congestion
1082 * state of the connection. If possible, the value returned is a multiple
1085 * @param tc tcp connection
1086 * @return number of bytes session is allowed to write
1089 tcp_snd_space_inline (tcp_connection_t * tc)
1091 int snd_space, snt_limited;
1093 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1094 || tc->state == TCP_STATE_CLOSED))
1097 snd_space = tcp_available_output_snd_space (tc);
1099 /* If we haven't gotten dupacks or if we did and have gotten sacked
1100 * bytes then we can still send as per Limited Transmit (RFC3042) */
1101 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1102 && (tcp_opts_sack_permitted (tc)
1103 && tc->sack_sb.last_sacked_bytes == 0)))
1105 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1106 tc->limited_transmit = tc->snd_nxt;
1107 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1109 snt_limited = tc->snd_nxt - tc->limited_transmit;
1110 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1112 return tcp_round_snd_space (tc, snd_space);
1116 tcp_snd_space (tcp_connection_t * tc)
1118 return tcp_snd_space_inline (tc);
1122 tcp_session_send_space (transport_connection_t * trans_conn)
1124 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1125 return clib_min (tcp_snd_space_inline (tc),
1126 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1130 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1132 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1134 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1136 /* This still works if fast retransmit is on */
1137 return (tc->snd_nxt - tc->snd_una);
1141 tcp_update_time (f64 now, u8 thread_index)
1143 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1145 tcp_set_time_now (wrk);
1146 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1147 tcp_do_fastretransmits (wrk);
1148 tcp_send_acks (wrk);
1149 tcp_flush_frames_to_output (wrk);
1153 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1155 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1156 return tcp_push_header (tc, b);
1160 tcp_session_flush_data (transport_connection_t * tconn)
1162 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1163 if (tc->flags & TCP_CONN_PSH_PENDING)
1165 tc->flags |= TCP_CONN_PSH_PENDING;
1166 tc->psh_seq = tc->snd_una_max + transport_max_tx_dequeue (tconn) - 1;
1170 const static transport_proto_vft_t tcp_proto = {
1171 .enable = vnet_tcp_enable_disable,
1172 .bind = tcp_session_bind,
1173 .unbind = tcp_session_unbind,
1174 .push_header = tcp_session_push_header,
1175 .get_connection = tcp_session_get_transport,
1176 .get_listener = tcp_session_get_listener,
1177 .get_half_open = tcp_half_open_session_get_transport,
1178 .open = tcp_session_open,
1179 .close = tcp_session_close,
1180 .cleanup = tcp_session_cleanup,
1181 .send_mss = tcp_session_send_mss,
1182 .send_space = tcp_session_send_space,
1183 .update_time = tcp_update_time,
1184 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1185 .flush_data = tcp_session_flush_data,
1186 .format_connection = format_tcp_session,
1187 .format_listener = format_tcp_listener_session,
1188 .format_half_open = format_tcp_half_open_session,
1189 .tx_type = TRANSPORT_TX_PEEK,
1190 .service_type = TRANSPORT_SERVICE_VC,
1195 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1200 if (!transport_connection_is_tx_paced (&tc->connection))
1203 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1204 /* TODO should constrain to interface's max throughput but
1205 * we don't have link speeds for sw ifs ..*/
1206 rate = tc->cwnd / srtt;
1207 transport_connection_tx_pacer_update (&tc->connection, rate);
1211 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1214 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1215 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1216 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1217 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1218 start_bucket, last_time);
1222 tcp_timer_keep_handler (u32 conn_index)
1224 u32 thread_index = vlib_get_thread_index ();
1225 tcp_connection_t *tc;
1227 tc = tcp_connection_get (conn_index, thread_index);
1228 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1230 tcp_connection_close (tc);
1234 tcp_timer_establish_handler (u32 conn_index)
1236 tcp_connection_t *tc;
1238 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1239 /* note: the connection may have already disappeared */
1240 if (PREDICT_FALSE (tc == 0))
1242 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1243 /* Start cleanup. App wasn't notified yet so use delete notify as
1244 * opposed to delete to cleanup session layer state. */
1245 session_transport_delete_notify (&tc->connection);
1246 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1247 tcp_connection_cleanup (tc);
1251 tcp_timer_establish_ao_handler (u32 conn_index)
1253 tcp_connection_t *tc;
1255 tc = tcp_half_open_connection_get (conn_index);
1259 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1260 /* Notify app if we haven't tried to clean this up already */
1261 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1262 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1264 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1265 tcp_connection_cleanup (tc);
1269 tcp_timer_waitclose_handler (u32 conn_index)
1271 u32 thread_index = vlib_get_thread_index (), rto;
1272 tcp_connection_t *tc;
1274 tc = tcp_connection_get (conn_index, thread_index);
1277 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1281 case TCP_STATE_CLOSE_WAIT:
1282 tcp_connection_timers_reset (tc);
1283 session_transport_closed_notify (&tc->connection);
1285 if (!(tc->flags & TCP_CONN_FINPNDG))
1287 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1288 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1292 /* Session didn't come back with a close. Send FIN either way
1293 * and switch to LAST_ACK. */
1294 tcp_cong_recovery_off (tc);
1295 /* Make sure we don't try to send unsent data */
1296 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1298 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1300 /* Make sure we don't wait in LAST ACK forever */
1301 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1303 /* Don't delete the connection yet */
1305 case TCP_STATE_FIN_WAIT_1:
1306 tcp_connection_timers_reset (tc);
1307 if (tc->flags & TCP_CONN_FINPNDG)
1309 /* If FIN pending send it before closing and wait as long as
1310 * the rto timeout would wait. Notify session layer that transport
1311 * is closed. We haven't sent everything but we did try. */
1312 tcp_cong_recovery_off (tc);
1314 rto = clib_max ((tc->rto >> tc->rto_boff) * TCP_TO_TIMER_TICK, 1);
1315 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE,
1316 clib_min (rto, TCP_2MSL_TIME));
1317 session_transport_closed_notify (&tc->connection);
1321 /* We've sent the fin but no progress. Close the connection and
1322 * to make sure everything is flushed, setup a cleanup timer */
1323 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1324 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1327 case TCP_STATE_LAST_ACK:
1328 case TCP_STATE_CLOSING:
1329 tcp_connection_timers_reset (tc);
1330 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1331 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1332 session_transport_closed_notify (&tc->connection);
1335 tcp_connection_del (tc);
1341 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1343 tcp_timer_retransmit_handler,
1344 tcp_timer_delack_handler,
1345 tcp_timer_persist_handler,
1346 tcp_timer_keep_handler,
1347 tcp_timer_waitclose_handler,
1348 tcp_timer_retransmit_syn_handler,
1349 tcp_timer_establish_handler,
1350 tcp_timer_establish_ao_handler,
1355 tcp_expired_timers_dispatch (u32 * expired_timers)
1358 u32 connection_index, timer_id;
1360 for (i = 0; i < vec_len (expired_timers); i++)
1362 /* Get session index and timer id */
1363 connection_index = expired_timers[i] & 0x0FFFFFFF;
1364 timer_id = expired_timers[i] >> 28;
1366 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1368 /* Handle expiration */
1369 (*timer_expiration_handlers[timer_id]) (connection_index);
1374 tcp_initialize_timer_wheels (tcp_main_t * tm)
1376 tw_timer_wheel_16t_2w_512sl_t *tw;
1378 foreach_vlib_main (({
1379 tw = &tm->wrk_ctx[ii].timer_wheel;
1380 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1381 100e-3 /* timer period 100ms */ , ~0);
1382 tw->last_run_time = vlib_time_now (this_vlib_main);
1388 tcp_initialize_iss_seed (tcp_main_t * tm)
1390 u32 default_seed = random_default_seed ();
1391 u64 time_now = clib_cpu_time_now ();
1393 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1394 tm->iss_seed.second = random_u64 (&time_now);
1397 static clib_error_t *
1398 tcp_main_enable (vlib_main_t * vm)
1400 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1401 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1402 tcp_connection_t *tc __attribute__ ((unused));
1403 tcp_main_t *tm = vnet_get_tcp_main ();
1404 clib_error_t *error = 0;
1407 if ((error = vlib_call_init_function (vm, ip_main_init)))
1409 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1411 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1418 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1419 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1422 * Initialize data structures
1425 num_threads = 1 /* main thread */ + vtm->n_threads;
1426 vec_validate (tm->connections, num_threads - 1);
1427 vec_validate (tm->wrk_ctx, num_threads - 1);
1428 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1429 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1431 for (thread = 0; thread < num_threads; thread++)
1433 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1434 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1435 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1436 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1437 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1438 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1439 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1440 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1441 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1442 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1443 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1444 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1445 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1448 * Preallocate connections. Assume that thread 0 won't
1449 * use preallocated threads when running multi-core
1451 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1452 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1456 * Use a preallocated half-open connection pool?
1458 if (tm->preallocated_half_open_connections)
1459 pool_init_fixed (tm->half_open_connections,
1460 tm->preallocated_half_open_connections);
1462 /* Initialize clocks per tick for TCP timestamp. Used to compute
1463 * monotonically increasing timestamps. */
1464 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1465 / TCP_TSTAMP_RESOLUTION;
1467 if (num_threads > 1)
1469 clib_spinlock_init (&tm->half_open_lock);
1472 tcp_initialize_timer_wheels (tm);
1473 tcp_initialize_iss_seed (tm);
1475 tm->bytes_per_buffer = VLIB_BUFFER_DATA_SIZE;
1481 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1485 if (tcp_main.is_enabled)
1488 return tcp_main_enable (vm);
1492 tcp_main.is_enabled = 0;
1499 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1501 tcp_main_t *tm = &tcp_main;
1503 tm->punt_unknown4 = is_add;
1505 tm->punt_unknown6 = is_add;
1508 static clib_error_t *
1509 tcp_init (vlib_main_t * vm)
1511 tcp_main_t *tm = vnet_get_tcp_main ();
1512 ip_main_t *im = &ip_main;
1513 ip_protocol_info_t *pi;
1515 /* Session layer, and by implication tcp, are disabled by default */
1518 /* Register with IP for header parsing */
1519 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1521 return clib_error_return (0, "TCP protocol info AWOL");
1522 pi->format_header = format_tcp_header;
1523 pi->unformat_pg_edit = unformat_pg_tcp_header;
1525 /* Register as transport with session layer */
1526 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1527 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1528 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1529 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1531 tcp_api_reference ();
1533 tm->cc_algo = TCP_CC_NEWRENO;
1537 VLIB_INIT_FUNCTION (tcp_init);
1540 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1542 uword *result = va_arg (*va, uword *);
1544 if (unformat (input, "newreno"))
1545 *result = TCP_CC_NEWRENO;
1546 else if (unformat (input, "cubic"))
1547 *result = TCP_CC_CUBIC;
1555 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1557 tcp_main_t *tm = vnet_get_tcp_main ();
1558 tcp_cc_algorithm_t *cc_alg;
1559 unformat_input_t sub_input;
1562 vec_foreach (cc_alg, tm->cc_algos)
1564 if (!unformat (input, cc_alg->name))
1567 if (cc_alg->unformat_cfg
1568 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1570 if (cc_alg->unformat_cfg (&sub_input))
1577 static clib_error_t *
1578 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1580 tcp_main_t *tm = vnet_get_tcp_main ();
1582 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1584 if (unformat (input, "preallocated-connections %d",
1585 &tm->preallocated_connections))
1587 else if (unformat (input, "preallocated-half-open-connections %d",
1588 &tm->preallocated_half_open_connections))
1590 else if (unformat (input, "buffer-fail-fraction %f",
1591 &tm->buffer_fail_fraction))
1593 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1596 else if (unformat (input, "no-tx-pacing"))
1598 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1601 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1604 return clib_error_return (0, "unknown input `%U'",
1605 format_unformat_error, input);
1610 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1614 * \brief Configure an ipv4 source address range
1615 * @param vm vlib_main_t pointer
1616 * @param start first ipv4 address in the source address range
1617 * @param end last ipv4 address in the source address range
1618 * @param table_id VRF / table ID, 0 for the default FIB
1619 * @return 0 if all OK, else an error indication from api_errno.h
1623 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1624 ip4_address_t * start,
1625 ip4_address_t * end, u32 table_id)
1627 tcp_main_t *tm = vnet_get_tcp_main ();
1628 vnet_main_t *vnm = vnet_get_main ();
1629 u32 start_host_byte_order, end_host_byte_order;
1630 fib_prefix_t prefix;
1631 vnet_sw_interface_t *si;
1632 fib_node_index_t fei;
1636 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1637 ip4_address_t * hi_addr, u32 fib_index,
1640 clib_memset (&prefix, 0, sizeof (prefix));
1642 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1644 if (fib_index == ~0)
1645 return VNET_API_ERROR_NO_SUCH_FIB;
1647 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1648 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1650 /* sanity check for reversed args or some such */
1651 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1652 return VNET_API_ERROR_INVALID_ARGUMENT;
1654 /* Lookup the last address, to identify the interface involved */
1656 prefix.fp_proto = FIB_PROTOCOL_IP4;
1657 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1659 fei = fib_table_lookup (fib_index, &prefix);
1661 /* Couldn't find route to destination. Bail out. */
1662 if (fei == FIB_NODE_INDEX_INVALID)
1663 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1665 sw_if_index = fib_entry_get_resolving_interface (fei);
1667 /* Enable proxy arp on the interface */
1668 si = vnet_get_sw_interface (vnm, sw_if_index);
1669 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1671 /* Configure proxy arp across the range */
1672 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1679 dpo_id_t dpo = DPO_INVALID;
1681 vec_add1 (tm->ip4_src_addresses, start[0]);
1683 /* Add local adjacencies for the range */
1685 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1688 prefix.fp_proto = FIB_PROTOCOL_IP4;
1689 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1691 fib_table_entry_special_dpo_update (fib_index,
1694 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1697 start_host_byte_order++;
1698 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1700 while (start_host_byte_order <= end_host_byte_order);
1706 * \brief Configure an ipv6 source address range
1707 * @param vm vlib_main_t pointer
1708 * @param start first ipv6 address in the source address range
1709 * @param end last ipv6 address in the source address range
1710 * @param table_id VRF / table ID, 0 for the default FIB
1711 * @return 0 if all OK, else an error indication from api_errno.h
1715 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1716 ip6_address_t * start,
1717 ip6_address_t * end, u32 table_id)
1719 tcp_main_t *tm = vnet_get_tcp_main ();
1720 fib_prefix_t prefix;
1722 fib_node_index_t fei;
1725 clib_memset (&prefix, 0, sizeof (prefix));
1727 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1729 if (fib_index == ~0)
1730 return VNET_API_ERROR_NO_SUCH_FIB;
1736 dpo_id_t dpo = DPO_INVALID;
1738 /* Remember this address */
1739 vec_add1 (tm->ip6_src_addresses, start[0]);
1741 /* Lookup the prefix, to identify the interface involved */
1742 prefix.fp_len = 128;
1743 prefix.fp_proto = FIB_PROTOCOL_IP6;
1744 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1746 fei = fib_table_lookup (fib_index, &prefix);
1748 /* Couldn't find route to destination. Bail out. */
1749 if (fei == FIB_NODE_INDEX_INVALID)
1750 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1752 sw_if_index = fib_entry_get_resolving_interface (fei);
1754 if (sw_if_index == (u32) ~ 0)
1755 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1757 /* Add a proxy neighbor discovery entry for this address */
1758 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1760 /* Add a receive adjacency for this address */
1761 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1764 fib_table_entry_special_dpo_update (fib_index,
1767 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1770 /* Done with the entire range? */
1771 if (!memcmp (start, end, sizeof (start[0])))
1774 /* Increment the address. DGMS. */
1776 for (i = 15; i >= 0; i--)
1779 if (tmp.as_u8[i] != 0)
1787 static clib_error_t *
1788 tcp_src_address (vlib_main_t * vm,
1789 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1791 ip4_address_t v4start, v4end;
1792 ip6_address_t v6start, v6end;
1798 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1800 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1801 unformat_ip4_address, &v4end))
1803 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1805 memcpy (&v4end, &v4start, sizeof (v4start));
1808 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1809 unformat_ip6_address, &v6end))
1811 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1813 memcpy (&v6end, &v6start, sizeof (v6start));
1816 else if (unformat (input, "fib-table %d", &table_id))
1822 if (!v4set && !v6set)
1823 return clib_error_return (0, "at least one v4 or v6 address required");
1827 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1834 case VNET_API_ERROR_NO_SUCH_FIB:
1835 return clib_error_return (0, "Invalid table-id %d", table_id);
1837 case VNET_API_ERROR_INVALID_ARGUMENT:
1838 return clib_error_return (0, "Invalid address range %U - %U",
1839 format_ip4_address, &v4start,
1840 format_ip4_address, &v4end);
1842 return clib_error_return (0, "error %d", rv);
1848 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1855 case VNET_API_ERROR_NO_SUCH_FIB:
1856 return clib_error_return (0, "Invalid table-id %d", table_id);
1859 return clib_error_return (0, "error %d", rv);
1867 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1869 .path = "tcp src-address",
1870 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1871 .function = tcp_src_address,
1876 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1878 #if TCP_SCOREBOARD_TRACE
1880 scoreboard_trace_elt_t *block;
1886 s = format (s, "scoreboard trace:");
1887 vec_foreach (block, sb->trace)
1889 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1890 block->ack, block->snd_una_max, block->group);
1892 s = format (s, "\n");
1900 static clib_error_t *
1901 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1902 vlib_cli_command_t * cmd_arg)
1904 transport_connection_t *tconn = 0;
1905 tcp_connection_t *tc;
1907 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1909 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1910 TRANSPORT_PROTO_TCP))
1913 return clib_error_return (0, "unknown input `%U'",
1914 format_unformat_error, input);
1917 if (!TCP_SCOREBOARD_TRACE)
1919 vlib_cli_output (vm, "scoreboard tracing not enabled");
1923 tc = tcp_get_connection_from_transport (tconn);
1924 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1925 vlib_cli_output (vm, "%v", s);
1930 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1932 .path = "show tcp scoreboard trace",
1933 .short_help = "show tcp scoreboard trace <connection>",
1934 .function = tcp_show_scoreboard_trace_fn,
1939 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1942 scoreboard_trace_elt_t *trace;
1943 u32 next_ack, left, group, has_new_ack = 0;
1944 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1945 sack_block_t *block;
1947 if (!TCP_SCOREBOARD_TRACE)
1949 s = format (s, "scoreboard tracing not enabled");
1956 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1957 tcp_connection_timers_init (dummy_tc);
1958 scoreboard_init (&dummy_tc->sack_sb);
1959 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1961 #if TCP_SCOREBOARD_TRACE
1962 trace = tc->sack_sb.trace;
1963 trace_len = vec_len (tc->sack_sb.trace);
1966 for (i = 0; i < trace_len; i++)
1968 if (trace[i].ack != 0)
1970 dummy_tc->snd_una = trace[i].ack - 1448;
1971 dummy_tc->snd_una_max = trace[i].ack;
1976 while (left < trace_len)
1978 group = trace[left].group;
1979 vec_reset_length (dummy_tc->rcv_opts.sacks);
1981 while (trace[left].group == group)
1983 if (trace[left].ack != 0)
1986 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1987 trace[left].ack, trace[left].snd_una_max);
1988 dummy_tc->snd_una_max = trace[left].snd_una_max;
1989 next_ack = trace[left].ack;
1995 s = format (s, "[%u, %u], ", trace[left].start,
1997 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1998 block->start = trace[left].start;
1999 block->end = trace[left].end;
2005 tcp_rcv_sacks (dummy_tc, next_ack);
2007 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2010 s = format (s, "result: %U", format_tcp_scoreboard,
2011 &dummy_tc->sack_sb);
2014 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2019 static clib_error_t *
2020 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2021 vlib_cli_command_t * cmd_arg)
2023 transport_connection_t *tconn = 0;
2024 tcp_connection_t *tc = 0;
2026 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2028 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2029 TRANSPORT_PROTO_TCP))
2032 return clib_error_return (0, "unknown input `%U'",
2033 format_unformat_error, input);
2036 if (!TCP_SCOREBOARD_TRACE)
2038 vlib_cli_output (vm, "scoreboard tracing not enabled");
2042 tc = tcp_get_connection_from_transport (tconn);
2045 vlib_cli_output (vm, "connection not found");
2048 str = tcp_scoreboard_replay (str, tc, 1);
2049 vlib_cli_output (vm, "%v", str);
2054 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2056 .path = "tcp replay scoreboard",
2057 .short_help = "tcp replay scoreboard <connection>",
2058 .function = tcp_scoreboard_trace_fn,
2062 static clib_error_t *
2063 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2064 vlib_cli_command_t * cmd_arg)
2066 tcp_main_t *tm = vnet_get_tcp_main ();
2067 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2068 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2070 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2071 tm->punt_unknown4 ? "enabled" : "disabled");
2072 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2073 tm->punt_unknown6 ? "enabled" : "disabled");
2077 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2079 .path = "show tcp punt",
2080 .short_help = "show tcp punt",
2081 .function = show_tcp_punt_fn,
2086 * fd.io coding-style-patch-verification: ON
2089 * eval: (c-set-style "gnu")