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);
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 stream_session_delete_notify (&tc->connection);
245 tcp_connection_cleanup (tc);
249 tcp_connection_new (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;
261 /** Notify session that connection has been reset.
263 * Switch state to closed and wait for session to call cleanup.
266 tcp_connection_reset (tcp_connection_t * tc)
268 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
271 case TCP_STATE_SYN_RCVD:
272 /* Cleanup everything. App wasn't notified yet */
273 stream_session_delete_notify (&tc->connection);
274 tcp_connection_cleanup (tc);
276 case TCP_STATE_SYN_SENT:
277 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
278 tcp_connection_cleanup (tc);
280 case TCP_STATE_ESTABLISHED:
281 tcp_connection_timers_reset (tc);
282 /* Set the cleanup timer, in case the session layer/app don't
283 * cleanly close the connection */
284 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
285 stream_session_reset_notify (&tc->connection);
287 case TCP_STATE_CLOSE_WAIT:
288 case TCP_STATE_FIN_WAIT_1:
289 case TCP_STATE_FIN_WAIT_2:
290 case TCP_STATE_CLOSING:
291 tc->state = TCP_STATE_CLOSED;
292 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
293 tcp_connection_timers_reset (tc);
294 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
296 case TCP_STATE_CLOSED:
299 tc->state = TCP_STATE_CLOSED;
303 * Begin connection closing procedure.
305 * If at the end the connection is not in CLOSED state, it is not removed.
306 * Instead, we rely on on TCP to advance through state machine to either
307 * 1) LAST_ACK (passive close) whereby when the last ACK is received
308 * tcp_connection_del is called. This notifies session of the delete and
310 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
311 * and cleanup is called.
313 * N.B. Half-close connections are not supported
316 tcp_connection_close (tcp_connection_t * tc)
318 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
320 /* Send/Program FIN if needed and switch state */
323 case TCP_STATE_SYN_SENT:
324 tc->state = TCP_STATE_CLOSED;
326 case TCP_STATE_SYN_RCVD:
327 tcp_connection_timers_reset (tc);
329 tc->state = TCP_STATE_FIN_WAIT_1;
330 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
332 case TCP_STATE_ESTABLISHED:
333 if (!session_tx_fifo_max_dequeue (&tc->connection))
336 tc->flags |= TCP_CONN_FINPNDG;
337 tc->state = TCP_STATE_FIN_WAIT_1;
339 case TCP_STATE_CLOSE_WAIT:
340 if (!session_tx_fifo_max_dequeue (&tc->connection))
343 tcp_connection_timers_reset (tc);
344 tc->state = TCP_STATE_LAST_ACK;
345 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
348 tc->flags |= TCP_CONN_FINPNDG;
350 case TCP_STATE_FIN_WAIT_1:
351 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
353 case TCP_STATE_CLOSED:
354 tcp_connection_timers_reset (tc);
357 TCP_DBG ("state: %u", tc->state);
360 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
362 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
363 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
364 && tc->state == TCP_STATE_CLOSED)
365 tcp_connection_del (tc);
369 tcp_session_close (u32 conn_index, u32 thread_index)
371 tcp_connection_t *tc;
372 tc = tcp_connection_get (conn_index, thread_index);
373 tcp_connection_close (tc);
377 tcp_session_cleanup (u32 conn_index, u32 thread_index)
379 tcp_connection_t *tc;
380 tc = tcp_connection_get (conn_index, thread_index);
381 tcp_connection_timers_reset (tc);
382 tc->state = TCP_STATE_CLOSED;
383 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
384 tcp_connection_cleanup (tc);
388 * Initialize all connection timers as invalid
391 tcp_connection_timers_init (tcp_connection_t * tc)
395 /* Set all to invalid */
396 for (i = 0; i < TCP_N_TIMERS; i++)
398 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
401 tc->rto = TCP_RTO_INIT;
405 * Stop all connection timers
408 tcp_connection_timers_reset (tcp_connection_t * tc)
411 for (i = 0; i < TCP_N_TIMERS; i++)
413 tcp_timer_reset (tc, i);
418 typedef struct ip4_tcp_hdr
424 typedef struct ip6_tcp_hdr
431 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
434 const dpo_id_t *choice;
438 lb = load_balance_get (dpo->dpoi_index);
442 clib_memset (&hdr, 0, sizeof (hdr));
443 hdr.ip.protocol = IP_PROTOCOL_TCP;
444 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
445 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
446 hdr.tcp.src_port = tc->c_lcl_port;
447 hdr.tcp.dst_port = tc->c_rmt_port;
448 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
453 clib_memset (&hdr, 0, sizeof (hdr));
454 hdr.ip.protocol = IP_PROTOCOL_TCP;
455 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
456 sizeof (ip6_address_t));
457 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
458 sizeof (ip6_address_t));
459 hdr.tcp.src_port = tc->c_lcl_port;
460 hdr.tcp.dst_port = tc->c_rmt_port;
461 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
463 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
464 dpo_copy (result, choice);
468 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
473 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
474 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
475 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
476 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
477 return fib_table_lookup (fib_index, &prefix);
481 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
483 dpo_id_t choice = DPO_INVALID;
484 u32 output_node_index;
487 fe = fib_entry_get (tc->c_rmt_fei);
488 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
491 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
494 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
495 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
499 /** Stack tcp connection on peer's fib entry.
501 * This ultimately populates the dpo the connection will use to send packets.
504 tcp_connection_fib_attach (tcp_connection_t * tc)
506 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
508 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
510 tcp_connection_stack_on_fib_entry (tc);
515 tcp_cc_init (tcp_connection_t * tc)
517 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
518 tc->cc_algo->init (tc);
522 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
523 const tcp_cc_algorithm_t * vft)
525 tcp_main_t *tm = vnet_get_tcp_main ();
526 vec_validate (tm->cc_algos, type);
528 tm->cc_algos[type] = *vft;
532 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
534 tcp_main_t *tm = vnet_get_tcp_main ();
535 return &tm->cc_algos[type];
540 * Initialize connection send variables.
543 tcp_init_snd_vars (tcp_connection_t * tc)
548 * We use the time to randomize iss and for setting up the initial
549 * timestamp. Make sure it's updated otherwise syn and ack in the
550 * handshake may make it look as if time has flown in the opposite
553 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
554 time_now = tcp_time_now ();
556 tc->iss = random_u32 (&time_now);
557 tc->snd_una = tc->iss;
558 tc->snd_nxt = tc->iss + 1;
559 tc->snd_una_max = tc->snd_nxt;
564 tcp_enable_pacing (tcp_connection_t * tc)
566 u32 initial_bucket, byte_rate;
567 initial_bucket = 16 * tc->snd_mss;
569 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
571 tc->mrtt_us = (u32) ~ 0;
574 /** Initialize tcp connection variables
576 * Should be called after having received a msg from the peer, i.e., a SYN or
577 * a SYNACK, such that connection options have already been exchanged. */
579 tcp_connection_init_vars (tcp_connection_t * tc)
581 tcp_connection_timers_init (tc);
583 scoreboard_init (&tc->sack_sb);
585 if (tc->state == TCP_STATE_SYN_RCVD)
586 tcp_init_snd_vars (tc);
588 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
589 tcp_add_del_adjacency (tc, 1);
591 /* tcp_connection_fib_attach (tc); */
593 if (transport_connection_is_tx_paced (&tc->connection)
594 || tcp_main.tx_pacing)
595 tcp_enable_pacing (tc);
599 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
600 u16 * lcl_port, u8 is_ip4)
605 index = tm->last_v4_address_rotor++;
606 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
607 tm->last_v4_address_rotor = 0;
608 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
612 index = tm->last_v6_address_rotor++;
613 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
614 tm->last_v6_address_rotor = 0;
615 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
616 sizeof (ip6_address_t));
618 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
621 clib_warning ("Failed to allocate src port");
629 tcp_session_open (transport_endpoint_cfg_t * rmt)
631 tcp_main_t *tm = vnet_get_tcp_main ();
632 tcp_connection_t *tc;
633 ip46_address_t lcl_addr;
638 * Allocate local endpoint
640 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
641 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
642 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
645 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
646 rmt, &lcl_addr, &lcl_port);
652 * Create connection and send SYN
654 clib_spinlock_lock_if_init (&tm->half_open_lock);
655 tc = tcp_half_open_connection_new ();
656 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
657 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
658 tc->c_rmt_port = rmt->port;
659 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
660 tc->c_is_ip4 = rmt->is_ip4;
661 tc->c_proto = TRANSPORT_PROTO_TCP;
662 tc->c_fib_index = rmt->fib_index;
663 /* The other connection vars will be initialized after SYN ACK */
664 tcp_connection_timers_init (tc);
666 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
667 tc->state = TCP_STATE_SYN_SENT;
668 tcp_init_snd_vars (tc);
670 clib_spinlock_unlock_if_init (&tm->half_open_lock);
672 return tc->c_c_index;
675 const char *tcp_dbg_evt_str[] = {
676 #define _(sym, str) str,
681 const char *tcp_fsm_states[] = {
682 #define _(sym, str) str,
683 foreach_tcp_fsm_state
688 format_tcp_state (u8 * s, va_list * args)
690 u32 state = va_arg (*args, u32);
692 if (state < TCP_N_STATES)
693 s = format (s, "%s", tcp_fsm_states[state]);
695 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
699 const char *tcp_connection_flags_str[] = {
700 #define _(sym, str) str,
701 foreach_tcp_connection_flag
706 format_tcp_connection_flags (u8 * s, va_list * args)
708 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
711 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
712 if (tc->flags & (1 << i))
714 for (i = 0; i < last; i++)
716 if (tc->flags & (1 << i))
717 s = format (s, "%s, ", tcp_connection_flags_str[i]);
720 s = format (s, "%s", tcp_connection_flags_str[last]);
724 const char *tcp_conn_timers[] = {
725 #define _(sym, str) str,
731 format_tcp_timers (u8 * s, va_list * args)
733 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
736 for (i = 0; i < TCP_N_TIMERS; i++)
737 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
740 for (i = 0; i < last; i++)
742 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
743 s = format (s, "%s,", tcp_conn_timers[i]);
747 s = format (s, "%s", tcp_conn_timers[i]);
753 format_tcp_congestion_status (u8 * s, va_list * args)
755 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
756 if (tcp_in_recovery (tc))
757 s = format (s, "recovery");
758 else if (tcp_in_fastrecovery (tc))
759 s = format (s, "fastrecovery");
761 s = format (s, "none");
766 tcp_rcv_wnd_available (tcp_connection_t * tc)
768 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
772 format_tcp_congestion (u8 * s, va_list * args)
774 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
775 u32 indent = format_get_indent (s);
777 s = format (s, "%U ", format_tcp_congestion_status, tc);
778 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
779 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
780 s = format (s, "%Ucc space %u prev_ssthresh %u snd_congestion %u"
781 " dupack %u\n", format_white_space, indent,
782 tcp_available_cc_snd_space (tc), tc->prev_ssthresh,
783 tc->snd_congestion - tc->iss, tc->rcv_dupacks);
784 s = format (s, "%Utsecr %u tsecr_last_ack %u limited_transmit %u\n",
785 format_white_space, indent, tc->rcv_opts.tsecr,
786 tc->tsecr_last_ack, tc->limited_transmit - tc->iss);
791 format_tcp_vars (u8 * s, va_list * args)
793 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
794 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
795 format_tcp_connection_flags, tc, format_tcp_timers, tc);
796 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
797 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
798 tc->snd_una_max - tc->iss);
799 s = format (s, " rcv_nxt %u rcv_las %u\n",
800 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
801 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
802 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
803 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
804 tc->snd_wl2 - tc->iss);
805 s = format (s, " flight size %u out space %u rcv_wnd_av %u\n",
806 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
807 tcp_rcv_wnd_available (tc));
808 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
809 tcp_time_now () - tc->tsval_recent_age);
810 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %x",
811 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
813 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
814 s = format (s, " cong: %U", format_tcp_congestion, tc);
816 if (tc->state >= TCP_STATE_ESTABLISHED)
818 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
821 if (vec_len (tc->snd_sacks))
822 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
828 format_tcp_connection_id (u8 * s, va_list * args)
830 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
835 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
836 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
837 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
838 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
842 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
843 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
844 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
845 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
852 format_tcp_connection (u8 * s, va_list * args)
854 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
855 u32 verbose = va_arg (*args, u32);
859 s = format (s, "%-50U", format_tcp_connection_id, tc);
862 s = format (s, "%-15U", format_tcp_state, tc->state);
864 s = format (s, "\n%U", format_tcp_vars, tc);
871 format_tcp_session (u8 * s, va_list * args)
873 u32 tci = va_arg (*args, u32);
874 u32 thread_index = va_arg (*args, u32);
875 u32 verbose = va_arg (*args, u32);
876 tcp_connection_t *tc;
878 tc = tcp_connection_get (tci, thread_index);
880 s = format (s, "%U", format_tcp_connection, tc, verbose);
882 s = format (s, "empty\n");
887 format_tcp_listener_session (u8 * s, va_list * args)
889 u32 tci = va_arg (*args, u32);
890 tcp_connection_t *tc = tcp_listener_get (tci);
891 return format (s, "%U", format_tcp_connection_id, tc);
895 format_tcp_half_open_session (u8 * s, va_list * args)
897 u32 tci = va_arg (*args, u32);
898 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
899 return format (s, "%U", format_tcp_connection_id, tc);
903 format_tcp_sacks (u8 * s, va_list * args)
905 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
906 sack_block_t *sacks = tc->snd_sacks;
910 len = vec_len (sacks);
911 for (i = 0; i < len - 1; i++)
914 s = format (s, " start %u end %u\n", block->start - tc->irs,
915 block->end - tc->irs);
919 block = &sacks[len - 1];
920 s = format (s, " start %u end %u", block->start - tc->irs,
921 block->end - tc->irs);
927 format_tcp_rcv_sacks (u8 * s, va_list * args)
929 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
930 sack_block_t *sacks = tc->rcv_opts.sacks;
934 len = vec_len (sacks);
935 for (i = 0; i < len - 1; i++)
938 s = format (s, " start %u end %u\n", block->start - tc->iss,
939 block->end - tc->iss);
943 block = &sacks[len - 1];
944 s = format (s, " start %u end %u", block->start - tc->iss,
945 block->end - tc->iss);
951 format_tcp_sack_hole (u8 * s, va_list * args)
953 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
954 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
956 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
958 s = format (s, " [%u, %u]", hole->start, hole->end);
963 format_tcp_scoreboard (u8 * s, va_list * args)
965 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
966 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
967 sack_scoreboard_hole_t *hole;
968 u32 indent = format_get_indent (s);
970 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
971 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
972 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
973 format_white_space, indent, sb->last_bytes_delivered,
974 sb->high_sacked - tc->iss, sb->snd_una_adv);
975 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
976 format_white_space, indent, sb->cur_rxt_hole,
977 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
979 hole = scoreboard_first_hole (sb);
981 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
982 indent, sb->head, sb->tail, pool_elts (sb->holes),
983 format_white_space, indent);
987 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
988 hole = scoreboard_next_hole (sb, hole);
994 static transport_connection_t *
995 tcp_session_get_transport (u32 conn_index, u32 thread_index)
997 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
998 return &tc->connection;
1001 static transport_connection_t *
1002 tcp_half_open_session_get_transport (u32 conn_index)
1004 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1005 return &tc->connection;
1009 * Compute maximum segment size for session layer.
1011 * Since the result needs to be the actual data length, it first computes
1012 * the tcp options to be used in the next burst and subtracts their
1013 * length from the connection's snd_mss.
1016 tcp_session_send_mss (transport_connection_t * trans_conn)
1018 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1020 /* Ensure snd_mss does accurately reflect the amount of data we can push
1021 * in a segment. This also makes sure that options are updated according to
1022 * the current state of the connection. */
1023 tcp_update_burst_snd_vars (tc);
1029 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1031 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1033 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1036 /* If not snd_wnd constrained and we can't write at least a segment,
1037 * don't try at all */
1038 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1039 return snd_space < tc->cwnd ? 0 : snd_space;
1041 /* round down to mss multiple */
1042 return snd_space - (snd_space % tc->snd_mss);
1046 * Compute tx window session is allowed to fill.
1048 * Takes into account available send space, snd_mss and the congestion
1049 * state of the connection. If possible, the value returned is a multiple
1052 * @param tc tcp connection
1053 * @return number of bytes session is allowed to write
1056 tcp_snd_space_inline (tcp_connection_t * tc)
1058 int snd_space, snt_limited;
1060 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1061 || tc->state == TCP_STATE_CLOSED))
1064 snd_space = tcp_available_output_snd_space (tc);
1066 /* If we haven't gotten dupacks or if we did and have gotten sacked
1067 * bytes then we can still send as per Limited Transmit (RFC3042) */
1068 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1069 && (tcp_opts_sack_permitted (tc)
1070 && tc->sack_sb.last_sacked_bytes == 0)))
1072 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1073 tc->limited_transmit = tc->snd_nxt;
1074 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1076 snt_limited = tc->snd_nxt - tc->limited_transmit;
1077 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1079 return tcp_round_snd_space (tc, snd_space);
1083 tcp_snd_space (tcp_connection_t * tc)
1085 return tcp_snd_space_inline (tc);
1089 tcp_session_send_space (transport_connection_t * trans_conn)
1091 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1092 return clib_min (tcp_snd_space_inline (tc),
1093 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1097 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1099 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1101 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1103 /* This still works if fast retransmit is on */
1104 return (tc->snd_nxt - tc->snd_una);
1108 tcp_update_time (f64 now, u8 thread_index)
1110 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1112 tcp_set_time_now (wrk);
1113 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1114 tcp_do_fastretransmits (wrk);
1115 tcp_send_acks (wrk);
1116 tcp_flush_frames_to_output (wrk);
1120 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1122 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1123 return tcp_push_header (tc, b);
1127 tcp_session_flush_data (transport_connection_t * tconn)
1129 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1130 if (tc->flags & TCP_CONN_PSH_PENDING)
1132 tc->flags |= TCP_CONN_PSH_PENDING;
1133 tc->psh_seq = tc->snd_una_max + transport_max_tx_dequeue (tconn) - 1;
1137 const static transport_proto_vft_t tcp_proto = {
1138 .enable = vnet_tcp_enable_disable,
1139 .bind = tcp_session_bind,
1140 .unbind = tcp_session_unbind,
1141 .push_header = tcp_session_push_header,
1142 .get_connection = tcp_session_get_transport,
1143 .get_listener = tcp_session_get_listener,
1144 .get_half_open = tcp_half_open_session_get_transport,
1145 .open = tcp_session_open,
1146 .close = tcp_session_close,
1147 .cleanup = tcp_session_cleanup,
1148 .send_mss = tcp_session_send_mss,
1149 .send_space = tcp_session_send_space,
1150 .update_time = tcp_update_time,
1151 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1152 .flush_data = tcp_session_flush_data,
1153 .format_connection = format_tcp_session,
1154 .format_listener = format_tcp_listener_session,
1155 .format_half_open = format_tcp_half_open_session,
1156 .tx_type = TRANSPORT_TX_PEEK,
1157 .service_type = TRANSPORT_SERVICE_VC,
1162 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1167 if (!transport_connection_is_tx_paced (&tc->connection))
1170 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1171 /* TODO should constrain to interface's max throughput but
1172 * we don't have link speeds for sw ifs ..*/
1173 rate = tc->cwnd / srtt;
1174 transport_connection_tx_pacer_update (&tc->connection, rate);
1178 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1181 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1182 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1183 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1184 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1185 start_bucket, last_time);
1189 tcp_timer_keep_handler (u32 conn_index)
1191 u32 thread_index = vlib_get_thread_index ();
1192 tcp_connection_t *tc;
1194 tc = tcp_connection_get (conn_index, thread_index);
1195 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1197 tcp_connection_close (tc);
1201 tcp_timer_establish_handler (u32 conn_index)
1203 tcp_connection_t *tc;
1205 tc = tcp_half_open_connection_get (conn_index);
1208 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1209 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1210 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1214 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1215 /* note: the connection may have already disappeared */
1216 if (PREDICT_FALSE (tc == 0))
1218 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1219 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1220 /* Start cleanup. App wasn't notified yet so use delete notify as
1221 * opposed to delete to cleanup session layer state. */
1222 stream_session_delete_notify (&tc->connection);
1224 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1225 tcp_connection_cleanup (tc);
1229 tcp_timer_waitclose_handler (u32 conn_index)
1231 u32 thread_index = vlib_get_thread_index ();
1232 tcp_connection_t *tc;
1234 tc = tcp_connection_get (conn_index, thread_index);
1237 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1239 /* Session didn't come back with a close(). Send FIN either way
1240 * and switch to LAST_ACK. */
1241 if (tc->state == TCP_STATE_CLOSE_WAIT)
1243 if (tc->flags & TCP_CONN_FINSNT)
1245 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1248 /* Make sure we don't try to send unsent data */
1249 tcp_connection_timers_reset (tc);
1250 tcp_cong_recovery_off (tc);
1251 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1253 tc->state = TCP_STATE_LAST_ACK;
1255 /* Make sure we don't wait in LAST ACK forever */
1256 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1258 /* Don't delete the connection yet */
1262 tcp_connection_del (tc);
1266 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1268 tcp_timer_retransmit_handler,
1269 tcp_timer_delack_handler,
1270 tcp_timer_persist_handler,
1271 tcp_timer_keep_handler,
1272 tcp_timer_waitclose_handler,
1273 tcp_timer_retransmit_syn_handler,
1274 tcp_timer_establish_handler
1279 tcp_expired_timers_dispatch (u32 * expired_timers)
1282 u32 connection_index, timer_id;
1284 for (i = 0; i < vec_len (expired_timers); i++)
1286 /* Get session index and timer id */
1287 connection_index = expired_timers[i] & 0x0FFFFFFF;
1288 timer_id = expired_timers[i] >> 28;
1290 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1292 /* Handle expiration */
1293 (*timer_expiration_handlers[timer_id]) (connection_index);
1298 tcp_initialize_timer_wheels (tcp_main_t * tm)
1300 tw_timer_wheel_16t_2w_512sl_t *tw;
1302 foreach_vlib_main (({
1303 tw = &tm->wrk_ctx[ii].timer_wheel;
1304 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1305 100e-3 /* timer period 100ms */ , ~0);
1306 tw->last_run_time = vlib_time_now (this_vlib_main);
1311 static clib_error_t *
1312 tcp_main_enable (vlib_main_t * vm)
1314 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1315 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1316 tcp_connection_t *tc __attribute__ ((unused));
1317 tcp_main_t *tm = vnet_get_tcp_main ();
1318 clib_error_t *error = 0;
1321 if ((error = vlib_call_init_function (vm, ip_main_init)))
1323 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1325 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1332 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1333 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1336 * Initialize data structures
1339 num_threads = 1 /* main thread */ + vtm->n_threads;
1340 vec_validate (tm->connections, num_threads - 1);
1341 vec_validate (tm->wrk_ctx, num_threads - 1);
1342 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1343 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1345 for (thread = 0; thread < num_threads; thread++)
1347 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1348 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1349 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1350 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1351 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1352 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1353 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1354 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1355 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1356 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1357 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1358 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1359 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1362 * Preallocate connections. Assume that thread 0 won't
1363 * use preallocated threads when running multi-core
1365 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1366 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1370 * Use a preallocated half-open connection pool?
1372 if (tm->preallocated_half_open_connections)
1373 pool_init_fixed (tm->half_open_connections,
1374 tm->preallocated_half_open_connections);
1376 /* Initialize clocks per tick for TCP timestamp. Used to compute
1377 * monotonically increasing timestamps. */
1378 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1379 / TCP_TSTAMP_RESOLUTION;
1381 if (num_threads > 1)
1383 clib_spinlock_init (&tm->half_open_lock);
1386 tcp_initialize_timer_wheels (tm);
1388 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1389 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1395 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1399 if (tcp_main.is_enabled)
1402 return tcp_main_enable (vm);
1406 tcp_main.is_enabled = 0;
1413 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1415 tcp_main_t *tm = &tcp_main;
1417 tm->punt_unknown4 = is_add;
1419 tm->punt_unknown6 = is_add;
1422 static clib_error_t *
1423 tcp_init (vlib_main_t * vm)
1425 tcp_main_t *tm = vnet_get_tcp_main ();
1426 ip_main_t *im = &ip_main;
1427 ip_protocol_info_t *pi;
1429 /* Session layer, and by implication tcp, are disabled by default */
1432 /* Register with IP for header parsing */
1433 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1435 return clib_error_return (0, "TCP protocol info AWOL");
1436 pi->format_header = format_tcp_header;
1437 pi->unformat_pg_edit = unformat_pg_tcp_header;
1439 /* Register as transport with session layer */
1440 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1441 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1442 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1443 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1445 tcp_api_reference ();
1447 tm->cc_algo = TCP_CC_NEWRENO;
1451 VLIB_INIT_FUNCTION (tcp_init);
1454 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1456 uword *result = va_arg (*va, uword *);
1458 if (unformat (input, "newreno"))
1459 *result = TCP_CC_NEWRENO;
1460 else if (unformat (input, "cubic"))
1461 *result = TCP_CC_CUBIC;
1469 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1471 tcp_main_t *tm = vnet_get_tcp_main ();
1472 tcp_cc_algorithm_t *cc_alg;
1473 unformat_input_t sub_input;
1476 vec_foreach (cc_alg, tm->cc_algos)
1478 if (!unformat (input, cc_alg->name))
1481 if (cc_alg->unformat_cfg
1482 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1484 if (cc_alg->unformat_cfg (&sub_input))
1491 static clib_error_t *
1492 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1494 tcp_main_t *tm = vnet_get_tcp_main ();
1496 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1498 if (unformat (input, "preallocated-connections %d",
1499 &tm->preallocated_connections))
1501 else if (unformat (input, "preallocated-half-open-connections %d",
1502 &tm->preallocated_half_open_connections))
1504 else if (unformat (input, "buffer-fail-fraction %f",
1505 &tm->buffer_fail_fraction))
1507 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1510 else if (unformat (input, "no-tx-pacing"))
1512 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1515 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1518 return clib_error_return (0, "unknown input `%U'",
1519 format_unformat_error, input);
1524 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1528 * \brief Configure an ipv4 source address range
1529 * @param vm vlib_main_t pointer
1530 * @param start first ipv4 address in the source address range
1531 * @param end last ipv4 address in the source address range
1532 * @param table_id VRF / table ID, 0 for the default FIB
1533 * @return 0 if all OK, else an error indication from api_errno.h
1537 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1538 ip4_address_t * start,
1539 ip4_address_t * end, u32 table_id)
1541 tcp_main_t *tm = vnet_get_tcp_main ();
1542 vnet_main_t *vnm = vnet_get_main ();
1543 u32 start_host_byte_order, end_host_byte_order;
1544 fib_prefix_t prefix;
1545 vnet_sw_interface_t *si;
1546 fib_node_index_t fei;
1550 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1551 ip4_address_t * hi_addr, u32 fib_index,
1554 clib_memset (&prefix, 0, sizeof (prefix));
1556 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1558 if (fib_index == ~0)
1559 return VNET_API_ERROR_NO_SUCH_FIB;
1561 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1562 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1564 /* sanity check for reversed args or some such */
1565 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1566 return VNET_API_ERROR_INVALID_ARGUMENT;
1568 /* Lookup the last address, to identify the interface involved */
1570 prefix.fp_proto = FIB_PROTOCOL_IP4;
1571 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1573 fei = fib_table_lookup (fib_index, &prefix);
1575 /* Couldn't find route to destination. Bail out. */
1576 if (fei == FIB_NODE_INDEX_INVALID)
1577 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1579 sw_if_index = fib_entry_get_resolving_interface (fei);
1581 /* Enable proxy arp on the interface */
1582 si = vnet_get_sw_interface (vnm, sw_if_index);
1583 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1585 /* Configure proxy arp across the range */
1586 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1593 dpo_id_t dpo = DPO_INVALID;
1595 vec_add1 (tm->ip4_src_addresses, start[0]);
1597 /* Add local adjacencies for the range */
1599 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1602 prefix.fp_proto = FIB_PROTOCOL_IP4;
1603 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1605 fib_table_entry_special_dpo_update (fib_index,
1608 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1611 start_host_byte_order++;
1612 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1614 while (start_host_byte_order <= end_host_byte_order);
1620 * \brief Configure an ipv6 source address range
1621 * @param vm vlib_main_t pointer
1622 * @param start first ipv6 address in the source address range
1623 * @param end last ipv6 address in the source address range
1624 * @param table_id VRF / table ID, 0 for the default FIB
1625 * @return 0 if all OK, else an error indication from api_errno.h
1629 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1630 ip6_address_t * start,
1631 ip6_address_t * end, u32 table_id)
1633 tcp_main_t *tm = vnet_get_tcp_main ();
1634 fib_prefix_t prefix;
1636 fib_node_index_t fei;
1639 clib_memset (&prefix, 0, sizeof (prefix));
1641 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1643 if (fib_index == ~0)
1644 return VNET_API_ERROR_NO_SUCH_FIB;
1650 dpo_id_t dpo = DPO_INVALID;
1652 /* Remember this address */
1653 vec_add1 (tm->ip6_src_addresses, start[0]);
1655 /* Lookup the prefix, to identify the interface involved */
1656 prefix.fp_len = 128;
1657 prefix.fp_proto = FIB_PROTOCOL_IP6;
1658 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1660 fei = fib_table_lookup (fib_index, &prefix);
1662 /* Couldn't find route to destination. Bail out. */
1663 if (fei == FIB_NODE_INDEX_INVALID)
1664 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1666 sw_if_index = fib_entry_get_resolving_interface (fei);
1668 if (sw_if_index == (u32) ~ 0)
1669 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1671 /* Add a proxy neighbor discovery entry for this address */
1672 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1674 /* Add a receive adjacency for this address */
1675 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1678 fib_table_entry_special_dpo_update (fib_index,
1681 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1684 /* Done with the entire range? */
1685 if (!memcmp (start, end, sizeof (start[0])))
1688 /* Increment the address. DGMS. */
1690 for (i = 15; i >= 0; i--)
1693 if (tmp.as_u8[i] != 0)
1701 static clib_error_t *
1702 tcp_src_address (vlib_main_t * vm,
1703 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1705 ip4_address_t v4start, v4end;
1706 ip6_address_t v6start, v6end;
1712 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1714 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1715 unformat_ip4_address, &v4end))
1717 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1719 memcpy (&v4end, &v4start, sizeof (v4start));
1722 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1723 unformat_ip6_address, &v6end))
1725 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1727 memcpy (&v6end, &v6start, sizeof (v6start));
1730 else if (unformat (input, "fib-table %d", &table_id))
1736 if (!v4set && !v6set)
1737 return clib_error_return (0, "at least one v4 or v6 address required");
1741 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1748 case VNET_API_ERROR_NO_SUCH_FIB:
1749 return clib_error_return (0, "Invalid table-id %d", table_id);
1751 case VNET_API_ERROR_INVALID_ARGUMENT:
1752 return clib_error_return (0, "Invalid address range %U - %U",
1753 format_ip4_address, &v4start,
1754 format_ip4_address, &v4end);
1756 return clib_error_return (0, "error %d", rv);
1762 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1769 case VNET_API_ERROR_NO_SUCH_FIB:
1770 return clib_error_return (0, "Invalid table-id %d", table_id);
1773 return clib_error_return (0, "error %d", rv);
1781 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1783 .path = "tcp src-address",
1784 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1785 .function = tcp_src_address,
1790 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1792 #if TCP_SCOREBOARD_TRACE
1794 scoreboard_trace_elt_t *block;
1800 s = format (s, "scoreboard trace:");
1801 vec_foreach (block, sb->trace)
1803 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1804 block->ack, block->snd_una_max, block->group);
1806 s = format (s, "\n");
1814 static clib_error_t *
1815 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1816 vlib_cli_command_t * cmd_arg)
1818 transport_connection_t *tconn = 0;
1819 tcp_connection_t *tc;
1821 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1823 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1824 TRANSPORT_PROTO_TCP))
1827 return clib_error_return (0, "unknown input `%U'",
1828 format_unformat_error, input);
1831 if (!TCP_SCOREBOARD_TRACE)
1833 vlib_cli_output (vm, "scoreboard tracing not enabled");
1837 tc = tcp_get_connection_from_transport (tconn);
1838 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1839 vlib_cli_output (vm, "%v", s);
1844 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1846 .path = "show tcp scoreboard trace",
1847 .short_help = "show tcp scoreboard trace <connection>",
1848 .function = tcp_show_scoreboard_trace_fn,
1853 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1856 scoreboard_trace_elt_t *trace;
1857 u32 next_ack, left, group, has_new_ack = 0;
1858 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1859 sack_block_t *block;
1861 if (!TCP_SCOREBOARD_TRACE)
1863 s = format (s, "scoreboard tracing not enabled");
1870 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1871 tcp_connection_timers_init (dummy_tc);
1872 scoreboard_init (&dummy_tc->sack_sb);
1873 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1875 #if TCP_SCOREBOARD_TRACE
1876 trace = tc->sack_sb.trace;
1877 trace_len = vec_len (tc->sack_sb.trace);
1880 for (i = 0; i < trace_len; i++)
1882 if (trace[i].ack != 0)
1884 dummy_tc->snd_una = trace[i].ack - 1448;
1885 dummy_tc->snd_una_max = trace[i].ack;
1890 while (left < trace_len)
1892 group = trace[left].group;
1893 vec_reset_length (dummy_tc->rcv_opts.sacks);
1895 while (trace[left].group == group)
1897 if (trace[left].ack != 0)
1900 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1901 trace[left].ack, trace[left].snd_una_max);
1902 dummy_tc->snd_una_max = trace[left].snd_una_max;
1903 next_ack = trace[left].ack;
1909 s = format (s, "[%u, %u], ", trace[left].start,
1911 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1912 block->start = trace[left].start;
1913 block->end = trace[left].end;
1919 tcp_rcv_sacks (dummy_tc, next_ack);
1921 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1924 s = format (s, "result: %U", format_tcp_scoreboard,
1925 &dummy_tc->sack_sb);
1928 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1933 static clib_error_t *
1934 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1935 vlib_cli_command_t * cmd_arg)
1937 transport_connection_t *tconn = 0;
1938 tcp_connection_t *tc = 0;
1940 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1942 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1943 TRANSPORT_PROTO_TCP))
1946 return clib_error_return (0, "unknown input `%U'",
1947 format_unformat_error, input);
1950 if (!TCP_SCOREBOARD_TRACE)
1952 vlib_cli_output (vm, "scoreboard tracing not enabled");
1956 tc = tcp_get_connection_from_transport (tconn);
1959 vlib_cli_output (vm, "connection not found");
1962 str = tcp_scoreboard_replay (str, tc, 1);
1963 vlib_cli_output (vm, "%v", str);
1968 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1970 .path = "tcp replay scoreboard",
1971 .short_help = "tcp replay scoreboard <connection>",
1972 .function = tcp_scoreboard_trace_fn,
1976 static clib_error_t *
1977 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1978 vlib_cli_command_t * cmd_arg)
1980 tcp_main_t *tm = vnet_get_tcp_main ();
1981 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1982 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1984 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1985 tm->punt_unknown4 ? "enabled" : "disabled");
1986 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1987 tm->punt_unknown6 ? "enabled" : "disabled");
1991 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1993 .path = "show tcp punt",
1994 .short_help = "show tcp punt",
1995 .function = show_tcp_punt_fn,
2000 * fd.io coding-style-patch-verification: ON
2003 * eval: (c-set-style "gnu")