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:
312 TCP_DBG ("reset state: %u", tc->state);
317 * Begin connection closing procedure.
319 * If at the end the connection is not in CLOSED state, it is not removed.
320 * Instead, we rely on on TCP to advance through state machine to either
321 * 1) LAST_ACK (passive close) whereby when the last ACK is received
322 * tcp_connection_del is called. This notifies session of the delete and
324 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
325 * and cleanup is called.
327 * N.B. Half-close connections are not supported
330 tcp_connection_close (tcp_connection_t * tc)
332 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
334 /* Send/Program FIN if needed and switch state */
337 case TCP_STATE_SYN_SENT:
338 /* Try to cleanup. If not on the right thread, mark as half-open done.
339 * Connection will be cleaned up when establish timer pops */
340 tcp_connection_cleanup (tc);
342 case TCP_STATE_SYN_RCVD:
343 tcp_connection_timers_reset (tc);
345 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
346 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
348 case TCP_STATE_ESTABLISHED:
349 if (!session_tx_fifo_max_dequeue (&tc->connection))
352 tc->flags |= TCP_CONN_FINPNDG;
353 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
354 /* Set a timer in case the peer stops responding. Otherwise the
355 * connection will be stuck here forever. */
356 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
357 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
359 case TCP_STATE_CLOSE_WAIT:
360 if (!session_tx_fifo_max_dequeue (&tc->connection))
363 tcp_connection_timers_reset (tc);
364 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
365 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
368 tc->flags |= TCP_CONN_FINPNDG;
370 case TCP_STATE_FIN_WAIT_1:
371 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
373 case TCP_STATE_CLOSED:
374 tcp_connection_timers_reset (tc);
375 /* Delete connection but instead of doing it now wait until next
376 * dispatch cycle to give the session layer a chance to clear
377 * unhandled events */
378 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
381 TCP_DBG ("state: %u", tc->state);
386 tcp_session_close (u32 conn_index, u32 thread_index)
388 tcp_connection_t *tc;
389 tc = tcp_connection_get (conn_index, thread_index);
390 tcp_connection_close (tc);
394 tcp_session_cleanup (u32 conn_index, u32 thread_index)
396 tcp_connection_t *tc;
397 tc = tcp_connection_get (conn_index, thread_index);
398 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
399 tcp_connection_cleanup (tc);
403 * Initialize all connection timers as invalid
406 tcp_connection_timers_init (tcp_connection_t * tc)
410 /* Set all to invalid */
411 for (i = 0; i < TCP_N_TIMERS; i++)
413 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
416 tc->rto = TCP_RTO_INIT;
420 * Stop all connection timers
423 tcp_connection_timers_reset (tcp_connection_t * tc)
426 for (i = 0; i < TCP_N_TIMERS; i++)
428 tcp_timer_reset (tc, i);
433 typedef struct ip4_tcp_hdr
439 typedef struct ip6_tcp_hdr
446 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
449 const dpo_id_t *choice;
453 lb = load_balance_get (dpo->dpoi_index);
457 clib_memset (&hdr, 0, sizeof (hdr));
458 hdr.ip.protocol = IP_PROTOCOL_TCP;
459 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
460 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
461 hdr.tcp.src_port = tc->c_lcl_port;
462 hdr.tcp.dst_port = tc->c_rmt_port;
463 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
468 clib_memset (&hdr, 0, sizeof (hdr));
469 hdr.ip.protocol = IP_PROTOCOL_TCP;
470 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
471 sizeof (ip6_address_t));
472 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
473 sizeof (ip6_address_t));
474 hdr.tcp.src_port = tc->c_lcl_port;
475 hdr.tcp.dst_port = tc->c_rmt_port;
476 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
478 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
479 dpo_copy (result, choice);
483 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
488 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
489 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
490 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
491 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
492 return fib_table_lookup (fib_index, &prefix);
496 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
498 dpo_id_t choice = DPO_INVALID;
499 u32 output_node_index;
502 fe = fib_entry_get (tc->c_rmt_fei);
503 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
506 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
509 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
510 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
514 /** Stack tcp connection on peer's fib entry.
516 * This ultimately populates the dpo the connection will use to send packets.
519 tcp_connection_fib_attach (tcp_connection_t * tc)
521 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
523 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
525 tcp_connection_stack_on_fib_entry (tc);
530 tcp_cc_init (tcp_connection_t * tc)
532 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
533 tc->cc_algo->init (tc);
537 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
538 const tcp_cc_algorithm_t * vft)
540 tcp_main_t *tm = vnet_get_tcp_main ();
541 vec_validate (tm->cc_algos, type);
543 tm->cc_algos[type] = *vft;
547 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
549 tcp_main_t *tm = vnet_get_tcp_main ();
550 return &tm->cc_algos[type];
555 * Initialize connection send variables.
558 tcp_init_snd_vars (tcp_connection_t * tc)
563 * We use the time to randomize iss and for setting up the initial
564 * timestamp. Make sure it's updated otherwise syn and ack in the
565 * handshake may make it look as if time has flown in the opposite
568 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
569 time_now = tcp_time_now ();
571 tc->iss = random_u32 (&time_now);
572 tc->snd_una = tc->iss;
573 tc->snd_nxt = tc->iss + 1;
574 tc->snd_una_max = tc->snd_nxt;
579 tcp_enable_pacing (tcp_connection_t * tc)
581 u32 initial_bucket, byte_rate;
582 initial_bucket = 16 * tc->snd_mss;
584 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
586 tc->mrtt_us = (u32) ~ 0;
589 /** Initialize tcp connection variables
591 * Should be called after having received a msg from the peer, i.e., a SYN or
592 * a SYNACK, such that connection options have already been exchanged. */
594 tcp_connection_init_vars (tcp_connection_t * tc)
596 tcp_connection_timers_init (tc);
598 scoreboard_init (&tc->sack_sb);
600 if (tc->state == TCP_STATE_SYN_RCVD)
601 tcp_init_snd_vars (tc);
603 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
604 tcp_add_del_adjacency (tc, 1);
606 /* tcp_connection_fib_attach (tc); */
608 if (transport_connection_is_tx_paced (&tc->connection)
609 || tcp_main.tx_pacing)
610 tcp_enable_pacing (tc);
614 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
615 u16 * lcl_port, u8 is_ip4)
620 index = tm->last_v4_address_rotor++;
621 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
622 tm->last_v4_address_rotor = 0;
623 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
627 index = tm->last_v6_address_rotor++;
628 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
629 tm->last_v6_address_rotor = 0;
630 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
631 sizeof (ip6_address_t));
633 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
636 clib_warning ("Failed to allocate src port");
644 tcp_session_open (transport_endpoint_cfg_t * rmt)
646 tcp_main_t *tm = vnet_get_tcp_main ();
647 tcp_connection_t *tc;
648 ip46_address_t lcl_addr;
653 * Allocate local endpoint
655 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
656 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
657 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
660 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
661 rmt, &lcl_addr, &lcl_port);
667 * Create connection and send SYN
669 clib_spinlock_lock_if_init (&tm->half_open_lock);
670 tc = tcp_half_open_connection_new ();
671 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
672 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
673 tc->c_rmt_port = rmt->port;
674 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
675 tc->c_is_ip4 = rmt->is_ip4;
676 tc->c_proto = TRANSPORT_PROTO_TCP;
677 tc->c_fib_index = rmt->fib_index;
678 /* The other connection vars will be initialized after SYN ACK */
679 tcp_connection_timers_init (tc);
681 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
682 tc->state = TCP_STATE_SYN_SENT;
683 tcp_init_snd_vars (tc);
685 clib_spinlock_unlock_if_init (&tm->half_open_lock);
687 return tc->c_c_index;
690 const char *tcp_dbg_evt_str[] = {
691 #define _(sym, str) str,
696 const char *tcp_fsm_states[] = {
697 #define _(sym, str) str,
698 foreach_tcp_fsm_state
703 format_tcp_state (u8 * s, va_list * args)
705 u32 state = va_arg (*args, u32);
707 if (state < TCP_N_STATES)
708 s = format (s, "%s", tcp_fsm_states[state]);
710 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
714 const char *tcp_connection_flags_str[] = {
715 #define _(sym, str) str,
716 foreach_tcp_connection_flag
721 format_tcp_connection_flags (u8 * s, va_list * args)
723 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
726 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
727 if (tc->flags & (1 << i))
729 for (i = 0; i < last; i++)
731 if (tc->flags & (1 << i))
732 s = format (s, "%s, ", tcp_connection_flags_str[i]);
735 s = format (s, "%s", tcp_connection_flags_str[last]);
739 const char *tcp_conn_timers[] = {
740 #define _(sym, str) str,
746 format_tcp_timers (u8 * s, va_list * args)
748 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
751 for (i = 0; i < TCP_N_TIMERS; i++)
752 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
755 for (i = 0; i < last; i++)
757 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
758 s = format (s, "%s,", tcp_conn_timers[i]);
762 s = format (s, "%s", tcp_conn_timers[i]);
768 format_tcp_congestion_status (u8 * s, va_list * args)
770 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
771 if (tcp_in_recovery (tc))
772 s = format (s, "recovery");
773 else if (tcp_in_fastrecovery (tc))
774 s = format (s, "fastrecovery");
776 s = format (s, "none");
781 tcp_rcv_wnd_available (tcp_connection_t * tc)
783 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
787 format_tcp_congestion (u8 * s, va_list * args)
789 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
790 u32 indent = format_get_indent (s);
792 s = format (s, "%U ", format_tcp_congestion_status, tc);
793 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
794 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
795 s = format (s, "%Ucc space %u prev_ssthresh %u snd_congestion %u"
796 " dupack %u\n", format_white_space, indent,
797 tcp_available_cc_snd_space (tc), tc->prev_ssthresh,
798 tc->snd_congestion - tc->iss, tc->rcv_dupacks);
799 s = format (s, "%Utsecr %u tsecr_last_ack %u limited_transmit %u\n",
800 format_white_space, indent, tc->rcv_opts.tsecr,
801 tc->tsecr_last_ack, tc->limited_transmit - tc->iss);
806 format_tcp_vars (u8 * s, va_list * args)
808 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
809 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
810 format_tcp_connection_flags, tc, format_tcp_timers, tc);
811 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
812 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
813 tc->snd_una_max - tc->iss);
814 s = format (s, " rcv_nxt %u rcv_las %u\n",
815 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
816 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
817 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
818 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
819 tc->snd_wl2 - tc->iss);
820 s = format (s, " flight size %u out space %u rcv_wnd_av %u\n",
821 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
822 tcp_rcv_wnd_available (tc));
823 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
824 tcp_time_now () - tc->tsval_recent_age);
825 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %x",
826 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
828 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
829 s = format (s, " cong: %U", format_tcp_congestion, tc);
831 if (tc->state >= TCP_STATE_ESTABLISHED)
833 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
836 if (vec_len (tc->snd_sacks))
837 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
843 format_tcp_connection_id (u8 * s, va_list * args)
845 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
850 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
851 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
852 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
853 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
857 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
858 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
859 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
860 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
867 format_tcp_connection (u8 * s, va_list * args)
869 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
870 u32 verbose = va_arg (*args, u32);
874 s = format (s, "%-50U", format_tcp_connection_id, tc);
877 s = format (s, "%-15U", format_tcp_state, tc->state);
879 s = format (s, "\n%U", format_tcp_vars, tc);
886 format_tcp_session (u8 * s, va_list * args)
888 u32 tci = va_arg (*args, u32);
889 u32 thread_index = va_arg (*args, u32);
890 u32 verbose = va_arg (*args, u32);
891 tcp_connection_t *tc;
893 tc = tcp_connection_get (tci, thread_index);
895 s = format (s, "%U", format_tcp_connection, tc, verbose);
897 s = format (s, "empty\n");
902 format_tcp_listener_session (u8 * s, va_list * args)
904 u32 tci = va_arg (*args, u32);
905 tcp_connection_t *tc = tcp_listener_get (tci);
906 return format (s, "%U", format_tcp_connection_id, tc);
910 format_tcp_half_open_session (u8 * s, va_list * args)
912 u32 tci = va_arg (*args, u32);
913 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
914 return format (s, "%U", format_tcp_connection_id, tc);
918 format_tcp_sacks (u8 * s, va_list * args)
920 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
921 sack_block_t *sacks = tc->snd_sacks;
925 len = vec_len (sacks);
926 for (i = 0; i < len - 1; i++)
929 s = format (s, " start %u end %u\n", block->start - tc->irs,
930 block->end - tc->irs);
934 block = &sacks[len - 1];
935 s = format (s, " start %u end %u", block->start - tc->irs,
936 block->end - tc->irs);
942 format_tcp_rcv_sacks (u8 * s, va_list * args)
944 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
945 sack_block_t *sacks = tc->rcv_opts.sacks;
949 len = vec_len (sacks);
950 for (i = 0; i < len - 1; i++)
953 s = format (s, " start %u end %u\n", block->start - tc->iss,
954 block->end - tc->iss);
958 block = &sacks[len - 1];
959 s = format (s, " start %u end %u", block->start - tc->iss,
960 block->end - tc->iss);
966 format_tcp_sack_hole (u8 * s, va_list * args)
968 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
969 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
971 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
973 s = format (s, " [%u, %u]", hole->start, hole->end);
978 format_tcp_scoreboard (u8 * s, va_list * args)
980 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
981 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
982 sack_scoreboard_hole_t *hole;
983 u32 indent = format_get_indent (s);
985 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
986 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
987 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
988 format_white_space, indent, sb->last_bytes_delivered,
989 sb->high_sacked - tc->iss, sb->snd_una_adv);
990 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
991 format_white_space, indent, sb->cur_rxt_hole,
992 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
994 hole = scoreboard_first_hole (sb);
996 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
997 indent, sb->head, sb->tail, pool_elts (sb->holes),
998 format_white_space, indent);
1002 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1003 hole = scoreboard_next_hole (sb, hole);
1009 static transport_connection_t *
1010 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1012 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1013 return &tc->connection;
1016 static transport_connection_t *
1017 tcp_half_open_session_get_transport (u32 conn_index)
1019 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1020 return &tc->connection;
1024 * Compute maximum segment size for session layer.
1026 * Since the result needs to be the actual data length, it first computes
1027 * the tcp options to be used in the next burst and subtracts their
1028 * length from the connection's snd_mss.
1031 tcp_session_send_mss (transport_connection_t * trans_conn)
1033 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1035 /* Ensure snd_mss does accurately reflect the amount of data we can push
1036 * in a segment. This also makes sure that options are updated according to
1037 * the current state of the connection. */
1038 tcp_update_burst_snd_vars (tc);
1044 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1046 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1048 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1051 /* If not snd_wnd constrained and we can't write at least a segment,
1052 * don't try at all */
1053 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1054 return snd_space < tc->cwnd ? 0 : snd_space;
1056 /* round down to mss multiple */
1057 return snd_space - (snd_space % tc->snd_mss);
1061 * Compute tx window session is allowed to fill.
1063 * Takes into account available send space, snd_mss and the congestion
1064 * state of the connection. If possible, the value returned is a multiple
1067 * @param tc tcp connection
1068 * @return number of bytes session is allowed to write
1071 tcp_snd_space_inline (tcp_connection_t * tc)
1073 int snd_space, snt_limited;
1075 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1076 || tc->state == TCP_STATE_CLOSED))
1079 snd_space = tcp_available_output_snd_space (tc);
1081 /* If we haven't gotten dupacks or if we did and have gotten sacked
1082 * bytes then we can still send as per Limited Transmit (RFC3042) */
1083 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1084 && (tcp_opts_sack_permitted (tc)
1085 && tc->sack_sb.last_sacked_bytes == 0)))
1087 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1088 tc->limited_transmit = tc->snd_nxt;
1089 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1091 snt_limited = tc->snd_nxt - tc->limited_transmit;
1092 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1094 return tcp_round_snd_space (tc, snd_space);
1098 tcp_snd_space (tcp_connection_t * tc)
1100 return tcp_snd_space_inline (tc);
1104 tcp_session_send_space (transport_connection_t * trans_conn)
1106 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1107 return clib_min (tcp_snd_space_inline (tc),
1108 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1112 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1114 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1116 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1118 /* This still works if fast retransmit is on */
1119 return (tc->snd_nxt - tc->snd_una);
1123 tcp_update_time (f64 now, u8 thread_index)
1125 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1127 tcp_set_time_now (wrk);
1128 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1129 tcp_do_fastretransmits (wrk);
1130 tcp_send_acks (wrk);
1131 tcp_flush_frames_to_output (wrk);
1135 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1137 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1138 return tcp_push_header (tc, b);
1142 tcp_session_flush_data (transport_connection_t * tconn)
1144 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1145 if (tc->flags & TCP_CONN_PSH_PENDING)
1147 tc->flags |= TCP_CONN_PSH_PENDING;
1148 tc->psh_seq = tc->snd_una_max + transport_max_tx_dequeue (tconn) - 1;
1152 const static transport_proto_vft_t tcp_proto = {
1153 .enable = vnet_tcp_enable_disable,
1154 .bind = tcp_session_bind,
1155 .unbind = tcp_session_unbind,
1156 .push_header = tcp_session_push_header,
1157 .get_connection = tcp_session_get_transport,
1158 .get_listener = tcp_session_get_listener,
1159 .get_half_open = tcp_half_open_session_get_transport,
1160 .open = tcp_session_open,
1161 .close = tcp_session_close,
1162 .cleanup = tcp_session_cleanup,
1163 .send_mss = tcp_session_send_mss,
1164 .send_space = tcp_session_send_space,
1165 .update_time = tcp_update_time,
1166 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1167 .flush_data = tcp_session_flush_data,
1168 .format_connection = format_tcp_session,
1169 .format_listener = format_tcp_listener_session,
1170 .format_half_open = format_tcp_half_open_session,
1171 .tx_type = TRANSPORT_TX_PEEK,
1172 .service_type = TRANSPORT_SERVICE_VC,
1177 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1182 if (!transport_connection_is_tx_paced (&tc->connection))
1185 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1186 /* TODO should constrain to interface's max throughput but
1187 * we don't have link speeds for sw ifs ..*/
1188 rate = tc->cwnd / srtt;
1189 transport_connection_tx_pacer_update (&tc->connection, rate);
1193 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1196 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1197 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1198 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1199 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1200 start_bucket, last_time);
1204 tcp_timer_keep_handler (u32 conn_index)
1206 u32 thread_index = vlib_get_thread_index ();
1207 tcp_connection_t *tc;
1209 tc = tcp_connection_get (conn_index, thread_index);
1210 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1212 tcp_connection_close (tc);
1216 tcp_timer_establish_handler (u32 conn_index)
1218 tcp_connection_t *tc;
1220 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1221 /* note: the connection may have already disappeared */
1222 if (PREDICT_FALSE (tc == 0))
1224 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1225 /* Start cleanup. App wasn't notified yet so use delete notify as
1226 * opposed to delete to cleanup session layer state. */
1227 session_transport_delete_notify (&tc->connection);
1228 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1229 tcp_connection_cleanup (tc);
1233 tcp_timer_establish_ao_handler (u32 conn_index)
1235 tcp_connection_t *tc;
1237 tc = tcp_half_open_connection_get (conn_index);
1241 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1242 /* Notify app if we haven't tried to clean this up already */
1243 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1244 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1246 tc->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
1247 tcp_connection_cleanup (tc);
1251 tcp_timer_waitclose_handler (u32 conn_index)
1253 u32 thread_index = vlib_get_thread_index (), rto;
1254 tcp_connection_t *tc;
1256 tc = tcp_connection_get (conn_index, thread_index);
1259 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1263 case TCP_STATE_CLOSE_WAIT:
1264 tcp_connection_timers_reset (tc);
1265 session_transport_closed_notify (&tc->connection);
1267 if (!(tc->flags & TCP_CONN_FINPNDG))
1269 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1270 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1274 /* Session didn't come back with a close. Send FIN either way
1275 * and switch to LAST_ACK. */
1276 tcp_cong_recovery_off (tc);
1277 /* Make sure we don't try to send unsent data */
1278 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1280 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1282 /* Make sure we don't wait in LAST ACK forever */
1283 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1285 /* Don't delete the connection yet */
1287 case TCP_STATE_FIN_WAIT_1:
1288 tcp_connection_timers_reset (tc);
1289 if (tc->flags & TCP_CONN_FINPNDG)
1291 /* If FIN pending send it before closing and wait as long as
1292 * the rto timeout would wait. Notify session layer that transport
1293 * is closed. We haven't sent everything but we did try. */
1294 tcp_cong_recovery_off (tc);
1296 rto = clib_max (tc->rto >> tc->rto_boff, 1);
1297 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE,
1298 clib_min (rto * TCP_TO_TIMER_TICK, TCP_2MSL_TIME));
1299 session_transport_closed_notify (&tc->connection);
1303 /* We've sent the fin but no progress. Close the connection and
1304 * to make sure everything is flushed, setup a cleanup timer */
1305 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1306 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1309 case TCP_STATE_LAST_ACK:
1310 case TCP_STATE_CLOSING:
1311 tcp_connection_timers_reset (tc);
1312 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1313 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1314 session_transport_closed_notify (&tc->connection);
1317 tcp_connection_del (tc);
1323 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1325 tcp_timer_retransmit_handler,
1326 tcp_timer_delack_handler,
1327 tcp_timer_persist_handler,
1328 tcp_timer_keep_handler,
1329 tcp_timer_waitclose_handler,
1330 tcp_timer_retransmit_syn_handler,
1331 tcp_timer_establish_handler,
1332 tcp_timer_establish_ao_handler,
1337 tcp_expired_timers_dispatch (u32 * expired_timers)
1340 u32 connection_index, timer_id;
1342 for (i = 0; i < vec_len (expired_timers); i++)
1344 /* Get session index and timer id */
1345 connection_index = expired_timers[i] & 0x0FFFFFFF;
1346 timer_id = expired_timers[i] >> 28;
1348 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1350 /* Handle expiration */
1351 (*timer_expiration_handlers[timer_id]) (connection_index);
1356 tcp_initialize_timer_wheels (tcp_main_t * tm)
1358 tw_timer_wheel_16t_2w_512sl_t *tw;
1360 foreach_vlib_main (({
1361 tw = &tm->wrk_ctx[ii].timer_wheel;
1362 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1363 100e-3 /* timer period 100ms */ , ~0);
1364 tw->last_run_time = vlib_time_now (this_vlib_main);
1369 static clib_error_t *
1370 tcp_main_enable (vlib_main_t * vm)
1372 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1373 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1374 tcp_connection_t *tc __attribute__ ((unused));
1375 tcp_main_t *tm = vnet_get_tcp_main ();
1376 clib_error_t *error = 0;
1379 if ((error = vlib_call_init_function (vm, ip_main_init)))
1381 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1383 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1390 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1391 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1394 * Initialize data structures
1397 num_threads = 1 /* main thread */ + vtm->n_threads;
1398 vec_validate (tm->connections, num_threads - 1);
1399 vec_validate (tm->wrk_ctx, num_threads - 1);
1400 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1401 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1403 for (thread = 0; thread < num_threads; thread++)
1405 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1406 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1407 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1408 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1409 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1410 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1411 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1412 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1413 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1414 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1415 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1416 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1417 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1420 * Preallocate connections. Assume that thread 0 won't
1421 * use preallocated threads when running multi-core
1423 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1424 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1428 * Use a preallocated half-open connection pool?
1430 if (tm->preallocated_half_open_connections)
1431 pool_init_fixed (tm->half_open_connections,
1432 tm->preallocated_half_open_connections);
1434 /* Initialize clocks per tick for TCP timestamp. Used to compute
1435 * monotonically increasing timestamps. */
1436 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1437 / TCP_TSTAMP_RESOLUTION;
1439 if (num_threads > 1)
1441 clib_spinlock_init (&tm->half_open_lock);
1444 tcp_initialize_timer_wheels (tm);
1446 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1447 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1453 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1457 if (tcp_main.is_enabled)
1460 return tcp_main_enable (vm);
1464 tcp_main.is_enabled = 0;
1471 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1473 tcp_main_t *tm = &tcp_main;
1475 tm->punt_unknown4 = is_add;
1477 tm->punt_unknown6 = is_add;
1480 static clib_error_t *
1481 tcp_init (vlib_main_t * vm)
1483 tcp_main_t *tm = vnet_get_tcp_main ();
1484 ip_main_t *im = &ip_main;
1485 ip_protocol_info_t *pi;
1487 /* Session layer, and by implication tcp, are disabled by default */
1490 /* Register with IP for header parsing */
1491 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1493 return clib_error_return (0, "TCP protocol info AWOL");
1494 pi->format_header = format_tcp_header;
1495 pi->unformat_pg_edit = unformat_pg_tcp_header;
1497 /* Register as transport with session layer */
1498 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1499 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1500 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1501 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1503 tcp_api_reference ();
1505 tm->cc_algo = TCP_CC_NEWRENO;
1509 VLIB_INIT_FUNCTION (tcp_init);
1512 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1514 uword *result = va_arg (*va, uword *);
1516 if (unformat (input, "newreno"))
1517 *result = TCP_CC_NEWRENO;
1518 else if (unformat (input, "cubic"))
1519 *result = TCP_CC_CUBIC;
1527 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1529 tcp_main_t *tm = vnet_get_tcp_main ();
1530 tcp_cc_algorithm_t *cc_alg;
1531 unformat_input_t sub_input;
1534 vec_foreach (cc_alg, tm->cc_algos)
1536 if (!unformat (input, cc_alg->name))
1539 if (cc_alg->unformat_cfg
1540 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1542 if (cc_alg->unformat_cfg (&sub_input))
1549 static clib_error_t *
1550 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1552 tcp_main_t *tm = vnet_get_tcp_main ();
1554 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1556 if (unformat (input, "preallocated-connections %d",
1557 &tm->preallocated_connections))
1559 else if (unformat (input, "preallocated-half-open-connections %d",
1560 &tm->preallocated_half_open_connections))
1562 else if (unformat (input, "buffer-fail-fraction %f",
1563 &tm->buffer_fail_fraction))
1565 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1568 else if (unformat (input, "no-tx-pacing"))
1570 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1573 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1576 return clib_error_return (0, "unknown input `%U'",
1577 format_unformat_error, input);
1582 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1586 * \brief Configure an ipv4 source address range
1587 * @param vm vlib_main_t pointer
1588 * @param start first ipv4 address in the source address range
1589 * @param end last ipv4 address in the source address range
1590 * @param table_id VRF / table ID, 0 for the default FIB
1591 * @return 0 if all OK, else an error indication from api_errno.h
1595 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1596 ip4_address_t * start,
1597 ip4_address_t * end, u32 table_id)
1599 tcp_main_t *tm = vnet_get_tcp_main ();
1600 vnet_main_t *vnm = vnet_get_main ();
1601 u32 start_host_byte_order, end_host_byte_order;
1602 fib_prefix_t prefix;
1603 vnet_sw_interface_t *si;
1604 fib_node_index_t fei;
1608 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1609 ip4_address_t * hi_addr, u32 fib_index,
1612 clib_memset (&prefix, 0, sizeof (prefix));
1614 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1616 if (fib_index == ~0)
1617 return VNET_API_ERROR_NO_SUCH_FIB;
1619 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1620 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1622 /* sanity check for reversed args or some such */
1623 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1624 return VNET_API_ERROR_INVALID_ARGUMENT;
1626 /* Lookup the last address, to identify the interface involved */
1628 prefix.fp_proto = FIB_PROTOCOL_IP4;
1629 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1631 fei = fib_table_lookup (fib_index, &prefix);
1633 /* Couldn't find route to destination. Bail out. */
1634 if (fei == FIB_NODE_INDEX_INVALID)
1635 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1637 sw_if_index = fib_entry_get_resolving_interface (fei);
1639 /* Enable proxy arp on the interface */
1640 si = vnet_get_sw_interface (vnm, sw_if_index);
1641 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1643 /* Configure proxy arp across the range */
1644 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1651 dpo_id_t dpo = DPO_INVALID;
1653 vec_add1 (tm->ip4_src_addresses, start[0]);
1655 /* Add local adjacencies for the range */
1657 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1660 prefix.fp_proto = FIB_PROTOCOL_IP4;
1661 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1663 fib_table_entry_special_dpo_update (fib_index,
1666 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1669 start_host_byte_order++;
1670 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1672 while (start_host_byte_order <= end_host_byte_order);
1678 * \brief Configure an ipv6 source address range
1679 * @param vm vlib_main_t pointer
1680 * @param start first ipv6 address in the source address range
1681 * @param end last ipv6 address in the source address range
1682 * @param table_id VRF / table ID, 0 for the default FIB
1683 * @return 0 if all OK, else an error indication from api_errno.h
1687 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1688 ip6_address_t * start,
1689 ip6_address_t * end, u32 table_id)
1691 tcp_main_t *tm = vnet_get_tcp_main ();
1692 fib_prefix_t prefix;
1694 fib_node_index_t fei;
1697 clib_memset (&prefix, 0, sizeof (prefix));
1699 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1701 if (fib_index == ~0)
1702 return VNET_API_ERROR_NO_SUCH_FIB;
1708 dpo_id_t dpo = DPO_INVALID;
1710 /* Remember this address */
1711 vec_add1 (tm->ip6_src_addresses, start[0]);
1713 /* Lookup the prefix, to identify the interface involved */
1714 prefix.fp_len = 128;
1715 prefix.fp_proto = FIB_PROTOCOL_IP6;
1716 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1718 fei = fib_table_lookup (fib_index, &prefix);
1720 /* Couldn't find route to destination. Bail out. */
1721 if (fei == FIB_NODE_INDEX_INVALID)
1722 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1724 sw_if_index = fib_entry_get_resolving_interface (fei);
1726 if (sw_if_index == (u32) ~ 0)
1727 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1729 /* Add a proxy neighbor discovery entry for this address */
1730 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1732 /* Add a receive adjacency for this address */
1733 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1736 fib_table_entry_special_dpo_update (fib_index,
1739 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1742 /* Done with the entire range? */
1743 if (!memcmp (start, end, sizeof (start[0])))
1746 /* Increment the address. DGMS. */
1748 for (i = 15; i >= 0; i--)
1751 if (tmp.as_u8[i] != 0)
1759 static clib_error_t *
1760 tcp_src_address (vlib_main_t * vm,
1761 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1763 ip4_address_t v4start, v4end;
1764 ip6_address_t v6start, v6end;
1770 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1772 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1773 unformat_ip4_address, &v4end))
1775 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1777 memcpy (&v4end, &v4start, sizeof (v4start));
1780 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1781 unformat_ip6_address, &v6end))
1783 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1785 memcpy (&v6end, &v6start, sizeof (v6start));
1788 else if (unformat (input, "fib-table %d", &table_id))
1794 if (!v4set && !v6set)
1795 return clib_error_return (0, "at least one v4 or v6 address required");
1799 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1806 case VNET_API_ERROR_NO_SUCH_FIB:
1807 return clib_error_return (0, "Invalid table-id %d", table_id);
1809 case VNET_API_ERROR_INVALID_ARGUMENT:
1810 return clib_error_return (0, "Invalid address range %U - %U",
1811 format_ip4_address, &v4start,
1812 format_ip4_address, &v4end);
1814 return clib_error_return (0, "error %d", rv);
1820 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1827 case VNET_API_ERROR_NO_SUCH_FIB:
1828 return clib_error_return (0, "Invalid table-id %d", table_id);
1831 return clib_error_return (0, "error %d", rv);
1839 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1841 .path = "tcp src-address",
1842 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1843 .function = tcp_src_address,
1848 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1850 #if TCP_SCOREBOARD_TRACE
1852 scoreboard_trace_elt_t *block;
1858 s = format (s, "scoreboard trace:");
1859 vec_foreach (block, sb->trace)
1861 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1862 block->ack, block->snd_una_max, block->group);
1864 s = format (s, "\n");
1872 static clib_error_t *
1873 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1874 vlib_cli_command_t * cmd_arg)
1876 transport_connection_t *tconn = 0;
1877 tcp_connection_t *tc;
1879 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1881 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1882 TRANSPORT_PROTO_TCP))
1885 return clib_error_return (0, "unknown input `%U'",
1886 format_unformat_error, input);
1889 if (!TCP_SCOREBOARD_TRACE)
1891 vlib_cli_output (vm, "scoreboard tracing not enabled");
1895 tc = tcp_get_connection_from_transport (tconn);
1896 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1897 vlib_cli_output (vm, "%v", s);
1902 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1904 .path = "show tcp scoreboard trace",
1905 .short_help = "show tcp scoreboard trace <connection>",
1906 .function = tcp_show_scoreboard_trace_fn,
1911 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1914 scoreboard_trace_elt_t *trace;
1915 u32 next_ack, left, group, has_new_ack = 0;
1916 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1917 sack_block_t *block;
1919 if (!TCP_SCOREBOARD_TRACE)
1921 s = format (s, "scoreboard tracing not enabled");
1928 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1929 tcp_connection_timers_init (dummy_tc);
1930 scoreboard_init (&dummy_tc->sack_sb);
1931 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1933 #if TCP_SCOREBOARD_TRACE
1934 trace = tc->sack_sb.trace;
1935 trace_len = vec_len (tc->sack_sb.trace);
1938 for (i = 0; i < trace_len; i++)
1940 if (trace[i].ack != 0)
1942 dummy_tc->snd_una = trace[i].ack - 1448;
1943 dummy_tc->snd_una_max = trace[i].ack;
1948 while (left < trace_len)
1950 group = trace[left].group;
1951 vec_reset_length (dummy_tc->rcv_opts.sacks);
1953 while (trace[left].group == group)
1955 if (trace[left].ack != 0)
1958 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1959 trace[left].ack, trace[left].snd_una_max);
1960 dummy_tc->snd_una_max = trace[left].snd_una_max;
1961 next_ack = trace[left].ack;
1967 s = format (s, "[%u, %u], ", trace[left].start,
1969 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1970 block->start = trace[left].start;
1971 block->end = trace[left].end;
1977 tcp_rcv_sacks (dummy_tc, next_ack);
1979 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1982 s = format (s, "result: %U", format_tcp_scoreboard,
1983 &dummy_tc->sack_sb);
1986 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1991 static clib_error_t *
1992 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1993 vlib_cli_command_t * cmd_arg)
1995 transport_connection_t *tconn = 0;
1996 tcp_connection_t *tc = 0;
1998 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2000 if (unformat (input, "%U", unformat_transport_connection, &tconn,
2001 TRANSPORT_PROTO_TCP))
2004 return clib_error_return (0, "unknown input `%U'",
2005 format_unformat_error, input);
2008 if (!TCP_SCOREBOARD_TRACE)
2010 vlib_cli_output (vm, "scoreboard tracing not enabled");
2014 tc = tcp_get_connection_from_transport (tconn);
2017 vlib_cli_output (vm, "connection not found");
2020 str = tcp_scoreboard_replay (str, tc, 1);
2021 vlib_cli_output (vm, "%v", str);
2026 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2028 .path = "tcp replay scoreboard",
2029 .short_help = "tcp replay scoreboard <connection>",
2030 .function = tcp_scoreboard_trace_fn,
2034 static clib_error_t *
2035 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2036 vlib_cli_command_t * cmd_arg)
2038 tcp_main_t *tm = vnet_get_tcp_main ();
2039 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2040 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2042 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2043 tm->punt_unknown4 ? "enabled" : "disabled");
2044 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2045 tm->punt_unknown6 ? "enabled" : "disabled");
2049 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2051 .path = "show tcp punt",
2052 .short_help = "show tcp punt",
2053 .function = show_tcp_punt_fn,
2058 * fd.io coding-style-patch-verification: ON
2061 * eval: (c-set-style "gnu")