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>
32 ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4)
34 ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
35 ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
36 ip_interface_address_t *ia = 0;
41 foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
43 return ip_interface_address_get_address (lm4, ia);
50 foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
53 rv = ip_interface_address_get_address (lm6, ia);
54 /* Trying to use a link-local ip6 src address is a fool's errand */
55 if (!ip6_address_is_link_local_unicast (rv))
65 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
67 tcp_main_t *tm = &tcp_main;
68 tcp_connection_t *listener;
71 pool_get (tm->listener_pool, listener);
72 memset (listener, 0, sizeof (*listener));
74 listener->c_c_index = listener - tm->listener_pool;
75 listener->c_lcl_port = lcl->port;
77 /* If we are provided a sw_if_index, bind using one of its ips */
78 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
80 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
82 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
84 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
85 listener->c_is_ip4 = lcl->is_ip4;
86 listener->c_transport_proto = TRANSPORT_PROTO_TCP;
87 listener->c_s_index = session_index;
88 listener->c_fib_index = lcl->fib_index;
89 listener->state = TCP_STATE_LISTEN;
91 tcp_connection_timers_init (listener);
93 TCP_EVT_DBG (TCP_EVT_BIND, listener);
95 return listener->c_c_index;
99 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
101 return tcp_connection_bind (session_index, tep);
105 tcp_connection_unbind (u32 listener_index)
107 tcp_main_t *tm = vnet_get_tcp_main ();
108 tcp_connection_t *tc;
110 tc = pool_elt_at_index (tm->listener_pool, listener_index);
112 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
114 /* Poison the entry */
116 memset (tc, 0xFA, sizeof (*tc));
118 pool_put_index (tm->listener_pool, listener_index);
122 tcp_session_unbind (u32 listener_index)
124 tcp_connection_unbind (listener_index);
128 transport_connection_t *
129 tcp_session_get_listener (u32 listener_index)
131 tcp_main_t *tm = vnet_get_tcp_main ();
132 tcp_connection_t *tc;
133 tc = pool_elt_at_index (tm->listener_pool, listener_index);
134 return &tc->connection;
138 transport_endpoint_del (u32 tepi)
140 tcp_main_t *tm = vnet_get_tcp_main ();
141 clib_spinlock_lock_if_init (&tm->local_endpoints_lock);
142 pool_put_index (tm->local_endpoints, tepi);
143 clib_spinlock_unlock_if_init (&tm->local_endpoints_lock);
146 always_inline transport_endpoint_t *
147 transport_endpoint_new (void)
149 tcp_main_t *tm = vnet_get_tcp_main ();
150 transport_endpoint_t *tep;
151 pool_get (tm->local_endpoints, tep);
156 * Cleanup half-open connection
160 tcp_half_open_connection_del (tcp_connection_t * tc)
162 tcp_main_t *tm = vnet_get_tcp_main ();
163 clib_spinlock_lock_if_init (&tm->half_open_lock);
164 pool_put_index (tm->half_open_connections, tc->c_c_index);
166 memset (tc, 0xFA, sizeof (*tc));
167 clib_spinlock_unlock_if_init (&tm->half_open_lock);
171 * Try to cleanup half-open connection
173 * If called from a thread that doesn't own tc, the call won't have any
176 * @param tc - connection to be cleaned up
177 * @return non-zero if cleanup failed.
180 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
182 /* Make sure this is the owning thread */
183 if (tc->c_thread_index != vlib_get_thread_index ())
185 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH);
186 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
187 tcp_half_open_connection_del (tc);
192 tcp_half_open_connection_new (void)
194 tcp_main_t *tm = vnet_get_tcp_main ();
195 tcp_connection_t *tc = 0;
196 ASSERT (vlib_get_thread_index () == 0);
197 pool_get (tm->half_open_connections, tc);
198 memset (tc, 0, sizeof (*tc));
199 tc->c_c_index = tc - tm->half_open_connections;
204 * Cleans up connection state.
209 tcp_connection_cleanup (tcp_connection_t * tc)
211 tcp_main_t *tm = &tcp_main;
213 transport_endpoint_t *tep;
215 /* Cleanup local endpoint if this was an active connect */
216 tepi = transport_endpoint_lookup (&tm->local_endpoints_table, &tc->c_lcl_ip,
217 clib_net_to_host_u16 (tc->c_lcl_port));
218 if (tepi != TRANSPORT_ENDPOINT_INVALID_INDEX)
220 tep = pool_elt_at_index (tm->local_endpoints, tepi);
221 transport_endpoint_table_del (&tm->local_endpoints_table, tep);
222 transport_endpoint_del (tepi);
225 /* Check if connection is not yet fully established */
226 if (tc->state == TCP_STATE_SYN_SENT)
228 /* Try to remove the half-open connection. If this is not the owning
229 * thread, tc won't be removed. Retransmit or establish timers will
230 * eventually expire and call again cleanup on the right thread. */
231 tcp_half_open_connection_cleanup (tc);
235 int thread_index = tc->c_thread_index;
237 /* Make sure all timers are cleared */
238 tcp_connection_timers_reset (tc);
240 /* Poison the entry */
242 memset (tc, 0xFA, sizeof (*tc));
243 pool_put (tm->connections[thread_index], tc);
248 * Connection removal.
250 * This should be called only once connection enters CLOSED state. Note
251 * that it notifies the session of the removal event, so if the goal is to
252 * just remove the connection, call tcp_connection_cleanup instead.
255 tcp_connection_del (tcp_connection_t * tc)
257 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
258 stream_session_delete_notify (&tc->connection);
259 tcp_connection_cleanup (tc);
263 tcp_connection_new (u8 thread_index)
265 tcp_main_t *tm = vnet_get_tcp_main ();
266 tcp_connection_t *tc;
268 pool_get (tm->connections[thread_index], tc);
269 memset (tc, 0, sizeof (*tc));
270 tc->c_c_index = tc - tm->connections[thread_index];
271 tc->c_thread_index = thread_index;
275 /** Notify session that connection has been reset.
277 * Switch state to closed and wait for session to call cleanup.
280 tcp_connection_reset (tcp_connection_t * tc)
282 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
285 case TCP_STATE_SYN_RCVD:
286 /* Cleanup everything. App wasn't notified yet */
287 stream_session_delete_notify (&tc->connection);
288 tcp_connection_cleanup (tc);
290 case TCP_STATE_SYN_SENT:
291 stream_session_connect_notify (&tc->connection, 1 /* fail */ );
292 tcp_connection_cleanup (tc);
294 case TCP_STATE_ESTABLISHED:
295 case TCP_STATE_CLOSE_WAIT:
296 case TCP_STATE_FIN_WAIT_1:
297 case TCP_STATE_FIN_WAIT_2:
298 case TCP_STATE_CLOSING:
299 tc->state = TCP_STATE_CLOSED;
300 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
302 /* Make sure all timers are cleared */
303 tcp_connection_timers_reset (tc);
304 stream_session_reset_notify (&tc->connection);
306 /* Wait for cleanup from session layer but not forever */
307 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
309 case TCP_STATE_CLOSED:
315 * Begin connection closing procedure.
317 * If at the end the connection is not in CLOSED state, it is not removed.
318 * Instead, we rely on on TCP to advance through state machine to either
319 * 1) LAST_ACK (passive close) whereby when the last ACK is received
320 * tcp_connection_del is called. This notifies session of the delete and
322 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
323 * and cleanup is called.
325 * N.B. Half-close connections are not supported
328 tcp_connection_close (tcp_connection_t * tc)
330 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
332 /* Send/Program FIN if needed and switch state */
335 case TCP_STATE_SYN_SENT:
336 tc->state = TCP_STATE_CLOSED;
338 case TCP_STATE_SYN_RCVD:
340 tc->state = TCP_STATE_FIN_WAIT_1;
342 case TCP_STATE_ESTABLISHED:
343 if (!stream_session_tx_fifo_max_dequeue (&tc->connection))
346 tc->flags |= TCP_CONN_FINPNDG;
347 tc->state = TCP_STATE_FIN_WAIT_1;
349 case TCP_STATE_CLOSE_WAIT:
350 tcp_connection_timers_reset (tc);
352 tc->state = TCP_STATE_LAST_ACK;
353 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
355 case TCP_STATE_FIN_WAIT_1:
356 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
359 TCP_DBG ("state: %u", tc->state);
362 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
364 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
365 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
366 && tc->state == TCP_STATE_CLOSED)
367 tcp_connection_del (tc);
371 tcp_session_close (u32 conn_index, u32 thread_index)
373 tcp_connection_t *tc;
374 tc = tcp_connection_get (conn_index, thread_index);
375 tcp_connection_close (tc);
379 tcp_session_cleanup (u32 conn_index, u32 thread_index)
381 tcp_connection_t *tc;
382 tc = tcp_connection_get (conn_index, thread_index);
383 tcp_connection_timers_reset (tc);
385 /* Wait for the session tx events to clear */
386 tc->state = TCP_STATE_CLOSED;
387 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
388 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
391 #define PORT_MASK ((1 << 16)- 1)
393 * Allocate local port and add if successful add entry to local endpoint
394 * table to mark the pair as used.
397 tcp_allocate_local_port (ip46_address_t * ip)
399 tcp_main_t *tm = vnet_get_tcp_main ();
400 transport_endpoint_t *tep;
402 u16 min = 1024, max = 65535; /* XXX configurable ? */
407 /* Only support active opens from thread 0 */
408 ASSERT (vlib_get_thread_index () == 0);
410 /* Search for first free slot */
411 for (tries = 0; tries < limit; tries++)
415 /* Find a port in the specified range */
418 port = random_u32 (&tm->port_allocator_seed) & PORT_MASK;
419 if (PREDICT_TRUE (port >= min && port < max))
424 tei = transport_endpoint_lookup (&tm->local_endpoints_table, ip, port);
425 /* If not found, we're done */
426 if (tei == TRANSPORT_ENDPOINT_INVALID_INDEX)
428 clib_spinlock_lock_if_init (&tm->local_endpoints_lock);
429 tep = transport_endpoint_new ();
430 clib_memcpy (&tep->ip, ip, sizeof (*ip));
432 transport_endpoint_table_add (&tm->local_endpoints_table, tep,
433 tep - tm->local_endpoints);
434 clib_spinlock_unlock_if_init (&tm->local_endpoints_lock);
443 * Initialize all connection timers as invalid
446 tcp_connection_timers_init (tcp_connection_t * tc)
450 /* Set all to invalid */
451 for (i = 0; i < TCP_N_TIMERS; i++)
453 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
456 tc->rto = TCP_RTO_INIT;
460 * Stop all connection timers
463 tcp_connection_timers_reset (tcp_connection_t * tc)
466 for (i = 0; i < TCP_N_TIMERS; i++)
468 tcp_timer_reset (tc, i);
473 typedef struct ip4_tcp_hdr
479 typedef struct ip6_tcp_hdr
486 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
489 const dpo_id_t *choice;
493 lb = load_balance_get (dpo->dpoi_index);
497 memset (&hdr, 0, sizeof (hdr));
498 hdr.ip.protocol = IP_PROTOCOL_TCP;
499 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
500 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
501 hdr.tcp.src_port = tc->c_lcl_port;
502 hdr.tcp.dst_port = tc->c_rmt_port;
503 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
508 memset (&hdr, 0, sizeof (hdr));
509 hdr.ip.protocol = IP_PROTOCOL_TCP;
510 clib_memcpy (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
511 sizeof (ip6_address_t));
512 clib_memcpy (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
513 sizeof (ip6_address_t));
514 hdr.tcp.src_port = tc->c_lcl_port;
515 hdr.tcp.dst_port = tc->c_rmt_port;
516 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
518 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
519 dpo_copy (result, choice);
523 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
528 clib_memcpy (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
529 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
530 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
531 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
532 return fib_table_lookup (fib_index, &prefix);
536 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
538 dpo_id_t choice = DPO_INVALID;
539 u32 output_node_index;
542 fe = fib_entry_get (tc->c_rmt_fei);
543 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
546 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
549 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
550 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
554 /** Stack tcp connection on peer's fib entry.
556 * This ultimately populates the dpo the connection will use to send packets.
559 tcp_connection_fib_attach (tcp_connection_t * tc)
561 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
563 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
565 tcp_connection_stack_on_fib_entry (tc);
570 * Initialize connection send variables.
573 tcp_init_snd_vars (tcp_connection_t * tc)
577 /* Set random initial sequence */
578 tcp_set_time_now (0);
579 time_now = tcp_time_now ();
580 tc->iss = random_u32 (&time_now);
581 tc->snd_una = tc->iss;
582 tc->snd_nxt = tc->iss + 1;
583 tc->snd_una_max = tc->snd_nxt;
586 /** Initialize tcp connection variables
588 * Should be called after having received a msg from the peer, i.e., a SYN or
589 * a SYNACK, such that connection options have already been exchanged. */
591 tcp_connection_init_vars (tcp_connection_t * tc)
593 tcp_connection_timers_init (tc);
595 scoreboard_init (&tc->sack_sb);
597 if (tc->state == TCP_STATE_SYN_RCVD)
598 tcp_init_snd_vars (tc);
600 // tcp_connection_fib_attach (tc);
604 tcp_connection_open (transport_endpoint_t * rmt)
606 tcp_main_t *tm = vnet_get_tcp_main ();
607 tcp_connection_t *tc;
609 fib_node_index_t fei;
611 ip46_address_t lcl_addr;
615 * Find the local address and allocate port
617 memset (&lcl_addr, 0, sizeof (lcl_addr));
619 /* Find a FIB path to the destination */
620 clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
621 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
622 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
624 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
625 fei = fib_table_lookup (rmt->fib_index, &prefix);
627 /* Couldn't find route to destination. Bail out. */
628 if (fei == FIB_NODE_INDEX_INVALID)
630 clib_warning ("no route to destination");
634 sw_if_index = rmt->sw_if_index;
635 if (sw_if_index == ENDPOINT_INVALID_INDEX)
636 sw_if_index = fib_entry_get_resolving_interface (fei);
638 if (sw_if_index == ENDPOINT_INVALID_INDEX)
640 clib_warning ("no resolving interface for %U", format_ip46_address,
641 &rmt->ip, (rmt->is_ip4 == 0) + 1);
649 if (vec_len (tm->ip4_src_addresses))
651 index = tm->last_v4_address_rotor++;
652 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
653 tm->last_v4_address_rotor = 0;
654 lcl_addr.ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
658 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
659 lcl_addr.ip4.as_u32 = ip4->as_u32;
667 if (vec_len (tm->ip6_src_addresses))
669 index = tm->last_v6_address_rotor++;
670 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
671 tm->last_v6_address_rotor = 0;
672 clib_memcpy (&lcl_addr.ip6, &tm->ip6_src_addresses[index],
677 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
680 clib_warning ("no routable ip6 addresses on %U",
681 format_vnet_sw_if_index_name, vnet_get_main (),
686 clib_memcpy (&lcl_addr.ip6, ip6, sizeof (*ip6));
690 /* Allocate source port */
691 lcl_port = tcp_allocate_local_port (&lcl_addr);
694 clib_warning ("Failed to allocate src port");
699 * Create connection and send SYN
701 clib_spinlock_lock_if_init (&tm->half_open_lock);
702 tc = tcp_half_open_connection_new ();
703 clib_memcpy (&tc->c_rmt_ip, &rmt->ip, sizeof (ip46_address_t));
704 clib_memcpy (&tc->c_lcl_ip, &lcl_addr, sizeof (ip46_address_t));
705 tc->c_rmt_port = rmt->port;
706 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
707 tc->c_is_ip4 = rmt->is_ip4;
708 tc->c_transport_proto = TRANSPORT_PROTO_TCP;
709 tc->c_fib_index = rmt->fib_index;
710 /* The other connection vars will be initialized after SYN ACK */
711 tcp_connection_timers_init (tc);
713 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
714 tc->state = TCP_STATE_SYN_SENT;
715 tcp_init_snd_vars (tc);
717 clib_spinlock_unlock_if_init (&tm->half_open_lock);
719 return tc->c_c_index;
723 tcp_session_open (transport_endpoint_t * tep)
725 return tcp_connection_open (tep);
728 const char *tcp_dbg_evt_str[] = {
729 #define _(sym, str) str,
734 const char *tcp_fsm_states[] = {
735 #define _(sym, str) str,
736 foreach_tcp_fsm_state
741 format_tcp_state (u8 * s, va_list * args)
743 u32 state = va_arg (*args, u32);
745 if (state < TCP_N_STATES)
746 s = format (s, "%s", tcp_fsm_states[state]);
748 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
752 const char *tcp_connection_flags_str[] = {
753 #define _(sym, str) str,
754 foreach_tcp_connection_flag
759 format_tcp_connection_flags (u8 * s, va_list * args)
761 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
764 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
765 if (tc->flags & (1 << i))
767 for (i = 0; i < last; i++)
769 if (tc->flags & (1 << i))
770 s = format (s, "%s, ", tcp_connection_flags_str[i]);
773 s = format (s, "%s", tcp_connection_flags_str[last]);
777 const char *tcp_conn_timers[] = {
778 #define _(sym, str) str,
784 format_tcp_timers (u8 * s, va_list * args)
786 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
789 for (i = 0; i < TCP_N_TIMERS; i++)
790 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
794 for (i = 0; i < last; i++)
796 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
797 s = format (s, "%s,", tcp_conn_timers[i]);
801 s = format (s, "%s]", tcp_conn_timers[i]);
809 format_tcp_congestion_status (u8 * s, va_list * args)
811 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
812 if (tcp_in_recovery (tc))
813 s = format (s, "recovery");
814 else if (tcp_in_fastrecovery (tc))
815 s = format (s, "fastrecovery");
817 s = format (s, "none");
822 format_tcp_vars (u8 * s, va_list * args)
824 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
825 s = format (s, " flags: %U timers: %U\n", format_tcp_connection_flags, tc,
826 format_tcp_timers, tc);
827 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
828 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
829 tc->snd_una_max - tc->iss);
830 s = format (s, " rcv_nxt %u rcv_las %u\n",
831 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
832 s = format (s, " snd_wnd %u rcv_wnd %u snd_wl1 %u snd_wl2 %u\n",
833 tc->snd_wnd, tc->rcv_wnd, tc->snd_wl1 - tc->irs,
834 tc->snd_wl2 - tc->iss);
835 s = format (s, " flight size %u send space %u rcv_wnd_av %d\n",
836 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
837 tcp_rcv_wnd_available (tc));
838 s = format (s, " cong %U ", format_tcp_congestion_status, tc);
839 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
840 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
841 s = format (s, " prev_ssthresh %u snd_congestion %u dupack %u",
842 tc->prev_ssthresh, tc->snd_congestion - tc->iss,
844 s = format (s, " limited_transmit %u\n", tc->limited_transmit - tc->iss);
845 s = format (s, " tsecr %u tsecr_last_ack %u\n", tc->rcv_opts.tsecr,
847 s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %u ", tc->rto,
848 tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
849 s = format (s, "rtt_seq %u\n", tc->rtt_seq);
850 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
851 tcp_time_now () - tc->tsval_recent_age);
852 if (tc->state >= TCP_STATE_ESTABLISHED)
853 s = format (s, " scoreboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
855 if (vec_len (tc->snd_sacks))
856 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
862 format_tcp_connection_id (u8 * s, va_list * args)
864 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
869 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
870 format_ip4_address, &tc->c_lcl_ip4,
871 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
872 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
876 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
877 format_ip6_address, &tc->c_lcl_ip6,
878 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
879 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
886 format_tcp_connection (u8 * s, va_list * args)
888 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
889 u32 verbose = va_arg (*args, u32);
893 s = format (s, "%-50U", format_tcp_connection_id, tc);
896 s = format (s, "%-15U", format_tcp_state, tc->state);
898 s = format (s, "\n%U", format_tcp_vars, tc);
905 format_tcp_session (u8 * s, va_list * args)
907 u32 tci = va_arg (*args, u32);
908 u32 thread_index = va_arg (*args, u32);
909 u32 verbose = va_arg (*args, u32);
910 tcp_connection_t *tc;
912 tc = tcp_connection_get (tci, thread_index);
914 s = format (s, "%U", format_tcp_connection, tc, verbose);
916 s = format (s, "empty\n");
921 format_tcp_listener_session (u8 * s, va_list * args)
923 u32 tci = va_arg (*args, u32);
924 tcp_connection_t *tc = tcp_listener_get (tci);
925 return format (s, "%U", format_tcp_connection_id, tc);
929 format_tcp_half_open_session (u8 * s, va_list * args)
931 u32 tci = va_arg (*args, u32);
932 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
933 return format (s, "%U", format_tcp_connection_id, tc);
937 format_tcp_sacks (u8 * s, va_list * args)
939 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
940 sack_block_t *sacks = tc->snd_sacks;
944 len = vec_len (sacks);
945 for (i = 0; i < len - 1; i++)
948 s = format (s, " start %u end %u\n", block->start - tc->irs,
949 block->end - tc->irs);
953 block = &sacks[len - 1];
954 s = format (s, " start %u end %u", block->start - tc->irs,
955 block->end - tc->irs);
961 format_tcp_rcv_sacks (u8 * s, va_list * args)
963 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
964 sack_block_t *sacks = tc->rcv_opts.sacks;
968 len = vec_len (sacks);
969 for (i = 0; i < len - 1; i++)
972 s = format (s, " start %u end %u\n", block->start - tc->iss,
973 block->end - tc->iss);
977 block = &sacks[len - 1];
978 s = format (s, " start %u end %u", block->start - tc->iss,
979 block->end - tc->iss);
985 format_tcp_sack_hole (u8 * s, va_list * args)
987 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
988 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
990 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
992 s = format (s, " [%u, %u]", hole->start, hole->end);
997 format_tcp_scoreboard (u8 * s, va_list * args)
999 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1000 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1001 sack_scoreboard_hole_t *hole;
1002 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1003 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1004 s = format (s, " last_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1005 sb->last_bytes_delivered, sb->high_sacked, sb->snd_una_adv);
1006 s = format (s, " cur_rxt_hole %u high_rxt %u rescue_rxt %u",
1007 sb->cur_rxt_hole, sb->high_rxt, sb->rescue_rxt);
1009 hole = scoreboard_first_hole (sb);
1011 s = format (s, "\n head %u tail %u holes:\n", sb->head, sb->tail);
1015 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1016 hole = scoreboard_next_hole (sb, hole);
1022 transport_connection_t *
1023 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1025 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1026 return &tc->connection;
1029 transport_connection_t *
1030 tcp_half_open_session_get_transport (u32 conn_index)
1032 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1033 return &tc->connection;
1037 * Compute maximum segment size for session layer.
1039 * Since the result needs to be the actual data length, it first computes
1040 * the tcp options to be used in the next burst and subtracts their
1041 * length from the connection's snd_mss.
1044 tcp_session_send_mss (transport_connection_t * trans_conn)
1046 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1048 /* Ensure snd_mss does accurately reflect the amount of data we can push
1049 * in a segment. This also makes sure that options are updated according to
1050 * the current state of the connection. */
1051 tcp_update_snd_mss (tc);
1057 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1059 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1061 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1064 /* If not snd_wnd constrained and we can't write at least a segment,
1065 * don't try at all */
1066 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1067 return snd_space < tc->cwnd ? 0 : snd_space;
1069 /* round down to mss multiple */
1070 return snd_space - (snd_space % tc->snd_mss);
1074 * Compute tx window session is allowed to fill.
1076 * Takes into account available send space, snd_mss and the congestion
1077 * state of the connection. If possible, the value returned is a multiple
1080 * @param tc tcp connection
1081 * @return number of bytes session is allowed to write
1084 tcp_snd_space (tcp_connection_t * tc)
1086 int snd_space, snt_limited;
1088 if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0))
1090 snd_space = tcp_available_output_snd_space (tc);
1092 /* If we haven't gotten dupacks or if we did and have gotten sacked
1093 * bytes then we can still send as per Limited Transmit (RFC3042) */
1094 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1095 && (tcp_opts_sack_permitted (tc)
1096 && tc->sack_sb.last_sacked_bytes == 0)))
1098 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1099 tc->limited_transmit = tc->snd_nxt;
1100 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1102 snt_limited = tc->snd_nxt - tc->limited_transmit;
1103 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1105 return tcp_round_snd_space (tc, snd_space);
1108 if (tcp_in_recovery (tc))
1110 tc->snd_nxt = tc->snd_una_max;
1111 snd_space = tcp_available_snd_wnd (tc) - tc->snd_rxt_bytes
1112 - (tc->snd_una_max - tc->snd_congestion);
1113 if (snd_space <= 0 || (tc->snd_una_max - tc->snd_una) >= tc->snd_wnd)
1115 return tcp_round_snd_space (tc, snd_space);
1118 /* RFC 5681: When previously unsent data is available and the new value of
1119 * cwnd and the receiver's advertised window allow, a TCP SHOULD send 1*SMSS
1120 * bytes of previously unsent data. */
1121 if (tcp_in_fastrecovery (tc) && !tcp_fastrecovery_sent_1_smss (tc))
1123 if (tcp_available_output_snd_space (tc) < tc->snd_mss)
1125 tcp_fastrecovery_1_smss_on (tc);
1133 tcp_session_send_space (transport_connection_t * trans_conn)
1135 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1136 return clib_min (tcp_snd_space (tc),
1137 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1141 tcp_rcv_wnd_available (tcp_connection_t * tc)
1143 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
1147 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1149 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1151 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1153 /* This still works if fast retransmit is on */
1154 return (tc->snd_nxt - tc->snd_una);
1158 const static transport_proto_vft_t tcp_proto = {
1159 .bind = tcp_session_bind,
1160 .unbind = tcp_session_unbind,
1161 .push_header = tcp_push_header,
1162 .get_connection = tcp_session_get_transport,
1163 .get_listener = tcp_session_get_listener,
1164 .get_half_open = tcp_half_open_session_get_transport,
1165 .open = tcp_session_open,
1166 .close = tcp_session_close,
1167 .cleanup = tcp_session_cleanup,
1168 .send_mss = tcp_session_send_mss,
1169 .send_space = tcp_session_send_space,
1170 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1171 .format_connection = format_tcp_session,
1172 .format_listener = format_tcp_listener_session,
1173 .format_half_open = format_tcp_half_open_session,
1178 tcp_timer_keep_handler (u32 conn_index)
1180 u32 thread_index = vlib_get_thread_index ();
1181 tcp_connection_t *tc;
1183 tc = tcp_connection_get (conn_index, thread_index);
1184 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1186 tcp_connection_close (tc);
1190 tcp_timer_establish_handler (u32 conn_index)
1192 tcp_connection_t *tc;
1194 tc = tcp_half_open_connection_get (conn_index);
1197 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1198 stream_session_connect_notify (&tc->connection, 1 /* fail */ );
1199 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1203 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1204 /* note: the connection may have already disappeared */
1205 if (PREDICT_FALSE (tc == 0))
1207 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1208 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1209 /* Start cleanup. App wasn't notified yet so use delete notify as
1210 * opposed to delete to cleanup session layer state. */
1211 stream_session_delete_notify (&tc->connection);
1213 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1214 tcp_connection_cleanup (tc);
1218 tcp_timer_waitclose_handler (u32 conn_index)
1220 u32 thread_index = vlib_get_thread_index ();
1221 tcp_connection_t *tc;
1223 tc = tcp_connection_get (conn_index, thread_index);
1226 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1228 /* Session didn't come back with a close(). Send FIN either way
1229 * and switch to LAST_ACK. */
1230 if (tc->state == TCP_STATE_CLOSE_WAIT)
1232 if (tc->flags & TCP_CONN_FINSNT)
1234 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1238 tc->state = TCP_STATE_LAST_ACK;
1240 /* Make sure we don't wait in LAST ACK forever */
1241 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1243 /* Don't delete the connection yet */
1247 tcp_connection_del (tc);
1251 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1253 tcp_timer_retransmit_handler,
1254 tcp_timer_delack_handler,
1255 tcp_timer_persist_handler,
1256 tcp_timer_keep_handler,
1257 tcp_timer_waitclose_handler,
1258 tcp_timer_retransmit_syn_handler,
1259 tcp_timer_establish_handler
1264 tcp_expired_timers_dispatch (u32 * expired_timers)
1267 u32 connection_index, timer_id;
1269 for (i = 0; i < vec_len (expired_timers); i++)
1271 /* Get session index and timer id */
1272 connection_index = expired_timers[i] & 0x0FFFFFFF;
1273 timer_id = expired_timers[i] >> 28;
1275 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1277 /* Handle expiration */
1278 (*timer_expiration_handlers[timer_id]) (connection_index);
1283 tcp_initialize_timer_wheels (tcp_main_t * tm)
1285 tw_timer_wheel_16t_2w_512sl_t *tw;
1287 foreach_vlib_main (({
1288 tw = &tm->timer_wheels[ii];
1289 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1290 100e-3 /* timer period 100ms */ , ~0);
1291 tw->last_run_time = vlib_time_now (this_vlib_main);
1297 tcp_main_enable (vlib_main_t * vm)
1299 tcp_main_t *tm = vnet_get_tcp_main ();
1300 ip_protocol_info_t *pi;
1301 ip_main_t *im = &ip_main;
1302 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1303 clib_error_t *error = 0;
1306 tcp_connection_t *tc __attribute__ ((unused));
1307 u32 preallocated_connections_per_thread;
1309 if ((error = vlib_call_init_function (vm, ip_main_init)))
1311 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1313 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1320 /* Register with IP */
1321 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1323 return clib_error_return (0, "TCP protocol info AWOL");
1324 pi->format_header = format_tcp_header;
1325 pi->unformat_pg_edit = unformat_pg_tcp_header;
1327 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1328 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1330 /* Register as transport with session layer */
1331 session_register_transport (TRANSPORT_PROTO_TCP, 1, &tcp_proto);
1332 session_register_transport (TRANSPORT_PROTO_TCP, 0, &tcp_proto);
1335 * Initialize data structures
1338 num_threads = 1 /* main thread */ + vtm->n_threads;
1339 vec_validate (tm->connections, num_threads - 1);
1342 * Preallocate connections. Assume that thread 0 won't
1343 * use preallocated threads when running multi-core
1345 if (num_threads == 1)
1348 preallocated_connections_per_thread = tm->preallocated_connections;
1353 preallocated_connections_per_thread =
1354 tm->preallocated_connections / (num_threads - 1);
1356 for (; thread < num_threads; thread++)
1358 if (preallocated_connections_per_thread)
1359 pool_init_fixed (tm->connections[thread],
1360 preallocated_connections_per_thread);
1364 * Use a preallocated half-open connection pool?
1366 if (tm->preallocated_half_open_connections)
1367 pool_init_fixed (tm->half_open_connections,
1368 tm->preallocated_half_open_connections);
1370 /* Initialize per worker thread tx buffers (used for control messages) */
1371 vec_validate (tm->tx_buffers, num_threads - 1);
1373 /* Initialize timer wheels */
1374 vec_validate (tm->timer_wheels, num_threads - 1);
1375 tcp_initialize_timer_wheels (tm);
1377 /* Initialize clocks per tick for TCP timestamp. Used to compute
1378 * monotonically increasing timestamps. */
1379 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1380 / TCP_TSTAMP_RESOLUTION;
1382 if (tm->local_endpoints_table_buckets == 0)
1383 tm->local_endpoints_table_buckets = 250000;
1384 if (tm->local_endpoints_table_memory == 0)
1385 tm->local_endpoints_table_memory = 512 << 20;
1387 clib_bihash_init_24_8 (&tm->local_endpoints_table, "local endpoint table",
1388 tm->local_endpoints_table_buckets,
1389 tm->local_endpoints_table_memory);
1391 /* Initialize [port-allocator] random number seed */
1392 tm->port_allocator_seed = (u32) clib_cpu_time_now ();
1394 if (num_threads > 1)
1396 clib_spinlock_init (&tm->half_open_lock);
1397 clib_spinlock_init (&tm->local_endpoints_lock);
1400 vec_validate (tm->tx_frames[0], num_threads - 1);
1401 vec_validate (tm->tx_frames[1], num_threads - 1);
1402 vec_validate (tm->ip_lookup_tx_frames[0], num_threads - 1);
1403 vec_validate (tm->ip_lookup_tx_frames[1], num_threads - 1);
1405 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1406 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1408 vec_validate (tm->time_now, num_threads - 1);
1413 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1417 if (tcp_main.is_enabled)
1420 return tcp_main_enable (vm);
1424 tcp_main.is_enabled = 0;
1431 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1433 tcp_main_t *tm = &tcp_main;
1435 tm->punt_unknown4 = is_add;
1437 tm->punt_unknown6 = is_add;
1441 tcp_init (vlib_main_t * vm)
1443 tcp_main_t *tm = vnet_get_tcp_main ();
1445 tcp_api_reference ();
1449 VLIB_INIT_FUNCTION (tcp_init);
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 ();
1457 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1460 (input, "preallocated-connections %d",
1461 &tm->preallocated_connections))
1463 else if (unformat (input, "preallocated-half-open-connections %d",
1464 &tm->preallocated_half_open_connections))
1466 else if (unformat (input, "local-endpoints-table-memory %U",
1467 unformat_memory_size, &tmp))
1469 if (tmp >= 0x100000000)
1470 return clib_error_return (0, "memory size %llx (%lld) too large",
1472 tm->local_endpoints_table_memory = tmp;
1474 else if (unformat (input, "local-endpoints-table-buckets %d",
1475 &tm->local_endpoints_table_buckets))
1480 return clib_error_return (0, "unknown input `%U'",
1481 format_unformat_error, input);
1486 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1490 * \brief Configure an ipv4 source address range
1491 * @param vm vlib_main_t pointer
1492 * @param start first ipv4 address in the source address range
1493 * @param end last ipv4 address in the source address range
1494 * @param table_id VRF / table ID, 0 for the default FIB
1495 * @return 0 if all OK, else an error indication from api_errno.h
1499 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1500 ip4_address_t * start,
1501 ip4_address_t * end, u32 table_id)
1503 tcp_main_t *tm = vnet_get_tcp_main ();
1504 vnet_main_t *vnm = vnet_get_main ();
1505 u32 start_host_byte_order, end_host_byte_order;
1506 fib_prefix_t prefix;
1507 vnet_sw_interface_t *si;
1508 fib_node_index_t fei;
1512 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1513 ip4_address_t * hi_addr, u32 fib_index,
1516 memset (&prefix, 0, sizeof (prefix));
1518 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1520 if (fib_index == ~0)
1521 return VNET_API_ERROR_NO_SUCH_FIB;
1523 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1524 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1526 /* sanity check for reversed args or some such */
1527 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1528 return VNET_API_ERROR_INVALID_ARGUMENT;
1530 /* Lookup the last address, to identify the interface involved */
1532 prefix.fp_proto = FIB_PROTOCOL_IP4;
1533 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1535 fei = fib_table_lookup (fib_index, &prefix);
1537 /* Couldn't find route to destination. Bail out. */
1538 if (fei == FIB_NODE_INDEX_INVALID)
1539 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1541 sw_if_index = fib_entry_get_resolving_interface (fei);
1543 /* Enable proxy arp on the interface */
1544 si = vnet_get_sw_interface (vnm, sw_if_index);
1545 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1547 /* Configure proxy arp across the range */
1548 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1555 dpo_id_t dpo = DPO_INVALID;
1557 vec_add1 (tm->ip4_src_addresses, start[0]);
1559 /* Add local adjacencies for the range */
1561 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1564 prefix.fp_proto = FIB_PROTOCOL_IP4;
1565 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1567 fib_table_entry_special_dpo_update (fib_index,
1570 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1573 start_host_byte_order++;
1574 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1576 while (start_host_byte_order <= end_host_byte_order);
1582 * \brief Configure an ipv6 source address range
1583 * @param vm vlib_main_t pointer
1584 * @param start first ipv6 address in the source address range
1585 * @param end last ipv6 address in the source address range
1586 * @param table_id VRF / table ID, 0 for the default FIB
1587 * @return 0 if all OK, else an error indication from api_errno.h
1591 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1592 ip6_address_t * start,
1593 ip6_address_t * end, u32 table_id)
1595 tcp_main_t *tm = vnet_get_tcp_main ();
1596 fib_prefix_t prefix;
1598 fib_node_index_t fei;
1601 memset (&prefix, 0, sizeof (prefix));
1603 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1605 if (fib_index == ~0)
1606 return VNET_API_ERROR_NO_SUCH_FIB;
1612 dpo_id_t dpo = DPO_INVALID;
1614 /* Remember this address */
1615 vec_add1 (tm->ip6_src_addresses, start[0]);
1617 /* Lookup the prefix, to identify the interface involved */
1618 prefix.fp_len = 128;
1619 prefix.fp_proto = FIB_PROTOCOL_IP6;
1620 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1622 fei = fib_table_lookup (fib_index, &prefix);
1624 /* Couldn't find route to destination. Bail out. */
1625 if (fei == FIB_NODE_INDEX_INVALID)
1626 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1628 sw_if_index = fib_entry_get_resolving_interface (fei);
1630 if (sw_if_index == (u32) ~ 0)
1631 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1633 /* Add a proxy neighbor discovery entry for this address */
1634 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1636 /* Add a receive adjacency for this address */
1637 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1640 fib_table_entry_special_dpo_update (fib_index,
1643 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1646 /* Done with the entire range? */
1647 if (!memcmp (start, end, sizeof (start[0])))
1650 /* Increment the address. DGMS. */
1652 for (i = 15; i >= 0; i--)
1655 if (tmp.as_u8[i] != 0)
1663 static clib_error_t *
1664 tcp_src_address (vlib_main_t * vm,
1665 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1667 ip4_address_t v4start, v4end;
1668 ip6_address_t v6start, v6end;
1674 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1676 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1677 unformat_ip4_address, &v4end))
1679 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1681 memcpy (&v4end, &v4start, sizeof (v4start));
1684 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1685 unformat_ip6_address, &v6end))
1687 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1689 memcpy (&v6end, &v6start, sizeof (v6start));
1692 else if (unformat (input, "fib-table %d", &table_id))
1698 if (!v4set && !v6set)
1699 return clib_error_return (0, "at least one v4 or v6 address required");
1703 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1710 case VNET_API_ERROR_NO_SUCH_FIB:
1711 return clib_error_return (0, "Invalid table-id %d", table_id);
1713 case VNET_API_ERROR_INVALID_ARGUMENT:
1714 return clib_error_return (0, "Invalid address range %U - %U",
1715 format_ip4_address, &v4start,
1716 format_ip4_address, &v4end);
1718 return clib_error_return (0, "error %d", rv);
1724 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1731 case VNET_API_ERROR_NO_SUCH_FIB:
1732 return clib_error_return (0, "Invalid table-id %d", table_id);
1735 return clib_error_return (0, "error %d", rv);
1743 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1745 .path = "tcp src-address",
1746 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1747 .function = tcp_src_address,
1752 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1754 #if TCP_SCOREBOARD_TRACE
1756 scoreboard_trace_elt_t *block;
1762 s = format (s, "scoreboard trace:");
1763 vec_foreach (block, sb->trace)
1765 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1766 block->ack, block->snd_una_max, block->group);
1768 s = format (s, "\n");
1776 static clib_error_t *
1777 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1778 vlib_cli_command_t * cmd_arg)
1780 transport_connection_t *tconn = 0;
1781 tcp_connection_t *tc;
1783 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1785 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1786 TRANSPORT_PROTO_TCP))
1789 return clib_error_return (0, "unknown input `%U'",
1790 format_unformat_error, input);
1793 if (!TCP_SCOREBOARD_TRACE)
1795 vlib_cli_output (vm, "scoreboard tracing not enabled");
1799 tc = tcp_get_connection_from_transport (tconn);
1800 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1801 vlib_cli_output (vm, "%v", s);
1806 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1808 .path = "show tcp scoreboard trace",
1809 .short_help = "show tcp scoreboard trace <connection>",
1810 .function = tcp_show_scoreboard_trace_fn,
1815 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1818 scoreboard_trace_elt_t *trace;
1819 u32 next_ack, left, group, has_new_ack = 0;
1820 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1821 sack_block_t *block;
1826 memset (dummy_tc, 0, sizeof (*dummy_tc));
1827 tcp_connection_timers_init (dummy_tc);
1828 scoreboard_init (&dummy_tc->sack_sb);
1829 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1831 #if TCP_SCOREBOARD_TRACE
1832 trace = tc->sack_sb.trace;
1833 trace_len = vec_len (tc->sack_sb.trace);
1839 for (i = 0; i < trace_len; i++)
1841 if (trace[i].ack != 0)
1843 dummy_tc->snd_una = trace[i].ack - 1448;
1844 dummy_tc->snd_una_max = trace[i].ack;
1849 while (left < trace_len)
1851 group = trace[left].group;
1852 vec_reset_length (dummy_tc->rcv_opts.sacks);
1854 while (trace[left].group == group)
1856 if (trace[left].ack != 0)
1859 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1860 trace[left].ack, trace[left].snd_una_max);
1861 dummy_tc->snd_una_max = trace[left].snd_una_max;
1862 next_ack = trace[left].ack;
1868 s = format (s, "[%u, %u], ", trace[left].start,
1870 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1871 block->start = trace[left].start;
1872 block->end = trace[left].end;
1878 tcp_rcv_sacks (dummy_tc, next_ack);
1880 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1883 s = format (s, "result: %U", format_tcp_scoreboard,
1884 &dummy_tc->sack_sb);
1887 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1892 static clib_error_t *
1893 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1894 vlib_cli_command_t * cmd_arg)
1896 transport_connection_t *tconn = 0;
1897 tcp_connection_t *tc = 0;
1899 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1901 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1902 TRANSPORT_PROTO_TCP))
1905 return clib_error_return (0, "unknown input `%U'",
1906 format_unformat_error, input);
1909 if (!TCP_SCOREBOARD_TRACE)
1911 vlib_cli_output (vm, "scoreboard tracing not enabled");
1915 tc = tcp_get_connection_from_transport (tconn);
1918 vlib_cli_output (vm, "connection not found");
1921 str = tcp_scoreboard_replay (str, tc, 1);
1922 vlib_cli_output (vm, "%v", str);
1927 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1929 .path = "tcp replay scoreboard",
1930 .short_help = "tcp replay scoreboard <connection>",
1931 .function = tcp_scoreboard_trace_fn,
1935 static clib_error_t *
1936 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1937 vlib_cli_command_t * cmd_arg)
1939 tcp_main_t *tm = vnet_get_tcp_main ();
1940 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1941 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1943 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1944 tm->punt_unknown4 ? "enabled" : "disabled");
1945 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1946 tm->punt_unknown6 ? "enabled" : "disabled");
1950 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1952 .path = "show tcp punt",
1953 .short_help = "show tcp punt",
1954 .function = show_tcp_punt_fn,
1959 * fd.io coding-style-patch-verification: ON
1962 * eval: (c-set-style "gnu")