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:
302 * Begin connection closing procedure.
304 * If at the end the connection is not in CLOSED state, it is not removed.
305 * Instead, we rely on on TCP to advance through state machine to either
306 * 1) LAST_ACK (passive close) whereby when the last ACK is received
307 * tcp_connection_del is called. This notifies session of the delete and
309 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
310 * and cleanup is called.
312 * N.B. Half-close connections are not supported
315 tcp_connection_close (tcp_connection_t * tc)
317 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
319 /* Send/Program FIN if needed and switch state */
322 case TCP_STATE_SYN_SENT:
323 tc->state = TCP_STATE_CLOSED;
325 case TCP_STATE_SYN_RCVD:
326 tcp_connection_timers_reset (tc);
328 tc->state = TCP_STATE_FIN_WAIT_1;
329 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
331 case TCP_STATE_ESTABLISHED:
332 if (!session_tx_fifo_max_dequeue (&tc->connection))
335 tc->flags |= TCP_CONN_FINPNDG;
336 tc->state = TCP_STATE_FIN_WAIT_1;
338 case TCP_STATE_CLOSE_WAIT:
339 if (!session_tx_fifo_max_dequeue (&tc->connection))
342 tcp_connection_timers_reset (tc);
343 tc->state = TCP_STATE_LAST_ACK;
344 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
347 tc->flags |= TCP_CONN_FINPNDG;
349 case TCP_STATE_FIN_WAIT_1:
350 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
353 TCP_DBG ("state: %u", tc->state);
356 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
358 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
359 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
360 && tc->state == TCP_STATE_CLOSED)
361 tcp_connection_del (tc);
365 tcp_session_close (u32 conn_index, u32 thread_index)
367 tcp_connection_t *tc;
368 tc = tcp_connection_get (conn_index, thread_index);
369 tcp_connection_close (tc);
373 tcp_session_cleanup (u32 conn_index, u32 thread_index)
375 tcp_connection_t *tc;
376 tc = tcp_connection_get (conn_index, thread_index);
377 tcp_connection_timers_reset (tc);
378 tc->state = TCP_STATE_CLOSED;
379 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
380 tcp_connection_cleanup (tc);
384 * Initialize all connection timers as invalid
387 tcp_connection_timers_init (tcp_connection_t * tc)
391 /* Set all to invalid */
392 for (i = 0; i < TCP_N_TIMERS; i++)
394 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
397 tc->rto = TCP_RTO_INIT;
401 * Stop all connection timers
404 tcp_connection_timers_reset (tcp_connection_t * tc)
407 for (i = 0; i < TCP_N_TIMERS; i++)
409 tcp_timer_reset (tc, i);
414 typedef struct ip4_tcp_hdr
420 typedef struct ip6_tcp_hdr
427 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
430 const dpo_id_t *choice;
434 lb = load_balance_get (dpo->dpoi_index);
438 clib_memset (&hdr, 0, sizeof (hdr));
439 hdr.ip.protocol = IP_PROTOCOL_TCP;
440 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
441 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
442 hdr.tcp.src_port = tc->c_lcl_port;
443 hdr.tcp.dst_port = tc->c_rmt_port;
444 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
449 clib_memset (&hdr, 0, sizeof (hdr));
450 hdr.ip.protocol = IP_PROTOCOL_TCP;
451 clib_memcpy (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
452 sizeof (ip6_address_t));
453 clib_memcpy (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
454 sizeof (ip6_address_t));
455 hdr.tcp.src_port = tc->c_lcl_port;
456 hdr.tcp.dst_port = tc->c_rmt_port;
457 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
459 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
460 dpo_copy (result, choice);
464 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
469 clib_memcpy (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
470 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
471 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
472 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
473 return fib_table_lookup (fib_index, &prefix);
477 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
479 dpo_id_t choice = DPO_INVALID;
480 u32 output_node_index;
483 fe = fib_entry_get (tc->c_rmt_fei);
484 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
487 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
490 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
491 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
495 /** Stack tcp connection on peer's fib entry.
497 * This ultimately populates the dpo the connection will use to send packets.
500 tcp_connection_fib_attach (tcp_connection_t * tc)
502 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
504 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
506 tcp_connection_stack_on_fib_entry (tc);
511 tcp_cc_init (tcp_connection_t * tc)
513 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
514 tc->cc_algo->init (tc);
518 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
519 const tcp_cc_algorithm_t * vft)
521 tcp_main_t *tm = vnet_get_tcp_main ();
522 vec_validate (tm->cc_algos, type);
524 tm->cc_algos[type] = *vft;
528 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
530 tcp_main_t *tm = vnet_get_tcp_main ();
531 return &tm->cc_algos[type];
536 * Initialize connection send variables.
539 tcp_init_snd_vars (tcp_connection_t * tc)
544 * We use the time to randomize iss and for setting up the initial
545 * timestamp. Make sure it's updated otherwise syn and ack in the
546 * handshake may make it look as if time has flown in the opposite
549 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
550 time_now = tcp_time_now ();
552 tc->iss = random_u32 (&time_now);
553 tc->snd_una = tc->iss;
554 tc->snd_nxt = tc->iss + 1;
555 tc->snd_una_max = tc->snd_nxt;
559 tcp_enable_pacing (tcp_connection_t * tc)
561 u32 initial_bucket, byte_rate;
562 initial_bucket = 16 * tc->snd_mss;
564 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
566 tc->mrtt_us = (u32) ~ 0;
569 /** Initialize tcp connection variables
571 * Should be called after having received a msg from the peer, i.e., a SYN or
572 * a SYNACK, such that connection options have already been exchanged. */
574 tcp_connection_init_vars (tcp_connection_t * tc)
576 tcp_connection_timers_init (tc);
578 scoreboard_init (&tc->sack_sb);
580 if (tc->state == TCP_STATE_SYN_RCVD)
581 tcp_init_snd_vars (tc);
583 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
584 tcp_add_del_adjacency (tc, 1);
586 /* tcp_connection_fib_attach (tc); */
588 if (transport_connection_is_tx_paced (&tc->connection)
589 || tcp_main.tx_pacing)
590 tcp_enable_pacing (tc);
594 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
595 u16 * lcl_port, u8 is_ip4)
600 index = tm->last_v4_address_rotor++;
601 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
602 tm->last_v4_address_rotor = 0;
603 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
607 index = tm->last_v6_address_rotor++;
608 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
609 tm->last_v6_address_rotor = 0;
610 clib_memcpy (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
611 sizeof (ip6_address_t));
613 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
616 clib_warning ("Failed to allocate src port");
624 tcp_session_open (transport_endpoint_cfg_t * rmt)
626 tcp_main_t *tm = vnet_get_tcp_main ();
627 tcp_connection_t *tc;
628 ip46_address_t lcl_addr;
633 * Allocate local endpoint
635 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
636 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
637 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
640 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
641 rmt, &lcl_addr, &lcl_port);
647 * Create connection and send SYN
649 clib_spinlock_lock_if_init (&tm->half_open_lock);
650 tc = tcp_half_open_connection_new ();
651 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
652 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
653 tc->c_rmt_port = rmt->port;
654 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
655 tc->c_is_ip4 = rmt->is_ip4;
656 tc->c_proto = TRANSPORT_PROTO_TCP;
657 tc->c_fib_index = rmt->fib_index;
658 /* The other connection vars will be initialized after SYN ACK */
659 tcp_connection_timers_init (tc);
661 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
662 tc->state = TCP_STATE_SYN_SENT;
663 tcp_init_snd_vars (tc);
665 clib_spinlock_unlock_if_init (&tm->half_open_lock);
667 return tc->c_c_index;
670 const char *tcp_dbg_evt_str[] = {
671 #define _(sym, str) str,
676 const char *tcp_fsm_states[] = {
677 #define _(sym, str) str,
678 foreach_tcp_fsm_state
683 format_tcp_state (u8 * s, va_list * args)
685 u32 state = va_arg (*args, u32);
687 if (state < TCP_N_STATES)
688 s = format (s, "%s", tcp_fsm_states[state]);
690 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
694 const char *tcp_connection_flags_str[] = {
695 #define _(sym, str) str,
696 foreach_tcp_connection_flag
701 format_tcp_connection_flags (u8 * s, va_list * args)
703 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
706 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
707 if (tc->flags & (1 << i))
709 for (i = 0; i < last; i++)
711 if (tc->flags & (1 << i))
712 s = format (s, "%s, ", tcp_connection_flags_str[i]);
715 s = format (s, "%s", tcp_connection_flags_str[last]);
719 const char *tcp_conn_timers[] = {
720 #define _(sym, str) str,
726 format_tcp_timers (u8 * s, va_list * args)
728 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
731 for (i = 0; i < TCP_N_TIMERS; i++)
732 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
735 for (i = 0; i < last; i++)
737 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
738 s = format (s, "%s,", tcp_conn_timers[i]);
742 s = format (s, "%s", tcp_conn_timers[i]);
748 format_tcp_congestion_status (u8 * s, va_list * args)
750 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
751 if (tcp_in_recovery (tc))
752 s = format (s, "recovery");
753 else if (tcp_in_fastrecovery (tc))
754 s = format (s, "fastrecovery");
756 s = format (s, "none");
761 tcp_rcv_wnd_available (tcp_connection_t * tc)
763 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
767 format_tcp_congestion (u8 * s, va_list * args)
769 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
770 u32 indent = format_get_indent (s);
772 s = format (s, "%U ", format_tcp_congestion_status, tc);
773 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
774 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
775 s = format (s, "%Ucc space %u prev_ssthresh %u snd_congestion %u"
776 " dupack %u\n", format_white_space, indent,
777 tcp_available_cc_snd_space (tc), tc->prev_ssthresh,
778 tc->snd_congestion - tc->iss, tc->rcv_dupacks);
779 s = format (s, "%Utsecr %u tsecr_last_ack %u limited_transmit %u\n",
780 format_white_space, indent, tc->rcv_opts.tsecr,
781 tc->tsecr_last_ack, tc->limited_transmit - tc->iss);
786 format_tcp_vars (u8 * s, va_list * args)
788 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
789 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
790 format_tcp_connection_flags, tc, format_tcp_timers, tc);
791 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
792 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
793 tc->snd_una_max - tc->iss);
794 s = format (s, " rcv_nxt %u rcv_las %u\n",
795 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
796 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
797 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
798 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
799 tc->snd_wl2 - tc->iss);
800 s = format (s, " flight size %u out space %u rcv_wnd_av %u\n",
801 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
802 tcp_rcv_wnd_available (tc));
803 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
804 tcp_time_now () - tc->tsval_recent_age);
805 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %x",
806 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
808 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
809 s = format (s, " cong: %U", format_tcp_congestion, tc);
811 if (tc->state >= TCP_STATE_ESTABLISHED)
813 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
816 if (vec_len (tc->snd_sacks))
817 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
823 format_tcp_connection_id (u8 * s, va_list * args)
825 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
830 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
831 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
832 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
833 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
837 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
838 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
839 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
840 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
847 format_tcp_connection (u8 * s, va_list * args)
849 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
850 u32 verbose = va_arg (*args, u32);
854 s = format (s, "%-50U", format_tcp_connection_id, tc);
857 s = format (s, "%-15U", format_tcp_state, tc->state);
859 s = format (s, "\n%U", format_tcp_vars, tc);
866 format_tcp_session (u8 * s, va_list * args)
868 u32 tci = va_arg (*args, u32);
869 u32 thread_index = va_arg (*args, u32);
870 u32 verbose = va_arg (*args, u32);
871 tcp_connection_t *tc;
873 tc = tcp_connection_get (tci, thread_index);
875 s = format (s, "%U", format_tcp_connection, tc, verbose);
877 s = format (s, "empty\n");
882 format_tcp_listener_session (u8 * s, va_list * args)
884 u32 tci = va_arg (*args, u32);
885 tcp_connection_t *tc = tcp_listener_get (tci);
886 return format (s, "%U", format_tcp_connection_id, tc);
890 format_tcp_half_open_session (u8 * s, va_list * args)
892 u32 tci = va_arg (*args, u32);
893 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
894 return format (s, "%U", format_tcp_connection_id, tc);
898 format_tcp_sacks (u8 * s, va_list * args)
900 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
901 sack_block_t *sacks = tc->snd_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->irs,
910 block->end - tc->irs);
914 block = &sacks[len - 1];
915 s = format (s, " start %u end %u", block->start - tc->irs,
916 block->end - tc->irs);
922 format_tcp_rcv_sacks (u8 * s, va_list * args)
924 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
925 sack_block_t *sacks = tc->rcv_opts.sacks;
929 len = vec_len (sacks);
930 for (i = 0; i < len - 1; i++)
933 s = format (s, " start %u end %u\n", block->start - tc->iss,
934 block->end - tc->iss);
938 block = &sacks[len - 1];
939 s = format (s, " start %u end %u", block->start - tc->iss,
940 block->end - tc->iss);
946 format_tcp_sack_hole (u8 * s, va_list * args)
948 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
949 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
951 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
953 s = format (s, " [%u, %u]", hole->start, hole->end);
958 format_tcp_scoreboard (u8 * s, va_list * args)
960 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
961 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
962 sack_scoreboard_hole_t *hole;
963 u32 indent = format_get_indent (s);
965 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
966 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
967 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
968 format_white_space, indent, sb->last_bytes_delivered,
969 sb->high_sacked - tc->iss, sb->snd_una_adv);
970 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
971 format_white_space, indent, sb->cur_rxt_hole,
972 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
974 hole = scoreboard_first_hole (sb);
976 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
977 indent, sb->head, sb->tail, pool_elts (sb->holes),
978 format_white_space, indent);
982 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
983 hole = scoreboard_next_hole (sb, hole);
989 static transport_connection_t *
990 tcp_session_get_transport (u32 conn_index, u32 thread_index)
992 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
993 return &tc->connection;
996 static transport_connection_t *
997 tcp_half_open_session_get_transport (u32 conn_index)
999 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1000 return &tc->connection;
1004 * Compute maximum segment size for session layer.
1006 * Since the result needs to be the actual data length, it first computes
1007 * the tcp options to be used in the next burst and subtracts their
1008 * length from the connection's snd_mss.
1011 tcp_session_send_mss (transport_connection_t * trans_conn)
1013 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1015 /* Ensure snd_mss does accurately reflect the amount of data we can push
1016 * in a segment. This also makes sure that options are updated according to
1017 * the current state of the connection. */
1018 tcp_update_burst_snd_vars (tc);
1024 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1026 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1028 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1031 /* If not snd_wnd constrained and we can't write at least a segment,
1032 * don't try at all */
1033 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1034 return snd_space < tc->cwnd ? 0 : snd_space;
1036 /* round down to mss multiple */
1037 return snd_space - (snd_space % tc->snd_mss);
1041 * Compute tx window session is allowed to fill.
1043 * Takes into account available send space, snd_mss and the congestion
1044 * state of the connection. If possible, the value returned is a multiple
1047 * @param tc tcp connection
1048 * @return number of bytes session is allowed to write
1051 tcp_snd_space_inline (tcp_connection_t * tc)
1053 int snd_space, snt_limited;
1055 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)))
1058 snd_space = tcp_available_output_snd_space (tc);
1060 /* If we haven't gotten dupacks or if we did and have gotten sacked
1061 * bytes then we can still send as per Limited Transmit (RFC3042) */
1062 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1063 && (tcp_opts_sack_permitted (tc)
1064 && tc->sack_sb.last_sacked_bytes == 0)))
1066 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1067 tc->limited_transmit = tc->snd_nxt;
1068 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1070 snt_limited = tc->snd_nxt - tc->limited_transmit;
1071 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1073 return tcp_round_snd_space (tc, snd_space);
1077 tcp_snd_space (tcp_connection_t * tc)
1079 return tcp_snd_space_inline (tc);
1083 tcp_session_send_space (transport_connection_t * trans_conn)
1085 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1086 return clib_min (tcp_snd_space_inline (tc),
1087 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1091 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1093 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1095 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1097 /* This still works if fast retransmit is on */
1098 return (tc->snd_nxt - tc->snd_una);
1102 tcp_update_time (f64 now, u8 thread_index)
1104 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1106 tcp_set_time_now (wrk);
1107 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1108 tcp_do_fastretransmits (wrk);
1109 tcp_send_acks (wrk);
1110 tcp_flush_frames_to_output (wrk);
1114 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1116 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1117 return tcp_push_header (tc, b);
1121 const static transport_proto_vft_t tcp_proto = {
1122 .enable = vnet_tcp_enable_disable,
1123 .bind = tcp_session_bind,
1124 .unbind = tcp_session_unbind,
1125 .push_header = tcp_session_push_header,
1126 .get_connection = tcp_session_get_transport,
1127 .get_listener = tcp_session_get_listener,
1128 .get_half_open = tcp_half_open_session_get_transport,
1129 .open = tcp_session_open,
1130 .close = tcp_session_close,
1131 .cleanup = tcp_session_cleanup,
1132 .send_mss = tcp_session_send_mss,
1133 .send_space = tcp_session_send_space,
1134 .update_time = tcp_update_time,
1135 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1136 .format_connection = format_tcp_session,
1137 .format_listener = format_tcp_listener_session,
1138 .format_half_open = format_tcp_half_open_session,
1139 .tx_type = TRANSPORT_TX_PEEK,
1140 .service_type = TRANSPORT_SERVICE_VC,
1145 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1150 if (!transport_connection_is_tx_paced (&tc->connection))
1153 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1154 /* TODO should constrain to interface's max throughput but
1155 * we don't have link speeds for sw ifs ..*/
1156 rate = tc->cwnd / srtt;
1157 transport_connection_tx_pacer_update (&tc->connection, rate);
1161 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1164 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1165 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1166 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1167 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1168 start_bucket, last_time);
1172 tcp_timer_keep_handler (u32 conn_index)
1174 u32 thread_index = vlib_get_thread_index ();
1175 tcp_connection_t *tc;
1177 tc = tcp_connection_get (conn_index, thread_index);
1178 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1180 tcp_connection_close (tc);
1184 tcp_timer_establish_handler (u32 conn_index)
1186 tcp_connection_t *tc;
1188 tc = tcp_half_open_connection_get (conn_index);
1191 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1192 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1193 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1197 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1198 /* note: the connection may have already disappeared */
1199 if (PREDICT_FALSE (tc == 0))
1201 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1202 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1203 /* Start cleanup. App wasn't notified yet so use delete notify as
1204 * opposed to delete to cleanup session layer state. */
1205 stream_session_delete_notify (&tc->connection);
1207 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1208 tcp_connection_cleanup (tc);
1212 tcp_timer_waitclose_handler (u32 conn_index)
1214 u32 thread_index = vlib_get_thread_index ();
1215 tcp_connection_t *tc;
1217 tc = tcp_connection_get (conn_index, thread_index);
1220 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1222 /* Session didn't come back with a close(). Send FIN either way
1223 * and switch to LAST_ACK. */
1224 if (tc->state == TCP_STATE_CLOSE_WAIT)
1226 if (tc->flags & TCP_CONN_FINSNT)
1228 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1231 /* Make sure we don't try to send unsent data */
1232 tcp_connection_timers_reset (tc);
1233 tcp_cong_recovery_off (tc);
1234 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1236 tc->state = TCP_STATE_LAST_ACK;
1238 /* Make sure we don't wait in LAST ACK forever */
1239 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1241 /* Don't delete the connection yet */
1245 tcp_connection_del (tc);
1249 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1251 tcp_timer_retransmit_handler,
1252 tcp_timer_delack_handler,
1253 tcp_timer_persist_handler,
1254 tcp_timer_keep_handler,
1255 tcp_timer_waitclose_handler,
1256 tcp_timer_retransmit_syn_handler,
1257 tcp_timer_establish_handler
1262 tcp_expired_timers_dispatch (u32 * expired_timers)
1265 u32 connection_index, timer_id;
1267 for (i = 0; i < vec_len (expired_timers); i++)
1269 /* Get session index and timer id */
1270 connection_index = expired_timers[i] & 0x0FFFFFFF;
1271 timer_id = expired_timers[i] >> 28;
1273 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1275 /* Handle expiration */
1276 (*timer_expiration_handlers[timer_id]) (connection_index);
1281 tcp_initialize_timer_wheels (tcp_main_t * tm)
1283 tw_timer_wheel_16t_2w_512sl_t *tw;
1285 foreach_vlib_main (({
1286 tw = &tm->wrk_ctx[ii].timer_wheel;
1287 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1288 100e-3 /* timer period 100ms */ , ~0);
1289 tw->last_run_time = vlib_time_now (this_vlib_main);
1294 static clib_error_t *
1295 tcp_main_enable (vlib_main_t * vm)
1297 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1298 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1299 tcp_connection_t *tc __attribute__ ((unused));
1300 tcp_main_t *tm = vnet_get_tcp_main ();
1301 clib_error_t *error = 0;
1304 if ((error = vlib_call_init_function (vm, ip_main_init)))
1306 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1308 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1315 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1316 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1319 * Initialize data structures
1322 num_threads = 1 /* main thread */ + vtm->n_threads;
1323 vec_validate (tm->connections, num_threads - 1);
1324 vec_validate (tm->wrk_ctx, num_threads - 1);
1325 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1326 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1328 for (thread = 0; thread < num_threads; thread++)
1330 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1331 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1332 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1333 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1334 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1335 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1336 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1337 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1338 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1339 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1340 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1341 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1342 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1345 * Preallocate connections. Assume that thread 0 won't
1346 * use preallocated threads when running multi-core
1348 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1349 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1353 * Use a preallocated half-open connection pool?
1355 if (tm->preallocated_half_open_connections)
1356 pool_init_fixed (tm->half_open_connections,
1357 tm->preallocated_half_open_connections);
1359 /* Initialize clocks per tick for TCP timestamp. Used to compute
1360 * monotonically increasing timestamps. */
1361 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1362 / TCP_TSTAMP_RESOLUTION;
1364 if (num_threads > 1)
1366 clib_spinlock_init (&tm->half_open_lock);
1369 tcp_initialize_timer_wheels (tm);
1371 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1372 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1378 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1382 if (tcp_main.is_enabled)
1385 return tcp_main_enable (vm);
1389 tcp_main.is_enabled = 0;
1396 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1398 tcp_main_t *tm = &tcp_main;
1400 tm->punt_unknown4 = is_add;
1402 tm->punt_unknown6 = is_add;
1405 static clib_error_t *
1406 tcp_init (vlib_main_t * vm)
1408 tcp_main_t *tm = vnet_get_tcp_main ();
1409 ip_main_t *im = &ip_main;
1410 ip_protocol_info_t *pi;
1412 /* Session layer, and by implication tcp, are disabled by default */
1415 /* Register with IP for header parsing */
1416 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1418 return clib_error_return (0, "TCP protocol info AWOL");
1419 pi->format_header = format_tcp_header;
1420 pi->unformat_pg_edit = unformat_pg_tcp_header;
1422 /* Register as transport with session layer */
1423 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1424 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1425 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1426 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1428 tcp_api_reference ();
1430 tm->cc_algo = TCP_CC_NEWRENO;
1434 VLIB_INIT_FUNCTION (tcp_init);
1437 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1439 uword *result = va_arg (*va, uword *);
1441 if (unformat (input, "newreno"))
1442 *result = TCP_CC_NEWRENO;
1443 else if (unformat (input, "cubic"))
1444 *result = TCP_CC_CUBIC;
1451 static clib_error_t *
1452 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1454 tcp_main_t *tm = vnet_get_tcp_main ();
1456 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1458 if (unformat (input, "preallocated-connections %d",
1459 &tm->preallocated_connections))
1461 else if (unformat (input, "preallocated-half-open-connections %d",
1462 &tm->preallocated_half_open_connections))
1464 else if (unformat (input, "buffer-fail-fraction %f",
1465 &tm->buffer_fail_fraction))
1467 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1470 else if (unformat (input, "no-tx-pacing"))
1472 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1476 return clib_error_return (0, "unknown input `%U'",
1477 format_unformat_error, input);
1482 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1486 * \brief Configure an ipv4 source address range
1487 * @param vm vlib_main_t pointer
1488 * @param start first ipv4 address in the source address range
1489 * @param end last ipv4 address in the source address range
1490 * @param table_id VRF / table ID, 0 for the default FIB
1491 * @return 0 if all OK, else an error indication from api_errno.h
1495 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1496 ip4_address_t * start,
1497 ip4_address_t * end, u32 table_id)
1499 tcp_main_t *tm = vnet_get_tcp_main ();
1500 vnet_main_t *vnm = vnet_get_main ();
1501 u32 start_host_byte_order, end_host_byte_order;
1502 fib_prefix_t prefix;
1503 vnet_sw_interface_t *si;
1504 fib_node_index_t fei;
1508 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1509 ip4_address_t * hi_addr, u32 fib_index,
1512 clib_memset (&prefix, 0, sizeof (prefix));
1514 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1516 if (fib_index == ~0)
1517 return VNET_API_ERROR_NO_SUCH_FIB;
1519 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1520 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1522 /* sanity check for reversed args or some such */
1523 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1524 return VNET_API_ERROR_INVALID_ARGUMENT;
1526 /* Lookup the last address, to identify the interface involved */
1528 prefix.fp_proto = FIB_PROTOCOL_IP4;
1529 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1531 fei = fib_table_lookup (fib_index, &prefix);
1533 /* Couldn't find route to destination. Bail out. */
1534 if (fei == FIB_NODE_INDEX_INVALID)
1535 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1537 sw_if_index = fib_entry_get_resolving_interface (fei);
1539 /* Enable proxy arp on the interface */
1540 si = vnet_get_sw_interface (vnm, sw_if_index);
1541 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1543 /* Configure proxy arp across the range */
1544 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1551 dpo_id_t dpo = DPO_INVALID;
1553 vec_add1 (tm->ip4_src_addresses, start[0]);
1555 /* Add local adjacencies for the range */
1557 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1560 prefix.fp_proto = FIB_PROTOCOL_IP4;
1561 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1563 fib_table_entry_special_dpo_update (fib_index,
1566 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1569 start_host_byte_order++;
1570 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1572 while (start_host_byte_order <= end_host_byte_order);
1578 * \brief Configure an ipv6 source address range
1579 * @param vm vlib_main_t pointer
1580 * @param start first ipv6 address in the source address range
1581 * @param end last ipv6 address in the source address range
1582 * @param table_id VRF / table ID, 0 for the default FIB
1583 * @return 0 if all OK, else an error indication from api_errno.h
1587 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1588 ip6_address_t * start,
1589 ip6_address_t * end, u32 table_id)
1591 tcp_main_t *tm = vnet_get_tcp_main ();
1592 fib_prefix_t prefix;
1594 fib_node_index_t fei;
1597 clib_memset (&prefix, 0, sizeof (prefix));
1599 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1601 if (fib_index == ~0)
1602 return VNET_API_ERROR_NO_SUCH_FIB;
1608 dpo_id_t dpo = DPO_INVALID;
1610 /* Remember this address */
1611 vec_add1 (tm->ip6_src_addresses, start[0]);
1613 /* Lookup the prefix, to identify the interface involved */
1614 prefix.fp_len = 128;
1615 prefix.fp_proto = FIB_PROTOCOL_IP6;
1616 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1618 fei = fib_table_lookup (fib_index, &prefix);
1620 /* Couldn't find route to destination. Bail out. */
1621 if (fei == FIB_NODE_INDEX_INVALID)
1622 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1624 sw_if_index = fib_entry_get_resolving_interface (fei);
1626 if (sw_if_index == (u32) ~ 0)
1627 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1629 /* Add a proxy neighbor discovery entry for this address */
1630 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1632 /* Add a receive adjacency for this address */
1633 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1636 fib_table_entry_special_dpo_update (fib_index,
1639 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1642 /* Done with the entire range? */
1643 if (!memcmp (start, end, sizeof (start[0])))
1646 /* Increment the address. DGMS. */
1648 for (i = 15; i >= 0; i--)
1651 if (tmp.as_u8[i] != 0)
1659 static clib_error_t *
1660 tcp_src_address (vlib_main_t * vm,
1661 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1663 ip4_address_t v4start, v4end;
1664 ip6_address_t v6start, v6end;
1670 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1672 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1673 unformat_ip4_address, &v4end))
1675 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1677 memcpy (&v4end, &v4start, sizeof (v4start));
1680 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1681 unformat_ip6_address, &v6end))
1683 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1685 memcpy (&v6end, &v6start, sizeof (v6start));
1688 else if (unformat (input, "fib-table %d", &table_id))
1694 if (!v4set && !v6set)
1695 return clib_error_return (0, "at least one v4 or v6 address required");
1699 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1706 case VNET_API_ERROR_NO_SUCH_FIB:
1707 return clib_error_return (0, "Invalid table-id %d", table_id);
1709 case VNET_API_ERROR_INVALID_ARGUMENT:
1710 return clib_error_return (0, "Invalid address range %U - %U",
1711 format_ip4_address, &v4start,
1712 format_ip4_address, &v4end);
1714 return clib_error_return (0, "error %d", rv);
1720 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1727 case VNET_API_ERROR_NO_SUCH_FIB:
1728 return clib_error_return (0, "Invalid table-id %d", table_id);
1731 return clib_error_return (0, "error %d", rv);
1739 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1741 .path = "tcp src-address",
1742 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1743 .function = tcp_src_address,
1748 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1750 #if TCP_SCOREBOARD_TRACE
1752 scoreboard_trace_elt_t *block;
1758 s = format (s, "scoreboard trace:");
1759 vec_foreach (block, sb->trace)
1761 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1762 block->ack, block->snd_una_max, block->group);
1764 s = format (s, "\n");
1772 static clib_error_t *
1773 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1774 vlib_cli_command_t * cmd_arg)
1776 transport_connection_t *tconn = 0;
1777 tcp_connection_t *tc;
1779 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1781 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1782 TRANSPORT_PROTO_TCP))
1785 return clib_error_return (0, "unknown input `%U'",
1786 format_unformat_error, input);
1789 if (!TCP_SCOREBOARD_TRACE)
1791 vlib_cli_output (vm, "scoreboard tracing not enabled");
1795 tc = tcp_get_connection_from_transport (tconn);
1796 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1797 vlib_cli_output (vm, "%v", s);
1802 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1804 .path = "show tcp scoreboard trace",
1805 .short_help = "show tcp scoreboard trace <connection>",
1806 .function = tcp_show_scoreboard_trace_fn,
1811 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1814 scoreboard_trace_elt_t *trace;
1815 u32 next_ack, left, group, has_new_ack = 0;
1816 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1817 sack_block_t *block;
1819 if (!TCP_SCOREBOARD_TRACE)
1821 s = format (s, "scoreboard tracing not enabled");
1828 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1829 tcp_connection_timers_init (dummy_tc);
1830 scoreboard_init (&dummy_tc->sack_sb);
1831 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1833 #if TCP_SCOREBOARD_TRACE
1834 trace = tc->sack_sb.trace;
1835 trace_len = vec_len (tc->sack_sb.trace);
1838 for (i = 0; i < trace_len; i++)
1840 if (trace[i].ack != 0)
1842 dummy_tc->snd_una = trace[i].ack - 1448;
1843 dummy_tc->snd_una_max = trace[i].ack;
1848 while (left < trace_len)
1850 group = trace[left].group;
1851 vec_reset_length (dummy_tc->rcv_opts.sacks);
1853 while (trace[left].group == group)
1855 if (trace[left].ack != 0)
1858 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1859 trace[left].ack, trace[left].snd_una_max);
1860 dummy_tc->snd_una_max = trace[left].snd_una_max;
1861 next_ack = trace[left].ack;
1867 s = format (s, "[%u, %u], ", trace[left].start,
1869 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1870 block->start = trace[left].start;
1871 block->end = trace[left].end;
1877 tcp_rcv_sacks (dummy_tc, next_ack);
1879 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1882 s = format (s, "result: %U", format_tcp_scoreboard,
1883 &dummy_tc->sack_sb);
1886 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1891 static clib_error_t *
1892 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1893 vlib_cli_command_t * cmd_arg)
1895 transport_connection_t *tconn = 0;
1896 tcp_connection_t *tc = 0;
1898 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1900 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1901 TRANSPORT_PROTO_TCP))
1904 return clib_error_return (0, "unknown input `%U'",
1905 format_unformat_error, input);
1908 if (!TCP_SCOREBOARD_TRACE)
1910 vlib_cli_output (vm, "scoreboard tracing not enabled");
1914 tc = tcp_get_connection_from_transport (tconn);
1917 vlib_cli_output (vm, "connection not found");
1920 str = tcp_scoreboard_replay (str, tc, 1);
1921 vlib_cli_output (vm, "%v", str);
1926 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1928 .path = "tcp replay scoreboard",
1929 .short_help = "tcp replay scoreboard <connection>",
1930 .function = tcp_scoreboard_trace_fn,
1934 static clib_error_t *
1935 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1936 vlib_cli_command_t * cmd_arg)
1938 tcp_main_t *tm = vnet_get_tcp_main ();
1939 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1940 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1942 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1943 tm->punt_unknown4 ? "enabled" : "disabled");
1944 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1945 tm->punt_unknown6 ? "enabled" : "disabled");
1949 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1951 .path = "show tcp punt",
1952 .short_help = "show tcp punt",
1953 .function = show_tcp_punt_fn,
1958 * fd.io coding-style-patch-verification: ON
1961 * eval: (c-set-style "gnu")