2 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 * @brief TCP host stack utilities
21 #include <vnet/tcp/tcp.h>
22 #include <vnet/session/session.h>
23 #include <vnet/fib/fib.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/dpo/receive_dpo.h>
26 #include <vnet/ip/ip6_neighbor.h>
33 fib_protocol_t nh_proto;
34 vnet_link_t link_type;
38 } tcp_add_del_adj_args_t;
41 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
46 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
51 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
53 if (ai != ADJ_INDEX_INVALID)
59 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
61 tcp_add_del_adj_args_t args = {
62 .nh_proto = FIB_PROTOCOL_IP6,
63 .link_type = VNET_LINK_IP6,
65 .sw_if_index = tc->sw_if_index,
68 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
73 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
75 tcp_main_t *tm = &tcp_main;
76 tcp_connection_t *listener;
79 pool_get (tm->listener_pool, listener);
80 clib_memset (listener, 0, sizeof (*listener));
82 listener->c_c_index = listener - tm->listener_pool;
83 listener->c_lcl_port = lcl->port;
85 /* If we are provided a sw_if_index, bind using one of its ips */
86 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
88 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
90 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
92 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
93 listener->c_is_ip4 = lcl->is_ip4;
94 listener->c_proto = TRANSPORT_PROTO_TCP;
95 listener->c_s_index = session_index;
96 listener->c_fib_index = lcl->fib_index;
97 listener->state = TCP_STATE_LISTEN;
99 tcp_connection_timers_init (listener);
101 TCP_EVT_DBG (TCP_EVT_BIND, listener);
103 return listener->c_c_index;
107 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
109 return tcp_connection_bind (session_index, tep);
113 tcp_connection_unbind (u32 listener_index)
115 tcp_main_t *tm = vnet_get_tcp_main ();
116 tcp_connection_t *tc;
118 tc = pool_elt_at_index (tm->listener_pool, listener_index);
120 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
122 /* Poison the entry */
124 clib_memset (tc, 0xFA, sizeof (*tc));
126 pool_put_index (tm->listener_pool, listener_index);
130 tcp_session_unbind (u32 listener_index)
132 tcp_connection_unbind (listener_index);
136 static transport_connection_t *
137 tcp_session_get_listener (u32 listener_index)
139 tcp_main_t *tm = vnet_get_tcp_main ();
140 tcp_connection_t *tc;
141 tc = pool_elt_at_index (tm->listener_pool, listener_index);
142 return &tc->connection;
146 * Cleanup half-open connection
150 tcp_half_open_connection_del (tcp_connection_t * tc)
152 tcp_main_t *tm = vnet_get_tcp_main ();
153 clib_spinlock_lock_if_init (&tm->half_open_lock);
154 pool_put_index (tm->half_open_connections, tc->c_c_index);
156 clib_memset (tc, 0xFA, sizeof (*tc));
157 clib_spinlock_unlock_if_init (&tm->half_open_lock);
161 * Try to cleanup half-open connection
163 * If called from a thread that doesn't own tc, the call won't have any
166 * @param tc - connection to be cleaned up
167 * @return non-zero if cleanup failed.
170 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
172 /* Make sure this is the owning thread */
173 if (tc->c_thread_index != vlib_get_thread_index ())
175 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH_AO);
176 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
177 tcp_half_open_connection_del (tc);
181 static tcp_connection_t *
182 tcp_half_open_connection_new (void)
184 tcp_main_t *tm = vnet_get_tcp_main ();
185 tcp_connection_t *tc = 0;
186 ASSERT (vlib_get_thread_index () == 0);
187 pool_get (tm->half_open_connections, tc);
188 clib_memset (tc, 0, sizeof (*tc));
189 tc->c_c_index = tc - tm->half_open_connections;
194 * Cleans up connection state.
199 tcp_connection_cleanup (tcp_connection_t * tc)
201 tcp_main_t *tm = &tcp_main;
203 /* Cleanup local endpoint if this was an active connect */
204 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
207 /* Check if connection is not yet fully established */
208 if (tc->state == TCP_STATE_SYN_SENT)
210 /* Try to remove the half-open connection. If this is not the owning
211 * thread, tc won't be removed. Retransmit or establish timers will
212 * eventually expire and call again cleanup on the right thread. */
213 if (tcp_half_open_connection_cleanup (tc))
214 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
218 int thread_index = tc->c_thread_index;
220 /* Make sure all timers are cleared */
221 tcp_connection_timers_reset (tc);
223 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
224 tcp_add_del_adjacency (tc, 0);
226 vec_free (tc->snd_sacks);
227 vec_free (tc->snd_sacks_fl);
229 /* Poison the entry */
231 clib_memset (tc, 0xFA, sizeof (*tc));
232 pool_put (tm->connections[thread_index], tc);
237 * Connection removal.
239 * This should be called only once connection enters CLOSED state. Note
240 * that it notifies the session of the removal event, so if the goal is to
241 * just remove the connection, call tcp_connection_cleanup instead.
244 tcp_connection_del (tcp_connection_t * tc)
246 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
247 session_transport_delete_notify (&tc->connection);
248 tcp_connection_cleanup (tc);
252 tcp_connection_alloc (u8 thread_index)
254 tcp_main_t *tm = vnet_get_tcp_main ();
255 tcp_connection_t *tc;
257 pool_get (tm->connections[thread_index], tc);
258 clib_memset (tc, 0, sizeof (*tc));
259 tc->c_c_index = tc - tm->connections[thread_index];
260 tc->c_thread_index = thread_index;
265 tcp_connection_free (tcp_connection_t * tc)
267 tcp_main_t *tm = &tcp_main;
268 pool_put (tm->connections[tc->c_thread_index], tc);
270 clib_memset (tc, 0xFA, sizeof (*tc));
273 /** Notify session that connection has been reset.
275 * Switch state to closed and wait for session to call cleanup.
278 tcp_connection_reset (tcp_connection_t * tc)
280 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
283 case TCP_STATE_SYN_RCVD:
284 /* Cleanup everything. App wasn't notified yet */
285 session_transport_delete_notify (&tc->connection);
286 tcp_connection_cleanup (tc);
288 case TCP_STATE_SYN_SENT:
289 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
290 tcp_connection_cleanup (tc);
292 case TCP_STATE_ESTABLISHED:
293 tcp_connection_timers_reset (tc);
294 /* Set the cleanup timer, in case the session layer/app don't
295 * cleanly close the connection */
296 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
297 session_transport_reset_notify (&tc->connection);
298 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
300 case TCP_STATE_CLOSE_WAIT:
301 case TCP_STATE_FIN_WAIT_1:
302 case TCP_STATE_FIN_WAIT_2:
303 case TCP_STATE_CLOSING:
304 case TCP_STATE_LAST_ACK:
305 tcp_connection_timers_reset (tc);
306 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
307 /* Make sure we mark the session as closed. In some states we may
308 * be still trying to send data */
309 session_transport_closed_notify (&tc->connection);
310 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
312 case TCP_STATE_CLOSED:
313 case TCP_STATE_TIME_WAIT:
316 TCP_DBG ("reset state: %u", tc->state);
321 * Begin connection closing procedure.
323 * If at the end the connection is not in CLOSED state, it is not removed.
324 * Instead, we rely on on TCP to advance through state machine to either
325 * 1) LAST_ACK (passive close) whereby when the last ACK is received
326 * tcp_connection_del is called. This notifies session of the delete and
328 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
329 * and cleanup is called.
331 * N.B. Half-close connections are not supported
334 tcp_connection_close (tcp_connection_t * tc)
336 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
338 /* Send/Program FIN if needed and switch state */
341 case TCP_STATE_SYN_SENT:
342 /* Try to cleanup. If not on the right thread, mark as half-open done.
343 * Connection will be cleaned up when establish timer pops */
344 tcp_connection_cleanup (tc);
346 case TCP_STATE_SYN_RCVD:
347 tcp_connection_timers_reset (tc);
349 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
350 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
352 case TCP_STATE_ESTABLISHED:
353 if (!transport_max_tx_dequeue (&tc->connection))
356 tc->flags |= TCP_CONN_FINPNDG;
357 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
358 /* Set a timer in case the peer stops responding. Otherwise the
359 * connection will be stuck here forever. */
360 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
361 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
363 case TCP_STATE_CLOSE_WAIT:
364 if (!transport_max_tx_dequeue (&tc->connection))
367 tcp_connection_timers_reset (tc);
368 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
369 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
372 tc->flags |= TCP_CONN_FINPNDG;
374 case TCP_STATE_FIN_WAIT_1:
375 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
377 case TCP_STATE_CLOSED:
378 tcp_connection_timers_reset (tc);
379 /* Delete connection but instead of doing it now wait until next
380 * dispatch cycle to give the session layer a chance to clear
381 * unhandled events */
382 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
385 TCP_DBG ("state: %u", tc->state);
390 tcp_session_close (u32 conn_index, u32 thread_index)
392 tcp_connection_t *tc;
393 tc = tcp_connection_get (conn_index, thread_index);
394 tcp_connection_close (tc);
398 tcp_session_cleanup (u32 conn_index, u32 thread_index)
400 tcp_connection_t *tc;
401 tc = tcp_connection_get (conn_index, thread_index);
402 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
403 tcp_connection_cleanup (tc);
407 * Initialize all connection timers as invalid
410 tcp_connection_timers_init (tcp_connection_t * tc)
414 /* Set all to invalid */
415 for (i = 0; i < TCP_N_TIMERS; i++)
417 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
420 tc->rto = TCP_RTO_INIT;
424 * Stop all connection timers
427 tcp_connection_timers_reset (tcp_connection_t * tc)
430 for (i = 0; i < TCP_N_TIMERS; i++)
432 tcp_timer_reset (tc, i);
437 typedef struct ip4_tcp_hdr
443 typedef struct ip6_tcp_hdr
450 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
453 const dpo_id_t *choice;
457 lb = load_balance_get (dpo->dpoi_index);
461 clib_memset (&hdr, 0, sizeof (hdr));
462 hdr.ip.protocol = IP_PROTOCOL_TCP;
463 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
464 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
465 hdr.tcp.src_port = tc->c_lcl_port;
466 hdr.tcp.dst_port = tc->c_rmt_port;
467 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
472 clib_memset (&hdr, 0, sizeof (hdr));
473 hdr.ip.protocol = IP_PROTOCOL_TCP;
474 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
475 sizeof (ip6_address_t));
476 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
477 sizeof (ip6_address_t));
478 hdr.tcp.src_port = tc->c_lcl_port;
479 hdr.tcp.dst_port = tc->c_rmt_port;
480 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
482 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
483 dpo_copy (result, choice);
487 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
492 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
493 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
494 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
495 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
496 return fib_table_lookup (fib_index, &prefix);
500 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
502 dpo_id_t choice = DPO_INVALID;
503 u32 output_node_index;
506 fe = fib_entry_get (tc->c_rmt_fei);
507 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
510 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
513 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
514 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
518 /** Stack tcp connection on peer's fib entry.
520 * This ultimately populates the dpo the connection will use to send packets.
523 tcp_connection_fib_attach (tcp_connection_t * tc)
525 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
527 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
529 tcp_connection_stack_on_fib_entry (tc);
534 tcp_cc_init (tcp_connection_t * tc)
536 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
537 tc->cc_algo->init (tc);
541 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
542 const tcp_cc_algorithm_t * vft)
544 tcp_main_t *tm = vnet_get_tcp_main ();
545 vec_validate (tm->cc_algos, type);
547 tm->cc_algos[type] = *vft;
551 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
553 tcp_main_t *tm = vnet_get_tcp_main ();
554 return &tm->cc_algos[type];
558 * Generate random iss as per rfc6528
561 tcp_generate_random_iss (tcp_connection_t * tc)
563 tcp_main_t *tm = &tcp_main;
567 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
569 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
570 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
572 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
573 tmp ^= tm->iss_seed.second;
574 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
575 return ((tmp >> 32) ^ (tmp & 0xffffffff));
579 * Initialize connection send variables.
582 tcp_init_snd_vars (tcp_connection_t * tc)
585 * We use the time to randomize iss and for setting up the initial
586 * timestamp. Make sure it's updated otherwise syn and ack in the
587 * handshake may make it look as if time has flown in the opposite
590 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
592 tc->iss = tcp_generate_random_iss (tc);
593 tc->snd_una = tc->iss;
594 tc->snd_nxt = tc->iss + 1;
595 tc->snd_una_max = tc->snd_nxt;
600 tcp_enable_pacing (tcp_connection_t * tc)
602 u32 initial_bucket, byte_rate;
603 initial_bucket = 16 * tc->snd_mss;
605 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
607 tc->mrtt_us = (u32) ~ 0;
610 /** Initialize tcp connection variables
612 * Should be called after having received a msg from the peer, i.e., a SYN or
613 * a SYNACK, such that connection options have already been exchanged. */
615 tcp_connection_init_vars (tcp_connection_t * tc)
617 tcp_connection_timers_init (tc);
619 scoreboard_init (&tc->sack_sb);
621 if (tc->state == TCP_STATE_SYN_RCVD)
622 tcp_init_snd_vars (tc);
624 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
625 tcp_add_del_adjacency (tc, 1);
627 /* tcp_connection_fib_attach (tc); */
629 if (transport_connection_is_tx_paced (&tc->connection)
630 || tcp_main.tx_pacing)
631 tcp_enable_pacing (tc);
635 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
636 u16 * lcl_port, u8 is_ip4)
641 index = tm->last_v4_address_rotor++;
642 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
643 tm->last_v4_address_rotor = 0;
644 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
648 index = tm->last_v6_address_rotor++;
649 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
650 tm->last_v6_address_rotor = 0;
651 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
652 sizeof (ip6_address_t));
654 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
657 clib_warning ("Failed to allocate src port");
665 tcp_session_open (transport_endpoint_cfg_t * rmt)
667 tcp_main_t *tm = vnet_get_tcp_main ();
668 tcp_connection_t *tc;
669 ip46_address_t lcl_addr;
674 * Allocate local endpoint
676 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
677 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
678 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
681 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
682 rmt, &lcl_addr, &lcl_port);
688 * Create connection and send SYN
690 clib_spinlock_lock_if_init (&tm->half_open_lock);
691 tc = tcp_half_open_connection_new ();
692 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
693 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
694 tc->c_rmt_port = rmt->port;
695 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
696 tc->c_is_ip4 = rmt->is_ip4;
697 tc->c_proto = TRANSPORT_PROTO_TCP;
698 tc->c_fib_index = rmt->fib_index;
699 /* The other connection vars will be initialized after SYN ACK */
700 tcp_connection_timers_init (tc);
702 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
703 tc->state = TCP_STATE_SYN_SENT;
704 tcp_init_snd_vars (tc);
706 clib_spinlock_unlock_if_init (&tm->half_open_lock);
708 return tc->c_c_index;
711 const char *tcp_dbg_evt_str[] = {
712 #define _(sym, str) str,
717 const char *tcp_fsm_states[] = {
718 #define _(sym, str) str,
719 foreach_tcp_fsm_state
724 format_tcp_state (u8 * s, va_list * args)
726 u32 state = va_arg (*args, u32);
728 if (state < TCP_N_STATES)
729 s = format (s, "%s", tcp_fsm_states[state]);
731 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
735 const char *tcp_connection_flags_str[] = {
736 #define _(sym, str) str,
737 foreach_tcp_connection_flag
742 format_tcp_connection_flags (u8 * s, va_list * args)
744 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
747 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
748 if (tc->flags & (1 << i))
750 for (i = 0; i < last; i++)
752 if (tc->flags & (1 << i))
753 s = format (s, "%s, ", tcp_connection_flags_str[i]);
756 s = format (s, "%s", tcp_connection_flags_str[last]);
760 const char *tcp_conn_timers[] = {
761 #define _(sym, str) str,
767 format_tcp_timers (u8 * s, va_list * args)
769 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
772 for (i = 0; i < TCP_N_TIMERS; i++)
773 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
776 for (i = 0; i < last; i++)
778 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
779 s = format (s, "%s,", tcp_conn_timers[i]);
783 s = format (s, "%s", tcp_conn_timers[i]);
789 format_tcp_congestion_status (u8 * s, va_list * args)
791 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
792 if (tcp_in_recovery (tc))
793 s = format (s, "recovery");
794 else if (tcp_in_fastrecovery (tc))
795 s = format (s, "fastrecovery");
797 s = format (s, "none");
802 tcp_rcv_wnd_available (tcp_connection_t * tc)
804 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
808 format_tcp_congestion (u8 * s, va_list * args)
810 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
811 u32 indent = format_get_indent (s);
813 s = format (s, "%U ", format_tcp_congestion_status, tc);
814 s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
815 tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
816 s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
817 format_white_space, indent, tcp_available_cc_snd_space (tc),
818 tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
819 s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
820 format_white_space, indent, tc->snd_congestion - tc->iss,
821 tc->rcv_dupacks, tc->limited_transmit - tc->iss);
826 format_tcp_vars (u8 * s, va_list * args)
828 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
829 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
830 format_tcp_connection_flags, tc, format_tcp_timers, tc);
831 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
832 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
833 tc->snd_una_max - tc->iss);
834 s = format (s, " rcv_nxt %u rcv_las %u\n",
835 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
836 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
837 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
838 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
839 tc->snd_wl2 - tc->iss);
840 s = format (s, " flight size %u out space %u rcv_wnd_av %u",
841 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
842 tcp_rcv_wnd_available (tc));
843 s = format (s, " tsval_recent %u\n", tc->tsval_recent);
844 s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u\n",
845 tc->rcv_opts.tsecr, tc->tsecr_last_ack,
846 tcp_time_now () - tc->tsval_recent_age);
847 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
848 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
850 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
851 s = format (s, " cong: %U", format_tcp_congestion, tc);
853 if (tc->state >= TCP_STATE_ESTABLISHED)
855 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
858 if (vec_len (tc->snd_sacks))
859 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
865 format_tcp_connection_id (u8 * s, va_list * args)
867 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
872 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
873 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
874 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
875 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
879 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
880 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
881 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
882 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
889 format_tcp_connection (u8 * s, va_list * args)
891 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
892 u32 verbose = va_arg (*args, u32);
896 s = format (s, "%-50U", format_tcp_connection_id, tc);
899 s = format (s, "%-15U", format_tcp_state, tc->state);
901 s = format (s, "\n%U", format_tcp_vars, tc);
908 format_tcp_session (u8 * s, va_list * args)
910 u32 tci = va_arg (*args, u32);
911 u32 thread_index = va_arg (*args, u32);
912 u32 verbose = va_arg (*args, u32);
913 tcp_connection_t *tc;
915 tc = tcp_connection_get (tci, thread_index);
917 s = format (s, "%U", format_tcp_connection, tc, verbose);
919 s = format (s, "empty\n");
924 format_tcp_listener_session (u8 * s, va_list * args)
926 u32 tci = va_arg (*args, u32);
927 u32 verbose = va_arg (*args, u32);
928 tcp_connection_t *tc = tcp_listener_get (tci);
929 s = format (s, "%-50U", format_tcp_connection_id, tc);
931 s = format (s, "%-15U", format_tcp_state, tc->state);
936 format_tcp_half_open_session (u8 * s, va_list * args)
938 u32 tci = va_arg (*args, u32);
939 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
940 return format (s, "%U", format_tcp_connection_id, tc);
944 format_tcp_sacks (u8 * s, va_list * args)
946 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
947 sack_block_t *sacks = tc->snd_sacks;
951 len = vec_len (sacks);
952 for (i = 0; i < len - 1; i++)
955 s = format (s, " start %u end %u\n", block->start - tc->irs,
956 block->end - tc->irs);
960 block = &sacks[len - 1];
961 s = format (s, " start %u end %u", block->start - tc->irs,
962 block->end - tc->irs);
968 format_tcp_rcv_sacks (u8 * s, va_list * args)
970 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
971 sack_block_t *sacks = tc->rcv_opts.sacks;
975 len = vec_len (sacks);
976 for (i = 0; i < len - 1; i++)
979 s = format (s, " start %u end %u\n", block->start - tc->iss,
980 block->end - tc->iss);
984 block = &sacks[len - 1];
985 s = format (s, " start %u end %u", block->start - tc->iss,
986 block->end - tc->iss);
992 format_tcp_sack_hole (u8 * s, va_list * args)
994 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
995 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
997 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
999 s = format (s, " [%u, %u]", hole->start, hole->end);
1004 format_tcp_scoreboard (u8 * s, va_list * args)
1006 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1007 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1008 sack_scoreboard_hole_t *hole;
1009 u32 indent = format_get_indent (s);
1011 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1012 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1013 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1014 format_white_space, indent, sb->last_bytes_delivered,
1015 sb->high_sacked - tc->iss, sb->snd_una_adv);
1016 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1017 format_white_space, indent, sb->cur_rxt_hole,
1018 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1020 hole = scoreboard_first_hole (sb);
1022 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1023 indent, sb->head, sb->tail, pool_elts (sb->holes),
1024 format_white_space, indent);
1028 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1029 hole = scoreboard_next_hole (sb, hole);
1035 static transport_connection_t *
1036 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1038 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1039 return &tc->connection;
1042 static transport_connection_t *
1043 tcp_half_open_session_get_transport (u32 conn_index)
1045 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1046 return &tc->connection;
1050 * Compute maximum segment size for session layer.
1052 * Since the result needs to be the actual data length, it first computes
1053 * the tcp options to be used in the next burst and subtracts their
1054 * length from the connection's snd_mss.
1057 tcp_session_send_mss (transport_connection_t * trans_conn)
1059 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1061 /* Ensure snd_mss does accurately reflect the amount of data we can push
1062 * in a segment. This also makes sure that options are updated according to
1063 * the current state of the connection. */
1064 tcp_update_burst_snd_vars (tc);
1070 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1072 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1074 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1077 /* If not snd_wnd constrained and we can't write at least a segment,
1078 * don't try at all */
1079 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1080 return snd_space < tc->cwnd ? 0 : snd_space;
1082 /* round down to mss multiple */
1083 return snd_space - (snd_space % tc->snd_mss);
1087 * Compute tx window session is allowed to fill.
1089 * Takes into account available send space, snd_mss and the congestion
1090 * state of the connection. If possible, the value returned is a multiple
1093 * @param tc tcp connection
1094 * @return number of bytes session is allowed to write
1097 tcp_snd_space_inline (tcp_connection_t * tc)
1099 int snd_space, snt_limited;
1101 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1102 || tc->state == TCP_STATE_CLOSED))
1105 snd_space = tcp_available_output_snd_space (tc);
1107 /* If we haven't gotten dupacks or if we did and have gotten sacked
1108 * bytes then we can still send as per Limited Transmit (RFC3042) */
1109 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1110 && (tcp_opts_sack_permitted (tc)
1111 && tc->sack_sb.last_sacked_bytes == 0)))
1113 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1114 tc->limited_transmit = tc->snd_nxt;
1115 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1117 snt_limited = tc->snd_nxt - tc->limited_transmit;
1118 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1120 return tcp_round_snd_space (tc, snd_space);
1124 tcp_snd_space (tcp_connection_t * tc)
1126 return tcp_snd_space_inline (tc);
1130 tcp_session_send_space (transport_connection_t * trans_conn)
1132 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1133 return clib_min (tcp_snd_space_inline (tc),
1134 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1138 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1140 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1142 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1144 /* This still works if fast retransmit is on */
1145 return (tc->snd_nxt - tc->snd_una);
1149 tcp_update_time (f64 now, u8 thread_index)
1151 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1153 tcp_set_time_now (wrk);
1154 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1155 tcp_do_fastretransmits (wrk);
1156 tcp_send_acks (wrk);
1157 tcp_flush_frames_to_output (wrk);
1161 tcp_session_flush_data (transport_connection_t * tconn)
1163 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1164 if (tc->flags & TCP_CONN_PSH_PENDING)
1166 tc->flags |= TCP_CONN_PSH_PENDING;
1167 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1171 const static transport_proto_vft_t tcp_proto = {
1172 .enable = vnet_tcp_enable_disable,
1173 .start_listen = tcp_session_bind,
1174 .stop_listen = tcp_session_unbind,
1175 .push_header = tcp_session_push_header,
1176 .get_connection = tcp_session_get_transport,
1177 .get_listener = tcp_session_get_listener,
1178 .get_half_open = tcp_half_open_session_get_transport,
1179 .connect = tcp_session_open,
1180 .close = tcp_session_close,
1181 .cleanup = tcp_session_cleanup,
1182 .send_mss = tcp_session_send_mss,
1183 .send_space = tcp_session_send_space,
1184 .update_time = tcp_update_time,
1185 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1186 .flush_data = tcp_session_flush_data,
1187 .format_connection = format_tcp_session,
1188 .format_listener = format_tcp_listener_session,
1189 .format_half_open = format_tcp_half_open_session,
1190 .tx_type = TRANSPORT_TX_PEEK,
1191 .service_type = TRANSPORT_SERVICE_VC,
1196 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1201 if (!transport_connection_is_tx_paced (&tc->connection))
1204 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1205 /* TODO should constrain to interface's max throughput but
1206 * we don't have link speeds for sw ifs ..*/
1207 rate = tc->cwnd / srtt;
1208 transport_connection_tx_pacer_update (&tc->connection, rate);
1212 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1215 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1216 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1217 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1218 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1219 start_bucket, last_time);
1223 tcp_timer_keep_handler (u32 conn_index)
1225 u32 thread_index = vlib_get_thread_index ();
1226 tcp_connection_t *tc;
1228 tc = tcp_connection_get (conn_index, thread_index);
1229 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1231 tcp_connection_close (tc);
1235 tcp_timer_establish_handler (u32 conn_index)
1237 tcp_connection_t *tc;
1239 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1240 /* note: the connection may have already disappeared */
1241 if (PREDICT_FALSE (tc == 0))
1243 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1244 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1245 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1246 /* Start cleanup. App wasn't notified yet so use delete notify as
1247 * opposed to delete to cleanup session layer state. */
1248 tcp_connection_timers_reset (tc);
1249 session_transport_delete_notify (&tc->connection);
1250 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1254 tcp_timer_establish_ao_handler (u32 conn_index)
1256 tcp_connection_t *tc;
1258 tc = tcp_half_open_connection_get (conn_index);
1262 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1263 /* Notify app if we haven't tried to clean this up already */
1264 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1265 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1267 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1268 tcp_connection_cleanup (tc);
1272 tcp_timer_waitclose_handler (u32 conn_index)
1274 u32 thread_index = vlib_get_thread_index (), rto;
1275 tcp_connection_t *tc;
1277 tc = tcp_connection_get (conn_index, thread_index);
1280 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1284 case TCP_STATE_CLOSE_WAIT:
1285 tcp_connection_timers_reset (tc);
1286 session_transport_closed_notify (&tc->connection);
1288 if (!(tc->flags & TCP_CONN_FINPNDG))
1290 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1291 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1295 /* Session didn't come back with a close. Send FIN either way
1296 * and switch to LAST_ACK. */
1297 tcp_cong_recovery_off (tc);
1298 /* Make sure we don't try to send unsent data */
1299 tc->snd_nxt = tc->snd_una;
1301 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1303 /* Make sure we don't wait in LAST ACK forever */
1304 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1306 /* Don't delete the connection yet */
1308 case TCP_STATE_FIN_WAIT_1:
1309 tcp_connection_timers_reset (tc);
1310 if (tc->flags & TCP_CONN_FINPNDG)
1312 /* If FIN pending send it before closing and wait as long as
1313 * the rto timeout would wait. Notify session layer that transport
1314 * is closed. We haven't sent everything but we did try. */
1315 tcp_cong_recovery_off (tc);
1317 rto = clib_max ((tc->rto >> tc->rto_boff) * TCP_TO_TIMER_TICK, 1);
1318 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE,
1319 clib_min (rto, TCP_2MSL_TIME));
1320 session_transport_closed_notify (&tc->connection);
1324 /* We've sent the fin but no progress. Close the connection and
1325 * to make sure everything is flushed, setup a cleanup timer */
1326 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1327 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1330 case TCP_STATE_LAST_ACK:
1331 case TCP_STATE_CLOSING:
1332 tcp_connection_timers_reset (tc);
1333 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1334 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1335 session_transport_closed_notify (&tc->connection);
1338 tcp_connection_del (tc);
1344 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1346 tcp_timer_retransmit_handler,
1347 tcp_timer_delack_handler,
1348 tcp_timer_persist_handler,
1349 tcp_timer_keep_handler,
1350 tcp_timer_waitclose_handler,
1351 tcp_timer_retransmit_syn_handler,
1352 tcp_timer_establish_handler,
1353 tcp_timer_establish_ao_handler,
1358 tcp_expired_timers_dispatch (u32 * expired_timers)
1361 u32 connection_index, timer_id;
1363 for (i = 0; i < vec_len (expired_timers); i++)
1365 /* Get session index and timer id */
1366 connection_index = expired_timers[i] & 0x0FFFFFFF;
1367 timer_id = expired_timers[i] >> 28;
1369 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1371 /* Handle expiration */
1372 (*timer_expiration_handlers[timer_id]) (connection_index);
1377 tcp_initialize_timer_wheels (tcp_main_t * tm)
1379 tw_timer_wheel_16t_2w_512sl_t *tw;
1381 foreach_vlib_main (({
1382 tw = &tm->wrk_ctx[ii].timer_wheel;
1383 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1384 100e-3 /* timer period 100ms */ , ~0);
1385 tw->last_run_time = vlib_time_now (this_vlib_main);
1391 tcp_initialize_iss_seed (tcp_main_t * tm)
1393 u32 default_seed = random_default_seed ();
1394 u64 time_now = clib_cpu_time_now ();
1396 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1397 tm->iss_seed.second = random_u64 (&time_now);
1400 static clib_error_t *
1401 tcp_main_enable (vlib_main_t * vm)
1403 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1404 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1405 tcp_connection_t *tc __attribute__ ((unused));
1406 tcp_main_t *tm = vnet_get_tcp_main ();
1407 clib_error_t *error = 0;
1410 if ((error = vlib_call_init_function (vm, ip_main_init)))
1412 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1414 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1421 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1422 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1425 * Initialize data structures
1428 num_threads = 1 /* main thread */ + vtm->n_threads;
1429 vec_validate (tm->connections, num_threads - 1);
1430 vec_validate (tm->wrk_ctx, num_threads - 1);
1431 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1432 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1434 for (thread = 0; thread < num_threads; thread++)
1436 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1437 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1438 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1439 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1440 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1441 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1442 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1443 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1444 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1445 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1446 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1447 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1448 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1451 * Preallocate connections. Assume that thread 0 won't
1452 * use preallocated threads when running multi-core
1454 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1455 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1459 * Use a preallocated half-open connection pool?
1461 if (tm->preallocated_half_open_connections)
1462 pool_init_fixed (tm->half_open_connections,
1463 tm->preallocated_half_open_connections);
1465 /* Initialize clocks per tick for TCP timestamp. Used to compute
1466 * monotonically increasing timestamps. */
1467 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1468 / TCP_TSTAMP_RESOLUTION;
1470 if (num_threads > 1)
1472 clib_spinlock_init (&tm->half_open_lock);
1475 tcp_initialize_timer_wheels (tm);
1476 tcp_initialize_iss_seed (tm);
1478 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1484 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1488 if (tcp_main.is_enabled)
1491 return tcp_main_enable (vm);
1495 tcp_main.is_enabled = 0;
1502 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1504 tcp_main_t *tm = &tcp_main;
1506 tm->punt_unknown4 = is_add;
1508 tm->punt_unknown6 = is_add;
1511 static clib_error_t *
1512 tcp_init (vlib_main_t * vm)
1514 tcp_main_t *tm = vnet_get_tcp_main ();
1515 ip_main_t *im = &ip_main;
1516 ip_protocol_info_t *pi;
1518 /* Session layer, and by implication tcp, are disabled by default */
1521 /* Register with IP for header parsing */
1522 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1524 return clib_error_return (0, "TCP protocol info AWOL");
1525 pi->format_header = format_tcp_header;
1526 pi->unformat_pg_edit = unformat_pg_tcp_header;
1528 /* Register as transport with session layer */
1529 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1530 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1531 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1532 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1534 tcp_api_reference ();
1536 tm->cc_algo = TCP_CC_NEWRENO;
1540 VLIB_INIT_FUNCTION (tcp_init);
1543 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1545 uword *result = va_arg (*va, uword *);
1547 if (unformat (input, "newreno"))
1548 *result = TCP_CC_NEWRENO;
1549 else if (unformat (input, "cubic"))
1550 *result = TCP_CC_CUBIC;
1558 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1560 tcp_main_t *tm = vnet_get_tcp_main ();
1561 tcp_cc_algorithm_t *cc_alg;
1562 unformat_input_t sub_input;
1565 vec_foreach (cc_alg, tm->cc_algos)
1567 if (!unformat (input, cc_alg->name))
1570 if (cc_alg->unformat_cfg
1571 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1573 if (cc_alg->unformat_cfg (&sub_input))
1580 static clib_error_t *
1581 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1583 tcp_main_t *tm = vnet_get_tcp_main ();
1585 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1587 if (unformat (input, "preallocated-connections %d",
1588 &tm->preallocated_connections))
1590 else if (unformat (input, "preallocated-half-open-connections %d",
1591 &tm->preallocated_half_open_connections))
1593 else if (unformat (input, "buffer-fail-fraction %f",
1594 &tm->buffer_fail_fraction))
1596 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1599 else if (unformat (input, "no-tx-pacing"))
1601 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1604 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1607 return clib_error_return (0, "unknown input `%U'",
1608 format_unformat_error, input);
1613 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1617 * \brief Configure an ipv4 source address range
1618 * @param vm vlib_main_t pointer
1619 * @param start first ipv4 address in the source address range
1620 * @param end last ipv4 address in the source address range
1621 * @param table_id VRF / table ID, 0 for the default FIB
1622 * @return 0 if all OK, else an error indication from api_errno.h
1626 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1627 ip4_address_t * start,
1628 ip4_address_t * end, u32 table_id)
1630 tcp_main_t *tm = vnet_get_tcp_main ();
1631 vnet_main_t *vnm = vnet_get_main ();
1632 u32 start_host_byte_order, end_host_byte_order;
1633 fib_prefix_t prefix;
1634 vnet_sw_interface_t *si;
1635 fib_node_index_t fei;
1639 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1640 ip4_address_t * hi_addr, u32 fib_index,
1643 clib_memset (&prefix, 0, sizeof (prefix));
1645 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1647 if (fib_index == ~0)
1648 return VNET_API_ERROR_NO_SUCH_FIB;
1650 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1651 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1653 /* sanity check for reversed args or some such */
1654 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1655 return VNET_API_ERROR_INVALID_ARGUMENT;
1657 /* Lookup the last address, to identify the interface involved */
1659 prefix.fp_proto = FIB_PROTOCOL_IP4;
1660 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1662 fei = fib_table_lookup (fib_index, &prefix);
1664 /* Couldn't find route to destination. Bail out. */
1665 if (fei == FIB_NODE_INDEX_INVALID)
1666 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1668 sw_if_index = fib_entry_get_resolving_interface (fei);
1670 /* Enable proxy arp on the interface */
1671 si = vnet_get_sw_interface (vnm, sw_if_index);
1672 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1674 /* Configure proxy arp across the range */
1675 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1682 dpo_id_t dpo = DPO_INVALID;
1684 vec_add1 (tm->ip4_src_addresses, start[0]);
1686 /* Add local adjacencies for the range */
1688 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1691 prefix.fp_proto = FIB_PROTOCOL_IP4;
1692 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1694 fib_table_entry_special_dpo_update (fib_index,
1697 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1700 start_host_byte_order++;
1701 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1703 while (start_host_byte_order <= end_host_byte_order);
1709 * \brief Configure an ipv6 source address range
1710 * @param vm vlib_main_t pointer
1711 * @param start first ipv6 address in the source address range
1712 * @param end last ipv6 address in the source address range
1713 * @param table_id VRF / table ID, 0 for the default FIB
1714 * @return 0 if all OK, else an error indication from api_errno.h
1718 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1719 ip6_address_t * start,
1720 ip6_address_t * end, u32 table_id)
1722 tcp_main_t *tm = vnet_get_tcp_main ();
1723 fib_prefix_t prefix;
1725 fib_node_index_t fei;
1728 clib_memset (&prefix, 0, sizeof (prefix));
1730 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1732 if (fib_index == ~0)
1733 return VNET_API_ERROR_NO_SUCH_FIB;
1739 dpo_id_t dpo = DPO_INVALID;
1741 /* Remember this address */
1742 vec_add1 (tm->ip6_src_addresses, start[0]);
1744 /* Lookup the prefix, to identify the interface involved */
1745 prefix.fp_len = 128;
1746 prefix.fp_proto = FIB_PROTOCOL_IP6;
1747 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1749 fei = fib_table_lookup (fib_index, &prefix);
1751 /* Couldn't find route to destination. Bail out. */
1752 if (fei == FIB_NODE_INDEX_INVALID)
1753 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1755 sw_if_index = fib_entry_get_resolving_interface (fei);
1757 if (sw_if_index == (u32) ~ 0)
1758 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1760 /* Add a proxy neighbor discovery entry for this address */
1761 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1763 /* Add a receive adjacency for this address */
1764 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1767 fib_table_entry_special_dpo_update (fib_index,
1770 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1773 /* Done with the entire range? */
1774 if (!memcmp (start, end, sizeof (start[0])))
1777 /* Increment the address. DGMS. */
1779 for (i = 15; i >= 0; i--)
1782 if (tmp.as_u8[i] != 0)
1790 static clib_error_t *
1791 tcp_src_address (vlib_main_t * vm,
1792 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1794 ip4_address_t v4start, v4end;
1795 ip6_address_t v6start, v6end;
1801 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1803 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1804 unformat_ip4_address, &v4end))
1806 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1808 memcpy (&v4end, &v4start, sizeof (v4start));
1811 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1812 unformat_ip6_address, &v6end))
1814 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1816 memcpy (&v6end, &v6start, sizeof (v6start));
1819 else if (unformat (input, "fib-table %d", &table_id))
1825 if (!v4set && !v6set)
1826 return clib_error_return (0, "at least one v4 or v6 address required");
1830 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1837 case VNET_API_ERROR_NO_SUCH_FIB:
1838 return clib_error_return (0, "Invalid table-id %d", table_id);
1840 case VNET_API_ERROR_INVALID_ARGUMENT:
1841 return clib_error_return (0, "Invalid address range %U - %U",
1842 format_ip4_address, &v4start,
1843 format_ip4_address, &v4end);
1845 return clib_error_return (0, "error %d", rv);
1851 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1858 case VNET_API_ERROR_NO_SUCH_FIB:
1859 return clib_error_return (0, "Invalid table-id %d", table_id);
1862 return clib_error_return (0, "error %d", rv);
1870 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1872 .path = "tcp src-address",
1873 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1874 .function = tcp_src_address,
1879 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1881 #if TCP_SCOREBOARD_TRACE
1883 scoreboard_trace_elt_t *block;
1889 s = format (s, "scoreboard trace:");
1890 vec_foreach (block, sb->trace)
1892 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1893 block->ack, block->snd_una_max, block->group);
1895 s = format (s, "\n");
1903 static clib_error_t *
1904 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1905 vlib_cli_command_t * cmd_arg)
1907 transport_connection_t *tconn = 0;
1908 tcp_connection_t *tc;
1910 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1912 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1913 TRANSPORT_PROTO_TCP))
1916 return clib_error_return (0, "unknown input `%U'",
1917 format_unformat_error, input);
1920 if (!TCP_SCOREBOARD_TRACE)
1922 vlib_cli_output (vm, "scoreboard tracing not enabled");
1926 tc = tcp_get_connection_from_transport (tconn);
1927 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1928 vlib_cli_output (vm, "%v", s);
1933 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1935 .path = "show tcp scoreboard trace",
1936 .short_help = "show tcp scoreboard trace <connection>",
1937 .function = tcp_show_scoreboard_trace_fn,
1942 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1945 scoreboard_trace_elt_t *trace;
1946 u32 next_ack, left, group, has_new_ack = 0;
1947 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1948 sack_block_t *block;
1950 if (!TCP_SCOREBOARD_TRACE)
1952 s = format (s, "scoreboard tracing not enabled");
1959 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1960 tcp_connection_timers_init (dummy_tc);
1961 scoreboard_init (&dummy_tc->sack_sb);
1962 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1964 #if TCP_SCOREBOARD_TRACE
1965 trace = tc->sack_sb.trace;
1966 trace_len = vec_len (tc->sack_sb.trace);
1969 for (i = 0; i < trace_len; i++)
1971 if (trace[i].ack != 0)
1973 dummy_tc->snd_una = trace[i].ack - 1448;
1974 dummy_tc->snd_una_max = trace[i].ack;
1979 while (left < trace_len)
1981 group = trace[left].group;
1982 vec_reset_length (dummy_tc->rcv_opts.sacks);
1984 while (trace[left].group == group)
1986 if (trace[left].ack != 0)
1989 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1990 trace[left].ack, trace[left].snd_una_max);
1991 dummy_tc->snd_una_max = trace[left].snd_una_max;
1992 next_ack = trace[left].ack;
1998 s = format (s, "[%u, %u], ", trace[left].start,
2000 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2001 block->start = trace[left].start;
2002 block->end = trace[left].end;
2008 tcp_rcv_sacks (dummy_tc, next_ack);
2010 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2013 s = format (s, "result: %U", format_tcp_scoreboard,
2014 &dummy_tc->sack_sb);
2017 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2022 static clib_error_t *
2023 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2024 vlib_cli_command_t * cmd_arg)
2026 transport_connection_t *tconn = 0;
2027 tcp_connection_t *tc = 0;
2029 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2031 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2032 TRANSPORT_PROTO_TCP))
2035 return clib_error_return (0, "unknown input `%U'",
2036 format_unformat_error, input);
2039 if (!TCP_SCOREBOARD_TRACE)
2041 vlib_cli_output (vm, "scoreboard tracing not enabled");
2045 tc = tcp_get_connection_from_transport (tconn);
2048 vlib_cli_output (vm, "connection not found");
2051 str = tcp_scoreboard_replay (str, tc, 1);
2052 vlib_cli_output (vm, "%v", str);
2057 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2059 .path = "tcp replay scoreboard",
2060 .short_help = "tcp replay scoreboard <connection>",
2061 .function = tcp_scoreboard_trace_fn,
2065 static clib_error_t *
2066 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2067 vlib_cli_command_t * cmd_arg)
2069 tcp_main_t *tm = vnet_get_tcp_main ();
2070 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2071 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2073 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2074 tm->punt_unknown4 ? "enabled" : "disabled");
2075 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2076 tm->punt_unknown6 ? "enabled" : "disabled");
2080 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2082 .path = "show tcp punt",
2083 .short_help = "show tcp punt",
2084 .function = show_tcp_punt_fn,
2089 * fd.io coding-style-patch-verification: ON
2092 * eval: (c-set-style "gnu")