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 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
34 tcp_main_t *tm = &tcp_main;
35 tcp_connection_t *listener;
37 pool_get (tm->listener_pool, listener);
38 memset (listener, 0, sizeof (*listener));
40 listener->c_c_index = listener - tm->listener_pool;
41 listener->c_lcl_port = lcl->port;
45 listener->c_lcl_ip4.as_u32 = lcl->ip.ip4.as_u32;
46 listener->c_is_ip4 = 1;
50 clib_memcpy (&listener->c_lcl_ip6, &lcl->ip.ip6,
51 sizeof (ip6_address_t));
54 listener->c_transport_proto = TRANSPORT_PROTO_TCP;
55 listener->c_s_index = session_index;
56 listener->state = TCP_STATE_LISTEN;
58 tcp_connection_timers_init (listener);
60 TCP_EVT_DBG (TCP_EVT_BIND, listener);
62 return listener->c_c_index;
66 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
68 return tcp_connection_bind (session_index, tep);
72 tcp_connection_unbind (u32 listener_index)
74 tcp_main_t *tm = vnet_get_tcp_main ();
77 tc = pool_elt_at_index (tm->listener_pool, listener_index);
79 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
81 /* Poison the entry */
83 memset (tc, 0xFA, sizeof (*tc));
85 pool_put_index (tm->listener_pool, listener_index);
89 tcp_session_unbind (u32 listener_index)
91 tcp_connection_unbind (listener_index);
95 transport_connection_t *
96 tcp_session_get_listener (u32 listener_index)
98 tcp_main_t *tm = vnet_get_tcp_main ();
100 tc = pool_elt_at_index (tm->listener_pool, listener_index);
101 return &tc->connection;
105 transport_endpoint_del (u32 tepi)
107 tcp_main_t *tm = vnet_get_tcp_main ();
108 clib_spinlock_lock_if_init (&tm->local_endpoints_lock);
109 pool_put_index (tm->local_endpoints, tepi);
110 clib_spinlock_unlock_if_init (&tm->local_endpoints_lock);
113 always_inline transport_endpoint_t *
114 transport_endpoint_new (void)
116 tcp_main_t *tm = vnet_get_tcp_main ();
117 transport_endpoint_t *tep;
118 pool_get (tm->local_endpoints, tep);
123 * Cleanup half-open connection
127 tcp_half_open_connection_del (tcp_connection_t * tc)
129 tcp_main_t *tm = vnet_get_tcp_main ();
130 clib_spinlock_lock_if_init (&tm->half_open_lock);
131 pool_put_index (tm->half_open_connections, tc->c_c_index);
133 memset (tc, 0xFA, sizeof (*tc));
134 clib_spinlock_unlock_if_init (&tm->half_open_lock);
138 * Try to cleanup half-open connection
140 * If called from a thread that doesn't own tc, the call won't have any
143 * @param tc - connection to be cleaned up
144 * @return non-zero if cleanup failed.
147 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
149 /* Make sure this is the owning thread */
150 if (tc->c_thread_index != vlib_get_thread_index ())
152 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH);
153 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
154 tcp_half_open_connection_del (tc);
159 tcp_half_open_connection_new (void)
161 tcp_main_t *tm = vnet_get_tcp_main ();
162 tcp_connection_t *tc = 0;
163 ASSERT (vlib_get_thread_index () == 0);
164 pool_get (tm->half_open_connections, tc);
165 memset (tc, 0, sizeof (*tc));
166 tc->c_c_index = tc - tm->half_open_connections;
171 * Cleans up connection state.
176 tcp_connection_cleanup (tcp_connection_t * tc)
178 tcp_main_t *tm = &tcp_main;
180 transport_endpoint_t *tep;
182 /* Cleanup local endpoint if this was an active connect */
183 tepi = transport_endpoint_lookup (&tm->local_endpoints_table, &tc->c_lcl_ip,
184 clib_net_to_host_u16 (tc->c_lcl_port));
185 if (tepi != TRANSPORT_ENDPOINT_INVALID_INDEX)
187 tep = pool_elt_at_index (tm->local_endpoints, tepi);
188 transport_endpoint_table_del (&tm->local_endpoints_table, tep);
189 transport_endpoint_del (tepi);
192 /* Check if connection is not yet fully established */
193 if (tc->state == TCP_STATE_SYN_SENT)
195 /* Try to remove the half-open connection. If this is not the owning
196 * thread, tc won't be removed. Retransmit or establish timers will
197 * eventually expire and call again cleanup on the right thread. */
198 tcp_half_open_connection_cleanup (tc);
202 int thread_index = tc->c_thread_index;
204 /* Make sure all timers are cleared */
205 tcp_connection_timers_reset (tc);
207 /* Poison the entry */
209 memset (tc, 0xFA, sizeof (*tc));
210 pool_put (tm->connections[thread_index], tc);
215 * Connection removal.
217 * This should be called only once connection enters CLOSED state. Note
218 * that it notifies the session of the removal event, so if the goal is to
219 * just remove the connection, call tcp_connection_cleanup instead.
222 tcp_connection_del (tcp_connection_t * tc)
224 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
225 stream_session_delete_notify (&tc->connection);
226 tcp_connection_cleanup (tc);
230 tcp_connection_new (u8 thread_index)
232 tcp_main_t *tm = vnet_get_tcp_main ();
233 tcp_connection_t *tc;
235 pool_get (tm->connections[thread_index], tc);
236 memset (tc, 0, sizeof (*tc));
237 tc->c_c_index = tc - tm->connections[thread_index];
238 tc->c_thread_index = thread_index;
242 /** Notify session that connection has been reset.
244 * Switch state to closed and wait for session to call cleanup.
247 tcp_connection_reset (tcp_connection_t * tc)
249 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
252 case TCP_STATE_SYN_RCVD:
253 /* Cleanup everything. App wasn't notified yet */
254 stream_session_delete_notify (&tc->connection);
255 tcp_connection_cleanup (tc);
257 case TCP_STATE_SYN_SENT:
258 stream_session_connect_notify (&tc->connection, 1 /* fail */ );
259 tcp_connection_cleanup (tc);
261 case TCP_STATE_ESTABLISHED:
262 case TCP_STATE_CLOSE_WAIT:
263 case TCP_STATE_FIN_WAIT_1:
264 case TCP_STATE_FIN_WAIT_2:
265 case TCP_STATE_CLOSING:
266 tc->state = TCP_STATE_CLOSED;
267 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
269 /* Make sure all timers are cleared */
270 tcp_connection_timers_reset (tc);
271 stream_session_reset_notify (&tc->connection);
273 /* Wait for cleanup from session layer but not forever */
274 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
276 case TCP_STATE_CLOSED:
282 * Begin connection closing procedure.
284 * If at the end the connection is not in CLOSED state, it is not removed.
285 * Instead, we rely on on TCP to advance through state machine to either
286 * 1) LAST_ACK (passive close) whereby when the last ACK is received
287 * tcp_connection_del is called. This notifies session of the delete and
289 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
290 * and cleanup is called.
292 * N.B. Half-close connections are not supported
295 tcp_connection_close (tcp_connection_t * tc)
297 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
299 /* Send/Program FIN if needed and switch state */
302 case TCP_STATE_SYN_SENT:
303 tc->state = TCP_STATE_CLOSED;
305 case TCP_STATE_SYN_RCVD:
307 tc->state = TCP_STATE_FIN_WAIT_1;
309 case TCP_STATE_ESTABLISHED:
310 if (!stream_session_tx_fifo_max_dequeue (&tc->connection))
313 tc->flags |= TCP_CONN_FINPNDG;
314 tc->state = TCP_STATE_FIN_WAIT_1;
316 case TCP_STATE_CLOSE_WAIT:
317 tcp_connection_timers_reset (tc);
319 tc->state = TCP_STATE_LAST_ACK;
320 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
322 case TCP_STATE_FIN_WAIT_1:
323 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
326 TCP_DBG ("state: %u", tc->state);
329 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
331 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
332 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
333 && tc->state == TCP_STATE_CLOSED)
334 tcp_connection_del (tc);
338 tcp_session_close (u32 conn_index, u32 thread_index)
340 tcp_connection_t *tc;
341 tc = tcp_connection_get (conn_index, thread_index);
342 tcp_connection_close (tc);
346 tcp_session_cleanup (u32 conn_index, u32 thread_index)
348 tcp_connection_t *tc;
349 tc = tcp_connection_get (conn_index, thread_index);
350 tcp_connection_timers_reset (tc);
352 /* Wait for the session tx events to clear */
353 tc->state = TCP_STATE_CLOSED;
354 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
355 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
359 ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4)
361 ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
362 ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
363 ip_interface_address_t *ia = 0;
368 foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
370 return ip_interface_address_get_address (lm4, ia);
377 foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
380 rv = ip_interface_address_get_address (lm6, ia);
381 /* Trying to use a link-local ip6 src address is a fool's errand */
382 if (!ip6_address_is_link_local_unicast (rv))
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_vrf);
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 time_now = tcp_time_now ();
579 tc->iss = random_u32 (&time_now);
580 tc->snd_una = tc->iss;
581 tc->snd_nxt = tc->iss + 1;
582 tc->snd_una_max = tc->snd_nxt;
585 /** Initialize tcp connection variables
587 * Should be called after having received a msg from the peer, i.e., a SYN or
588 * a SYNACK, such that connection options have already been exchanged. */
590 tcp_connection_init_vars (tcp_connection_t * tc)
592 tcp_connection_timers_init (tc);
594 scoreboard_init (&tc->sack_sb);
596 if (tc->state == TCP_STATE_SYN_RCVD)
597 tcp_init_snd_vars (tc);
599 // tcp_connection_fib_attach (tc);
603 tcp_connection_open (transport_endpoint_t * rmt)
605 tcp_main_t *tm = vnet_get_tcp_main ();
606 tcp_connection_t *tc;
608 fib_node_index_t fei;
609 u32 sw_if_index, fib_index;
610 ip46_address_t lcl_addr;
614 * Find the local address and allocate port
616 memset (&lcl_addr, 0, sizeof (lcl_addr));
618 /* Find a FIB path to the destination */
619 clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
620 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
621 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
623 fib_index = fib_table_find (prefix.fp_proto, rmt->vrf);
624 if (fib_index == (u32) ~ 0)
626 clib_warning ("no fib table");
630 fei = fib_table_lookup (fib_index, &prefix);
632 /* Couldn't find route to destination. Bail out. */
633 if (fei == FIB_NODE_INDEX_INVALID)
635 clib_warning ("no route to destination");
639 sw_if_index = fib_entry_get_resolving_interface (fei);
641 if (sw_if_index == (u32) ~ 0)
643 clib_warning ("no resolving interface for %U", format_ip46_address,
644 &rmt->ip, IP46_TYPE_IP4);
652 if (vec_len (tm->ip4_src_addresses))
654 index = tm->last_v4_address_rotor++;
655 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
656 tm->last_v4_address_rotor = 0;
657 lcl_addr.ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
661 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
662 lcl_addr.ip4.as_u32 = ip4->as_u32;
670 if (vec_len (tm->ip6_src_addresses))
672 index = tm->last_v6_address_rotor++;
673 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
674 tm->last_v6_address_rotor = 0;
675 clib_memcpy (&lcl_addr.ip6, &tm->ip6_src_addresses[index],
680 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
683 clib_warning ("no routable ip6 addresses on %U",
684 format_vnet_sw_if_index_name, vnet_get_main (),
689 clib_memcpy (&lcl_addr.ip6, ip6, sizeof (*ip6));
693 /* Allocate source port */
694 lcl_port = tcp_allocate_local_port (&lcl_addr);
697 clib_warning ("Failed to allocate src port");
702 * Create connection and send SYN
704 clib_spinlock_lock_if_init (&tm->half_open_lock);
705 tc = tcp_half_open_connection_new ();
706 clib_memcpy (&tc->c_rmt_ip, &rmt->ip, sizeof (ip46_address_t));
707 clib_memcpy (&tc->c_lcl_ip, &lcl_addr, sizeof (ip46_address_t));
708 tc->c_rmt_port = rmt->port;
709 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
710 tc->c_is_ip4 = rmt->is_ip4;
711 tc->c_transport_proto = TRANSPORT_PROTO_TCP;
712 tc->c_vrf = rmt->vrf;
713 /* The other connection vars will be initialized after SYN ACK */
714 tcp_connection_timers_init (tc);
716 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
717 tc->state = TCP_STATE_SYN_SENT;
718 tcp_init_snd_vars (tc);
720 clib_spinlock_unlock_if_init (&tm->half_open_lock);
722 return tc->c_c_index;
726 tcp_session_open (transport_endpoint_t * tep)
728 return tcp_connection_open (tep);
731 const char *tcp_dbg_evt_str[] = {
732 #define _(sym, str) str,
737 const char *tcp_fsm_states[] = {
738 #define _(sym, str) str,
739 foreach_tcp_fsm_state
744 format_tcp_state (u8 * s, va_list * args)
746 u32 state = va_arg (*args, u32);
748 if (state < TCP_N_STATES)
749 s = format (s, "%s", tcp_fsm_states[state]);
751 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
755 const char *tcp_connection_flags_str[] = {
756 #define _(sym, str) str,
757 foreach_tcp_connection_flag
762 format_tcp_connection_flags (u8 * s, va_list * args)
764 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
767 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
768 if (tc->flags & (1 << i))
770 for (i = 0; i < last; i++)
772 if (tc->flags & (1 << i))
773 s = format (s, "%s, ", tcp_connection_flags_str[i]);
776 s = format (s, "%s", tcp_connection_flags_str[last]);
780 const char *tcp_conn_timers[] = {
781 #define _(sym, str) str,
787 format_tcp_timers (u8 * s, va_list * args)
789 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
792 for (i = 0; i < TCP_N_TIMERS; i++)
793 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
797 for (i = 0; i < last; i++)
799 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
800 s = format (s, "%s,", tcp_conn_timers[i]);
804 s = format (s, "%s]", tcp_conn_timers[i]);
812 format_tcp_congestion_status (u8 * s, va_list * args)
814 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
815 if (tcp_in_recovery (tc))
816 s = format (s, "recovery");
817 else if (tcp_in_fastrecovery (tc))
818 s = format (s, "fastrecovery");
820 s = format (s, "none");
825 format_tcp_vars (u8 * s, va_list * args)
827 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
828 s = format (s, " flags: %U timers: %U\n", format_tcp_connection_flags, tc,
829 format_tcp_timers, tc);
830 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
831 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
832 tc->snd_una_max - tc->iss);
833 s = format (s, " rcv_nxt %u rcv_las %u\n",
834 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
835 s = format (s, " snd_wnd %u rcv_wnd %u snd_wl1 %u snd_wl2 %u\n",
836 tc->snd_wnd, tc->rcv_wnd, tc->snd_wl1 - tc->irs,
837 tc->snd_wl2 - tc->iss);
838 s = format (s, " flight size %u send space %u rcv_wnd_av %d\n",
839 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
840 tcp_rcv_wnd_available (tc));
841 s = format (s, " cong %U ", format_tcp_congestion_status, tc);
842 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
843 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
844 s = format (s, " prev_ssthresh %u snd_congestion %u dupack %u",
845 tc->prev_ssthresh, tc->snd_congestion - tc->iss,
847 s = format (s, " limited_transmit %u\n", tc->limited_transmit - tc->iss);
848 s = format (s, " tsecr %u tsecr_last_ack %u\n", tc->rcv_opts.tsecr,
850 s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %u ", tc->rto,
851 tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
852 s = format (s, "rtt_seq %u\n", tc->rtt_seq);
853 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
854 tcp_time_now () - tc->tsval_recent_age);
855 s = format (s, " scoreboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
857 if (vec_len (tc->snd_sacks))
858 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
864 format_tcp_connection_id (u8 * s, va_list * args)
866 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
871 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
872 format_ip4_address, &tc->c_lcl_ip4,
873 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
874 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
878 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
879 format_ip6_address, &tc->c_lcl_ip6,
880 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
881 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
888 format_tcp_connection (u8 * s, va_list * args)
890 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
891 u32 verbose = va_arg (*args, u32);
895 s = format (s, "%-50U", format_tcp_connection_id, tc);
898 s = format (s, "%-15U", format_tcp_state, tc->state);
900 s = format (s, "\n%U", format_tcp_vars, tc);
907 format_tcp_session (u8 * s, va_list * args)
909 u32 tci = va_arg (*args, u32);
910 u32 thread_index = va_arg (*args, u32);
911 u32 verbose = va_arg (*args, u32);
912 tcp_connection_t *tc;
914 tc = tcp_connection_get (tci, thread_index);
916 s = format (s, "%U", format_tcp_connection, tc, verbose);
918 s = format (s, "empty\n");
923 format_tcp_listener_session (u8 * s, va_list * args)
925 u32 tci = va_arg (*args, u32);
926 tcp_connection_t *tc = tcp_listener_get (tci);
927 return format (s, "%U", format_tcp_connection_id, tc);
931 format_tcp_half_open_session (u8 * s, va_list * args)
933 u32 tci = va_arg (*args, u32);
934 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
935 return format (s, "%U", format_tcp_connection_id, tc);
939 format_tcp_sacks (u8 * s, va_list * args)
941 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
942 sack_block_t *sacks = tc->snd_sacks;
946 len = vec_len (sacks);
947 for (i = 0; i < len - 1; i++)
950 s = format (s, " start %u end %u\n", block->start - tc->irs,
951 block->end - tc->irs);
955 block = &sacks[len - 1];
956 s = format (s, " start %u end %u", block->start - tc->irs,
957 block->end - tc->irs);
963 format_tcp_rcv_sacks (u8 * s, va_list * args)
965 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
966 sack_block_t *sacks = tc->rcv_opts.sacks;
970 len = vec_len (sacks);
971 for (i = 0; i < len - 1; i++)
974 s = format (s, " start %u end %u\n", block->start - tc->iss,
975 block->end - tc->iss);
979 block = &sacks[len - 1];
980 s = format (s, " start %u end %u", block->start - tc->iss,
981 block->end - tc->iss);
987 format_tcp_sack_hole (u8 * s, va_list * args)
989 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
990 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
992 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
994 s = format (s, " [%u, %u]", hole->start, hole->end);
999 format_tcp_scoreboard (u8 * s, va_list * args)
1001 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1002 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1003 sack_scoreboard_hole_t *hole;
1004 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1005 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1006 s = format (s, " last_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1007 sb->last_bytes_delivered, sb->high_sacked, sb->snd_una_adv);
1008 s = format (s, " cur_rxt_hole %u high_rxt %u rescue_rxt %u",
1009 sb->cur_rxt_hole, sb->high_rxt, sb->rescue_rxt);
1011 hole = scoreboard_first_hole (sb);
1013 s = format (s, "\n head %u tail %u holes:\n", sb->head, sb->tail);
1017 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1018 hole = scoreboard_next_hole (sb, hole);
1024 transport_connection_t *
1025 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1027 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1028 return &tc->connection;
1031 transport_connection_t *
1032 tcp_half_open_session_get_transport (u32 conn_index)
1034 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1035 return &tc->connection;
1039 * Compute maximum segment size for session layer.
1041 * Since the result needs to be the actual data length, it first computes
1042 * the tcp options to be used in the next burst and subtracts their
1043 * length from the connection's snd_mss.
1046 tcp_session_send_mss (transport_connection_t * trans_conn)
1048 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1050 /* Ensure snd_mss does accurately reflect the amount of data we can push
1051 * in a segment. This also makes sure that options are updated according to
1052 * the current state of the connection. */
1053 tcp_update_snd_mss (tc);
1059 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1061 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1063 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1066 /* If not snd_wnd constrained and we can't write at least a segment,
1067 * don't try at all */
1068 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1069 return snd_space < tc->cwnd ? 0 : snd_space;
1071 /* round down to mss multiple */
1072 return snd_space - (snd_space % tc->snd_mss);
1076 * Compute tx window session is allowed to fill.
1078 * Takes into account available send space, snd_mss and the congestion
1079 * state of the connection. If possible, the value returned is a multiple
1082 * @param tc tcp connection
1083 * @return number of bytes session is allowed to write
1086 tcp_snd_space (tcp_connection_t * tc)
1088 int snd_space, snt_limited;
1090 if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0))
1092 snd_space = tcp_available_output_snd_space (tc);
1094 /* If we haven't gotten dupacks or if we did and have gotten sacked
1095 * bytes then we can still send as per Limited Transmit (RFC3042) */
1096 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1097 && (tcp_opts_sack_permitted (tc)
1098 && tc->sack_sb.last_sacked_bytes == 0)))
1100 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1101 tc->limited_transmit = tc->snd_nxt;
1102 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1104 snt_limited = tc->snd_nxt - tc->limited_transmit;
1105 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1107 return tcp_round_snd_space (tc, snd_space);
1110 if (tcp_in_recovery (tc))
1112 tc->snd_nxt = tc->snd_una_max;
1113 snd_space = tcp_available_snd_wnd (tc) - tc->snd_rxt_bytes
1114 - (tc->snd_una_max - tc->snd_congestion);
1115 if (snd_space <= 0 || (tc->snd_una_max - tc->snd_una) >= tc->snd_wnd)
1117 return tcp_round_snd_space (tc, snd_space);
1120 /* RFC 5681: When previously unsent data is available and the new value of
1121 * cwnd and the receiver's advertised window allow, a TCP SHOULD send 1*SMSS
1122 * bytes of previously unsent data. */
1123 if (tcp_in_fastrecovery (tc) && !tcp_fastrecovery_sent_1_smss (tc))
1125 if (tcp_available_output_snd_space (tc) < tc->snd_mss)
1127 tcp_fastrecovery_1_smss_on (tc);
1135 tcp_session_send_space (transport_connection_t * trans_conn)
1137 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1138 return clib_min (tcp_snd_space (tc),
1139 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1143 tcp_rcv_wnd_available (tcp_connection_t * tc)
1145 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
1149 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1151 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1153 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1155 /* This still works if fast retransmit is on */
1156 return (tc->snd_nxt - tc->snd_una);
1160 const static transport_proto_vft_t tcp_proto = {
1161 .bind = tcp_session_bind,
1162 .unbind = tcp_session_unbind,
1163 .push_header = tcp_push_header,
1164 .get_connection = tcp_session_get_transport,
1165 .get_listener = tcp_session_get_listener,
1166 .get_half_open = tcp_half_open_session_get_transport,
1167 .open = tcp_session_open,
1168 .close = tcp_session_close,
1169 .cleanup = tcp_session_cleanup,
1170 .send_mss = tcp_session_send_mss,
1171 .send_space = tcp_session_send_space,
1172 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1173 .format_connection = format_tcp_session,
1174 .format_listener = format_tcp_listener_session,
1175 .format_half_open = format_tcp_half_open_session,
1180 tcp_timer_keep_handler (u32 conn_index)
1182 u32 thread_index = vlib_get_thread_index ();
1183 tcp_connection_t *tc;
1185 tc = tcp_connection_get (conn_index, thread_index);
1186 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1188 tcp_connection_close (tc);
1192 tcp_timer_establish_handler (u32 conn_index)
1194 tcp_connection_t *tc;
1196 tc = tcp_half_open_connection_get (conn_index);
1199 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1200 stream_session_connect_notify (&tc->connection, 1 /* fail */ );
1201 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1205 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1206 /* note: the connection may have already disappeared */
1207 if (PREDICT_FALSE (tc == 0))
1209 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1210 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1211 /* Start cleanup. App wasn't notified yet so use delete notify as
1212 * opposed to delete to cleanup session layer state. */
1213 stream_session_delete_notify (&tc->connection);
1215 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1216 tcp_connection_cleanup (tc);
1220 tcp_timer_waitclose_handler (u32 conn_index)
1222 u32 thread_index = vlib_get_thread_index ();
1223 tcp_connection_t *tc;
1225 tc = tcp_connection_get (conn_index, thread_index);
1228 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1230 /* Session didn't come back with a close(). Send FIN either way
1231 * and switch to LAST_ACK. */
1232 if (tc->state == TCP_STATE_CLOSE_WAIT)
1234 if (tc->flags & TCP_CONN_FINSNT)
1236 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1240 tc->state = TCP_STATE_LAST_ACK;
1242 /* Make sure we don't wait in LAST ACK forever */
1243 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1245 /* Don't delete the connection yet */
1249 tcp_connection_del (tc);
1253 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1255 tcp_timer_retransmit_handler,
1256 tcp_timer_delack_handler,
1257 tcp_timer_persist_handler,
1258 tcp_timer_keep_handler,
1259 tcp_timer_waitclose_handler,
1260 tcp_timer_retransmit_syn_handler,
1261 tcp_timer_establish_handler
1266 tcp_expired_timers_dispatch (u32 * expired_timers)
1269 u32 connection_index, timer_id;
1271 for (i = 0; i < vec_len (expired_timers); i++)
1273 /* Get session index and timer id */
1274 connection_index = expired_timers[i] & 0x0FFFFFFF;
1275 timer_id = expired_timers[i] >> 28;
1277 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1279 /* Handle expiration */
1280 (*timer_expiration_handlers[timer_id]) (connection_index);
1285 tcp_initialize_timer_wheels (tcp_main_t * tm)
1287 tw_timer_wheel_16t_2w_512sl_t *tw;
1289 foreach_vlib_main (({
1290 tw = &tm->timer_wheels[ii];
1291 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1292 100e-3 /* timer period 100ms */ , ~0);
1293 tw->last_run_time = vlib_time_now (this_vlib_main);
1299 tcp_main_enable (vlib_main_t * vm)
1301 tcp_main_t *tm = vnet_get_tcp_main ();
1302 ip_protocol_info_t *pi;
1303 ip_main_t *im = &ip_main;
1304 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1305 clib_error_t *error = 0;
1308 tcp_connection_t *tc __attribute__ ((unused));
1309 u32 preallocated_connections_per_thread;
1311 if ((error = vlib_call_init_function (vm, ip_main_init)))
1313 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1315 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1322 /* Register with IP */
1323 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1325 return clib_error_return (0, "TCP protocol info AWOL");
1326 pi->format_header = format_tcp_header;
1327 pi->unformat_pg_edit = unformat_pg_tcp_header;
1329 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1330 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1332 /* Register as transport with session layer */
1333 session_register_transport (TRANSPORT_PROTO_TCP, 1, &tcp_proto);
1334 session_register_transport (TRANSPORT_PROTO_TCP, 0, &tcp_proto);
1337 * Initialize data structures
1340 num_threads = 1 /* main thread */ + vtm->n_threads;
1341 vec_validate (tm->connections, num_threads - 1);
1344 * Preallocate connections. Assume that thread 0 won't
1345 * use preallocated threads when running multi-core
1347 if (num_threads == 1)
1350 preallocated_connections_per_thread = tm->preallocated_connections;
1355 preallocated_connections_per_thread =
1356 tm->preallocated_connections / (num_threads - 1);
1358 for (; thread < num_threads; thread++)
1360 if (preallocated_connections_per_thread)
1361 pool_init_fixed (tm->connections[thread],
1362 preallocated_connections_per_thread);
1366 * Use a preallocated half-open connection pool?
1368 if (tm->preallocated_half_open_connections)
1369 pool_init_fixed (tm->half_open_connections,
1370 tm->preallocated_half_open_connections);
1372 /* Initialize per worker thread tx buffers (used for control messages) */
1373 vec_validate (tm->tx_buffers, num_threads - 1);
1375 /* Initialize timer wheels */
1376 vec_validate (tm->timer_wheels, num_threads - 1);
1377 tcp_initialize_timer_wheels (tm);
1379 /* Initialize clocks per tick for TCP timestamp. Used to compute
1380 * monotonically increasing timestamps. */
1381 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1382 / TCP_TSTAMP_RESOLUTION;
1384 if (tm->local_endpoints_table_buckets == 0)
1385 tm->local_endpoints_table_buckets = 250000;
1386 if (tm->local_endpoints_table_memory == 0)
1387 tm->local_endpoints_table_memory = 512 << 20;
1389 clib_bihash_init_24_8 (&tm->local_endpoints_table, "local endpoint table",
1390 tm->local_endpoints_table_buckets,
1391 tm->local_endpoints_table_memory);
1393 /* Initialize [port-allocator] random number seed */
1394 tm->port_allocator_seed = (u32) clib_cpu_time_now ();
1396 if (num_threads > 1)
1398 clib_spinlock_init (&tm->half_open_lock);
1399 clib_spinlock_init (&tm->local_endpoints_lock);
1402 vec_validate (tm->tx_frames[0], num_threads - 1);
1403 vec_validate (tm->tx_frames[1], num_threads - 1);
1404 vec_validate (tm->ip_lookup_tx_frames[0], num_threads - 1);
1405 vec_validate (tm->ip_lookup_tx_frames[1], num_threads - 1);
1407 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1408 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1410 vec_validate (tm->time_now, num_threads - 1);
1415 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1419 if (tcp_main.is_enabled)
1422 return tcp_main_enable (vm);
1426 tcp_main.is_enabled = 0;
1433 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1435 tcp_main_t *tm = &tcp_main;
1437 tm->punt_unknown4 = is_add;
1439 tm->punt_unknown6 = is_add;
1443 tcp_init (vlib_main_t * vm)
1445 tcp_main_t *tm = vnet_get_tcp_main ();
1447 tcp_api_reference ();
1451 VLIB_INIT_FUNCTION (tcp_init);
1453 static clib_error_t *
1454 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1456 tcp_main_t *tm = vnet_get_tcp_main ();
1459 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1462 (input, "preallocated-connections %d",
1463 &tm->preallocated_connections))
1465 else if (unformat (input, "preallocated-half-open-connections %d",
1466 &tm->preallocated_half_open_connections))
1468 else if (unformat (input, "local-endpoints-table-memory %U",
1469 unformat_memory_size, &tmp))
1471 if (tmp >= 0x100000000)
1472 return clib_error_return (0, "memory size %llx (%lld) too large",
1474 tm->local_endpoints_table_memory = tmp;
1476 else if (unformat (input, "local-endpoints-table-buckets %d",
1477 &tm->local_endpoints_table_buckets))
1482 return clib_error_return (0, "unknown input `%U'",
1483 format_unformat_error, input);
1488 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1492 * \brief Configure an ipv4 source address range
1493 * @param vm vlib_main_t pointer
1494 * @param start first ipv4 address in the source address range
1495 * @param end last ipv4 address in the source address range
1496 * @param table_id VRF / table ID, 0 for the default FIB
1497 * @return 0 if all OK, else an error indication from api_errno.h
1501 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1502 ip4_address_t * start,
1503 ip4_address_t * end, u32 table_id)
1505 tcp_main_t *tm = vnet_get_tcp_main ();
1506 vnet_main_t *vnm = vnet_get_main ();
1507 u32 start_host_byte_order, end_host_byte_order;
1508 fib_prefix_t prefix;
1509 vnet_sw_interface_t *si;
1510 fib_node_index_t fei;
1514 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1515 ip4_address_t * hi_addr, u32 fib_index,
1518 memset (&prefix, 0, sizeof (prefix));
1520 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1522 if (fib_index == ~0)
1523 return VNET_API_ERROR_NO_SUCH_FIB;
1525 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1526 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1528 /* sanity check for reversed args or some such */
1529 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1530 return VNET_API_ERROR_INVALID_ARGUMENT;
1532 /* Lookup the last address, to identify the interface involved */
1534 prefix.fp_proto = FIB_PROTOCOL_IP4;
1535 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1537 fei = fib_table_lookup (fib_index, &prefix);
1539 /* Couldn't find route to destination. Bail out. */
1540 if (fei == FIB_NODE_INDEX_INVALID)
1541 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1543 sw_if_index = fib_entry_get_resolving_interface (fei);
1545 /* Enable proxy arp on the interface */
1546 si = vnet_get_sw_interface (vnm, sw_if_index);
1547 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1549 /* Configure proxy arp across the range */
1550 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1557 dpo_id_t dpo = DPO_INVALID;
1559 vec_add1 (tm->ip4_src_addresses, start[0]);
1561 /* Add local adjacencies for the range */
1563 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1566 prefix.fp_proto = FIB_PROTOCOL_IP4;
1567 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1569 fib_table_entry_special_dpo_update (fib_index,
1572 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1575 start_host_byte_order++;
1576 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1578 while (start_host_byte_order <= end_host_byte_order);
1584 * \brief Configure an ipv6 source address range
1585 * @param vm vlib_main_t pointer
1586 * @param start first ipv6 address in the source address range
1587 * @param end last ipv6 address in the source address range
1588 * @param table_id VRF / table ID, 0 for the default FIB
1589 * @return 0 if all OK, else an error indication from api_errno.h
1593 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1594 ip6_address_t * start,
1595 ip6_address_t * end, u32 table_id)
1597 tcp_main_t *tm = vnet_get_tcp_main ();
1598 fib_prefix_t prefix;
1600 fib_node_index_t fei;
1603 memset (&prefix, 0, sizeof (prefix));
1605 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1607 if (fib_index == ~0)
1608 return VNET_API_ERROR_NO_SUCH_FIB;
1614 dpo_id_t dpo = DPO_INVALID;
1616 /* Remember this address */
1617 vec_add1 (tm->ip6_src_addresses, start[0]);
1619 /* Lookup the prefix, to identify the interface involved */
1620 prefix.fp_len = 128;
1621 prefix.fp_proto = FIB_PROTOCOL_IP6;
1622 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1624 fei = fib_table_lookup (fib_index, &prefix);
1626 /* Couldn't find route to destination. Bail out. */
1627 if (fei == FIB_NODE_INDEX_INVALID)
1628 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1630 sw_if_index = fib_entry_get_resolving_interface (fei);
1632 if (sw_if_index == (u32) ~ 0)
1633 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1635 /* Add a proxy neighbor discovery entry for this address */
1636 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1638 /* Add a receive adjacency for this address */
1639 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1642 fib_table_entry_special_dpo_update (fib_index,
1645 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1648 /* Done with the entire range? */
1649 if (!memcmp (start, end, sizeof (start[0])))
1652 /* Increment the address. DGMS. */
1654 for (i = 15; i >= 0; i--)
1657 if (tmp.as_u8[i] != 0)
1665 static clib_error_t *
1666 tcp_src_address (vlib_main_t * vm,
1667 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1669 ip4_address_t v4start, v4end;
1670 ip6_address_t v6start, v6end;
1676 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1678 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1679 unformat_ip4_address, &v4end))
1681 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1683 memcpy (&v4end, &v4start, sizeof (v4start));
1686 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1687 unformat_ip6_address, &v6end))
1689 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1691 memcpy (&v6end, &v6start, sizeof (v6start));
1694 else if (unformat (input, "fib-table %d", &table_id))
1700 if (!v4set && !v6set)
1701 return clib_error_return (0, "at least one v4 or v6 address required");
1705 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1712 case VNET_API_ERROR_NO_SUCH_FIB:
1713 return clib_error_return (0, "Invalid table-id %d", table_id);
1715 case VNET_API_ERROR_INVALID_ARGUMENT:
1716 return clib_error_return (0, "Invalid address range %U - %U",
1717 format_ip4_address, &v4start,
1718 format_ip4_address, &v4end);
1720 return clib_error_return (0, "error %d", rv);
1726 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1733 case VNET_API_ERROR_NO_SUCH_FIB:
1734 return clib_error_return (0, "Invalid table-id %d", table_id);
1737 return clib_error_return (0, "error %d", rv);
1745 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1747 .path = "tcp src-address",
1748 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1749 .function = tcp_src_address,
1754 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1756 #if TCP_SCOREBOARD_TRACE
1758 scoreboard_trace_elt_t *block;
1764 s = format (s, "scoreboard trace:");
1765 vec_foreach (block, sb->trace)
1767 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1768 block->ack, block->snd_una_max, block->group);
1770 s = format (s, "\n");
1778 static clib_error_t *
1779 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1780 vlib_cli_command_t * cmd_arg)
1782 transport_connection_t *tconn = 0;
1783 tcp_connection_t *tc;
1785 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1787 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1788 TRANSPORT_PROTO_TCP))
1791 return clib_error_return (0, "unknown input `%U'",
1792 format_unformat_error, input);
1795 if (!TCP_SCOREBOARD_TRACE)
1797 vlib_cli_output (vm, "scoreboard tracing not enabled");
1801 tc = tcp_get_connection_from_transport (tconn);
1802 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1803 vlib_cli_output (vm, "%v", s);
1808 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1810 .path = "show tcp scoreboard trace",
1811 .short_help = "show tcp scoreboard trace <connection>",
1812 .function = tcp_show_scoreboard_trace_fn,
1817 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1820 scoreboard_trace_elt_t *trace;
1821 u32 next_ack, left, group, has_new_ack = 0;
1822 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1823 sack_block_t *block;
1828 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);
1841 for (i = 0; i < trace_len; i++)
1843 if (trace[i].ack != 0)
1845 dummy_tc->snd_una = trace[i].ack - 1448;
1846 dummy_tc->snd_una_max = trace[i].ack;
1851 while (left < trace_len)
1853 group = trace[left].group;
1854 vec_reset_length (dummy_tc->rcv_opts.sacks);
1856 while (trace[left].group == group)
1858 if (trace[left].ack != 0)
1861 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1862 trace[left].ack, trace[left].snd_una_max);
1863 dummy_tc->snd_una_max = trace[left].snd_una_max;
1864 next_ack = trace[left].ack;
1870 s = format (s, "[%u, %u], ", trace[left].start,
1872 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1873 block->start = trace[left].start;
1874 block->end = trace[left].end;
1880 tcp_rcv_sacks (dummy_tc, next_ack);
1882 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1885 s = format (s, "result: %U", format_tcp_scoreboard,
1886 &dummy_tc->sack_sb);
1889 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1894 static clib_error_t *
1895 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1896 vlib_cli_command_t * cmd_arg)
1898 transport_connection_t *tconn = 0;
1899 tcp_connection_t *tc = 0;
1901 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1903 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1904 TRANSPORT_PROTO_TCP))
1907 return clib_error_return (0, "unknown input `%U'",
1908 format_unformat_error, input);
1911 if (!TCP_SCOREBOARD_TRACE)
1913 vlib_cli_output (vm, "scoreboard tracing not enabled");
1917 tc = tcp_get_connection_from_transport (tconn);
1920 vlib_cli_output (vm, "connection not found");
1923 str = tcp_scoreboard_replay (str, tc, 1);
1924 vlib_cli_output (vm, "%v", str);
1929 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1931 .path = "tcp replay scoreboard",
1932 .short_help = "tcp replay scoreboard <connection>",
1933 .function = tcp_scoreboard_trace_fn,
1937 static clib_error_t *
1938 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1939 vlib_cli_command_t * cmd_arg)
1941 tcp_main_t *tm = vnet_get_tcp_main ();
1942 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1943 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1945 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1946 tm->punt_unknown4 ? "enabled" : "disabled");
1947 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1948 tm->punt_unknown6 ? "enabled" : "disabled");
1952 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1954 .path = "show tcp punt",
1955 .short_help = "show tcp punt",
1956 .function = show_tcp_punt_fn,
1961 * fd.io coding-style-patch-verification: ON
1964 * eval: (c-set-style "gnu")