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 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 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 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 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);
176 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
177 tcp_half_open_connection_del (tc);
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 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 tcp_half_open_connection_cleanup (tc);
217 int thread_index = tc->c_thread_index;
219 /* Make sure all timers are cleared */
220 tcp_connection_timers_reset (tc);
222 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
223 tcp_add_del_adjacency (tc, 0);
225 /* Poison the entry */
227 memset (tc, 0xFA, sizeof (*tc));
228 pool_put (tm->connections[thread_index], tc);
233 * Connection removal.
235 * This should be called only once connection enters CLOSED state. Note
236 * that it notifies the session of the removal event, so if the goal is to
237 * just remove the connection, call tcp_connection_cleanup instead.
240 tcp_connection_del (tcp_connection_t * tc)
242 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
243 stream_session_delete_notify (&tc->connection);
244 tcp_connection_cleanup (tc);
248 tcp_connection_new (u8 thread_index)
250 tcp_main_t *tm = vnet_get_tcp_main ();
251 tcp_connection_t *tc;
253 pool_get (tm->connections[thread_index], tc);
254 memset (tc, 0, sizeof (*tc));
255 tc->c_c_index = tc - tm->connections[thread_index];
256 tc->c_thread_index = thread_index;
260 /** Notify session that connection has been reset.
262 * Switch state to closed and wait for session to call cleanup.
265 tcp_connection_reset (tcp_connection_t * tc)
267 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
270 case TCP_STATE_SYN_RCVD:
271 /* Cleanup everything. App wasn't notified yet */
272 stream_session_delete_notify (&tc->connection);
273 tcp_connection_cleanup (tc);
275 case TCP_STATE_SYN_SENT:
276 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
277 tcp_connection_cleanup (tc);
279 case TCP_STATE_ESTABLISHED:
280 tcp_connection_timers_reset (tc);
281 /* Set the cleanup timer, in case the session layer/app don't
282 * cleanly close the connection */
283 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
284 stream_session_reset_notify (&tc->connection);
286 case TCP_STATE_CLOSE_WAIT:
287 case TCP_STATE_FIN_WAIT_1:
288 case TCP_STATE_FIN_WAIT_2:
289 case TCP_STATE_CLOSING:
290 tc->state = TCP_STATE_CLOSED;
291 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
292 tcp_connection_timers_reset (tc);
293 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
295 case TCP_STATE_CLOSED:
301 * Begin connection closing procedure.
303 * If at the end the connection is not in CLOSED state, it is not removed.
304 * Instead, we rely on on TCP to advance through state machine to either
305 * 1) LAST_ACK (passive close) whereby when the last ACK is received
306 * tcp_connection_del is called. This notifies session of the delete and
308 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
309 * and cleanup is called.
311 * N.B. Half-close connections are not supported
314 tcp_connection_close (tcp_connection_t * tc)
316 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
318 /* Send/Program FIN if needed and switch state */
321 case TCP_STATE_SYN_SENT:
322 tc->state = TCP_STATE_CLOSED;
324 case TCP_STATE_SYN_RCVD:
326 tc->state = TCP_STATE_FIN_WAIT_1;
328 case TCP_STATE_ESTABLISHED:
329 if (!session_tx_fifo_max_dequeue (&tc->connection))
332 tc->flags |= TCP_CONN_FINPNDG;
333 tc->state = TCP_STATE_FIN_WAIT_1;
335 case TCP_STATE_CLOSE_WAIT:
336 if (!session_tx_fifo_max_dequeue (&tc->connection))
339 tcp_connection_timers_reset (tc);
340 tc->state = TCP_STATE_LAST_ACK;
341 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
344 tc->flags |= TCP_CONN_FINPNDG;
346 case TCP_STATE_FIN_WAIT_1:
347 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
350 TCP_DBG ("state: %u", tc->state);
353 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
355 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
356 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
357 && tc->state == TCP_STATE_CLOSED)
358 tcp_connection_del (tc);
362 tcp_session_close (u32 conn_index, u32 thread_index)
364 tcp_connection_t *tc;
365 tc = tcp_connection_get (conn_index, thread_index);
366 tcp_connection_close (tc);
370 tcp_session_cleanup (u32 conn_index, u32 thread_index)
372 tcp_connection_t *tc;
373 tc = tcp_connection_get (conn_index, thread_index);
374 tcp_connection_timers_reset (tc);
375 tc->state = TCP_STATE_CLOSED;
376 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
377 tcp_connection_cleanup (tc);
381 * Initialize all connection timers as invalid
384 tcp_connection_timers_init (tcp_connection_t * tc)
388 /* Set all to invalid */
389 for (i = 0; i < TCP_N_TIMERS; i++)
391 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
394 tc->rto = TCP_RTO_INIT;
398 * Stop all connection timers
401 tcp_connection_timers_reset (tcp_connection_t * tc)
404 for (i = 0; i < TCP_N_TIMERS; i++)
406 tcp_timer_reset (tc, i);
411 typedef struct ip4_tcp_hdr
417 typedef struct ip6_tcp_hdr
424 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
427 const dpo_id_t *choice;
431 lb = load_balance_get (dpo->dpoi_index);
435 memset (&hdr, 0, sizeof (hdr));
436 hdr.ip.protocol = IP_PROTOCOL_TCP;
437 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
438 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
439 hdr.tcp.src_port = tc->c_lcl_port;
440 hdr.tcp.dst_port = tc->c_rmt_port;
441 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
446 memset (&hdr, 0, sizeof (hdr));
447 hdr.ip.protocol = IP_PROTOCOL_TCP;
448 clib_memcpy (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
449 sizeof (ip6_address_t));
450 clib_memcpy (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
451 sizeof (ip6_address_t));
452 hdr.tcp.src_port = tc->c_lcl_port;
453 hdr.tcp.dst_port = tc->c_rmt_port;
454 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
456 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
457 dpo_copy (result, choice);
461 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
466 clib_memcpy (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
467 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
468 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
469 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
470 return fib_table_lookup (fib_index, &prefix);
474 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
476 dpo_id_t choice = DPO_INVALID;
477 u32 output_node_index;
480 fe = fib_entry_get (tc->c_rmt_fei);
481 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
484 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
487 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
488 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
492 /** Stack tcp connection on peer's fib entry.
494 * This ultimately populates the dpo the connection will use to send packets.
497 tcp_connection_fib_attach (tcp_connection_t * tc)
499 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
501 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
503 tcp_connection_stack_on_fib_entry (tc);
508 * Initialize connection send variables.
511 tcp_init_snd_vars (tcp_connection_t * tc)
516 * We use the time to randomize iss and for setting up the initial
517 * timestamp. Make sure it's updated otherwise syn and ack in the
518 * handshake may make it look as if time has flown in the opposite
521 tcp_set_time_now (vlib_get_thread_index ());
522 time_now = tcp_time_now ();
524 tc->iss = random_u32 (&time_now);
525 tc->snd_una = tc->iss;
526 tc->snd_nxt = tc->iss + 1;
527 tc->snd_una_max = tc->snd_nxt;
530 /** Initialize tcp connection variables
532 * Should be called after having received a msg from the peer, i.e., a SYN or
533 * a SYNACK, such that connection options have already been exchanged. */
535 tcp_connection_init_vars (tcp_connection_t * tc)
537 tcp_connection_timers_init (tc);
539 scoreboard_init (&tc->sack_sb);
541 if (tc->state == TCP_STATE_SYN_RCVD)
542 tcp_init_snd_vars (tc);
544 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
545 tcp_add_del_adjacency (tc, 1);
547 // tcp_connection_fib_attach (tc);
551 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
552 u16 * lcl_port, u8 is_ip4)
557 index = tm->last_v4_address_rotor++;
558 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
559 tm->last_v4_address_rotor = 0;
560 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
564 index = tm->last_v6_address_rotor++;
565 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
566 tm->last_v6_address_rotor = 0;
567 clib_memcpy (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
568 sizeof (ip6_address_t));
570 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
573 clib_warning ("Failed to allocate src port");
581 tcp_connection_open (transport_endpoint_t * rmt)
583 tcp_main_t *tm = vnet_get_tcp_main ();
584 tcp_connection_t *tc;
585 ip46_address_t lcl_addr;
590 * Allocate local endpoint
592 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
593 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
594 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
597 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
598 rmt, &lcl_addr, &lcl_port);
604 * Create connection and send SYN
606 clib_spinlock_lock_if_init (&tm->half_open_lock);
607 tc = tcp_half_open_connection_new ();
608 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
609 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
610 tc->c_rmt_port = rmt->port;
611 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
612 tc->c_is_ip4 = rmt->is_ip4;
613 tc->c_proto = TRANSPORT_PROTO_TCP;
614 tc->c_fib_index = rmt->fib_index;
615 /* The other connection vars will be initialized after SYN ACK */
616 tcp_connection_timers_init (tc);
618 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
619 tc->state = TCP_STATE_SYN_SENT;
620 tcp_init_snd_vars (tc);
622 clib_spinlock_unlock_if_init (&tm->half_open_lock);
624 return tc->c_c_index;
628 tcp_session_open (transport_endpoint_t * tep)
630 return tcp_connection_open (tep);
633 const char *tcp_dbg_evt_str[] = {
634 #define _(sym, str) str,
639 const char *tcp_fsm_states[] = {
640 #define _(sym, str) str,
641 foreach_tcp_fsm_state
646 format_tcp_state (u8 * s, va_list * args)
648 u32 state = va_arg (*args, u32);
650 if (state < TCP_N_STATES)
651 s = format (s, "%s", tcp_fsm_states[state]);
653 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
657 const char *tcp_connection_flags_str[] = {
658 #define _(sym, str) str,
659 foreach_tcp_connection_flag
664 format_tcp_connection_flags (u8 * s, va_list * args)
666 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
669 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
670 if (tc->flags & (1 << i))
672 for (i = 0; i < last; i++)
674 if (tc->flags & (1 << i))
675 s = format (s, "%s, ", tcp_connection_flags_str[i]);
678 s = format (s, "%s", tcp_connection_flags_str[last]);
682 const char *tcp_conn_timers[] = {
683 #define _(sym, str) str,
689 format_tcp_timers (u8 * s, va_list * args)
691 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
694 for (i = 0; i < TCP_N_TIMERS; i++)
695 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
699 for (i = 0; i < last; i++)
701 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
702 s = format (s, "%s,", tcp_conn_timers[i]);
706 s = format (s, "%s]", tcp_conn_timers[i]);
714 format_tcp_congestion_status (u8 * s, va_list * args)
716 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
717 if (tcp_in_recovery (tc))
718 s = format (s, "recovery");
719 else if (tcp_in_fastrecovery (tc))
720 s = format (s, "fastrecovery");
722 s = format (s, "none");
727 format_tcp_vars (u8 * s, va_list * args)
729 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
730 s = format (s, " flags: %U timers: %U\n", format_tcp_connection_flags, tc,
731 format_tcp_timers, tc);
732 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
733 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
734 tc->snd_una_max - tc->iss);
735 s = format (s, " rcv_nxt %u rcv_las %u\n",
736 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
737 s = format (s, " snd_wnd %u rcv_wnd %u snd_wl1 %u snd_wl2 %u\n",
738 tc->snd_wnd, tc->rcv_wnd, tc->snd_wl1 - tc->irs,
739 tc->snd_wl2 - tc->iss);
740 s = format (s, " flight size %u out space %u cc space %u rcv_wnd_av %u\n",
741 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
742 tcp_available_cc_snd_space (tc), tcp_rcv_wnd_available (tc));
743 s = format (s, " cong %U ", format_tcp_congestion_status, tc);
744 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
745 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
746 s = format (s, " prev_ssthresh %u snd_congestion %u dupack %u",
747 tc->prev_ssthresh, tc->snd_congestion - tc->iss,
749 s = format (s, " limited_transmit %u\n", tc->limited_transmit - tc->iss);
750 s = format (s, " tsecr %u tsecr_last_ack %u\n", tc->rcv_opts.tsecr,
752 s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %u ", tc->rto,
753 tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
754 s = format (s, "rtt_seq %u\n", tc->rtt_seq);
755 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
756 tcp_time_now () - tc->tsval_recent_age);
757 if (tc->state >= TCP_STATE_ESTABLISHED)
758 s = format (s, " scoreboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
760 if (vec_len (tc->snd_sacks))
761 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
767 format_tcp_connection_id (u8 * s, va_list * args)
769 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
774 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
775 format_ip4_address, &tc->c_lcl_ip4,
776 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
777 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
781 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
782 format_ip6_address, &tc->c_lcl_ip6,
783 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
784 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
791 format_tcp_connection (u8 * s, va_list * args)
793 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
794 u32 verbose = va_arg (*args, u32);
798 s = format (s, "%-50U", format_tcp_connection_id, tc);
801 s = format (s, "%-15U", format_tcp_state, tc->state);
803 s = format (s, "\n%U", format_tcp_vars, tc);
810 format_tcp_session (u8 * s, va_list * args)
812 u32 tci = va_arg (*args, u32);
813 u32 thread_index = va_arg (*args, u32);
814 u32 verbose = va_arg (*args, u32);
815 tcp_connection_t *tc;
817 tc = tcp_connection_get (tci, thread_index);
819 s = format (s, "%U", format_tcp_connection, tc, verbose);
821 s = format (s, "empty\n");
826 format_tcp_listener_session (u8 * s, va_list * args)
828 u32 tci = va_arg (*args, u32);
829 tcp_connection_t *tc = tcp_listener_get (tci);
830 return format (s, "%U", format_tcp_connection_id, tc);
834 format_tcp_half_open_session (u8 * s, va_list * args)
836 u32 tci = va_arg (*args, u32);
837 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
838 return format (s, "%U", format_tcp_connection_id, tc);
842 format_tcp_sacks (u8 * s, va_list * args)
844 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
845 sack_block_t *sacks = tc->snd_sacks;
849 len = vec_len (sacks);
850 for (i = 0; i < len - 1; i++)
853 s = format (s, " start %u end %u\n", block->start - tc->irs,
854 block->end - tc->irs);
858 block = &sacks[len - 1];
859 s = format (s, " start %u end %u", block->start - tc->irs,
860 block->end - tc->irs);
866 format_tcp_rcv_sacks (u8 * s, va_list * args)
868 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
869 sack_block_t *sacks = tc->rcv_opts.sacks;
873 len = vec_len (sacks);
874 for (i = 0; i < len - 1; i++)
877 s = format (s, " start %u end %u\n", block->start - tc->iss,
878 block->end - tc->iss);
882 block = &sacks[len - 1];
883 s = format (s, " start %u end %u", block->start - tc->iss,
884 block->end - tc->iss);
890 format_tcp_sack_hole (u8 * s, va_list * args)
892 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
893 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
895 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
897 s = format (s, " [%u, %u]", hole->start, hole->end);
902 format_tcp_scoreboard (u8 * s, va_list * args)
904 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
905 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
906 sack_scoreboard_hole_t *hole;
907 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
908 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
909 s = format (s, " last_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
910 sb->last_bytes_delivered, sb->high_sacked, sb->snd_una_adv);
911 s = format (s, " cur_rxt_hole %u high_rxt %u rescue_rxt %u",
912 sb->cur_rxt_hole, sb->high_rxt, sb->rescue_rxt);
914 hole = scoreboard_first_hole (sb);
916 s = format (s, "\n head %u tail %u holes:\n", sb->head, sb->tail);
920 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
921 hole = scoreboard_next_hole (sb, hole);
927 transport_connection_t *
928 tcp_session_get_transport (u32 conn_index, u32 thread_index)
930 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
931 return &tc->connection;
934 transport_connection_t *
935 tcp_half_open_session_get_transport (u32 conn_index)
937 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
938 return &tc->connection;
942 * Compute maximum segment size for session layer.
944 * Since the result needs to be the actual data length, it first computes
945 * the tcp options to be used in the next burst and subtracts their
946 * length from the connection's snd_mss.
949 tcp_session_send_mss (transport_connection_t * trans_conn)
951 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
953 /* Ensure snd_mss does accurately reflect the amount of data we can push
954 * in a segment. This also makes sure that options are updated according to
955 * the current state of the connection. */
956 tcp_update_snd_mss (tc);
962 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
964 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
966 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
969 /* If not snd_wnd constrained and we can't write at least a segment,
970 * don't try at all */
971 if (PREDICT_FALSE (snd_space < tc->snd_mss))
972 return snd_space < tc->cwnd ? 0 : snd_space;
974 /* round down to mss multiple */
975 return snd_space - (snd_space % tc->snd_mss);
979 * Compute tx window session is allowed to fill.
981 * Takes into account available send space, snd_mss and the congestion
982 * state of the connection. If possible, the value returned is a multiple
985 * @param tc tcp connection
986 * @return number of bytes session is allowed to write
989 tcp_snd_space (tcp_connection_t * tc)
991 int snd_space, snt_limited;
993 if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0))
995 snd_space = tcp_available_output_snd_space (tc);
997 /* If we haven't gotten dupacks or if we did and have gotten sacked
998 * bytes then we can still send as per Limited Transmit (RFC3042) */
999 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1000 && (tcp_opts_sack_permitted (tc)
1001 && tc->sack_sb.last_sacked_bytes == 0)))
1003 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1004 tc->limited_transmit = tc->snd_nxt;
1005 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1007 snt_limited = tc->snd_nxt - tc->limited_transmit;
1008 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1010 return tcp_round_snd_space (tc, snd_space);
1013 if (tcp_in_recovery (tc))
1015 tc->snd_nxt = tc->snd_una_max;
1016 snd_space = tcp_available_snd_wnd (tc) - tc->snd_rxt_bytes
1017 - (tc->snd_una_max - tc->snd_congestion);
1018 if (snd_space <= 0 || (tc->snd_una_max - tc->snd_una) >= tc->snd_wnd)
1020 return tcp_round_snd_space (tc, snd_space);
1023 /* RFC 5681: When previously unsent data is available and the new value of
1024 * cwnd and the receiver's advertised window allow, a TCP SHOULD send 1*SMSS
1025 * bytes of previously unsent data. */
1026 if (tcp_in_fastrecovery (tc) && !tcp_fastrecovery_sent_1_smss (tc))
1028 if (tcp_available_cc_snd_space (tc) < tc->snd_mss)
1030 tcp_fastrecovery_1_smss_on (tc);
1038 tcp_session_send_space (transport_connection_t * trans_conn)
1040 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1041 return clib_min (tcp_snd_space (tc),
1042 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1046 tcp_rcv_wnd_available (tcp_connection_t * tc)
1048 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
1052 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1054 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1056 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1058 /* This still works if fast retransmit is on */
1059 return (tc->snd_nxt - tc->snd_una);
1063 tcp_update_time (f64 now, u8 thread_index)
1065 tcp_set_time_now (thread_index);
1066 tw_timer_expire_timers_16t_2w_512sl (&tcp_main.timer_wheels[thread_index],
1068 tcp_flush_frames_to_output (thread_index);
1072 const static transport_proto_vft_t tcp_proto = {
1073 .enable = vnet_tcp_enable_disable,
1074 .bind = tcp_session_bind,
1075 .unbind = tcp_session_unbind,
1076 .push_header = tcp_session_push_header,
1077 .get_connection = tcp_session_get_transport,
1078 .get_listener = tcp_session_get_listener,
1079 .get_half_open = tcp_half_open_session_get_transport,
1080 .open = tcp_session_open,
1081 .close = tcp_session_close,
1082 .cleanup = tcp_session_cleanup,
1083 .send_mss = tcp_session_send_mss,
1084 .send_space = tcp_session_send_space,
1085 .update_time = tcp_update_time,
1086 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1087 .format_connection = format_tcp_session,
1088 .format_listener = format_tcp_listener_session,
1089 .format_half_open = format_tcp_half_open_session,
1090 .tx_type = TRANSPORT_TX_PEEK,
1091 .service_type = TRANSPORT_SERVICE_VC,
1096 tcp_timer_keep_handler (u32 conn_index)
1098 u32 thread_index = vlib_get_thread_index ();
1099 tcp_connection_t *tc;
1101 tc = tcp_connection_get (conn_index, thread_index);
1102 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1104 tcp_connection_close (tc);
1108 tcp_timer_establish_handler (u32 conn_index)
1110 tcp_connection_t *tc;
1112 tc = tcp_half_open_connection_get (conn_index);
1115 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1116 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1117 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1121 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1122 /* note: the connection may have already disappeared */
1123 if (PREDICT_FALSE (tc == 0))
1125 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1126 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1127 /* Start cleanup. App wasn't notified yet so use delete notify as
1128 * opposed to delete to cleanup session layer state. */
1129 stream_session_delete_notify (&tc->connection);
1131 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1132 tcp_connection_cleanup (tc);
1136 tcp_timer_waitclose_handler (u32 conn_index)
1138 u32 thread_index = vlib_get_thread_index ();
1139 tcp_connection_t *tc;
1141 tc = tcp_connection_get (conn_index, thread_index);
1144 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1146 /* Session didn't come back with a close(). Send FIN either way
1147 * and switch to LAST_ACK. */
1148 if (tc->state == TCP_STATE_CLOSE_WAIT)
1150 if (tc->flags & TCP_CONN_FINSNT)
1152 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1156 tc->state = TCP_STATE_LAST_ACK;
1158 /* Make sure we don't wait in LAST ACK forever */
1159 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1161 /* Don't delete the connection yet */
1165 tcp_connection_del (tc);
1169 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1171 tcp_timer_retransmit_handler,
1172 tcp_timer_delack_handler,
1173 tcp_timer_persist_handler,
1174 tcp_timer_keep_handler,
1175 tcp_timer_waitclose_handler,
1176 tcp_timer_retransmit_syn_handler,
1177 tcp_timer_establish_handler
1182 tcp_expired_timers_dispatch (u32 * expired_timers)
1185 u32 connection_index, timer_id;
1187 for (i = 0; i < vec_len (expired_timers); i++)
1189 /* Get session index and timer id */
1190 connection_index = expired_timers[i] & 0x0FFFFFFF;
1191 timer_id = expired_timers[i] >> 28;
1193 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1195 /* Handle expiration */
1196 (*timer_expiration_handlers[timer_id]) (connection_index);
1201 tcp_initialize_timer_wheels (tcp_main_t * tm)
1203 tw_timer_wheel_16t_2w_512sl_t *tw;
1205 foreach_vlib_main (({
1206 tw = &tm->timer_wheels[ii];
1207 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1208 100e-3 /* timer period 100ms */ , ~0);
1209 tw->last_run_time = vlib_time_now (this_vlib_main);
1215 tcp_main_enable (vlib_main_t * vm)
1217 tcp_main_t *tm = vnet_get_tcp_main ();
1218 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1219 clib_error_t *error = 0;
1222 tcp_connection_t *tc __attribute__ ((unused));
1223 u32 preallocated_connections_per_thread;
1225 if ((error = vlib_call_init_function (vm, ip_main_init)))
1227 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1229 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1236 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1237 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1240 * Initialize data structures
1243 num_threads = 1 /* main thread */ + vtm->n_threads;
1244 vec_validate (tm->connections, num_threads - 1);
1247 * Preallocate connections. Assume that thread 0 won't
1248 * use preallocated threads when running multi-core
1250 if (num_threads == 1)
1253 preallocated_connections_per_thread = tm->preallocated_connections;
1258 preallocated_connections_per_thread =
1259 tm->preallocated_connections / (num_threads - 1);
1261 for (; thread < num_threads; thread++)
1263 if (preallocated_connections_per_thread)
1264 pool_init_fixed (tm->connections[thread],
1265 preallocated_connections_per_thread);
1269 * Use a preallocated half-open connection pool?
1271 if (tm->preallocated_half_open_connections)
1272 pool_init_fixed (tm->half_open_connections,
1273 tm->preallocated_half_open_connections);
1275 /* Initialize per worker thread tx buffers (used for control messages) */
1276 vec_validate (tm->tx_buffers, num_threads - 1);
1278 /* Initialize timer wheels */
1279 vec_validate (tm->timer_wheels, num_threads - 1);
1280 tcp_initialize_timer_wheels (tm);
1282 /* Initialize clocks per tick for TCP timestamp. Used to compute
1283 * monotonically increasing timestamps. */
1284 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1285 / TCP_TSTAMP_RESOLUTION;
1287 if (num_threads > 1)
1289 clib_spinlock_init (&tm->half_open_lock);
1292 vec_validate (tm->tx_frames[0], num_threads - 1);
1293 vec_validate (tm->tx_frames[1], num_threads - 1);
1294 vec_validate (tm->ip_lookup_tx_frames[0], num_threads - 1);
1295 vec_validate (tm->ip_lookup_tx_frames[1], num_threads - 1);
1297 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1298 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1300 vec_validate (tm->time_now, num_threads - 1);
1305 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1309 if (tcp_main.is_enabled)
1312 return tcp_main_enable (vm);
1316 tcp_main.is_enabled = 0;
1323 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1325 tcp_main_t *tm = &tcp_main;
1327 tm->punt_unknown4 = is_add;
1329 tm->punt_unknown6 = is_add;
1333 tcp_init (vlib_main_t * vm)
1335 tcp_main_t *tm = vnet_get_tcp_main ();
1336 ip_main_t *im = &ip_main;
1337 ip_protocol_info_t *pi;
1339 /* Session layer, and by implication tcp, are disabled by default */
1342 /* Register with IP for header parsing */
1343 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1345 return clib_error_return (0, "TCP protocol info AWOL");
1346 pi->format_header = format_tcp_header;
1347 pi->unformat_pg_edit = unformat_pg_tcp_header;
1349 /* Register as transport with session layer */
1350 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1351 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1352 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1353 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1355 tcp_api_reference ();
1359 VLIB_INIT_FUNCTION (tcp_init);
1361 static clib_error_t *
1362 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1364 tcp_main_t *tm = vnet_get_tcp_main ();
1366 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1369 (input, "preallocated-connections %d",
1370 &tm->preallocated_connections))
1372 else if (unformat (input, "preallocated-half-open-connections %d",
1373 &tm->preallocated_half_open_connections))
1375 else if (unformat (input, "buffer-fail-fraction %f",
1376 &tm->buffer_fail_fraction))
1379 return clib_error_return (0, "unknown input `%U'",
1380 format_unformat_error, input);
1385 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1389 * \brief Configure an ipv4 source address range
1390 * @param vm vlib_main_t pointer
1391 * @param start first ipv4 address in the source address range
1392 * @param end last ipv4 address in the source address range
1393 * @param table_id VRF / table ID, 0 for the default FIB
1394 * @return 0 if all OK, else an error indication from api_errno.h
1398 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1399 ip4_address_t * start,
1400 ip4_address_t * end, u32 table_id)
1402 tcp_main_t *tm = vnet_get_tcp_main ();
1403 vnet_main_t *vnm = vnet_get_main ();
1404 u32 start_host_byte_order, end_host_byte_order;
1405 fib_prefix_t prefix;
1406 vnet_sw_interface_t *si;
1407 fib_node_index_t fei;
1411 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1412 ip4_address_t * hi_addr, u32 fib_index,
1415 memset (&prefix, 0, sizeof (prefix));
1417 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1419 if (fib_index == ~0)
1420 return VNET_API_ERROR_NO_SUCH_FIB;
1422 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1423 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1425 /* sanity check for reversed args or some such */
1426 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1427 return VNET_API_ERROR_INVALID_ARGUMENT;
1429 /* Lookup the last address, to identify the interface involved */
1431 prefix.fp_proto = FIB_PROTOCOL_IP4;
1432 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1434 fei = fib_table_lookup (fib_index, &prefix);
1436 /* Couldn't find route to destination. Bail out. */
1437 if (fei == FIB_NODE_INDEX_INVALID)
1438 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1440 sw_if_index = fib_entry_get_resolving_interface (fei);
1442 /* Enable proxy arp on the interface */
1443 si = vnet_get_sw_interface (vnm, sw_if_index);
1444 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1446 /* Configure proxy arp across the range */
1447 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1454 dpo_id_t dpo = DPO_INVALID;
1456 vec_add1 (tm->ip4_src_addresses, start[0]);
1458 /* Add local adjacencies for the range */
1460 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1463 prefix.fp_proto = FIB_PROTOCOL_IP4;
1464 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1466 fib_table_entry_special_dpo_update (fib_index,
1469 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1472 start_host_byte_order++;
1473 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1475 while (start_host_byte_order <= end_host_byte_order);
1481 * \brief Configure an ipv6 source address range
1482 * @param vm vlib_main_t pointer
1483 * @param start first ipv6 address in the source address range
1484 * @param end last ipv6 address in the source address range
1485 * @param table_id VRF / table ID, 0 for the default FIB
1486 * @return 0 if all OK, else an error indication from api_errno.h
1490 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1491 ip6_address_t * start,
1492 ip6_address_t * end, u32 table_id)
1494 tcp_main_t *tm = vnet_get_tcp_main ();
1495 fib_prefix_t prefix;
1497 fib_node_index_t fei;
1500 memset (&prefix, 0, sizeof (prefix));
1502 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1504 if (fib_index == ~0)
1505 return VNET_API_ERROR_NO_SUCH_FIB;
1511 dpo_id_t dpo = DPO_INVALID;
1513 /* Remember this address */
1514 vec_add1 (tm->ip6_src_addresses, start[0]);
1516 /* Lookup the prefix, to identify the interface involved */
1517 prefix.fp_len = 128;
1518 prefix.fp_proto = FIB_PROTOCOL_IP6;
1519 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1521 fei = fib_table_lookup (fib_index, &prefix);
1523 /* Couldn't find route to destination. Bail out. */
1524 if (fei == FIB_NODE_INDEX_INVALID)
1525 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1527 sw_if_index = fib_entry_get_resolving_interface (fei);
1529 if (sw_if_index == (u32) ~ 0)
1530 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1532 /* Add a proxy neighbor discovery entry for this address */
1533 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1535 /* Add a receive adjacency for this address */
1536 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1539 fib_table_entry_special_dpo_update (fib_index,
1542 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1545 /* Done with the entire range? */
1546 if (!memcmp (start, end, sizeof (start[0])))
1549 /* Increment the address. DGMS. */
1551 for (i = 15; i >= 0; i--)
1554 if (tmp.as_u8[i] != 0)
1562 static clib_error_t *
1563 tcp_src_address (vlib_main_t * vm,
1564 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1566 ip4_address_t v4start, v4end;
1567 ip6_address_t v6start, v6end;
1573 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1575 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1576 unformat_ip4_address, &v4end))
1578 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1580 memcpy (&v4end, &v4start, sizeof (v4start));
1583 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1584 unformat_ip6_address, &v6end))
1586 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1588 memcpy (&v6end, &v6start, sizeof (v6start));
1591 else if (unformat (input, "fib-table %d", &table_id))
1597 if (!v4set && !v6set)
1598 return clib_error_return (0, "at least one v4 or v6 address required");
1602 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1609 case VNET_API_ERROR_NO_SUCH_FIB:
1610 return clib_error_return (0, "Invalid table-id %d", table_id);
1612 case VNET_API_ERROR_INVALID_ARGUMENT:
1613 return clib_error_return (0, "Invalid address range %U - %U",
1614 format_ip4_address, &v4start,
1615 format_ip4_address, &v4end);
1617 return clib_error_return (0, "error %d", rv);
1623 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1630 case VNET_API_ERROR_NO_SUCH_FIB:
1631 return clib_error_return (0, "Invalid table-id %d", table_id);
1634 return clib_error_return (0, "error %d", rv);
1642 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1644 .path = "tcp src-address",
1645 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1646 .function = tcp_src_address,
1651 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1653 #if TCP_SCOREBOARD_TRACE
1655 scoreboard_trace_elt_t *block;
1661 s = format (s, "scoreboard trace:");
1662 vec_foreach (block, sb->trace)
1664 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1665 block->ack, block->snd_una_max, block->group);
1667 s = format (s, "\n");
1675 static clib_error_t *
1676 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1677 vlib_cli_command_t * cmd_arg)
1679 transport_connection_t *tconn = 0;
1680 tcp_connection_t *tc;
1682 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1684 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1685 TRANSPORT_PROTO_TCP))
1688 return clib_error_return (0, "unknown input `%U'",
1689 format_unformat_error, input);
1692 if (!TCP_SCOREBOARD_TRACE)
1694 vlib_cli_output (vm, "scoreboard tracing not enabled");
1698 tc = tcp_get_connection_from_transport (tconn);
1699 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1700 vlib_cli_output (vm, "%v", s);
1705 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1707 .path = "show tcp scoreboard trace",
1708 .short_help = "show tcp scoreboard trace <connection>",
1709 .function = tcp_show_scoreboard_trace_fn,
1714 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1717 scoreboard_trace_elt_t *trace;
1718 u32 next_ack, left, group, has_new_ack = 0;
1719 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1720 sack_block_t *block;
1725 memset (dummy_tc, 0, sizeof (*dummy_tc));
1726 tcp_connection_timers_init (dummy_tc);
1727 scoreboard_init (&dummy_tc->sack_sb);
1728 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1730 #if TCP_SCOREBOARD_TRACE
1731 trace = tc->sack_sb.trace;
1732 trace_len = vec_len (tc->sack_sb.trace);
1738 for (i = 0; i < trace_len; i++)
1740 if (trace[i].ack != 0)
1742 dummy_tc->snd_una = trace[i].ack - 1448;
1743 dummy_tc->snd_una_max = trace[i].ack;
1748 while (left < trace_len)
1750 group = trace[left].group;
1751 vec_reset_length (dummy_tc->rcv_opts.sacks);
1753 while (trace[left].group == group)
1755 if (trace[left].ack != 0)
1758 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1759 trace[left].ack, trace[left].snd_una_max);
1760 dummy_tc->snd_una_max = trace[left].snd_una_max;
1761 next_ack = trace[left].ack;
1767 s = format (s, "[%u, %u], ", trace[left].start,
1769 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1770 block->start = trace[left].start;
1771 block->end = trace[left].end;
1777 tcp_rcv_sacks (dummy_tc, next_ack);
1779 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1782 s = format (s, "result: %U", format_tcp_scoreboard,
1783 &dummy_tc->sack_sb);
1786 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1791 static clib_error_t *
1792 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1793 vlib_cli_command_t * cmd_arg)
1795 transport_connection_t *tconn = 0;
1796 tcp_connection_t *tc = 0;
1798 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1800 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1801 TRANSPORT_PROTO_TCP))
1804 return clib_error_return (0, "unknown input `%U'",
1805 format_unformat_error, input);
1808 if (!TCP_SCOREBOARD_TRACE)
1810 vlib_cli_output (vm, "scoreboard tracing not enabled");
1814 tc = tcp_get_connection_from_transport (tconn);
1817 vlib_cli_output (vm, "connection not found");
1820 str = tcp_scoreboard_replay (str, tc, 1);
1821 vlib_cli_output (vm, "%v", str);
1826 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1828 .path = "tcp replay scoreboard",
1829 .short_help = "tcp replay scoreboard <connection>",
1830 .function = tcp_scoreboard_trace_fn,
1834 static clib_error_t *
1835 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1836 vlib_cli_command_t * cmd_arg)
1838 tcp_main_t *tm = vnet_get_tcp_main ();
1839 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1840 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1842 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1843 tm->punt_unknown4 ? "enabled" : "disabled");
1844 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1845 tm->punt_unknown6 ? "enabled" : "disabled");
1849 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1851 .path = "show tcp punt",
1852 .short_help = "show tcp punt",
1853 .function = show_tcp_punt_fn,
1858 * fd.io coding-style-patch-verification: ON
1861 * eval: (c-set-style "gnu")