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 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 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);
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 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 tcp_cc_init (tcp_connection_t * tc)
510 tc->cc_algo = tcp_cc_algo_get (TCP_CC_NEWRENO);
511 tc->cc_algo->init (tc);
515 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
516 const tcp_cc_algorithm_t * vft)
518 tcp_main_t *tm = vnet_get_tcp_main ();
519 vec_validate (tm->cc_algos, type);
521 tm->cc_algos[type] = *vft;
525 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
527 tcp_main_t *tm = vnet_get_tcp_main ();
528 return &tm->cc_algos[type];
533 * Initialize connection send variables.
536 tcp_init_snd_vars (tcp_connection_t * tc)
541 * We use the time to randomize iss and for setting up the initial
542 * timestamp. Make sure it's updated otherwise syn and ack in the
543 * handshake may make it look as if time has flown in the opposite
546 tcp_set_time_now (vlib_get_thread_index ());
547 time_now = tcp_time_now ();
549 tc->iss = random_u32 (&time_now);
550 tc->snd_una = tc->iss;
551 tc->snd_nxt = tc->iss + 1;
552 tc->snd_una_max = tc->snd_nxt;
555 /** Initialize tcp connection variables
557 * Should be called after having received a msg from the peer, i.e., a SYN or
558 * a SYNACK, such that connection options have already been exchanged. */
560 tcp_connection_init_vars (tcp_connection_t * tc)
562 tcp_connection_timers_init (tc);
564 scoreboard_init (&tc->sack_sb);
566 if (tc->state == TCP_STATE_SYN_RCVD)
567 tcp_init_snd_vars (tc);
569 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
570 tcp_add_del_adjacency (tc, 1);
572 // tcp_connection_fib_attach (tc);
576 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
577 u16 * lcl_port, u8 is_ip4)
582 index = tm->last_v4_address_rotor++;
583 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
584 tm->last_v4_address_rotor = 0;
585 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
589 index = tm->last_v6_address_rotor++;
590 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
591 tm->last_v6_address_rotor = 0;
592 clib_memcpy (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
593 sizeof (ip6_address_t));
595 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
598 clib_warning ("Failed to allocate src port");
606 tcp_connection_open (transport_endpoint_t * rmt)
608 tcp_main_t *tm = vnet_get_tcp_main ();
609 tcp_connection_t *tc;
610 ip46_address_t lcl_addr;
615 * Allocate local endpoint
617 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
618 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
619 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
622 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
623 rmt, &lcl_addr, &lcl_port);
629 * Create connection and send SYN
631 clib_spinlock_lock_if_init (&tm->half_open_lock);
632 tc = tcp_half_open_connection_new ();
633 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
634 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
635 tc->c_rmt_port = rmt->port;
636 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
637 tc->c_is_ip4 = rmt->is_ip4;
638 tc->c_proto = TRANSPORT_PROTO_TCP;
639 tc->c_fib_index = rmt->fib_index;
640 /* The other connection vars will be initialized after SYN ACK */
641 tcp_connection_timers_init (tc);
643 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
644 tc->state = TCP_STATE_SYN_SENT;
645 tcp_init_snd_vars (tc);
647 clib_spinlock_unlock_if_init (&tm->half_open_lock);
649 return tc->c_c_index;
653 tcp_session_open (transport_endpoint_t * tep)
655 return tcp_connection_open (tep);
658 const char *tcp_dbg_evt_str[] = {
659 #define _(sym, str) str,
664 const char *tcp_fsm_states[] = {
665 #define _(sym, str) str,
666 foreach_tcp_fsm_state
671 format_tcp_state (u8 * s, va_list * args)
673 u32 state = va_arg (*args, u32);
675 if (state < TCP_N_STATES)
676 s = format (s, "%s", tcp_fsm_states[state]);
678 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
682 const char *tcp_connection_flags_str[] = {
683 #define _(sym, str) str,
684 foreach_tcp_connection_flag
689 format_tcp_connection_flags (u8 * s, va_list * args)
691 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
694 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
695 if (tc->flags & (1 << i))
697 for (i = 0; i < last; i++)
699 if (tc->flags & (1 << i))
700 s = format (s, "%s, ", tcp_connection_flags_str[i]);
703 s = format (s, "%s", tcp_connection_flags_str[last]);
707 const char *tcp_conn_timers[] = {
708 #define _(sym, str) str,
714 format_tcp_timers (u8 * s, va_list * args)
716 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
719 for (i = 0; i < TCP_N_TIMERS; i++)
720 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
724 for (i = 0; i < last; i++)
726 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
727 s = format (s, "%s,", tcp_conn_timers[i]);
731 s = format (s, "%s]", tcp_conn_timers[i]);
739 format_tcp_congestion_status (u8 * s, va_list * args)
741 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
742 if (tcp_in_recovery (tc))
743 s = format (s, "recovery");
744 else if (tcp_in_fastrecovery (tc))
745 s = format (s, "fastrecovery");
747 s = format (s, "none");
752 tcp_rcv_wnd_available (tcp_connection_t * tc)
754 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
758 format_tcp_vars (u8 * s, va_list * args)
760 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
761 s = format (s, " flags: %U timers: %U\n", format_tcp_connection_flags, tc,
762 format_tcp_timers, tc);
763 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
764 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
765 tc->snd_una_max - tc->iss);
766 s = format (s, " rcv_nxt %u rcv_las %u\n",
767 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
768 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
769 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
770 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
771 tc->snd_wl2 - tc->iss);
772 s = format (s, " flight size %u out space %u cc space %u rcv_wnd_av %u\n",
773 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
774 tcp_available_cc_snd_space (tc), tcp_rcv_wnd_available (tc));
775 s = format (s, " cong %U ", format_tcp_congestion_status, tc);
776 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
777 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
778 s = format (s, " prev_ssthresh %u snd_congestion %u dupack %u",
779 tc->prev_ssthresh, tc->snd_congestion - tc->iss,
781 s = format (s, " limited_transmit %u\n", tc->limited_transmit - tc->iss);
782 s = format (s, " tsecr %u tsecr_last_ack %u\n", tc->rcv_opts.tsecr,
784 s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %u ", tc->rto,
785 tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
786 s = format (s, "rtt_seq %u\n", tc->rtt_seq);
787 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
788 tcp_time_now () - tc->tsval_recent_age);
789 if (tc->state >= TCP_STATE_ESTABLISHED)
790 s = format (s, " scoreboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
792 if (vec_len (tc->snd_sacks))
793 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
799 format_tcp_connection_id (u8 * s, va_list * args)
801 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
806 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
807 format_ip4_address, &tc->c_lcl_ip4,
808 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
809 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
813 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
814 format_ip6_address, &tc->c_lcl_ip6,
815 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
816 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
823 format_tcp_connection (u8 * s, va_list * args)
825 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
826 u32 verbose = va_arg (*args, u32);
830 s = format (s, "%-50U", format_tcp_connection_id, tc);
833 s = format (s, "%-15U", format_tcp_state, tc->state);
835 s = format (s, "\n%U", format_tcp_vars, tc);
842 format_tcp_session (u8 * s, va_list * args)
844 u32 tci = va_arg (*args, u32);
845 u32 thread_index = va_arg (*args, u32);
846 u32 verbose = va_arg (*args, u32);
847 tcp_connection_t *tc;
849 tc = tcp_connection_get (tci, thread_index);
851 s = format (s, "%U", format_tcp_connection, tc, verbose);
853 s = format (s, "empty\n");
858 format_tcp_listener_session (u8 * s, va_list * args)
860 u32 tci = va_arg (*args, u32);
861 tcp_connection_t *tc = tcp_listener_get (tci);
862 return format (s, "%U", format_tcp_connection_id, tc);
866 format_tcp_half_open_session (u8 * s, va_list * args)
868 u32 tci = va_arg (*args, u32);
869 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
870 return format (s, "%U", format_tcp_connection_id, tc);
874 format_tcp_sacks (u8 * s, va_list * args)
876 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
877 sack_block_t *sacks = tc->snd_sacks;
881 len = vec_len (sacks);
882 for (i = 0; i < len - 1; i++)
885 s = format (s, " start %u end %u\n", block->start - tc->irs,
886 block->end - tc->irs);
890 block = &sacks[len - 1];
891 s = format (s, " start %u end %u", block->start - tc->irs,
892 block->end - tc->irs);
898 format_tcp_rcv_sacks (u8 * s, va_list * args)
900 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
901 sack_block_t *sacks = tc->rcv_opts.sacks;
905 len = vec_len (sacks);
906 for (i = 0; i < len - 1; i++)
909 s = format (s, " start %u end %u\n", block->start - tc->iss,
910 block->end - tc->iss);
914 block = &sacks[len - 1];
915 s = format (s, " start %u end %u", block->start - tc->iss,
916 block->end - tc->iss);
922 format_tcp_sack_hole (u8 * s, va_list * args)
924 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
925 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
927 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
929 s = format (s, " [%u, %u]", hole->start, hole->end);
934 format_tcp_scoreboard (u8 * s, va_list * args)
936 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
937 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
938 sack_scoreboard_hole_t *hole;
939 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
940 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
941 s = format (s, " last_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
942 sb->last_bytes_delivered, sb->high_sacked - tc->iss,
944 s = format (s, " cur_rxt_hole %u high_rxt %u rescue_rxt %u",
945 sb->cur_rxt_hole, sb->high_rxt - tc->iss,
946 sb->rescue_rxt - tc->iss);
948 hole = scoreboard_first_hole (sb);
950 s = format (s, "\n head %u tail %u holes:\n", sb->head, sb->tail);
954 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
955 hole = scoreboard_next_hole (sb, hole);
961 static transport_connection_t *
962 tcp_session_get_transport (u32 conn_index, u32 thread_index)
964 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
965 return &tc->connection;
968 static transport_connection_t *
969 tcp_half_open_session_get_transport (u32 conn_index)
971 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
972 return &tc->connection;
976 * Compute maximum segment size for session layer.
978 * Since the result needs to be the actual data length, it first computes
979 * the tcp options to be used in the next burst and subtracts their
980 * length from the connection's snd_mss.
983 tcp_session_send_mss (transport_connection_t * trans_conn)
985 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
987 /* Ensure snd_mss does accurately reflect the amount of data we can push
988 * in a segment. This also makes sure that options are updated according to
989 * the current state of the connection. */
990 tcp_update_burst_snd_vars (tc);
996 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
998 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1000 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1003 /* If not snd_wnd constrained and we can't write at least a segment,
1004 * don't try at all */
1005 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1006 return snd_space < tc->cwnd ? 0 : snd_space;
1008 /* round down to mss multiple */
1009 return snd_space - (snd_space % tc->snd_mss);
1013 * Compute tx window session is allowed to fill.
1015 * Takes into account available send space, snd_mss and the congestion
1016 * state of the connection. If possible, the value returned is a multiple
1019 * @param tc tcp connection
1020 * @return number of bytes session is allowed to write
1023 tcp_snd_space_inline (tcp_connection_t * tc)
1025 int snd_space, snt_limited;
1027 if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0))
1029 snd_space = tcp_available_output_snd_space (tc);
1031 /* If we haven't gotten dupacks or if we did and have gotten sacked
1032 * bytes then we can still send as per Limited Transmit (RFC3042) */
1033 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1034 && (tcp_opts_sack_permitted (tc)
1035 && tc->sack_sb.last_sacked_bytes == 0)))
1037 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1038 tc->limited_transmit = tc->snd_nxt;
1039 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1041 snt_limited = tc->snd_nxt - tc->limited_transmit;
1042 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1044 return tcp_round_snd_space (tc, snd_space);
1047 if (tcp_in_recovery (tc))
1049 tc->snd_nxt = tc->snd_una_max;
1050 snd_space = tcp_available_snd_wnd (tc) - tc->snd_rxt_bytes
1051 - (tc->snd_una_max - tc->snd_congestion);
1052 if (snd_space <= 0 || (tc->snd_una_max - tc->snd_una) >= tc->snd_wnd)
1054 return tcp_round_snd_space (tc, snd_space);
1057 /* RFC 5681: When previously unsent data is available and the new value of
1058 * cwnd and the receiver's advertised window allow, a TCP SHOULD send 1*SMSS
1059 * bytes of previously unsent data. */
1060 if (tcp_in_fastrecovery (tc) && !tcp_fastrecovery_sent_1_smss (tc))
1062 if (tcp_available_cc_snd_space (tc) < tc->snd_mss)
1064 tcp_fastrecovery_1_smss_on (tc);
1072 tcp_snd_space (tcp_connection_t * tc)
1074 return tcp_snd_space_inline (tc);
1078 tcp_session_send_space (transport_connection_t * trans_conn)
1080 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1081 return clib_min (tcp_snd_space_inline (tc),
1082 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1086 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1088 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1090 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1092 /* This still works if fast retransmit is on */
1093 return (tc->snd_nxt - tc->snd_una);
1097 tcp_update_time (f64 now, u8 thread_index)
1099 tcp_set_time_now (thread_index);
1100 tw_timer_expire_timers_16t_2w_512sl (&tcp_main.
1101 wrk_ctx[thread_index].timer_wheel,
1103 tcp_flush_frames_to_output (thread_index);
1107 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1109 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1110 return tcp_push_header (tc, b);
1114 const static transport_proto_vft_t tcp_proto = {
1115 .enable = vnet_tcp_enable_disable,
1116 .bind = tcp_session_bind,
1117 .unbind = tcp_session_unbind,
1118 .push_header = tcp_session_push_header,
1119 .get_connection = tcp_session_get_transport,
1120 .get_listener = tcp_session_get_listener,
1121 .get_half_open = tcp_half_open_session_get_transport,
1122 .open = tcp_session_open,
1123 .close = tcp_session_close,
1124 .cleanup = tcp_session_cleanup,
1125 .send_mss = tcp_session_send_mss,
1126 .send_space = tcp_session_send_space,
1127 .update_time = tcp_update_time,
1128 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1129 .format_connection = format_tcp_session,
1130 .format_listener = format_tcp_listener_session,
1131 .format_half_open = format_tcp_half_open_session,
1132 .tx_type = TRANSPORT_TX_PEEK,
1133 .service_type = TRANSPORT_SERVICE_VC,
1138 tcp_timer_keep_handler (u32 conn_index)
1140 u32 thread_index = vlib_get_thread_index ();
1141 tcp_connection_t *tc;
1143 tc = tcp_connection_get (conn_index, thread_index);
1144 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1146 tcp_connection_close (tc);
1150 tcp_timer_establish_handler (u32 conn_index)
1152 tcp_connection_t *tc;
1154 tc = tcp_half_open_connection_get (conn_index);
1157 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1158 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1159 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1163 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1164 /* note: the connection may have already disappeared */
1165 if (PREDICT_FALSE (tc == 0))
1167 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1168 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1169 /* Start cleanup. App wasn't notified yet so use delete notify as
1170 * opposed to delete to cleanup session layer state. */
1171 stream_session_delete_notify (&tc->connection);
1173 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1174 tcp_connection_cleanup (tc);
1178 tcp_timer_waitclose_handler (u32 conn_index)
1180 u32 thread_index = vlib_get_thread_index ();
1181 tcp_connection_t *tc;
1183 tc = tcp_connection_get (conn_index, thread_index);
1186 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1188 /* Session didn't come back with a close(). Send FIN either way
1189 * and switch to LAST_ACK. */
1190 if (tc->state == TCP_STATE_CLOSE_WAIT)
1192 if (tc->flags & TCP_CONN_FINSNT)
1194 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1197 /* Make sure we don't try to send unsent data */
1198 tcp_connection_timers_reset (tc);
1199 tcp_cong_recovery_off (tc);
1200 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1202 tc->state = TCP_STATE_LAST_ACK;
1204 /* Make sure we don't wait in LAST ACK forever */
1205 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1207 /* Don't delete the connection yet */
1211 tcp_connection_del (tc);
1215 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1217 tcp_timer_retransmit_handler,
1218 tcp_timer_delack_handler,
1219 tcp_timer_persist_handler,
1220 tcp_timer_keep_handler,
1221 tcp_timer_waitclose_handler,
1222 tcp_timer_retransmit_syn_handler,
1223 tcp_timer_establish_handler
1228 tcp_expired_timers_dispatch (u32 * expired_timers)
1231 u32 connection_index, timer_id;
1233 for (i = 0; i < vec_len (expired_timers); i++)
1235 /* Get session index and timer id */
1236 connection_index = expired_timers[i] & 0x0FFFFFFF;
1237 timer_id = expired_timers[i] >> 28;
1239 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1241 /* Handle expiration */
1242 (*timer_expiration_handlers[timer_id]) (connection_index);
1247 tcp_initialize_timer_wheels (tcp_main_t * tm)
1249 tw_timer_wheel_16t_2w_512sl_t *tw;
1251 foreach_vlib_main (({
1252 tw = &tm->wrk_ctx[ii].timer_wheel;
1253 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1254 100e-3 /* timer period 100ms */ , ~0);
1255 tw->last_run_time = vlib_time_now (this_vlib_main);
1260 static clib_error_t *
1261 tcp_main_enable (vlib_main_t * vm)
1263 tcp_main_t *tm = vnet_get_tcp_main ();
1264 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1265 clib_error_t *error = 0;
1268 tcp_connection_t *tc __attribute__ ((unused));
1269 u32 preallocated_connections_per_thread;
1271 if ((error = vlib_call_init_function (vm, ip_main_init)))
1273 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1275 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1282 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1283 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1286 * Initialize data structures
1289 num_threads = 1 /* main thread */ + vtm->n_threads;
1290 vec_validate (tm->connections, num_threads - 1);
1293 * Preallocate connections. Assume that thread 0 won't
1294 * use preallocated threads when running multi-core
1296 if (num_threads == 1)
1299 preallocated_connections_per_thread = tm->preallocated_connections;
1304 preallocated_connections_per_thread =
1305 tm->preallocated_connections / (num_threads - 1);
1307 for (; thread < num_threads; thread++)
1309 if (preallocated_connections_per_thread)
1310 pool_init_fixed (tm->connections[thread],
1311 preallocated_connections_per_thread);
1315 * Use a preallocated half-open connection pool?
1317 if (tm->preallocated_half_open_connections)
1318 pool_init_fixed (tm->half_open_connections,
1319 tm->preallocated_half_open_connections);
1321 /* Initialize clocks per tick for TCP timestamp. Used to compute
1322 * monotonically increasing timestamps. */
1323 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1324 / TCP_TSTAMP_RESOLUTION;
1326 if (num_threads > 1)
1328 clib_spinlock_init (&tm->half_open_lock);
1331 vec_validate (tm->wrk_ctx, num_threads - 1);
1332 tcp_initialize_timer_wheels (tm);
1334 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1335 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1341 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1345 if (tcp_main.is_enabled)
1348 return tcp_main_enable (vm);
1352 tcp_main.is_enabled = 0;
1359 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1361 tcp_main_t *tm = &tcp_main;
1363 tm->punt_unknown4 = is_add;
1365 tm->punt_unknown6 = is_add;
1368 static clib_error_t *
1369 tcp_init (vlib_main_t * vm)
1371 tcp_main_t *tm = vnet_get_tcp_main ();
1372 ip_main_t *im = &ip_main;
1373 ip_protocol_info_t *pi;
1375 /* Session layer, and by implication tcp, are disabled by default */
1378 /* Register with IP for header parsing */
1379 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1381 return clib_error_return (0, "TCP protocol info AWOL");
1382 pi->format_header = format_tcp_header;
1383 pi->unformat_pg_edit = unformat_pg_tcp_header;
1385 /* Register as transport with session layer */
1386 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1387 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1388 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1389 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1391 tcp_api_reference ();
1395 VLIB_INIT_FUNCTION (tcp_init);
1397 static clib_error_t *
1398 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1400 tcp_main_t *tm = vnet_get_tcp_main ();
1402 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1404 if (unformat (input, "preallocated-connections %d",
1405 &tm->preallocated_connections))
1407 else if (unformat (input, "preallocated-half-open-connections %d",
1408 &tm->preallocated_half_open_connections))
1410 else if (unformat (input, "buffer-fail-fraction %f",
1411 &tm->buffer_fail_fraction))
1413 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1417 return clib_error_return (0, "unknown input `%U'",
1418 format_unformat_error, input);
1423 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1427 * \brief Configure an ipv4 source address range
1428 * @param vm vlib_main_t pointer
1429 * @param start first ipv4 address in the source address range
1430 * @param end last ipv4 address in the source address range
1431 * @param table_id VRF / table ID, 0 for the default FIB
1432 * @return 0 if all OK, else an error indication from api_errno.h
1436 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1437 ip4_address_t * start,
1438 ip4_address_t * end, u32 table_id)
1440 tcp_main_t *tm = vnet_get_tcp_main ();
1441 vnet_main_t *vnm = vnet_get_main ();
1442 u32 start_host_byte_order, end_host_byte_order;
1443 fib_prefix_t prefix;
1444 vnet_sw_interface_t *si;
1445 fib_node_index_t fei;
1449 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1450 ip4_address_t * hi_addr, u32 fib_index,
1453 memset (&prefix, 0, sizeof (prefix));
1455 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1457 if (fib_index == ~0)
1458 return VNET_API_ERROR_NO_SUCH_FIB;
1460 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1461 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1463 /* sanity check for reversed args or some such */
1464 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1465 return VNET_API_ERROR_INVALID_ARGUMENT;
1467 /* Lookup the last address, to identify the interface involved */
1469 prefix.fp_proto = FIB_PROTOCOL_IP4;
1470 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1472 fei = fib_table_lookup (fib_index, &prefix);
1474 /* Couldn't find route to destination. Bail out. */
1475 if (fei == FIB_NODE_INDEX_INVALID)
1476 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1478 sw_if_index = fib_entry_get_resolving_interface (fei);
1480 /* Enable proxy arp on the interface */
1481 si = vnet_get_sw_interface (vnm, sw_if_index);
1482 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1484 /* Configure proxy arp across the range */
1485 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1492 dpo_id_t dpo = DPO_INVALID;
1494 vec_add1 (tm->ip4_src_addresses, start[0]);
1496 /* Add local adjacencies for the range */
1498 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1501 prefix.fp_proto = FIB_PROTOCOL_IP4;
1502 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1504 fib_table_entry_special_dpo_update (fib_index,
1507 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1510 start_host_byte_order++;
1511 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1513 while (start_host_byte_order <= end_host_byte_order);
1519 * \brief Configure an ipv6 source address range
1520 * @param vm vlib_main_t pointer
1521 * @param start first ipv6 address in the source address range
1522 * @param end last ipv6 address in the source address range
1523 * @param table_id VRF / table ID, 0 for the default FIB
1524 * @return 0 if all OK, else an error indication from api_errno.h
1528 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1529 ip6_address_t * start,
1530 ip6_address_t * end, u32 table_id)
1532 tcp_main_t *tm = vnet_get_tcp_main ();
1533 fib_prefix_t prefix;
1535 fib_node_index_t fei;
1538 memset (&prefix, 0, sizeof (prefix));
1540 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1542 if (fib_index == ~0)
1543 return VNET_API_ERROR_NO_SUCH_FIB;
1549 dpo_id_t dpo = DPO_INVALID;
1551 /* Remember this address */
1552 vec_add1 (tm->ip6_src_addresses, start[0]);
1554 /* Lookup the prefix, to identify the interface involved */
1555 prefix.fp_len = 128;
1556 prefix.fp_proto = FIB_PROTOCOL_IP6;
1557 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1559 fei = fib_table_lookup (fib_index, &prefix);
1561 /* Couldn't find route to destination. Bail out. */
1562 if (fei == FIB_NODE_INDEX_INVALID)
1563 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1565 sw_if_index = fib_entry_get_resolving_interface (fei);
1567 if (sw_if_index == (u32) ~ 0)
1568 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1570 /* Add a proxy neighbor discovery entry for this address */
1571 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1573 /* Add a receive adjacency for this address */
1574 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1577 fib_table_entry_special_dpo_update (fib_index,
1580 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1583 /* Done with the entire range? */
1584 if (!memcmp (start, end, sizeof (start[0])))
1587 /* Increment the address. DGMS. */
1589 for (i = 15; i >= 0; i--)
1592 if (tmp.as_u8[i] != 0)
1600 static clib_error_t *
1601 tcp_src_address (vlib_main_t * vm,
1602 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1604 ip4_address_t v4start, v4end;
1605 ip6_address_t v6start, v6end;
1611 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1613 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1614 unformat_ip4_address, &v4end))
1616 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1618 memcpy (&v4end, &v4start, sizeof (v4start));
1621 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1622 unformat_ip6_address, &v6end))
1624 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1626 memcpy (&v6end, &v6start, sizeof (v6start));
1629 else if (unformat (input, "fib-table %d", &table_id))
1635 if (!v4set && !v6set)
1636 return clib_error_return (0, "at least one v4 or v6 address required");
1640 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1647 case VNET_API_ERROR_NO_SUCH_FIB:
1648 return clib_error_return (0, "Invalid table-id %d", table_id);
1650 case VNET_API_ERROR_INVALID_ARGUMENT:
1651 return clib_error_return (0, "Invalid address range %U - %U",
1652 format_ip4_address, &v4start,
1653 format_ip4_address, &v4end);
1655 return clib_error_return (0, "error %d", rv);
1661 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1668 case VNET_API_ERROR_NO_SUCH_FIB:
1669 return clib_error_return (0, "Invalid table-id %d", table_id);
1672 return clib_error_return (0, "error %d", rv);
1680 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1682 .path = "tcp src-address",
1683 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1684 .function = tcp_src_address,
1689 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1691 #if TCP_SCOREBOARD_TRACE
1693 scoreboard_trace_elt_t *block;
1699 s = format (s, "scoreboard trace:");
1700 vec_foreach (block, sb->trace)
1702 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1703 block->ack, block->snd_una_max, block->group);
1705 s = format (s, "\n");
1713 static clib_error_t *
1714 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1715 vlib_cli_command_t * cmd_arg)
1717 transport_connection_t *tconn = 0;
1718 tcp_connection_t *tc;
1720 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1722 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1723 TRANSPORT_PROTO_TCP))
1726 return clib_error_return (0, "unknown input `%U'",
1727 format_unformat_error, input);
1730 if (!TCP_SCOREBOARD_TRACE)
1732 vlib_cli_output (vm, "scoreboard tracing not enabled");
1736 tc = tcp_get_connection_from_transport (tconn);
1737 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1738 vlib_cli_output (vm, "%v", s);
1743 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1745 .path = "show tcp scoreboard trace",
1746 .short_help = "show tcp scoreboard trace <connection>",
1747 .function = tcp_show_scoreboard_trace_fn,
1752 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1755 scoreboard_trace_elt_t *trace;
1756 u32 next_ack, left, group, has_new_ack = 0;
1757 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1758 sack_block_t *block;
1763 memset (dummy_tc, 0, sizeof (*dummy_tc));
1764 tcp_connection_timers_init (dummy_tc);
1765 scoreboard_init (&dummy_tc->sack_sb);
1766 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1768 #if TCP_SCOREBOARD_TRACE
1769 trace = tc->sack_sb.trace;
1770 trace_len = vec_len (tc->sack_sb.trace);
1776 for (i = 0; i < trace_len; i++)
1778 if (trace[i].ack != 0)
1780 dummy_tc->snd_una = trace[i].ack - 1448;
1781 dummy_tc->snd_una_max = trace[i].ack;
1786 while (left < trace_len)
1788 group = trace[left].group;
1789 vec_reset_length (dummy_tc->rcv_opts.sacks);
1791 while (trace[left].group == group)
1793 if (trace[left].ack != 0)
1796 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1797 trace[left].ack, trace[left].snd_una_max);
1798 dummy_tc->snd_una_max = trace[left].snd_una_max;
1799 next_ack = trace[left].ack;
1805 s = format (s, "[%u, %u], ", trace[left].start,
1807 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1808 block->start = trace[left].start;
1809 block->end = trace[left].end;
1815 tcp_rcv_sacks (dummy_tc, next_ack);
1817 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1820 s = format (s, "result: %U", format_tcp_scoreboard,
1821 &dummy_tc->sack_sb);
1824 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1829 static clib_error_t *
1830 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1831 vlib_cli_command_t * cmd_arg)
1833 transport_connection_t *tconn = 0;
1834 tcp_connection_t *tc = 0;
1836 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1838 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1839 TRANSPORT_PROTO_TCP))
1842 return clib_error_return (0, "unknown input `%U'",
1843 format_unformat_error, input);
1846 if (!TCP_SCOREBOARD_TRACE)
1848 vlib_cli_output (vm, "scoreboard tracing not enabled");
1852 tc = tcp_get_connection_from_transport (tconn);
1855 vlib_cli_output (vm, "connection not found");
1858 str = tcp_scoreboard_replay (str, tc, 1);
1859 vlib_cli_output (vm, "%v", str);
1864 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1866 .path = "tcp replay scoreboard",
1867 .short_help = "tcp replay scoreboard <connection>",
1868 .function = tcp_scoreboard_trace_fn,
1872 static clib_error_t *
1873 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1874 vlib_cli_command_t * cmd_arg)
1876 tcp_main_t *tm = vnet_get_tcp_main ();
1877 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1878 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1880 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1881 tm->punt_unknown4 ? "enabled" : "disabled");
1882 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1883 tm->punt_unknown6 ? "enabled" : "disabled");
1887 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1889 .path = "show tcp punt",
1890 .short_help = "show tcp punt",
1891 .function = show_tcp_punt_fn,
1896 * fd.io coding-style-patch-verification: ON
1899 * eval: (c-set-style "gnu")