2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 * @brief TCP host stack utilities
21 #include <vnet/tcp/tcp.h>
22 #include <vnet/session/session.h>
23 #include <vnet/fib/fib.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/dpo/receive_dpo.h>
26 #include <vnet/ip/ip6_neighbor.h>
33 fib_protocol_t nh_proto;
34 vnet_link_t link_type;
38 } tcp_add_del_adj_args_t;
41 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
46 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
51 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
53 if (ai != ADJ_INDEX_INVALID)
59 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
61 tcp_add_del_adj_args_t args = {
62 .nh_proto = FIB_PROTOCOL_IP6,
63 .link_type = VNET_LINK_IP6,
65 .sw_if_index = tc->sw_if_index,
68 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
73 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
75 tcp_main_t *tm = &tcp_main;
76 tcp_connection_t *listener;
79 pool_get (tm->listener_pool, listener);
80 clib_memset (listener, 0, sizeof (*listener));
82 listener->c_c_index = listener - tm->listener_pool;
83 listener->c_lcl_port = lcl->port;
85 /* If we are provided a sw_if_index, bind using one of its ips */
86 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
88 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
90 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
92 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
93 listener->c_is_ip4 = lcl->is_ip4;
94 listener->c_proto = TRANSPORT_PROTO_TCP;
95 listener->c_s_index = session_index;
96 listener->c_fib_index = lcl->fib_index;
97 listener->state = TCP_STATE_LISTEN;
99 tcp_connection_timers_init (listener);
101 TCP_EVT_DBG (TCP_EVT_BIND, listener);
103 return listener->c_c_index;
107 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
109 return tcp_connection_bind (session_index, tep);
113 tcp_connection_unbind (u32 listener_index)
115 tcp_main_t *tm = vnet_get_tcp_main ();
116 tcp_connection_t *tc;
118 tc = pool_elt_at_index (tm->listener_pool, listener_index);
120 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
122 /* Poison the entry */
124 clib_memset (tc, 0xFA, sizeof (*tc));
126 pool_put_index (tm->listener_pool, listener_index);
130 tcp_session_unbind (u32 listener_index)
132 tcp_connection_unbind (listener_index);
136 static transport_connection_t *
137 tcp_session_get_listener (u32 listener_index)
139 tcp_main_t *tm = vnet_get_tcp_main ();
140 tcp_connection_t *tc;
141 tc = pool_elt_at_index (tm->listener_pool, listener_index);
142 return &tc->connection;
146 * Cleanup half-open connection
150 tcp_half_open_connection_del (tcp_connection_t * tc)
152 tcp_main_t *tm = vnet_get_tcp_main ();
153 clib_spinlock_lock_if_init (&tm->half_open_lock);
154 pool_put_index (tm->half_open_connections, tc->c_c_index);
156 clib_memset (tc, 0xFA, sizeof (*tc));
157 clib_spinlock_unlock_if_init (&tm->half_open_lock);
161 * Try to cleanup half-open connection
163 * If called from a thread that doesn't own tc, the call won't have any
166 * @param tc - connection to be cleaned up
167 * @return non-zero if cleanup failed.
170 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
172 /* Make sure this is the owning thread */
173 if (tc->c_thread_index != vlib_get_thread_index ())
175 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH);
176 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
177 tcp_half_open_connection_del (tc);
181 static tcp_connection_t *
182 tcp_half_open_connection_new (void)
184 tcp_main_t *tm = vnet_get_tcp_main ();
185 tcp_connection_t *tc = 0;
186 ASSERT (vlib_get_thread_index () == 0);
187 pool_get (tm->half_open_connections, tc);
188 clib_memset (tc, 0, sizeof (*tc));
189 tc->c_c_index = tc - tm->half_open_connections;
194 * Cleans up connection state.
199 tcp_connection_cleanup (tcp_connection_t * tc)
201 tcp_main_t *tm = &tcp_main;
203 /* Cleanup local endpoint if this was an active connect */
204 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
207 /* Check if connection is not yet fully established */
208 if (tc->state == TCP_STATE_SYN_SENT)
210 /* Try to remove the half-open connection. If this is not the owning
211 * thread, tc won't be removed. Retransmit or establish timers will
212 * eventually expire and call again cleanup on the right thread. */
213 if (tcp_half_open_connection_cleanup (tc))
214 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
218 int thread_index = tc->c_thread_index;
220 /* Make sure all timers are cleared */
221 tcp_connection_timers_reset (tc);
223 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
224 tcp_add_del_adjacency (tc, 0);
226 /* Poison the entry */
228 clib_memset (tc, 0xFA, sizeof (*tc));
229 pool_put (tm->connections[thread_index], tc);
234 * Connection removal.
236 * This should be called only once connection enters CLOSED state. Note
237 * that it notifies the session of the removal event, so if the goal is to
238 * just remove the connection, call tcp_connection_cleanup instead.
241 tcp_connection_del (tcp_connection_t * tc)
243 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
244 stream_session_delete_notify (&tc->connection);
245 tcp_connection_cleanup (tc);
249 tcp_connection_new (u8 thread_index)
251 tcp_main_t *tm = vnet_get_tcp_main ();
252 tcp_connection_t *tc;
254 pool_get (tm->connections[thread_index], tc);
255 clib_memset (tc, 0, sizeof (*tc));
256 tc->c_c_index = tc - tm->connections[thread_index];
257 tc->c_thread_index = thread_index;
261 /** Notify session that connection has been reset.
263 * Switch state to closed and wait for session to call cleanup.
266 tcp_connection_reset (tcp_connection_t * tc)
268 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
271 case TCP_STATE_SYN_RCVD:
272 /* Cleanup everything. App wasn't notified yet */
273 stream_session_delete_notify (&tc->connection);
274 tcp_connection_cleanup (tc);
276 case TCP_STATE_SYN_SENT:
277 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
278 tcp_connection_cleanup (tc);
280 case TCP_STATE_ESTABLISHED:
281 tcp_connection_timers_reset (tc);
282 /* Set the cleanup timer, in case the session layer/app don't
283 * cleanly close the connection */
284 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
285 stream_session_reset_notify (&tc->connection);
287 case TCP_STATE_CLOSE_WAIT:
288 case TCP_STATE_FIN_WAIT_1:
289 case TCP_STATE_FIN_WAIT_2:
290 case TCP_STATE_CLOSING:
291 tc->state = TCP_STATE_CLOSED;
292 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
293 tcp_connection_timers_reset (tc);
294 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
296 case TCP_STATE_CLOSED:
302 * Begin connection closing procedure.
304 * If at the end the connection is not in CLOSED state, it is not removed.
305 * Instead, we rely on on TCP to advance through state machine to either
306 * 1) LAST_ACK (passive close) whereby when the last ACK is received
307 * tcp_connection_del is called. This notifies session of the delete and
309 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
310 * and cleanup is called.
312 * N.B. Half-close connections are not supported
315 tcp_connection_close (tcp_connection_t * tc)
317 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
319 /* Send/Program FIN if needed and switch state */
322 case TCP_STATE_SYN_SENT:
323 tc->state = TCP_STATE_CLOSED;
325 case TCP_STATE_SYN_RCVD:
326 tcp_connection_timers_reset (tc);
328 tc->state = TCP_STATE_FIN_WAIT_1;
329 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
331 case TCP_STATE_ESTABLISHED:
332 if (!session_tx_fifo_max_dequeue (&tc->connection))
335 tc->flags |= TCP_CONN_FINPNDG;
336 tc->state = TCP_STATE_FIN_WAIT_1;
338 case TCP_STATE_CLOSE_WAIT:
339 if (!session_tx_fifo_max_dequeue (&tc->connection))
342 tcp_connection_timers_reset (tc);
343 tc->state = TCP_STATE_LAST_ACK;
344 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
347 tc->flags |= TCP_CONN_FINPNDG;
349 case TCP_STATE_FIN_WAIT_1:
350 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
353 TCP_DBG ("state: %u", tc->state);
356 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
358 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
359 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
360 && tc->state == TCP_STATE_CLOSED)
361 tcp_connection_del (tc);
365 tcp_session_close (u32 conn_index, u32 thread_index)
367 tcp_connection_t *tc;
368 tc = tcp_connection_get (conn_index, thread_index);
369 tcp_connection_close (tc);
373 tcp_session_cleanup (u32 conn_index, u32 thread_index)
375 tcp_connection_t *tc;
376 tc = tcp_connection_get (conn_index, thread_index);
377 tcp_connection_timers_reset (tc);
378 tc->state = TCP_STATE_CLOSED;
379 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
380 tcp_connection_cleanup (tc);
384 * Initialize all connection timers as invalid
387 tcp_connection_timers_init (tcp_connection_t * tc)
391 /* Set all to invalid */
392 for (i = 0; i < TCP_N_TIMERS; i++)
394 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
397 tc->rto = TCP_RTO_INIT;
401 * Stop all connection timers
404 tcp_connection_timers_reset (tcp_connection_t * tc)
407 for (i = 0; i < TCP_N_TIMERS; i++)
409 tcp_timer_reset (tc, i);
414 typedef struct ip4_tcp_hdr
420 typedef struct ip6_tcp_hdr
427 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
430 const dpo_id_t *choice;
434 lb = load_balance_get (dpo->dpoi_index);
438 clib_memset (&hdr, 0, sizeof (hdr));
439 hdr.ip.protocol = IP_PROTOCOL_TCP;
440 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
441 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
442 hdr.tcp.src_port = tc->c_lcl_port;
443 hdr.tcp.dst_port = tc->c_rmt_port;
444 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
449 clib_memset (&hdr, 0, sizeof (hdr));
450 hdr.ip.protocol = IP_PROTOCOL_TCP;
451 clib_memcpy (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
452 sizeof (ip6_address_t));
453 clib_memcpy (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
454 sizeof (ip6_address_t));
455 hdr.tcp.src_port = tc->c_lcl_port;
456 hdr.tcp.dst_port = tc->c_rmt_port;
457 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
459 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
460 dpo_copy (result, choice);
464 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
469 clib_memcpy (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
470 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
471 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
472 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
473 return fib_table_lookup (fib_index, &prefix);
477 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
479 dpo_id_t choice = DPO_INVALID;
480 u32 output_node_index;
483 fe = fib_entry_get (tc->c_rmt_fei);
484 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
487 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
490 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
491 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
495 /** Stack tcp connection on peer's fib entry.
497 * This ultimately populates the dpo the connection will use to send packets.
500 tcp_connection_fib_attach (tcp_connection_t * tc)
502 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
504 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
506 tcp_connection_stack_on_fib_entry (tc);
511 tcp_cc_init (tcp_connection_t * tc)
513 tc->cc_algo = tcp_cc_algo_get (TCP_CC_NEWRENO);
514 tc->cc_algo->init (tc);
518 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
519 const tcp_cc_algorithm_t * vft)
521 tcp_main_t *tm = vnet_get_tcp_main ();
522 vec_validate (tm->cc_algos, type);
524 tm->cc_algos[type] = *vft;
528 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
530 tcp_main_t *tm = vnet_get_tcp_main ();
531 return &tm->cc_algos[type];
536 * Initialize connection send variables.
539 tcp_init_snd_vars (tcp_connection_t * tc)
544 * We use the time to randomize iss and for setting up the initial
545 * timestamp. Make sure it's updated otherwise syn and ack in the
546 * handshake may make it look as if time has flown in the opposite
549 tcp_set_time_now (vlib_get_thread_index ());
550 time_now = tcp_time_now ();
552 tc->iss = random_u32 (&time_now);
553 tc->snd_una = tc->iss;
554 tc->snd_nxt = tc->iss + 1;
555 tc->snd_una_max = tc->snd_nxt;
559 tcp_enable_pacing (tcp_connection_t * tc)
561 u32 initial_bucket, byte_rate;
562 initial_bucket = 16 * tc->snd_mss;
564 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
566 tc->mrtt_us = (u32) ~ 0;
569 /** Initialize tcp connection variables
571 * Should be called after having received a msg from the peer, i.e., a SYN or
572 * a SYNACK, such that connection options have already been exchanged. */
574 tcp_connection_init_vars (tcp_connection_t * tc)
576 tcp_connection_timers_init (tc);
578 scoreboard_init (&tc->sack_sb);
580 if (tc->state == TCP_STATE_SYN_RCVD)
581 tcp_init_snd_vars (tc);
583 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
584 tcp_add_del_adjacency (tc, 1);
586 /* tcp_connection_fib_attach (tc); */
588 if (transport_connection_is_tx_paced (&tc->connection)
589 || tcp_main.tx_pacing)
590 tcp_enable_pacing (tc);
594 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
595 u16 * lcl_port, u8 is_ip4)
600 index = tm->last_v4_address_rotor++;
601 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
602 tm->last_v4_address_rotor = 0;
603 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
607 index = tm->last_v6_address_rotor++;
608 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
609 tm->last_v6_address_rotor = 0;
610 clib_memcpy (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
611 sizeof (ip6_address_t));
613 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
616 clib_warning ("Failed to allocate src port");
624 tcp_session_open (transport_endpoint_cfg_t * rmt)
626 tcp_main_t *tm = vnet_get_tcp_main ();
627 tcp_connection_t *tc;
628 ip46_address_t lcl_addr;
633 * Allocate local endpoint
635 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
636 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
637 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
640 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
641 rmt, &lcl_addr, &lcl_port);
647 * Create connection and send SYN
649 clib_spinlock_lock_if_init (&tm->half_open_lock);
650 tc = tcp_half_open_connection_new ();
651 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
652 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
653 tc->c_rmt_port = rmt->port;
654 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
655 tc->c_is_ip4 = rmt->is_ip4;
656 tc->c_proto = TRANSPORT_PROTO_TCP;
657 tc->c_fib_index = rmt->fib_index;
658 /* The other connection vars will be initialized after SYN ACK */
659 tcp_connection_timers_init (tc);
661 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
662 tc->state = TCP_STATE_SYN_SENT;
663 tcp_init_snd_vars (tc);
665 clib_spinlock_unlock_if_init (&tm->half_open_lock);
667 return tc->c_c_index;
670 const char *tcp_dbg_evt_str[] = {
671 #define _(sym, str) str,
676 const char *tcp_fsm_states[] = {
677 #define _(sym, str) str,
678 foreach_tcp_fsm_state
683 format_tcp_state (u8 * s, va_list * args)
685 u32 state = va_arg (*args, u32);
687 if (state < TCP_N_STATES)
688 s = format (s, "%s", tcp_fsm_states[state]);
690 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
694 const char *tcp_connection_flags_str[] = {
695 #define _(sym, str) str,
696 foreach_tcp_connection_flag
701 format_tcp_connection_flags (u8 * s, va_list * args)
703 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
706 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
707 if (tc->flags & (1 << i))
709 for (i = 0; i < last; i++)
711 if (tc->flags & (1 << i))
712 s = format (s, "%s, ", tcp_connection_flags_str[i]);
715 s = format (s, "%s", tcp_connection_flags_str[last]);
719 const char *tcp_conn_timers[] = {
720 #define _(sym, str) str,
726 format_tcp_timers (u8 * s, va_list * args)
728 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
731 for (i = 0; i < TCP_N_TIMERS; i++)
732 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
735 for (i = 0; i < last; i++)
737 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
738 s = format (s, "%s,", tcp_conn_timers[i]);
742 s = format (s, "%s", tcp_conn_timers[i]);
748 format_tcp_congestion_status (u8 * s, va_list * args)
750 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
751 if (tcp_in_recovery (tc))
752 s = format (s, "recovery");
753 else if (tcp_in_fastrecovery (tc))
754 s = format (s, "fastrecovery");
756 s = format (s, "none");
761 tcp_rcv_wnd_available (tcp_connection_t * tc)
763 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
767 format_tcp_congestion (u8 * s, va_list * args)
769 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
770 u32 indent = format_get_indent (s);
772 s = format (s, "%U ", format_tcp_congestion_status, tc);
773 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
774 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
775 s = format (s, "%Ucc space %u prev_ssthresh %u snd_congestion %u"
776 " dupack %u\n", format_white_space, indent,
777 tcp_available_cc_snd_space (tc), tc->prev_ssthresh,
778 tc->snd_congestion - tc->iss, tc->rcv_dupacks);
779 s = format (s, "%Utsecr %u tsecr_last_ack %u limited_transmit %u\n",
780 format_white_space, indent, tc->rcv_opts.tsecr,
781 tc->tsecr_last_ack, tc->limited_transmit - tc->iss);
786 format_tcp_vars (u8 * s, va_list * args)
788 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
789 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
790 format_tcp_connection_flags, tc, format_tcp_timers, tc);
791 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
792 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
793 tc->snd_una_max - tc->iss);
794 s = format (s, " rcv_nxt %u rcv_las %u\n",
795 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
796 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
797 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
798 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
799 tc->snd_wl2 - tc->iss);
800 s = format (s, " flight size %u out space %u rcv_wnd_av %u\n",
801 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
802 tcp_rcv_wnd_available (tc));
803 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
804 tcp_time_now () - tc->tsval_recent_age);
805 s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %2.5f ",
806 tc->rto, tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
807 s = format (s, "rtt_seq %u\n", tc->rtt_seq - tc->iss);
808 s = format (s, " cong: %U", format_tcp_congestion, tc);
810 if (tc->state >= TCP_STATE_ESTABLISHED)
812 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
815 if (vec_len (tc->snd_sacks))
816 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
822 format_tcp_connection_id (u8 * s, va_list * args)
824 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
829 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
830 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
831 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
832 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
836 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
837 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
838 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
839 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
846 format_tcp_connection (u8 * s, va_list * args)
848 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
849 u32 verbose = va_arg (*args, u32);
853 s = format (s, "%-50U", format_tcp_connection_id, tc);
856 s = format (s, "%-15U", format_tcp_state, tc->state);
858 s = format (s, "\n%U", format_tcp_vars, tc);
865 format_tcp_session (u8 * s, va_list * args)
867 u32 tci = va_arg (*args, u32);
868 u32 thread_index = va_arg (*args, u32);
869 u32 verbose = va_arg (*args, u32);
870 tcp_connection_t *tc;
872 tc = tcp_connection_get (tci, thread_index);
874 s = format (s, "%U", format_tcp_connection, tc, verbose);
876 s = format (s, "empty\n");
881 format_tcp_listener_session (u8 * s, va_list * args)
883 u32 tci = va_arg (*args, u32);
884 tcp_connection_t *tc = tcp_listener_get (tci);
885 return format (s, "%U", format_tcp_connection_id, tc);
889 format_tcp_half_open_session (u8 * s, va_list * args)
891 u32 tci = va_arg (*args, u32);
892 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
893 return format (s, "%U", format_tcp_connection_id, tc);
897 format_tcp_sacks (u8 * s, va_list * args)
899 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
900 sack_block_t *sacks = tc->snd_sacks;
904 len = vec_len (sacks);
905 for (i = 0; i < len - 1; i++)
908 s = format (s, " start %u end %u\n", block->start - tc->irs,
909 block->end - tc->irs);
913 block = &sacks[len - 1];
914 s = format (s, " start %u end %u", block->start - tc->irs,
915 block->end - tc->irs);
921 format_tcp_rcv_sacks (u8 * s, va_list * args)
923 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
924 sack_block_t *sacks = tc->rcv_opts.sacks;
928 len = vec_len (sacks);
929 for (i = 0; i < len - 1; i++)
932 s = format (s, " start %u end %u\n", block->start - tc->iss,
933 block->end - tc->iss);
937 block = &sacks[len - 1];
938 s = format (s, " start %u end %u", block->start - tc->iss,
939 block->end - tc->iss);
945 format_tcp_sack_hole (u8 * s, va_list * args)
947 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
948 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
950 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
952 s = format (s, " [%u, %u]", hole->start, hole->end);
957 format_tcp_scoreboard (u8 * s, va_list * args)
959 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
960 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
961 sack_scoreboard_hole_t *hole;
962 u32 indent = format_get_indent (s);
964 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
965 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
966 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
967 format_white_space, indent, sb->last_bytes_delivered,
968 sb->high_sacked - tc->iss, sb->snd_una_adv);
969 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
970 format_white_space, indent, sb->cur_rxt_hole,
971 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
973 hole = scoreboard_first_hole (sb);
975 s = format (s, "\n%Uhead %u tail %u %u holes:\n", format_white_space,
976 indent, sb->head, sb->tail, pool_elts (sb->holes));
980 s = format (s, "%U%U", format_white_space, indent, format_tcp_sack_hole,
982 hole = scoreboard_next_hole (sb, hole);
988 static transport_connection_t *
989 tcp_session_get_transport (u32 conn_index, u32 thread_index)
991 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
992 return &tc->connection;
995 static transport_connection_t *
996 tcp_half_open_session_get_transport (u32 conn_index)
998 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
999 return &tc->connection;
1003 * Compute maximum segment size for session layer.
1005 * Since the result needs to be the actual data length, it first computes
1006 * the tcp options to be used in the next burst and subtracts their
1007 * length from the connection's snd_mss.
1010 tcp_session_send_mss (transport_connection_t * trans_conn)
1012 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1014 /* Ensure snd_mss does accurately reflect the amount of data we can push
1015 * in a segment. This also makes sure that options are updated according to
1016 * the current state of the connection. */
1017 tcp_update_burst_snd_vars (tc);
1023 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1025 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1027 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1030 /* If not snd_wnd constrained and we can't write at least a segment,
1031 * don't try at all */
1032 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1033 return snd_space < tc->cwnd ? 0 : snd_space;
1035 /* round down to mss multiple */
1036 return snd_space - (snd_space % tc->snd_mss);
1040 * Compute tx window session is allowed to fill.
1042 * Takes into account available send space, snd_mss and the congestion
1043 * state of the connection. If possible, the value returned is a multiple
1046 * @param tc tcp connection
1047 * @return number of bytes session is allowed to write
1050 tcp_snd_space_inline (tcp_connection_t * tc)
1052 int snd_space, snt_limited;
1054 if (PREDICT_TRUE (!tcp_in_fastrecovery (tc)))
1056 snd_space = tcp_available_output_snd_space (tc);
1058 /* If we haven't gotten dupacks or if we did and have gotten sacked
1059 * bytes then we can still send as per Limited Transmit (RFC3042) */
1060 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1061 && (tcp_opts_sack_permitted (tc)
1062 && tc->sack_sb.last_sacked_bytes == 0)))
1064 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1065 tc->limited_transmit = tc->snd_nxt;
1066 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1068 snt_limited = tc->snd_nxt - tc->limited_transmit;
1069 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1071 return tcp_round_snd_space (tc, snd_space);
1074 /* RFC 5681: When previously unsent data is available and the new value of
1075 * cwnd and the receiver's advertised window allow, a TCP SHOULD send 1*SMSS
1076 * bytes of previously unsent data. */
1077 if (tcp_in_fastrecovery (tc) && !tcp_fastrecovery_sent_1_smss (tc))
1079 if (tcp_available_cc_snd_space (tc) < tc->snd_mss)
1081 tcp_fastrecovery_1_smss_on (tc);
1089 tcp_snd_space (tcp_connection_t * tc)
1091 return tcp_snd_space_inline (tc);
1095 tcp_session_send_space (transport_connection_t * trans_conn)
1097 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1098 return clib_min (tcp_snd_space_inline (tc),
1099 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1103 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1105 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1107 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1109 /* This still works if fast retransmit is on */
1110 return (tc->snd_nxt - tc->snd_una);
1114 tcp_update_time (f64 now, u8 thread_index)
1116 tcp_set_time_now (thread_index);
1117 tw_timer_expire_timers_16t_2w_512sl (&tcp_main.
1118 wrk_ctx[thread_index].timer_wheel,
1120 tcp_do_fastretransmits (thread_index);
1121 tcp_flush_frames_to_output (thread_index);
1125 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1127 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1128 return tcp_push_header (tc, b);
1132 const static transport_proto_vft_t tcp_proto = {
1133 .enable = vnet_tcp_enable_disable,
1134 .bind = tcp_session_bind,
1135 .unbind = tcp_session_unbind,
1136 .push_header = tcp_session_push_header,
1137 .get_connection = tcp_session_get_transport,
1138 .get_listener = tcp_session_get_listener,
1139 .get_half_open = tcp_half_open_session_get_transport,
1140 .open = tcp_session_open,
1141 .close = tcp_session_close,
1142 .cleanup = tcp_session_cleanup,
1143 .send_mss = tcp_session_send_mss,
1144 .send_space = tcp_session_send_space,
1145 .update_time = tcp_update_time,
1146 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1147 .format_connection = format_tcp_session,
1148 .format_listener = format_tcp_listener_session,
1149 .format_half_open = format_tcp_half_open_session,
1150 .tx_type = TRANSPORT_TX_PEEK,
1151 .service_type = TRANSPORT_SERVICE_VC,
1156 tcp_update_pacer (tcp_connection_t * tc)
1160 if (!transport_connection_is_tx_paced (&tc->connection))
1163 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1164 transport_connection_tx_pacer_update (&tc->connection,
1165 ((f64) tc->cwnd) / srtt);
1169 tcp_timer_keep_handler (u32 conn_index)
1171 u32 thread_index = vlib_get_thread_index ();
1172 tcp_connection_t *tc;
1174 tc = tcp_connection_get (conn_index, thread_index);
1175 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1177 tcp_connection_close (tc);
1181 tcp_timer_establish_handler (u32 conn_index)
1183 tcp_connection_t *tc;
1185 tc = tcp_half_open_connection_get (conn_index);
1188 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1189 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1190 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1194 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1195 /* note: the connection may have already disappeared */
1196 if (PREDICT_FALSE (tc == 0))
1198 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1199 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1200 /* Start cleanup. App wasn't notified yet so use delete notify as
1201 * opposed to delete to cleanup session layer state. */
1202 stream_session_delete_notify (&tc->connection);
1204 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1205 tcp_connection_cleanup (tc);
1209 tcp_timer_waitclose_handler (u32 conn_index)
1211 u32 thread_index = vlib_get_thread_index ();
1212 tcp_connection_t *tc;
1214 tc = tcp_connection_get (conn_index, thread_index);
1217 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1219 /* Session didn't come back with a close(). Send FIN either way
1220 * and switch to LAST_ACK. */
1221 if (tc->state == TCP_STATE_CLOSE_WAIT)
1223 if (tc->flags & TCP_CONN_FINSNT)
1225 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1228 /* Make sure we don't try to send unsent data */
1229 tcp_connection_timers_reset (tc);
1230 tcp_cong_recovery_off (tc);
1231 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1233 tc->state = TCP_STATE_LAST_ACK;
1235 /* Make sure we don't wait in LAST ACK forever */
1236 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1238 /* Don't delete the connection yet */
1242 tcp_connection_del (tc);
1246 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1248 tcp_timer_retransmit_handler,
1249 tcp_timer_delack_handler,
1250 tcp_timer_persist_handler,
1251 tcp_timer_keep_handler,
1252 tcp_timer_waitclose_handler,
1253 tcp_timer_retransmit_syn_handler,
1254 tcp_timer_establish_handler
1259 tcp_expired_timers_dispatch (u32 * expired_timers)
1262 u32 connection_index, timer_id;
1264 for (i = 0; i < vec_len (expired_timers); i++)
1266 /* Get session index and timer id */
1267 connection_index = expired_timers[i] & 0x0FFFFFFF;
1268 timer_id = expired_timers[i] >> 28;
1270 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1272 /* Handle expiration */
1273 (*timer_expiration_handlers[timer_id]) (connection_index);
1278 tcp_initialize_timer_wheels (tcp_main_t * tm)
1280 tw_timer_wheel_16t_2w_512sl_t *tw;
1282 foreach_vlib_main (({
1283 tw = &tm->wrk_ctx[ii].timer_wheel;
1284 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1285 100e-3 /* timer period 100ms */ , ~0);
1286 tw->last_run_time = vlib_time_now (this_vlib_main);
1291 static clib_error_t *
1292 tcp_main_enable (vlib_main_t * vm)
1294 tcp_main_t *tm = vnet_get_tcp_main ();
1295 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1296 clib_error_t *error = 0;
1299 tcp_connection_t *tc __attribute__ ((unused));
1300 u32 preallocated_connections_per_thread;
1302 if ((error = vlib_call_init_function (vm, ip_main_init)))
1304 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1306 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1313 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1314 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1317 * Initialize data structures
1320 num_threads = 1 /* main thread */ + vtm->n_threads;
1321 vec_validate (tm->connections, num_threads - 1);
1322 vec_validate (tm->wrk_ctx, num_threads - 1);
1325 * Preallocate connections. Assume that thread 0 won't
1326 * use preallocated threads when running multi-core
1328 if (num_threads == 1)
1331 preallocated_connections_per_thread = tm->preallocated_connections;
1336 preallocated_connections_per_thread =
1337 tm->preallocated_connections / (num_threads - 1);
1339 for (; thread < num_threads; thread++)
1341 if (preallocated_connections_per_thread)
1342 pool_init_fixed (tm->connections[thread],
1343 preallocated_connections_per_thread);
1344 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 0);
1345 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 0);
1346 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 0);
1347 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1348 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1349 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1350 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1354 * Use a preallocated half-open connection pool?
1356 if (tm->preallocated_half_open_connections)
1357 pool_init_fixed (tm->half_open_connections,
1358 tm->preallocated_half_open_connections);
1360 /* Initialize clocks per tick for TCP timestamp. Used to compute
1361 * monotonically increasing timestamps. */
1362 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1363 / TCP_TSTAMP_RESOLUTION;
1365 if (num_threads > 1)
1367 clib_spinlock_init (&tm->half_open_lock);
1370 tcp_initialize_timer_wheels (tm);
1372 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1373 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1379 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1383 if (tcp_main.is_enabled)
1386 return tcp_main_enable (vm);
1390 tcp_main.is_enabled = 0;
1397 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1399 tcp_main_t *tm = &tcp_main;
1401 tm->punt_unknown4 = is_add;
1403 tm->punt_unknown6 = is_add;
1406 static clib_error_t *
1407 tcp_init (vlib_main_t * vm)
1409 tcp_main_t *tm = vnet_get_tcp_main ();
1410 ip_main_t *im = &ip_main;
1411 ip_protocol_info_t *pi;
1413 /* Session layer, and by implication tcp, are disabled by default */
1416 /* Register with IP for header parsing */
1417 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1419 return clib_error_return (0, "TCP protocol info AWOL");
1420 pi->format_header = format_tcp_header;
1421 pi->unformat_pg_edit = unformat_pg_tcp_header;
1423 /* Register as transport with session layer */
1424 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1425 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1426 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1427 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1429 tcp_api_reference ();
1433 VLIB_INIT_FUNCTION (tcp_init);
1435 static clib_error_t *
1436 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1438 tcp_main_t *tm = vnet_get_tcp_main ();
1440 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1442 if (unformat (input, "preallocated-connections %d",
1443 &tm->preallocated_connections))
1445 else if (unformat (input, "preallocated-half-open-connections %d",
1446 &tm->preallocated_half_open_connections))
1448 else if (unformat (input, "buffer-fail-fraction %f",
1449 &tm->buffer_fail_fraction))
1451 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1454 else if (unformat (input, "tx-pacing"))
1457 return clib_error_return (0, "unknown input `%U'",
1458 format_unformat_error, input);
1463 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1467 * \brief Configure an ipv4 source address range
1468 * @param vm vlib_main_t pointer
1469 * @param start first ipv4 address in the source address range
1470 * @param end last ipv4 address in the source address range
1471 * @param table_id VRF / table ID, 0 for the default FIB
1472 * @return 0 if all OK, else an error indication from api_errno.h
1476 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1477 ip4_address_t * start,
1478 ip4_address_t * end, u32 table_id)
1480 tcp_main_t *tm = vnet_get_tcp_main ();
1481 vnet_main_t *vnm = vnet_get_main ();
1482 u32 start_host_byte_order, end_host_byte_order;
1483 fib_prefix_t prefix;
1484 vnet_sw_interface_t *si;
1485 fib_node_index_t fei;
1489 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1490 ip4_address_t * hi_addr, u32 fib_index,
1493 clib_memset (&prefix, 0, sizeof (prefix));
1495 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1497 if (fib_index == ~0)
1498 return VNET_API_ERROR_NO_SUCH_FIB;
1500 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1501 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1503 /* sanity check for reversed args or some such */
1504 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1505 return VNET_API_ERROR_INVALID_ARGUMENT;
1507 /* Lookup the last address, to identify the interface involved */
1509 prefix.fp_proto = FIB_PROTOCOL_IP4;
1510 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1512 fei = fib_table_lookup (fib_index, &prefix);
1514 /* Couldn't find route to destination. Bail out. */
1515 if (fei == FIB_NODE_INDEX_INVALID)
1516 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1518 sw_if_index = fib_entry_get_resolving_interface (fei);
1520 /* Enable proxy arp on the interface */
1521 si = vnet_get_sw_interface (vnm, sw_if_index);
1522 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1524 /* Configure proxy arp across the range */
1525 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1532 dpo_id_t dpo = DPO_INVALID;
1534 vec_add1 (tm->ip4_src_addresses, start[0]);
1536 /* Add local adjacencies for the range */
1538 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1541 prefix.fp_proto = FIB_PROTOCOL_IP4;
1542 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1544 fib_table_entry_special_dpo_update (fib_index,
1547 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1550 start_host_byte_order++;
1551 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1553 while (start_host_byte_order <= end_host_byte_order);
1559 * \brief Configure an ipv6 source address range
1560 * @param vm vlib_main_t pointer
1561 * @param start first ipv6 address in the source address range
1562 * @param end last ipv6 address in the source address range
1563 * @param table_id VRF / table ID, 0 for the default FIB
1564 * @return 0 if all OK, else an error indication from api_errno.h
1568 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1569 ip6_address_t * start,
1570 ip6_address_t * end, u32 table_id)
1572 tcp_main_t *tm = vnet_get_tcp_main ();
1573 fib_prefix_t prefix;
1575 fib_node_index_t fei;
1578 clib_memset (&prefix, 0, sizeof (prefix));
1580 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1582 if (fib_index == ~0)
1583 return VNET_API_ERROR_NO_SUCH_FIB;
1589 dpo_id_t dpo = DPO_INVALID;
1591 /* Remember this address */
1592 vec_add1 (tm->ip6_src_addresses, start[0]);
1594 /* Lookup the prefix, to identify the interface involved */
1595 prefix.fp_len = 128;
1596 prefix.fp_proto = FIB_PROTOCOL_IP6;
1597 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1599 fei = fib_table_lookup (fib_index, &prefix);
1601 /* Couldn't find route to destination. Bail out. */
1602 if (fei == FIB_NODE_INDEX_INVALID)
1603 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1605 sw_if_index = fib_entry_get_resolving_interface (fei);
1607 if (sw_if_index == (u32) ~ 0)
1608 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1610 /* Add a proxy neighbor discovery entry for this address */
1611 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1613 /* Add a receive adjacency for this address */
1614 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1617 fib_table_entry_special_dpo_update (fib_index,
1620 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1623 /* Done with the entire range? */
1624 if (!memcmp (start, end, sizeof (start[0])))
1627 /* Increment the address. DGMS. */
1629 for (i = 15; i >= 0; i--)
1632 if (tmp.as_u8[i] != 0)
1640 static clib_error_t *
1641 tcp_src_address (vlib_main_t * vm,
1642 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1644 ip4_address_t v4start, v4end;
1645 ip6_address_t v6start, v6end;
1651 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1653 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1654 unformat_ip4_address, &v4end))
1656 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1658 memcpy (&v4end, &v4start, sizeof (v4start));
1661 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1662 unformat_ip6_address, &v6end))
1664 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1666 memcpy (&v6end, &v6start, sizeof (v6start));
1669 else if (unformat (input, "fib-table %d", &table_id))
1675 if (!v4set && !v6set)
1676 return clib_error_return (0, "at least one v4 or v6 address required");
1680 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1687 case VNET_API_ERROR_NO_SUCH_FIB:
1688 return clib_error_return (0, "Invalid table-id %d", table_id);
1690 case VNET_API_ERROR_INVALID_ARGUMENT:
1691 return clib_error_return (0, "Invalid address range %U - %U",
1692 format_ip4_address, &v4start,
1693 format_ip4_address, &v4end);
1695 return clib_error_return (0, "error %d", rv);
1701 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1708 case VNET_API_ERROR_NO_SUCH_FIB:
1709 return clib_error_return (0, "Invalid table-id %d", table_id);
1712 return clib_error_return (0, "error %d", rv);
1720 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1722 .path = "tcp src-address",
1723 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1724 .function = tcp_src_address,
1729 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1731 #if TCP_SCOREBOARD_TRACE
1733 scoreboard_trace_elt_t *block;
1739 s = format (s, "scoreboard trace:");
1740 vec_foreach (block, sb->trace)
1742 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1743 block->ack, block->snd_una_max, block->group);
1745 s = format (s, "\n");
1753 static clib_error_t *
1754 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1755 vlib_cli_command_t * cmd_arg)
1757 transport_connection_t *tconn = 0;
1758 tcp_connection_t *tc;
1760 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1762 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1763 TRANSPORT_PROTO_TCP))
1766 return clib_error_return (0, "unknown input `%U'",
1767 format_unformat_error, input);
1770 if (!TCP_SCOREBOARD_TRACE)
1772 vlib_cli_output (vm, "scoreboard tracing not enabled");
1776 tc = tcp_get_connection_from_transport (tconn);
1777 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1778 vlib_cli_output (vm, "%v", s);
1783 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1785 .path = "show tcp scoreboard trace",
1786 .short_help = "show tcp scoreboard trace <connection>",
1787 .function = tcp_show_scoreboard_trace_fn,
1792 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1795 scoreboard_trace_elt_t *trace;
1796 u32 next_ack, left, group, has_new_ack = 0;
1797 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1798 sack_block_t *block;
1803 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1804 tcp_connection_timers_init (dummy_tc);
1805 scoreboard_init (&dummy_tc->sack_sb);
1806 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1808 /* Since this is also accessible via decl. in tcp.h.
1809 * Otherwise, it is gated earlier by cli parser.
1811 #if (!TCP_SCOREBOARD_TRACE)
1812 s = format (0, "scoreboard tracing not enabled");
1815 trace = tc->sack_sb.trace;
1816 trace_len = vec_len (tc->sack_sb.trace);
1819 for (i = 0; i < trace_len; i++)
1821 if (trace[i].ack != 0)
1823 dummy_tc->snd_una = trace[i].ack - 1448;
1824 dummy_tc->snd_una_max = trace[i].ack;
1829 while (left < trace_len)
1831 group = trace[left].group;
1832 vec_reset_length (dummy_tc->rcv_opts.sacks);
1834 while (trace[left].group == group)
1836 if (trace[left].ack != 0)
1839 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1840 trace[left].ack, trace[left].snd_una_max);
1841 dummy_tc->snd_una_max = trace[left].snd_una_max;
1842 next_ack = trace[left].ack;
1848 s = format (s, "[%u, %u], ", trace[left].start,
1850 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1851 block->start = trace[left].start;
1852 block->end = trace[left].end;
1858 tcp_rcv_sacks (dummy_tc, next_ack);
1860 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1863 s = format (s, "result: %U", format_tcp_scoreboard,
1864 &dummy_tc->sack_sb);
1867 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1872 static clib_error_t *
1873 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1874 vlib_cli_command_t * cmd_arg)
1876 transport_connection_t *tconn = 0;
1877 tcp_connection_t *tc = 0;
1879 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1881 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1882 TRANSPORT_PROTO_TCP))
1885 return clib_error_return (0, "unknown input `%U'",
1886 format_unformat_error, input);
1889 if (!TCP_SCOREBOARD_TRACE)
1891 vlib_cli_output (vm, "scoreboard tracing not enabled");
1895 tc = tcp_get_connection_from_transport (tconn);
1898 vlib_cli_output (vm, "connection not found");
1901 str = tcp_scoreboard_replay (str, tc, 1);
1902 vlib_cli_output (vm, "%v", str);
1907 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1909 .path = "tcp replay scoreboard",
1910 .short_help = "tcp replay scoreboard <connection>",
1911 .function = tcp_scoreboard_trace_fn,
1915 static clib_error_t *
1916 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1917 vlib_cli_command_t * cmd_arg)
1919 tcp_main_t *tm = vnet_get_tcp_main ();
1920 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1921 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1923 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1924 tm->punt_unknown4 ? "enabled" : "disabled");
1925 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1926 tm->punt_unknown6 ? "enabled" : "disabled");
1930 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1932 .path = "show tcp punt",
1933 .short_help = "show tcp punt",
1934 .function = show_tcp_punt_fn,
1939 * fd.io coding-style-patch-verification: ON
1942 * eval: (c-set-style "gnu")