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_alloc (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;
262 tcp_connection_free (tcp_connection_t * tc)
264 tcp_main_t *tm = &tcp_main;
265 pool_put (tm->connections[tc->c_thread_index], tc);
267 clib_memset (tc, 0xFA, sizeof (*tc));
270 /** Notify session that connection has been reset.
272 * Switch state to closed and wait for session to call cleanup.
275 tcp_connection_reset (tcp_connection_t * tc)
277 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
280 case TCP_STATE_SYN_RCVD:
281 /* Cleanup everything. App wasn't notified yet */
282 stream_session_delete_notify (&tc->connection);
283 tcp_connection_cleanup (tc);
285 case TCP_STATE_SYN_SENT:
286 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
287 tcp_connection_cleanup (tc);
289 case TCP_STATE_ESTABLISHED:
290 tcp_connection_timers_reset (tc);
291 /* Set the cleanup timer, in case the session layer/app don't
292 * cleanly close the connection */
293 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
294 stream_session_reset_notify (&tc->connection);
295 tc->state = TCP_STATE_CLOSED;
296 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
298 case TCP_STATE_CLOSE_WAIT:
299 case TCP_STATE_FIN_WAIT_1:
300 case TCP_STATE_FIN_WAIT_2:
301 case TCP_STATE_CLOSING:
302 case TCP_STATE_LAST_ACK:
303 tcp_connection_timers_reset (tc);
304 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
305 tc->state = TCP_STATE_CLOSED;
306 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
308 case TCP_STATE_CLOSED:
314 * Begin connection closing procedure.
316 * If at the end the connection is not in CLOSED state, it is not removed.
317 * Instead, we rely on on TCP to advance through state machine to either
318 * 1) LAST_ACK (passive close) whereby when the last ACK is received
319 * tcp_connection_del is called. This notifies session of the delete and
321 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
322 * and cleanup is called.
324 * N.B. Half-close connections are not supported
327 tcp_connection_close (tcp_connection_t * tc)
329 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
331 /* Send/Program FIN if needed and switch state */
334 case TCP_STATE_SYN_SENT:
335 /* Do nothing. Establish timer will pop and cleanup the connection */
337 case TCP_STATE_SYN_RCVD:
338 tcp_connection_timers_reset (tc);
340 tc->state = TCP_STATE_FIN_WAIT_1;
341 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
343 case TCP_STATE_ESTABLISHED:
344 if (!session_tx_fifo_max_dequeue (&tc->connection))
347 tc->flags |= TCP_CONN_FINPNDG;
348 tc->state = TCP_STATE_FIN_WAIT_1;
349 /* Set a timer in case the peer stops responding. Otherwise the
350 * connection will be stuck here forever. */
351 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_FINWAIT1_TIME);
353 case TCP_STATE_CLOSE_WAIT:
354 if (!session_tx_fifo_max_dequeue (&tc->connection))
357 tcp_connection_timers_reset (tc);
358 tc->state = TCP_STATE_LAST_ACK;
359 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
362 tc->flags |= TCP_CONN_FINPNDG;
364 case TCP_STATE_FIN_WAIT_1:
365 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
367 case TCP_STATE_CLOSED:
368 tcp_connection_timers_reset (tc);
371 TCP_DBG ("state: %u", tc->state);
374 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
376 /* If in CLOSED and WAITCLOSE timer is not set, delete connection.
377 * But instead of doing it now wait until next dispatch cycle to give
378 * the session layer a chance to clear unhandled events */
379 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
380 && tc->state == TCP_STATE_CLOSED)
381 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
385 tcp_session_close (u32 conn_index, u32 thread_index)
387 tcp_connection_t *tc;
388 tc = tcp_connection_get (conn_index, thread_index);
389 tcp_connection_close (tc);
393 tcp_session_cleanup (u32 conn_index, u32 thread_index)
395 tcp_connection_t *tc;
396 tc = tcp_connection_get (conn_index, thread_index);
397 tcp_connection_timers_reset (tc);
398 tc->state = TCP_STATE_CLOSED;
399 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
400 tcp_connection_cleanup (tc);
404 * Initialize all connection timers as invalid
407 tcp_connection_timers_init (tcp_connection_t * tc)
411 /* Set all to invalid */
412 for (i = 0; i < TCP_N_TIMERS; i++)
414 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
417 tc->rto = TCP_RTO_INIT;
421 * Stop all connection timers
424 tcp_connection_timers_reset (tcp_connection_t * tc)
427 for (i = 0; i < TCP_N_TIMERS; i++)
429 tcp_timer_reset (tc, i);
434 typedef struct ip4_tcp_hdr
440 typedef struct ip6_tcp_hdr
447 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
450 const dpo_id_t *choice;
454 lb = load_balance_get (dpo->dpoi_index);
458 clib_memset (&hdr, 0, sizeof (hdr));
459 hdr.ip.protocol = IP_PROTOCOL_TCP;
460 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
461 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
462 hdr.tcp.src_port = tc->c_lcl_port;
463 hdr.tcp.dst_port = tc->c_rmt_port;
464 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
469 clib_memset (&hdr, 0, sizeof (hdr));
470 hdr.ip.protocol = IP_PROTOCOL_TCP;
471 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
472 sizeof (ip6_address_t));
473 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
474 sizeof (ip6_address_t));
475 hdr.tcp.src_port = tc->c_lcl_port;
476 hdr.tcp.dst_port = tc->c_rmt_port;
477 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
479 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
480 dpo_copy (result, choice);
484 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
489 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
490 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
491 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
492 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
493 return fib_table_lookup (fib_index, &prefix);
497 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
499 dpo_id_t choice = DPO_INVALID;
500 u32 output_node_index;
503 fe = fib_entry_get (tc->c_rmt_fei);
504 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
507 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
510 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
511 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
515 /** Stack tcp connection on peer's fib entry.
517 * This ultimately populates the dpo the connection will use to send packets.
520 tcp_connection_fib_attach (tcp_connection_t * tc)
522 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
524 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
526 tcp_connection_stack_on_fib_entry (tc);
531 tcp_cc_init (tcp_connection_t * tc)
533 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
534 tc->cc_algo->init (tc);
538 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
539 const tcp_cc_algorithm_t * vft)
541 tcp_main_t *tm = vnet_get_tcp_main ();
542 vec_validate (tm->cc_algos, type);
544 tm->cc_algos[type] = *vft;
548 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
550 tcp_main_t *tm = vnet_get_tcp_main ();
551 return &tm->cc_algos[type];
556 * Initialize connection send variables.
559 tcp_init_snd_vars (tcp_connection_t * tc)
564 * We use the time to randomize iss and for setting up the initial
565 * timestamp. Make sure it's updated otherwise syn and ack in the
566 * handshake may make it look as if time has flown in the opposite
569 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
570 time_now = tcp_time_now ();
572 tc->iss = random_u32 (&time_now);
573 tc->snd_una = tc->iss;
574 tc->snd_nxt = tc->iss + 1;
575 tc->snd_una_max = tc->snd_nxt;
580 tcp_enable_pacing (tcp_connection_t * tc)
582 u32 initial_bucket, byte_rate;
583 initial_bucket = 16 * tc->snd_mss;
585 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
587 tc->mrtt_us = (u32) ~ 0;
590 /** Initialize tcp connection variables
592 * Should be called after having received a msg from the peer, i.e., a SYN or
593 * a SYNACK, such that connection options have already been exchanged. */
595 tcp_connection_init_vars (tcp_connection_t * tc)
597 tcp_connection_timers_init (tc);
599 scoreboard_init (&tc->sack_sb);
601 if (tc->state == TCP_STATE_SYN_RCVD)
602 tcp_init_snd_vars (tc);
604 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
605 tcp_add_del_adjacency (tc, 1);
607 /* tcp_connection_fib_attach (tc); */
609 if (transport_connection_is_tx_paced (&tc->connection)
610 || tcp_main.tx_pacing)
611 tcp_enable_pacing (tc);
615 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
616 u16 * lcl_port, u8 is_ip4)
621 index = tm->last_v4_address_rotor++;
622 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
623 tm->last_v4_address_rotor = 0;
624 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
628 index = tm->last_v6_address_rotor++;
629 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
630 tm->last_v6_address_rotor = 0;
631 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
632 sizeof (ip6_address_t));
634 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
637 clib_warning ("Failed to allocate src port");
645 tcp_session_open (transport_endpoint_cfg_t * rmt)
647 tcp_main_t *tm = vnet_get_tcp_main ();
648 tcp_connection_t *tc;
649 ip46_address_t lcl_addr;
654 * Allocate local endpoint
656 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
657 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
658 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
661 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
662 rmt, &lcl_addr, &lcl_port);
668 * Create connection and send SYN
670 clib_spinlock_lock_if_init (&tm->half_open_lock);
671 tc = tcp_half_open_connection_new ();
672 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
673 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
674 tc->c_rmt_port = rmt->port;
675 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
676 tc->c_is_ip4 = rmt->is_ip4;
677 tc->c_proto = TRANSPORT_PROTO_TCP;
678 tc->c_fib_index = rmt->fib_index;
679 /* The other connection vars will be initialized after SYN ACK */
680 tcp_connection_timers_init (tc);
682 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
683 tc->state = TCP_STATE_SYN_SENT;
684 tcp_init_snd_vars (tc);
686 clib_spinlock_unlock_if_init (&tm->half_open_lock);
688 return tc->c_c_index;
691 const char *tcp_dbg_evt_str[] = {
692 #define _(sym, str) str,
697 const char *tcp_fsm_states[] = {
698 #define _(sym, str) str,
699 foreach_tcp_fsm_state
704 format_tcp_state (u8 * s, va_list * args)
706 u32 state = va_arg (*args, u32);
708 if (state < TCP_N_STATES)
709 s = format (s, "%s", tcp_fsm_states[state]);
711 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
715 const char *tcp_connection_flags_str[] = {
716 #define _(sym, str) str,
717 foreach_tcp_connection_flag
722 format_tcp_connection_flags (u8 * s, va_list * args)
724 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
727 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
728 if (tc->flags & (1 << i))
730 for (i = 0; i < last; i++)
732 if (tc->flags & (1 << i))
733 s = format (s, "%s, ", tcp_connection_flags_str[i]);
736 s = format (s, "%s", tcp_connection_flags_str[last]);
740 const char *tcp_conn_timers[] = {
741 #define _(sym, str) str,
747 format_tcp_timers (u8 * s, va_list * args)
749 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
752 for (i = 0; i < TCP_N_TIMERS; i++)
753 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
756 for (i = 0; i < last; i++)
758 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
759 s = format (s, "%s,", tcp_conn_timers[i]);
763 s = format (s, "%s", tcp_conn_timers[i]);
769 format_tcp_congestion_status (u8 * s, va_list * args)
771 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
772 if (tcp_in_recovery (tc))
773 s = format (s, "recovery");
774 else if (tcp_in_fastrecovery (tc))
775 s = format (s, "fastrecovery");
777 s = format (s, "none");
782 tcp_rcv_wnd_available (tcp_connection_t * tc)
784 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
788 format_tcp_congestion (u8 * s, va_list * args)
790 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
791 u32 indent = format_get_indent (s);
793 s = format (s, "%U ", format_tcp_congestion_status, tc);
794 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
795 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
796 s = format (s, "%Ucc space %u prev_ssthresh %u snd_congestion %u"
797 " dupack %u\n", format_white_space, indent,
798 tcp_available_cc_snd_space (tc), tc->prev_ssthresh,
799 tc->snd_congestion - tc->iss, tc->rcv_dupacks);
800 s = format (s, "%Utsecr %u tsecr_last_ack %u limited_transmit %u\n",
801 format_white_space, indent, tc->rcv_opts.tsecr,
802 tc->tsecr_last_ack, tc->limited_transmit - tc->iss);
807 format_tcp_vars (u8 * s, va_list * args)
809 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
810 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
811 format_tcp_connection_flags, tc, format_tcp_timers, tc);
812 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
813 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
814 tc->snd_una_max - tc->iss);
815 s = format (s, " rcv_nxt %u rcv_las %u\n",
816 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
817 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
818 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
819 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
820 tc->snd_wl2 - tc->iss);
821 s = format (s, " flight size %u out space %u rcv_wnd_av %u\n",
822 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
823 tcp_rcv_wnd_available (tc));
824 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
825 tcp_time_now () - tc->tsval_recent_age);
826 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %x",
827 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
829 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
830 s = format (s, " cong: %U", format_tcp_congestion, tc);
832 if (tc->state >= TCP_STATE_ESTABLISHED)
834 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
837 if (vec_len (tc->snd_sacks))
838 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
844 format_tcp_connection_id (u8 * s, va_list * args)
846 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
851 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
852 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
853 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
854 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
858 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
859 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
860 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
861 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
868 format_tcp_connection (u8 * s, va_list * args)
870 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
871 u32 verbose = va_arg (*args, u32);
875 s = format (s, "%-50U", format_tcp_connection_id, tc);
878 s = format (s, "%-15U", format_tcp_state, tc->state);
880 s = format (s, "\n%U", format_tcp_vars, tc);
887 format_tcp_session (u8 * s, va_list * args)
889 u32 tci = va_arg (*args, u32);
890 u32 thread_index = va_arg (*args, u32);
891 u32 verbose = va_arg (*args, u32);
892 tcp_connection_t *tc;
894 tc = tcp_connection_get (tci, thread_index);
896 s = format (s, "%U", format_tcp_connection, tc, verbose);
898 s = format (s, "empty\n");
903 format_tcp_listener_session (u8 * s, va_list * args)
905 u32 tci = va_arg (*args, u32);
906 tcp_connection_t *tc = tcp_listener_get (tci);
907 return format (s, "%U", format_tcp_connection_id, tc);
911 format_tcp_half_open_session (u8 * s, va_list * args)
913 u32 tci = va_arg (*args, u32);
914 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
915 return format (s, "%U", format_tcp_connection_id, tc);
919 format_tcp_sacks (u8 * s, va_list * args)
921 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
922 sack_block_t *sacks = tc->snd_sacks;
926 len = vec_len (sacks);
927 for (i = 0; i < len - 1; i++)
930 s = format (s, " start %u end %u\n", block->start - tc->irs,
931 block->end - tc->irs);
935 block = &sacks[len - 1];
936 s = format (s, " start %u end %u", block->start - tc->irs,
937 block->end - tc->irs);
943 format_tcp_rcv_sacks (u8 * s, va_list * args)
945 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
946 sack_block_t *sacks = tc->rcv_opts.sacks;
950 len = vec_len (sacks);
951 for (i = 0; i < len - 1; i++)
954 s = format (s, " start %u end %u\n", block->start - tc->iss,
955 block->end - tc->iss);
959 block = &sacks[len - 1];
960 s = format (s, " start %u end %u", block->start - tc->iss,
961 block->end - tc->iss);
967 format_tcp_sack_hole (u8 * s, va_list * args)
969 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
970 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
972 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
974 s = format (s, " [%u, %u]", hole->start, hole->end);
979 format_tcp_scoreboard (u8 * s, va_list * args)
981 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
982 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
983 sack_scoreboard_hole_t *hole;
984 u32 indent = format_get_indent (s);
986 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
987 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
988 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
989 format_white_space, indent, sb->last_bytes_delivered,
990 sb->high_sacked - tc->iss, sb->snd_una_adv);
991 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
992 format_white_space, indent, sb->cur_rxt_hole,
993 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
995 hole = scoreboard_first_hole (sb);
997 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
998 indent, sb->head, sb->tail, pool_elts (sb->holes),
999 format_white_space, indent);
1003 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1004 hole = scoreboard_next_hole (sb, hole);
1010 static transport_connection_t *
1011 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1013 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1014 return &tc->connection;
1017 static transport_connection_t *
1018 tcp_half_open_session_get_transport (u32 conn_index)
1020 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1021 return &tc->connection;
1025 * Compute maximum segment size for session layer.
1027 * Since the result needs to be the actual data length, it first computes
1028 * the tcp options to be used in the next burst and subtracts their
1029 * length from the connection's snd_mss.
1032 tcp_session_send_mss (transport_connection_t * trans_conn)
1034 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1036 /* Ensure snd_mss does accurately reflect the amount of data we can push
1037 * in a segment. This also makes sure that options are updated according to
1038 * the current state of the connection. */
1039 tcp_update_burst_snd_vars (tc);
1045 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1047 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1049 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1052 /* If not snd_wnd constrained and we can't write at least a segment,
1053 * don't try at all */
1054 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1055 return snd_space < tc->cwnd ? 0 : snd_space;
1057 /* round down to mss multiple */
1058 return snd_space - (snd_space % tc->snd_mss);
1062 * Compute tx window session is allowed to fill.
1064 * Takes into account available send space, snd_mss and the congestion
1065 * state of the connection. If possible, the value returned is a multiple
1068 * @param tc tcp connection
1069 * @return number of bytes session is allowed to write
1072 tcp_snd_space_inline (tcp_connection_t * tc)
1074 int snd_space, snt_limited;
1076 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1077 || tc->state == TCP_STATE_CLOSED))
1080 snd_space = tcp_available_output_snd_space (tc);
1082 /* If we haven't gotten dupacks or if we did and have gotten sacked
1083 * bytes then we can still send as per Limited Transmit (RFC3042) */
1084 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1085 && (tcp_opts_sack_permitted (tc)
1086 && tc->sack_sb.last_sacked_bytes == 0)))
1088 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1089 tc->limited_transmit = tc->snd_nxt;
1090 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1092 snt_limited = tc->snd_nxt - tc->limited_transmit;
1093 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1095 return tcp_round_snd_space (tc, snd_space);
1099 tcp_snd_space (tcp_connection_t * tc)
1101 return tcp_snd_space_inline (tc);
1105 tcp_session_send_space (transport_connection_t * trans_conn)
1107 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1108 return clib_min (tcp_snd_space_inline (tc),
1109 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1113 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1115 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1117 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1119 /* This still works if fast retransmit is on */
1120 return (tc->snd_nxt - tc->snd_una);
1124 tcp_update_time (f64 now, u8 thread_index)
1126 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1128 tcp_set_time_now (wrk);
1129 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1130 tcp_do_fastretransmits (wrk);
1131 tcp_send_acks (wrk);
1132 tcp_flush_frames_to_output (wrk);
1136 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1138 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1139 return tcp_push_header (tc, b);
1143 tcp_session_flush_data (transport_connection_t * tconn)
1145 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1146 if (tc->flags & TCP_CONN_PSH_PENDING)
1148 tc->flags |= TCP_CONN_PSH_PENDING;
1149 tc->psh_seq = tc->snd_una_max + transport_max_tx_dequeue (tconn) - 1;
1153 const static transport_proto_vft_t tcp_proto = {
1154 .enable = vnet_tcp_enable_disable,
1155 .bind = tcp_session_bind,
1156 .unbind = tcp_session_unbind,
1157 .push_header = tcp_session_push_header,
1158 .get_connection = tcp_session_get_transport,
1159 .get_listener = tcp_session_get_listener,
1160 .get_half_open = tcp_half_open_session_get_transport,
1161 .open = tcp_session_open,
1162 .close = tcp_session_close,
1163 .cleanup = tcp_session_cleanup,
1164 .send_mss = tcp_session_send_mss,
1165 .send_space = tcp_session_send_space,
1166 .update_time = tcp_update_time,
1167 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1168 .flush_data = tcp_session_flush_data,
1169 .format_connection = format_tcp_session,
1170 .format_listener = format_tcp_listener_session,
1171 .format_half_open = format_tcp_half_open_session,
1172 .tx_type = TRANSPORT_TX_PEEK,
1173 .service_type = TRANSPORT_SERVICE_VC,
1178 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1183 if (!transport_connection_is_tx_paced (&tc->connection))
1186 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1187 /* TODO should constrain to interface's max throughput but
1188 * we don't have link speeds for sw ifs ..*/
1189 rate = tc->cwnd / srtt;
1190 transport_connection_tx_pacer_update (&tc->connection, rate);
1194 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1197 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1198 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1199 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1200 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1201 start_bucket, last_time);
1205 tcp_timer_keep_handler (u32 conn_index)
1207 u32 thread_index = vlib_get_thread_index ();
1208 tcp_connection_t *tc;
1210 tc = tcp_connection_get (conn_index, thread_index);
1211 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1213 tcp_connection_close (tc);
1217 tcp_timer_establish_handler (u32 conn_index)
1219 tcp_connection_t *tc;
1221 tc = tcp_half_open_connection_get (conn_index);
1224 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1225 /* Notify app if we haven't tried to clean this up already */
1226 if (!(tc->flags & TCP_CONN_HALF_OPEN_DONE))
1227 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1231 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1232 /* note: the connection may have already disappeared */
1233 if (PREDICT_FALSE (tc == 0))
1235 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1236 /* Start cleanup. App wasn't notified yet so use delete notify as
1237 * opposed to delete to cleanup session layer state. */
1238 stream_session_delete_notify (&tc->connection);
1240 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1241 tcp_connection_cleanup (tc);
1245 tcp_timer_waitclose_handler (u32 conn_index)
1247 u32 thread_index = vlib_get_thread_index ();
1248 tcp_connection_t *tc;
1250 tc = tcp_connection_get (conn_index, thread_index);
1254 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1258 case TCP_STATE_CLOSE_WAIT:
1259 tcp_connection_timers_reset (tc);
1261 if (!(tc->flags & TCP_CONN_FINPNDG))
1263 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1264 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1268 /* Session didn't come back with a close. Send FIN either way
1269 * and switch to LAST_ACK. */
1270 tcp_cong_recovery_off (tc);
1271 /* Make sure we don't try to send unsent data */
1272 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1274 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1276 /* Make sure we don't wait in LAST ACK forever */
1277 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1279 /* Don't delete the connection yet */
1281 case TCP_STATE_FIN_WAIT_1:
1282 tcp_connection_timers_reset (tc);
1283 if (tc->flags & TCP_CONN_FINPNDG)
1285 /* If FIN pending send it before closing and wait as long as
1286 * the rto timeout would wait. Notify session layer that transport
1287 * is closed. We haven't sent everything but we did try. */
1288 tcp_cong_recovery_off (tc);
1290 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE,
1291 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1292 session_stream_close_notify (&tc->connection);
1296 /* We've sent the fin but no progress. Close the connection and
1297 * to make sure everything is flushed, setup a cleanup timer */
1298 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1299 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1302 case TCP_STATE_LAST_ACK:
1303 case TCP_STATE_CLOSING:
1304 tcp_connection_timers_reset (tc);
1305 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1306 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
1309 tcp_connection_del (tc);
1315 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1317 tcp_timer_retransmit_handler,
1318 tcp_timer_delack_handler,
1319 tcp_timer_persist_handler,
1320 tcp_timer_keep_handler,
1321 tcp_timer_waitclose_handler,
1322 tcp_timer_retransmit_syn_handler,
1323 tcp_timer_establish_handler
1328 tcp_expired_timers_dispatch (u32 * expired_timers)
1331 u32 connection_index, timer_id;
1333 for (i = 0; i < vec_len (expired_timers); i++)
1335 /* Get session index and timer id */
1336 connection_index = expired_timers[i] & 0x0FFFFFFF;
1337 timer_id = expired_timers[i] >> 28;
1339 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1341 /* Handle expiration */
1342 (*timer_expiration_handlers[timer_id]) (connection_index);
1347 tcp_initialize_timer_wheels (tcp_main_t * tm)
1349 tw_timer_wheel_16t_2w_512sl_t *tw;
1351 foreach_vlib_main (({
1352 tw = &tm->wrk_ctx[ii].timer_wheel;
1353 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1354 100e-3 /* timer period 100ms */ , ~0);
1355 tw->last_run_time = vlib_time_now (this_vlib_main);
1360 static clib_error_t *
1361 tcp_main_enable (vlib_main_t * vm)
1363 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1364 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1365 tcp_connection_t *tc __attribute__ ((unused));
1366 tcp_main_t *tm = vnet_get_tcp_main ();
1367 clib_error_t *error = 0;
1370 if ((error = vlib_call_init_function (vm, ip_main_init)))
1372 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1374 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1381 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1382 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1385 * Initialize data structures
1388 num_threads = 1 /* main thread */ + vtm->n_threads;
1389 vec_validate (tm->connections, num_threads - 1);
1390 vec_validate (tm->wrk_ctx, num_threads - 1);
1391 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1392 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1394 for (thread = 0; thread < num_threads; thread++)
1396 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1397 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1398 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1399 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1400 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1401 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1402 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1403 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1404 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1405 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1406 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1407 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1408 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1411 * Preallocate connections. Assume that thread 0 won't
1412 * use preallocated threads when running multi-core
1414 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1415 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1419 * Use a preallocated half-open connection pool?
1421 if (tm->preallocated_half_open_connections)
1422 pool_init_fixed (tm->half_open_connections,
1423 tm->preallocated_half_open_connections);
1425 /* Initialize clocks per tick for TCP timestamp. Used to compute
1426 * monotonically increasing timestamps. */
1427 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1428 / TCP_TSTAMP_RESOLUTION;
1430 if (num_threads > 1)
1432 clib_spinlock_init (&tm->half_open_lock);
1435 tcp_initialize_timer_wheels (tm);
1437 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1438 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1444 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1448 if (tcp_main.is_enabled)
1451 return tcp_main_enable (vm);
1455 tcp_main.is_enabled = 0;
1462 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1464 tcp_main_t *tm = &tcp_main;
1466 tm->punt_unknown4 = is_add;
1468 tm->punt_unknown6 = is_add;
1471 static clib_error_t *
1472 tcp_init (vlib_main_t * vm)
1474 tcp_main_t *tm = vnet_get_tcp_main ();
1475 ip_main_t *im = &ip_main;
1476 ip_protocol_info_t *pi;
1478 /* Session layer, and by implication tcp, are disabled by default */
1481 /* Register with IP for header parsing */
1482 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1484 return clib_error_return (0, "TCP protocol info AWOL");
1485 pi->format_header = format_tcp_header;
1486 pi->unformat_pg_edit = unformat_pg_tcp_header;
1488 /* Register as transport with session layer */
1489 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1490 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1491 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1492 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1494 tcp_api_reference ();
1496 tm->cc_algo = TCP_CC_NEWRENO;
1500 VLIB_INIT_FUNCTION (tcp_init);
1503 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1505 uword *result = va_arg (*va, uword *);
1507 if (unformat (input, "newreno"))
1508 *result = TCP_CC_NEWRENO;
1509 else if (unformat (input, "cubic"))
1510 *result = TCP_CC_CUBIC;
1518 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1520 tcp_main_t *tm = vnet_get_tcp_main ();
1521 tcp_cc_algorithm_t *cc_alg;
1522 unformat_input_t sub_input;
1525 vec_foreach (cc_alg, tm->cc_algos)
1527 if (!unformat (input, cc_alg->name))
1530 if (cc_alg->unformat_cfg
1531 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1533 if (cc_alg->unformat_cfg (&sub_input))
1540 static clib_error_t *
1541 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1543 tcp_main_t *tm = vnet_get_tcp_main ();
1545 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1547 if (unformat (input, "preallocated-connections %d",
1548 &tm->preallocated_connections))
1550 else if (unformat (input, "preallocated-half-open-connections %d",
1551 &tm->preallocated_half_open_connections))
1553 else if (unformat (input, "buffer-fail-fraction %f",
1554 &tm->buffer_fail_fraction))
1556 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1559 else if (unformat (input, "no-tx-pacing"))
1561 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1564 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1567 return clib_error_return (0, "unknown input `%U'",
1568 format_unformat_error, input);
1573 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1577 * \brief Configure an ipv4 source address range
1578 * @param vm vlib_main_t pointer
1579 * @param start first ipv4 address in the source address range
1580 * @param end last ipv4 address in the source address range
1581 * @param table_id VRF / table ID, 0 for the default FIB
1582 * @return 0 if all OK, else an error indication from api_errno.h
1586 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1587 ip4_address_t * start,
1588 ip4_address_t * end, u32 table_id)
1590 tcp_main_t *tm = vnet_get_tcp_main ();
1591 vnet_main_t *vnm = vnet_get_main ();
1592 u32 start_host_byte_order, end_host_byte_order;
1593 fib_prefix_t prefix;
1594 vnet_sw_interface_t *si;
1595 fib_node_index_t fei;
1599 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1600 ip4_address_t * hi_addr, u32 fib_index,
1603 clib_memset (&prefix, 0, sizeof (prefix));
1605 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1607 if (fib_index == ~0)
1608 return VNET_API_ERROR_NO_SUCH_FIB;
1610 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1611 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1613 /* sanity check for reversed args or some such */
1614 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1615 return VNET_API_ERROR_INVALID_ARGUMENT;
1617 /* Lookup the last address, to identify the interface involved */
1619 prefix.fp_proto = FIB_PROTOCOL_IP4;
1620 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1622 fei = fib_table_lookup (fib_index, &prefix);
1624 /* Couldn't find route to destination. Bail out. */
1625 if (fei == FIB_NODE_INDEX_INVALID)
1626 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1628 sw_if_index = fib_entry_get_resolving_interface (fei);
1630 /* Enable proxy arp on the interface */
1631 si = vnet_get_sw_interface (vnm, sw_if_index);
1632 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1634 /* Configure proxy arp across the range */
1635 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1642 dpo_id_t dpo = DPO_INVALID;
1644 vec_add1 (tm->ip4_src_addresses, start[0]);
1646 /* Add local adjacencies for the range */
1648 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1651 prefix.fp_proto = FIB_PROTOCOL_IP4;
1652 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1654 fib_table_entry_special_dpo_update (fib_index,
1657 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1660 start_host_byte_order++;
1661 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1663 while (start_host_byte_order <= end_host_byte_order);
1669 * \brief Configure an ipv6 source address range
1670 * @param vm vlib_main_t pointer
1671 * @param start first ipv6 address in the source address range
1672 * @param end last ipv6 address in the source address range
1673 * @param table_id VRF / table ID, 0 for the default FIB
1674 * @return 0 if all OK, else an error indication from api_errno.h
1678 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1679 ip6_address_t * start,
1680 ip6_address_t * end, u32 table_id)
1682 tcp_main_t *tm = vnet_get_tcp_main ();
1683 fib_prefix_t prefix;
1685 fib_node_index_t fei;
1688 clib_memset (&prefix, 0, sizeof (prefix));
1690 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1692 if (fib_index == ~0)
1693 return VNET_API_ERROR_NO_SUCH_FIB;
1699 dpo_id_t dpo = DPO_INVALID;
1701 /* Remember this address */
1702 vec_add1 (tm->ip6_src_addresses, start[0]);
1704 /* Lookup the prefix, to identify the interface involved */
1705 prefix.fp_len = 128;
1706 prefix.fp_proto = FIB_PROTOCOL_IP6;
1707 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1709 fei = fib_table_lookup (fib_index, &prefix);
1711 /* Couldn't find route to destination. Bail out. */
1712 if (fei == FIB_NODE_INDEX_INVALID)
1713 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1715 sw_if_index = fib_entry_get_resolving_interface (fei);
1717 if (sw_if_index == (u32) ~ 0)
1718 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1720 /* Add a proxy neighbor discovery entry for this address */
1721 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1723 /* Add a receive adjacency for this address */
1724 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1727 fib_table_entry_special_dpo_update (fib_index,
1730 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1733 /* Done with the entire range? */
1734 if (!memcmp (start, end, sizeof (start[0])))
1737 /* Increment the address. DGMS. */
1739 for (i = 15; i >= 0; i--)
1742 if (tmp.as_u8[i] != 0)
1750 static clib_error_t *
1751 tcp_src_address (vlib_main_t * vm,
1752 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1754 ip4_address_t v4start, v4end;
1755 ip6_address_t v6start, v6end;
1761 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1763 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1764 unformat_ip4_address, &v4end))
1766 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1768 memcpy (&v4end, &v4start, sizeof (v4start));
1771 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1772 unformat_ip6_address, &v6end))
1774 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1776 memcpy (&v6end, &v6start, sizeof (v6start));
1779 else if (unformat (input, "fib-table %d", &table_id))
1785 if (!v4set && !v6set)
1786 return clib_error_return (0, "at least one v4 or v6 address required");
1790 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1797 case VNET_API_ERROR_NO_SUCH_FIB:
1798 return clib_error_return (0, "Invalid table-id %d", table_id);
1800 case VNET_API_ERROR_INVALID_ARGUMENT:
1801 return clib_error_return (0, "Invalid address range %U - %U",
1802 format_ip4_address, &v4start,
1803 format_ip4_address, &v4end);
1805 return clib_error_return (0, "error %d", rv);
1811 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1818 case VNET_API_ERROR_NO_SUCH_FIB:
1819 return clib_error_return (0, "Invalid table-id %d", table_id);
1822 return clib_error_return (0, "error %d", rv);
1830 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1832 .path = "tcp src-address",
1833 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1834 .function = tcp_src_address,
1839 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1841 #if TCP_SCOREBOARD_TRACE
1843 scoreboard_trace_elt_t *block;
1849 s = format (s, "scoreboard trace:");
1850 vec_foreach (block, sb->trace)
1852 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1853 block->ack, block->snd_una_max, block->group);
1855 s = format (s, "\n");
1863 static clib_error_t *
1864 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1865 vlib_cli_command_t * cmd_arg)
1867 transport_connection_t *tconn = 0;
1868 tcp_connection_t *tc;
1870 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1872 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1873 TRANSPORT_PROTO_TCP))
1876 return clib_error_return (0, "unknown input `%U'",
1877 format_unformat_error, input);
1880 if (!TCP_SCOREBOARD_TRACE)
1882 vlib_cli_output (vm, "scoreboard tracing not enabled");
1886 tc = tcp_get_connection_from_transport (tconn);
1887 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1888 vlib_cli_output (vm, "%v", s);
1893 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1895 .path = "show tcp scoreboard trace",
1896 .short_help = "show tcp scoreboard trace <connection>",
1897 .function = tcp_show_scoreboard_trace_fn,
1902 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1905 scoreboard_trace_elt_t *trace;
1906 u32 next_ack, left, group, has_new_ack = 0;
1907 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1908 sack_block_t *block;
1910 if (!TCP_SCOREBOARD_TRACE)
1912 s = format (s, "scoreboard tracing not enabled");
1919 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1920 tcp_connection_timers_init (dummy_tc);
1921 scoreboard_init (&dummy_tc->sack_sb);
1922 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1924 #if TCP_SCOREBOARD_TRACE
1925 trace = tc->sack_sb.trace;
1926 trace_len = vec_len (tc->sack_sb.trace);
1929 for (i = 0; i < trace_len; i++)
1931 if (trace[i].ack != 0)
1933 dummy_tc->snd_una = trace[i].ack - 1448;
1934 dummy_tc->snd_una_max = trace[i].ack;
1939 while (left < trace_len)
1941 group = trace[left].group;
1942 vec_reset_length (dummy_tc->rcv_opts.sacks);
1944 while (trace[left].group == group)
1946 if (trace[left].ack != 0)
1949 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1950 trace[left].ack, trace[left].snd_una_max);
1951 dummy_tc->snd_una_max = trace[left].snd_una_max;
1952 next_ack = trace[left].ack;
1958 s = format (s, "[%u, %u], ", trace[left].start,
1960 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1961 block->start = trace[left].start;
1962 block->end = trace[left].end;
1968 tcp_rcv_sacks (dummy_tc, next_ack);
1970 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1973 s = format (s, "result: %U", format_tcp_scoreboard,
1974 &dummy_tc->sack_sb);
1977 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1982 static clib_error_t *
1983 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1984 vlib_cli_command_t * cmd_arg)
1986 transport_connection_t *tconn = 0;
1987 tcp_connection_t *tc = 0;
1989 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1991 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1992 TRANSPORT_PROTO_TCP))
1995 return clib_error_return (0, "unknown input `%U'",
1996 format_unformat_error, input);
1999 if (!TCP_SCOREBOARD_TRACE)
2001 vlib_cli_output (vm, "scoreboard tracing not enabled");
2005 tc = tcp_get_connection_from_transport (tconn);
2008 vlib_cli_output (vm, "connection not found");
2011 str = tcp_scoreboard_replay (str, tc, 1);
2012 vlib_cli_output (vm, "%v", str);
2017 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2019 .path = "tcp replay scoreboard",
2020 .short_help = "tcp replay scoreboard <connection>",
2021 .function = tcp_scoreboard_trace_fn,
2025 static clib_error_t *
2026 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2027 vlib_cli_command_t * cmd_arg)
2029 tcp_main_t *tm = vnet_get_tcp_main ();
2030 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2031 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2033 vlib_cli_output (vm, "IPv4 TCP punt: %s",
2034 tm->punt_unknown4 ? "enabled" : "disabled");
2035 vlib_cli_output (vm, "IPv6 TCP punt: %s",
2036 tm->punt_unknown6 ? "enabled" : "disabled");
2040 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2042 .path = "show tcp punt",
2043 .short_help = "show tcp punt",
2044 .function = show_tcp_punt_fn,
2049 * fd.io coding-style-patch-verification: ON
2052 * eval: (c-set-style "gnu")