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:
299 tc->state = TCP_STATE_CLOSED;
303 * Begin connection closing procedure.
305 * If at the end the connection is not in CLOSED state, it is not removed.
306 * Instead, we rely on on TCP to advance through state machine to either
307 * 1) LAST_ACK (passive close) whereby when the last ACK is received
308 * tcp_connection_del is called. This notifies session of the delete and
310 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
311 * and cleanup is called.
313 * N.B. Half-close connections are not supported
316 tcp_connection_close (tcp_connection_t * tc)
318 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
320 /* Send/Program FIN if needed and switch state */
323 case TCP_STATE_SYN_SENT:
324 tc->state = TCP_STATE_CLOSED;
326 case TCP_STATE_SYN_RCVD:
327 tcp_connection_timers_reset (tc);
329 tc->state = TCP_STATE_FIN_WAIT_1;
330 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
332 case TCP_STATE_ESTABLISHED:
333 if (!session_tx_fifo_max_dequeue (&tc->connection))
336 tc->flags |= TCP_CONN_FINPNDG;
337 tc->state = TCP_STATE_FIN_WAIT_1;
339 case TCP_STATE_CLOSE_WAIT:
340 if (!session_tx_fifo_max_dequeue (&tc->connection))
343 tcp_connection_timers_reset (tc);
344 tc->state = TCP_STATE_LAST_ACK;
345 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
348 tc->flags |= TCP_CONN_FINPNDG;
350 case TCP_STATE_FIN_WAIT_1:
351 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
353 case TCP_STATE_CLOSED:
354 tcp_connection_timers_reset (tc);
357 TCP_DBG ("state: %u", tc->state);
360 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
362 /* If in CLOSED and WAITCLOSE timer is not set, delete connection.
363 * But instead of doing it now wait until next dispatch cycle to give
364 * the session layer a chance to clear unhandled events */
365 if (!tcp_timer_is_active (tc, TCP_TIMER_WAITCLOSE)
366 && tc->state == TCP_STATE_CLOSED)
367 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, 1);
371 tcp_session_close (u32 conn_index, u32 thread_index)
373 tcp_connection_t *tc;
374 tc = tcp_connection_get (conn_index, thread_index);
375 tcp_connection_close (tc);
379 tcp_session_cleanup (u32 conn_index, u32 thread_index)
381 tcp_connection_t *tc;
382 tc = tcp_connection_get (conn_index, thread_index);
383 tcp_connection_timers_reset (tc);
384 tc->state = TCP_STATE_CLOSED;
385 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
386 tcp_connection_cleanup (tc);
390 * Initialize all connection timers as invalid
393 tcp_connection_timers_init (tcp_connection_t * tc)
397 /* Set all to invalid */
398 for (i = 0; i < TCP_N_TIMERS; i++)
400 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
403 tc->rto = TCP_RTO_INIT;
407 * Stop all connection timers
410 tcp_connection_timers_reset (tcp_connection_t * tc)
413 for (i = 0; i < TCP_N_TIMERS; i++)
415 tcp_timer_reset (tc, i);
420 typedef struct ip4_tcp_hdr
426 typedef struct ip6_tcp_hdr
433 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
436 const dpo_id_t *choice;
440 lb = load_balance_get (dpo->dpoi_index);
444 clib_memset (&hdr, 0, sizeof (hdr));
445 hdr.ip.protocol = IP_PROTOCOL_TCP;
446 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
447 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
448 hdr.tcp.src_port = tc->c_lcl_port;
449 hdr.tcp.dst_port = tc->c_rmt_port;
450 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
455 clib_memset (&hdr, 0, sizeof (hdr));
456 hdr.ip.protocol = IP_PROTOCOL_TCP;
457 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
458 sizeof (ip6_address_t));
459 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
460 sizeof (ip6_address_t));
461 hdr.tcp.src_port = tc->c_lcl_port;
462 hdr.tcp.dst_port = tc->c_rmt_port;
463 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
465 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
466 dpo_copy (result, choice);
470 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
475 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
476 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
477 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
478 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
479 return fib_table_lookup (fib_index, &prefix);
483 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
485 dpo_id_t choice = DPO_INVALID;
486 u32 output_node_index;
489 fe = fib_entry_get (tc->c_rmt_fei);
490 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
493 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
496 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
497 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
501 /** Stack tcp connection on peer's fib entry.
503 * This ultimately populates the dpo the connection will use to send packets.
506 tcp_connection_fib_attach (tcp_connection_t * tc)
508 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
510 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
512 tcp_connection_stack_on_fib_entry (tc);
517 tcp_cc_init (tcp_connection_t * tc)
519 tc->cc_algo = tcp_cc_algo_get (tcp_main.cc_algo);
520 tc->cc_algo->init (tc);
524 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
525 const tcp_cc_algorithm_t * vft)
527 tcp_main_t *tm = vnet_get_tcp_main ();
528 vec_validate (tm->cc_algos, type);
530 tm->cc_algos[type] = *vft;
534 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
536 tcp_main_t *tm = vnet_get_tcp_main ();
537 return &tm->cc_algos[type];
542 * Initialize connection send variables.
545 tcp_init_snd_vars (tcp_connection_t * tc)
550 * We use the time to randomize iss and for setting up the initial
551 * timestamp. Make sure it's updated otherwise syn and ack in the
552 * handshake may make it look as if time has flown in the opposite
555 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
556 time_now = tcp_time_now ();
558 tc->iss = random_u32 (&time_now);
559 tc->snd_una = tc->iss;
560 tc->snd_nxt = tc->iss + 1;
561 tc->snd_una_max = tc->snd_nxt;
566 tcp_enable_pacing (tcp_connection_t * tc)
568 u32 initial_bucket, byte_rate;
569 initial_bucket = 16 * tc->snd_mss;
571 transport_connection_tx_pacer_init (&tc->connection, byte_rate,
573 tc->mrtt_us = (u32) ~ 0;
576 /** Initialize tcp connection variables
578 * Should be called after having received a msg from the peer, i.e., a SYN or
579 * a SYNACK, such that connection options have already been exchanged. */
581 tcp_connection_init_vars (tcp_connection_t * tc)
583 tcp_connection_timers_init (tc);
585 scoreboard_init (&tc->sack_sb);
587 if (tc->state == TCP_STATE_SYN_RCVD)
588 tcp_init_snd_vars (tc);
590 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
591 tcp_add_del_adjacency (tc, 1);
593 /* tcp_connection_fib_attach (tc); */
595 if (transport_connection_is_tx_paced (&tc->connection)
596 || tcp_main.tx_pacing)
597 tcp_enable_pacing (tc);
601 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
602 u16 * lcl_port, u8 is_ip4)
607 index = tm->last_v4_address_rotor++;
608 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
609 tm->last_v4_address_rotor = 0;
610 lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
614 index = tm->last_v6_address_rotor++;
615 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
616 tm->last_v6_address_rotor = 0;
617 clib_memcpy_fast (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
618 sizeof (ip6_address_t));
620 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
623 clib_warning ("Failed to allocate src port");
631 tcp_session_open (transport_endpoint_cfg_t * rmt)
633 tcp_main_t *tm = vnet_get_tcp_main ();
634 tcp_connection_t *tc;
635 ip46_address_t lcl_addr;
640 * Allocate local endpoint
642 if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
643 || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
644 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
647 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
648 rmt, &lcl_addr, &lcl_port);
654 * Create connection and send SYN
656 clib_spinlock_lock_if_init (&tm->half_open_lock);
657 tc = tcp_half_open_connection_new ();
658 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
659 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
660 tc->c_rmt_port = rmt->port;
661 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
662 tc->c_is_ip4 = rmt->is_ip4;
663 tc->c_proto = TRANSPORT_PROTO_TCP;
664 tc->c_fib_index = rmt->fib_index;
665 /* The other connection vars will be initialized after SYN ACK */
666 tcp_connection_timers_init (tc);
668 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
669 tc->state = TCP_STATE_SYN_SENT;
670 tcp_init_snd_vars (tc);
672 clib_spinlock_unlock_if_init (&tm->half_open_lock);
674 return tc->c_c_index;
677 const char *tcp_dbg_evt_str[] = {
678 #define _(sym, str) str,
683 const char *tcp_fsm_states[] = {
684 #define _(sym, str) str,
685 foreach_tcp_fsm_state
690 format_tcp_state (u8 * s, va_list * args)
692 u32 state = va_arg (*args, u32);
694 if (state < TCP_N_STATES)
695 s = format (s, "%s", tcp_fsm_states[state]);
697 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
701 const char *tcp_connection_flags_str[] = {
702 #define _(sym, str) str,
703 foreach_tcp_connection_flag
708 format_tcp_connection_flags (u8 * s, va_list * args)
710 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
713 for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
714 if (tc->flags & (1 << i))
716 for (i = 0; i < last; i++)
718 if (tc->flags & (1 << i))
719 s = format (s, "%s, ", tcp_connection_flags_str[i]);
722 s = format (s, "%s", tcp_connection_flags_str[last]);
726 const char *tcp_conn_timers[] = {
727 #define _(sym, str) str,
733 format_tcp_timers (u8 * s, va_list * args)
735 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
738 for (i = 0; i < TCP_N_TIMERS; i++)
739 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
742 for (i = 0; i < last; i++)
744 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
745 s = format (s, "%s,", tcp_conn_timers[i]);
749 s = format (s, "%s", tcp_conn_timers[i]);
755 format_tcp_congestion_status (u8 * s, va_list * args)
757 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
758 if (tcp_in_recovery (tc))
759 s = format (s, "recovery");
760 else if (tcp_in_fastrecovery (tc))
761 s = format (s, "fastrecovery");
763 s = format (s, "none");
768 tcp_rcv_wnd_available (tcp_connection_t * tc)
770 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
774 format_tcp_congestion (u8 * s, va_list * args)
776 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
777 u32 indent = format_get_indent (s);
779 s = format (s, "%U ", format_tcp_congestion_status, tc);
780 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
781 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
782 s = format (s, "%Ucc space %u prev_ssthresh %u snd_congestion %u"
783 " dupack %u\n", format_white_space, indent,
784 tcp_available_cc_snd_space (tc), tc->prev_ssthresh,
785 tc->snd_congestion - tc->iss, tc->rcv_dupacks);
786 s = format (s, "%Utsecr %u tsecr_last_ack %u limited_transmit %u\n",
787 format_white_space, indent, tc->rcv_opts.tsecr,
788 tc->tsecr_last_ack, tc->limited_transmit - tc->iss);
793 format_tcp_vars (u8 * s, va_list * args)
795 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
796 s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
797 format_tcp_connection_flags, tc, format_tcp_timers, tc);
798 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
799 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
800 tc->snd_una_max - tc->iss);
801 s = format (s, " rcv_nxt %u rcv_las %u\n",
802 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
803 s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
804 tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
805 s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
806 tc->snd_wl2 - tc->iss);
807 s = format (s, " flight size %u out space %u rcv_wnd_av %u\n",
808 tcp_flight_size (tc), tcp_available_output_snd_space (tc),
809 tcp_rcv_wnd_available (tc));
810 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
811 tcp_time_now () - tc->tsval_recent_age);
812 s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %x",
813 tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
815 s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
816 s = format (s, " cong: %U", format_tcp_congestion, tc);
818 if (tc->state >= TCP_STATE_ESTABLISHED)
820 s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
823 if (vec_len (tc->snd_sacks))
824 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
830 format_tcp_connection_id (u8 * s, va_list * args)
832 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
837 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
838 tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
839 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
840 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
844 s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
845 tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
846 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
847 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
854 format_tcp_connection (u8 * s, va_list * args)
856 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
857 u32 verbose = va_arg (*args, u32);
861 s = format (s, "%-50U", format_tcp_connection_id, tc);
864 s = format (s, "%-15U", format_tcp_state, tc->state);
866 s = format (s, "\n%U", format_tcp_vars, tc);
873 format_tcp_session (u8 * s, va_list * args)
875 u32 tci = va_arg (*args, u32);
876 u32 thread_index = va_arg (*args, u32);
877 u32 verbose = va_arg (*args, u32);
878 tcp_connection_t *tc;
880 tc = tcp_connection_get (tci, thread_index);
882 s = format (s, "%U", format_tcp_connection, tc, verbose);
884 s = format (s, "empty\n");
889 format_tcp_listener_session (u8 * s, va_list * args)
891 u32 tci = va_arg (*args, u32);
892 tcp_connection_t *tc = tcp_listener_get (tci);
893 return format (s, "%U", format_tcp_connection_id, tc);
897 format_tcp_half_open_session (u8 * s, va_list * args)
899 u32 tci = va_arg (*args, u32);
900 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
901 return format (s, "%U", format_tcp_connection_id, tc);
905 format_tcp_sacks (u8 * s, va_list * args)
907 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
908 sack_block_t *sacks = tc->snd_sacks;
912 len = vec_len (sacks);
913 for (i = 0; i < len - 1; i++)
916 s = format (s, " start %u end %u\n", block->start - tc->irs,
917 block->end - tc->irs);
921 block = &sacks[len - 1];
922 s = format (s, " start %u end %u", block->start - tc->irs,
923 block->end - tc->irs);
929 format_tcp_rcv_sacks (u8 * s, va_list * args)
931 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
932 sack_block_t *sacks = tc->rcv_opts.sacks;
936 len = vec_len (sacks);
937 for (i = 0; i < len - 1; i++)
940 s = format (s, " start %u end %u\n", block->start - tc->iss,
941 block->end - tc->iss);
945 block = &sacks[len - 1];
946 s = format (s, " start %u end %u", block->start - tc->iss,
947 block->end - tc->iss);
953 format_tcp_sack_hole (u8 * s, va_list * args)
955 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
956 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
958 s = format (s, " [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
960 s = format (s, " [%u, %u]", hole->start, hole->end);
965 format_tcp_scoreboard (u8 * s, va_list * args)
967 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
968 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
969 sack_scoreboard_hole_t *hole;
970 u32 indent = format_get_indent (s);
972 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
973 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
974 s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
975 format_white_space, indent, sb->last_bytes_delivered,
976 sb->high_sacked - tc->iss, sb->snd_una_adv);
977 s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
978 format_white_space, indent, sb->cur_rxt_hole,
979 sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
981 hole = scoreboard_first_hole (sb);
983 s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
984 indent, sb->head, sb->tail, pool_elts (sb->holes),
985 format_white_space, indent);
989 s = format (s, "%U", format_tcp_sack_hole, hole, tc);
990 hole = scoreboard_next_hole (sb, hole);
996 static transport_connection_t *
997 tcp_session_get_transport (u32 conn_index, u32 thread_index)
999 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1000 return &tc->connection;
1003 static transport_connection_t *
1004 tcp_half_open_session_get_transport (u32 conn_index)
1006 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1007 return &tc->connection;
1011 * Compute maximum segment size for session layer.
1013 * Since the result needs to be the actual data length, it first computes
1014 * the tcp options to be used in the next burst and subtracts their
1015 * length from the connection's snd_mss.
1018 tcp_session_send_mss (transport_connection_t * trans_conn)
1020 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1022 /* Ensure snd_mss does accurately reflect the amount of data we can push
1023 * in a segment. This also makes sure that options are updated according to
1024 * the current state of the connection. */
1025 tcp_update_burst_snd_vars (tc);
1031 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1033 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1035 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1038 /* If not snd_wnd constrained and we can't write at least a segment,
1039 * don't try at all */
1040 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1041 return snd_space < tc->cwnd ? 0 : snd_space;
1043 /* round down to mss multiple */
1044 return snd_space - (snd_space % tc->snd_mss);
1048 * Compute tx window session is allowed to fill.
1050 * Takes into account available send space, snd_mss and the congestion
1051 * state of the connection. If possible, the value returned is a multiple
1054 * @param tc tcp connection
1055 * @return number of bytes session is allowed to write
1058 tcp_snd_space_inline (tcp_connection_t * tc)
1060 int snd_space, snt_limited;
1062 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1063 || tc->state == TCP_STATE_CLOSED))
1066 snd_space = tcp_available_output_snd_space (tc);
1068 /* If we haven't gotten dupacks or if we did and have gotten sacked
1069 * bytes then we can still send as per Limited Transmit (RFC3042) */
1070 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1071 && (tcp_opts_sack_permitted (tc)
1072 && tc->sack_sb.last_sacked_bytes == 0)))
1074 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1075 tc->limited_transmit = tc->snd_nxt;
1076 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1078 snt_limited = tc->snd_nxt - tc->limited_transmit;
1079 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1081 return tcp_round_snd_space (tc, snd_space);
1085 tcp_snd_space (tcp_connection_t * tc)
1087 return tcp_snd_space_inline (tc);
1091 tcp_session_send_space (transport_connection_t * trans_conn)
1093 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1094 return clib_min (tcp_snd_space_inline (tc),
1095 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1099 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1101 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1103 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1105 /* This still works if fast retransmit is on */
1106 return (tc->snd_nxt - tc->snd_una);
1110 tcp_update_time (f64 now, u8 thread_index)
1112 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1114 tcp_set_time_now (wrk);
1115 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1116 tcp_do_fastretransmits (wrk);
1117 tcp_send_acks (wrk);
1118 tcp_flush_frames_to_output (wrk);
1122 tcp_session_push_header (transport_connection_t * tconn, vlib_buffer_t * b)
1124 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1125 return tcp_push_header (tc, b);
1129 tcp_session_flush_data (transport_connection_t * tconn)
1131 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1132 if (tc->flags & TCP_CONN_PSH_PENDING)
1134 tc->flags |= TCP_CONN_PSH_PENDING;
1135 tc->psh_seq = tc->snd_una_max + transport_max_tx_dequeue (tconn) - 1;
1139 const static transport_proto_vft_t tcp_proto = {
1140 .enable = vnet_tcp_enable_disable,
1141 .bind = tcp_session_bind,
1142 .unbind = tcp_session_unbind,
1143 .push_header = tcp_session_push_header,
1144 .get_connection = tcp_session_get_transport,
1145 .get_listener = tcp_session_get_listener,
1146 .get_half_open = tcp_half_open_session_get_transport,
1147 .open = tcp_session_open,
1148 .close = tcp_session_close,
1149 .cleanup = tcp_session_cleanup,
1150 .send_mss = tcp_session_send_mss,
1151 .send_space = tcp_session_send_space,
1152 .update_time = tcp_update_time,
1153 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1154 .flush_data = tcp_session_flush_data,
1155 .format_connection = format_tcp_session,
1156 .format_listener = format_tcp_listener_session,
1157 .format_half_open = format_tcp_half_open_session,
1158 .tx_type = TRANSPORT_TX_PEEK,
1159 .service_type = TRANSPORT_SERVICE_VC,
1164 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1169 if (!transport_connection_is_tx_paced (&tc->connection))
1172 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1173 /* TODO should constrain to interface's max throughput but
1174 * we don't have link speeds for sw ifs ..*/
1175 rate = tc->cwnd / srtt;
1176 transport_connection_tx_pacer_update (&tc->connection, rate);
1180 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1183 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1184 u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1185 u64 last_time = wrk->vm->clib_time.last_cpu_time;
1186 transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1187 start_bucket, last_time);
1191 tcp_timer_keep_handler (u32 conn_index)
1193 u32 thread_index = vlib_get_thread_index ();
1194 tcp_connection_t *tc;
1196 tc = tcp_connection_get (conn_index, thread_index);
1197 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1199 tcp_connection_close (tc);
1203 tcp_timer_establish_handler (u32 conn_index)
1205 tcp_connection_t *tc;
1207 tc = tcp_half_open_connection_get (conn_index);
1210 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1211 session_stream_connect_notify (&tc->connection, 1 /* fail */ );
1212 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1216 tc = tcp_connection_get (conn_index, vlib_get_thread_index ());
1217 /* note: the connection may have already disappeared */
1218 if (PREDICT_FALSE (tc == 0))
1220 TCP_DBG ("establish pop: %U", format_tcp_connection, tc, 2);
1221 ASSERT (tc->state == TCP_STATE_SYN_RCVD);
1222 /* Start cleanup. App wasn't notified yet so use delete notify as
1223 * opposed to delete to cleanup session layer state. */
1224 stream_session_delete_notify (&tc->connection);
1226 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1227 tcp_connection_cleanup (tc);
1231 tcp_timer_waitclose_handler (u32 conn_index)
1233 u32 thread_index = vlib_get_thread_index ();
1234 tcp_connection_t *tc;
1236 tc = tcp_connection_get (conn_index, thread_index);
1239 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1241 /* Session didn't come back with a close(). Send FIN either way
1242 * and switch to LAST_ACK. */
1243 if (tc->state == TCP_STATE_CLOSE_WAIT)
1245 if (tc->flags & TCP_CONN_FINSNT)
1247 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1250 /* Make sure we don't try to send unsent data */
1251 tcp_connection_timers_reset (tc);
1252 tcp_cong_recovery_off (tc);
1253 tc->snd_una_max = tc->snd_nxt = tc->snd_una;
1255 tc->state = TCP_STATE_LAST_ACK;
1257 /* Make sure we don't wait in LAST ACK forever */
1258 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1260 /* Don't delete the connection yet */
1264 tcp_connection_del (tc);
1268 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1270 tcp_timer_retransmit_handler,
1271 tcp_timer_delack_handler,
1272 tcp_timer_persist_handler,
1273 tcp_timer_keep_handler,
1274 tcp_timer_waitclose_handler,
1275 tcp_timer_retransmit_syn_handler,
1276 tcp_timer_establish_handler
1281 tcp_expired_timers_dispatch (u32 * expired_timers)
1284 u32 connection_index, timer_id;
1286 for (i = 0; i < vec_len (expired_timers); i++)
1288 /* Get session index and timer id */
1289 connection_index = expired_timers[i] & 0x0FFFFFFF;
1290 timer_id = expired_timers[i] >> 28;
1292 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1294 /* Handle expiration */
1295 (*timer_expiration_handlers[timer_id]) (connection_index);
1300 tcp_initialize_timer_wheels (tcp_main_t * tm)
1302 tw_timer_wheel_16t_2w_512sl_t *tw;
1304 foreach_vlib_main (({
1305 tw = &tm->wrk_ctx[ii].timer_wheel;
1306 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1307 100e-3 /* timer period 100ms */ , ~0);
1308 tw->last_run_time = vlib_time_now (this_vlib_main);
1313 static clib_error_t *
1314 tcp_main_enable (vlib_main_t * vm)
1316 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1317 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1318 tcp_connection_t *tc __attribute__ ((unused));
1319 tcp_main_t *tm = vnet_get_tcp_main ();
1320 clib_error_t *error = 0;
1323 if ((error = vlib_call_init_function (vm, ip_main_init)))
1325 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1327 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1334 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1335 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1338 * Initialize data structures
1341 num_threads = 1 /* main thread */ + vtm->n_threads;
1342 vec_validate (tm->connections, num_threads - 1);
1343 vec_validate (tm->wrk_ctx, num_threads - 1);
1344 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1345 prealloc_conn_per_wrk = tm->preallocated_connections / n_workers;
1347 for (thread = 0; thread < num_threads; thread++)
1349 vec_validate (tm->wrk_ctx[thread].pending_fast_rxt, 255);
1350 vec_validate (tm->wrk_ctx[thread].ongoing_fast_rxt, 255);
1351 vec_validate (tm->wrk_ctx[thread].postponed_fast_rxt, 255);
1352 vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1353 vec_validate (tm->wrk_ctx[thread].pending_acks, 255);
1354 vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1355 vec_reset_length (tm->wrk_ctx[thread].pending_fast_rxt);
1356 vec_reset_length (tm->wrk_ctx[thread].ongoing_fast_rxt);
1357 vec_reset_length (tm->wrk_ctx[thread].postponed_fast_rxt);
1358 vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1359 vec_reset_length (tm->wrk_ctx[thread].pending_acks);
1360 vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1361 tm->wrk_ctx[thread].vm = vlib_mains[thread];
1364 * Preallocate connections. Assume that thread 0 won't
1365 * use preallocated threads when running multi-core
1367 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1368 pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1372 * Use a preallocated half-open connection pool?
1374 if (tm->preallocated_half_open_connections)
1375 pool_init_fixed (tm->half_open_connections,
1376 tm->preallocated_half_open_connections);
1378 /* Initialize clocks per tick for TCP timestamp. Used to compute
1379 * monotonically increasing timestamps. */
1380 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1381 / TCP_TSTAMP_RESOLUTION;
1383 if (num_threads > 1)
1385 clib_spinlock_init (&tm->half_open_lock);
1388 tcp_initialize_timer_wheels (tm);
1390 tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
1391 (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1397 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1401 if (tcp_main.is_enabled)
1404 return tcp_main_enable (vm);
1408 tcp_main.is_enabled = 0;
1415 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1417 tcp_main_t *tm = &tcp_main;
1419 tm->punt_unknown4 = is_add;
1421 tm->punt_unknown6 = is_add;
1424 static clib_error_t *
1425 tcp_init (vlib_main_t * vm)
1427 tcp_main_t *tm = vnet_get_tcp_main ();
1428 ip_main_t *im = &ip_main;
1429 ip_protocol_info_t *pi;
1431 /* Session layer, and by implication tcp, are disabled by default */
1434 /* Register with IP for header parsing */
1435 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1437 return clib_error_return (0, "TCP protocol info AWOL");
1438 pi->format_header = format_tcp_header;
1439 pi->unformat_pg_edit = unformat_pg_tcp_header;
1441 /* Register as transport with session layer */
1442 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1443 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1444 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1445 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1447 tcp_api_reference ();
1449 tm->cc_algo = TCP_CC_NEWRENO;
1453 VLIB_INIT_FUNCTION (tcp_init);
1456 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1458 uword *result = va_arg (*va, uword *);
1460 if (unformat (input, "newreno"))
1461 *result = TCP_CC_NEWRENO;
1462 else if (unformat (input, "cubic"))
1463 *result = TCP_CC_CUBIC;
1471 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1473 tcp_main_t *tm = vnet_get_tcp_main ();
1474 tcp_cc_algorithm_t *cc_alg;
1475 unformat_input_t sub_input;
1478 vec_foreach (cc_alg, tm->cc_algos)
1480 if (!unformat (input, cc_alg->name))
1483 if (cc_alg->unformat_cfg
1484 && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1486 if (cc_alg->unformat_cfg (&sub_input))
1493 static clib_error_t *
1494 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1496 tcp_main_t *tm = vnet_get_tcp_main ();
1498 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1500 if (unformat (input, "preallocated-connections %d",
1501 &tm->preallocated_connections))
1503 else if (unformat (input, "preallocated-half-open-connections %d",
1504 &tm->preallocated_half_open_connections))
1506 else if (unformat (input, "buffer-fail-fraction %f",
1507 &tm->buffer_fail_fraction))
1509 else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1512 else if (unformat (input, "no-tx-pacing"))
1514 else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1517 else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1520 return clib_error_return (0, "unknown input `%U'",
1521 format_unformat_error, input);
1526 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1530 * \brief Configure an ipv4 source address range
1531 * @param vm vlib_main_t pointer
1532 * @param start first ipv4 address in the source address range
1533 * @param end last ipv4 address in the source address range
1534 * @param table_id VRF / table ID, 0 for the default FIB
1535 * @return 0 if all OK, else an error indication from api_errno.h
1539 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1540 ip4_address_t * start,
1541 ip4_address_t * end, u32 table_id)
1543 tcp_main_t *tm = vnet_get_tcp_main ();
1544 vnet_main_t *vnm = vnet_get_main ();
1545 u32 start_host_byte_order, end_host_byte_order;
1546 fib_prefix_t prefix;
1547 vnet_sw_interface_t *si;
1548 fib_node_index_t fei;
1552 int vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1553 ip4_address_t * hi_addr, u32 fib_index,
1556 clib_memset (&prefix, 0, sizeof (prefix));
1558 fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1560 if (fib_index == ~0)
1561 return VNET_API_ERROR_NO_SUCH_FIB;
1563 start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1564 end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1566 /* sanity check for reversed args or some such */
1567 if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1568 return VNET_API_ERROR_INVALID_ARGUMENT;
1570 /* Lookup the last address, to identify the interface involved */
1572 prefix.fp_proto = FIB_PROTOCOL_IP4;
1573 memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1575 fei = fib_table_lookup (fib_index, &prefix);
1577 /* Couldn't find route to destination. Bail out. */
1578 if (fei == FIB_NODE_INDEX_INVALID)
1579 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1581 sw_if_index = fib_entry_get_resolving_interface (fei);
1583 /* Enable proxy arp on the interface */
1584 si = vnet_get_sw_interface (vnm, sw_if_index);
1585 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
1587 /* Configure proxy arp across the range */
1588 rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1595 dpo_id_t dpo = DPO_INVALID;
1597 vec_add1 (tm->ip4_src_addresses, start[0]);
1599 /* Add local adjacencies for the range */
1601 receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1604 prefix.fp_proto = FIB_PROTOCOL_IP4;
1605 prefix.fp_addr.ip4.as_u32 = start->as_u32;
1607 fib_table_entry_special_dpo_update (fib_index,
1610 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1613 start_host_byte_order++;
1614 start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1616 while (start_host_byte_order <= end_host_byte_order);
1622 * \brief Configure an ipv6 source address range
1623 * @param vm vlib_main_t pointer
1624 * @param start first ipv6 address in the source address range
1625 * @param end last ipv6 address in the source address range
1626 * @param table_id VRF / table ID, 0 for the default FIB
1627 * @return 0 if all OK, else an error indication from api_errno.h
1631 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1632 ip6_address_t * start,
1633 ip6_address_t * end, u32 table_id)
1635 tcp_main_t *tm = vnet_get_tcp_main ();
1636 fib_prefix_t prefix;
1638 fib_node_index_t fei;
1641 clib_memset (&prefix, 0, sizeof (prefix));
1643 fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1645 if (fib_index == ~0)
1646 return VNET_API_ERROR_NO_SUCH_FIB;
1652 dpo_id_t dpo = DPO_INVALID;
1654 /* Remember this address */
1655 vec_add1 (tm->ip6_src_addresses, start[0]);
1657 /* Lookup the prefix, to identify the interface involved */
1658 prefix.fp_len = 128;
1659 prefix.fp_proto = FIB_PROTOCOL_IP6;
1660 memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1662 fei = fib_table_lookup (fib_index, &prefix);
1664 /* Couldn't find route to destination. Bail out. */
1665 if (fei == FIB_NODE_INDEX_INVALID)
1666 return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1668 sw_if_index = fib_entry_get_resolving_interface (fei);
1670 if (sw_if_index == (u32) ~ 0)
1671 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1673 /* Add a proxy neighbor discovery entry for this address */
1674 ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1676 /* Add a receive adjacency for this address */
1677 receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1680 fib_table_entry_special_dpo_update (fib_index,
1683 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1686 /* Done with the entire range? */
1687 if (!memcmp (start, end, sizeof (start[0])))
1690 /* Increment the address. DGMS. */
1692 for (i = 15; i >= 0; i--)
1695 if (tmp.as_u8[i] != 0)
1703 static clib_error_t *
1704 tcp_src_address (vlib_main_t * vm,
1705 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1707 ip4_address_t v4start, v4end;
1708 ip6_address_t v6start, v6end;
1714 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1716 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1717 unformat_ip4_address, &v4end))
1719 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1721 memcpy (&v4end, &v4start, sizeof (v4start));
1724 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1725 unformat_ip6_address, &v6end))
1727 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1729 memcpy (&v6end, &v6start, sizeof (v6start));
1732 else if (unformat (input, "fib-table %d", &table_id))
1738 if (!v4set && !v6set)
1739 return clib_error_return (0, "at least one v4 or v6 address required");
1743 rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1750 case VNET_API_ERROR_NO_SUCH_FIB:
1751 return clib_error_return (0, "Invalid table-id %d", table_id);
1753 case VNET_API_ERROR_INVALID_ARGUMENT:
1754 return clib_error_return (0, "Invalid address range %U - %U",
1755 format_ip4_address, &v4start,
1756 format_ip4_address, &v4end);
1758 return clib_error_return (0, "error %d", rv);
1764 rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1771 case VNET_API_ERROR_NO_SUCH_FIB:
1772 return clib_error_return (0, "Invalid table-id %d", table_id);
1775 return clib_error_return (0, "error %d", rv);
1783 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1785 .path = "tcp src-address",
1786 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1787 .function = tcp_src_address,
1792 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1794 #if TCP_SCOREBOARD_TRACE
1796 scoreboard_trace_elt_t *block;
1802 s = format (s, "scoreboard trace:");
1803 vec_foreach (block, sb->trace)
1805 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1806 block->ack, block->snd_una_max, block->group);
1808 s = format (s, "\n");
1816 static clib_error_t *
1817 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1818 vlib_cli_command_t * cmd_arg)
1820 transport_connection_t *tconn = 0;
1821 tcp_connection_t *tc;
1823 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1825 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1826 TRANSPORT_PROTO_TCP))
1829 return clib_error_return (0, "unknown input `%U'",
1830 format_unformat_error, input);
1833 if (!TCP_SCOREBOARD_TRACE)
1835 vlib_cli_output (vm, "scoreboard tracing not enabled");
1839 tc = tcp_get_connection_from_transport (tconn);
1840 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1841 vlib_cli_output (vm, "%v", s);
1846 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1848 .path = "show tcp scoreboard trace",
1849 .short_help = "show tcp scoreboard trace <connection>",
1850 .function = tcp_show_scoreboard_trace_fn,
1855 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1858 scoreboard_trace_elt_t *trace;
1859 u32 next_ack, left, group, has_new_ack = 0;
1860 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1861 sack_block_t *block;
1863 if (!TCP_SCOREBOARD_TRACE)
1865 s = format (s, "scoreboard tracing not enabled");
1872 clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
1873 tcp_connection_timers_init (dummy_tc);
1874 scoreboard_init (&dummy_tc->sack_sb);
1875 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1877 #if TCP_SCOREBOARD_TRACE
1878 trace = tc->sack_sb.trace;
1879 trace_len = vec_len (tc->sack_sb.trace);
1882 for (i = 0; i < trace_len; i++)
1884 if (trace[i].ack != 0)
1886 dummy_tc->snd_una = trace[i].ack - 1448;
1887 dummy_tc->snd_una_max = trace[i].ack;
1892 while (left < trace_len)
1894 group = trace[left].group;
1895 vec_reset_length (dummy_tc->rcv_opts.sacks);
1897 while (trace[left].group == group)
1899 if (trace[left].ack != 0)
1902 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1903 trace[left].ack, trace[left].snd_una_max);
1904 dummy_tc->snd_una_max = trace[left].snd_una_max;
1905 next_ack = trace[left].ack;
1911 s = format (s, "[%u, %u], ", trace[left].start,
1913 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1914 block->start = trace[left].start;
1915 block->end = trace[left].end;
1921 tcp_rcv_sacks (dummy_tc, next_ack);
1923 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1926 s = format (s, "result: %U", format_tcp_scoreboard,
1927 &dummy_tc->sack_sb);
1930 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1935 static clib_error_t *
1936 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1937 vlib_cli_command_t * cmd_arg)
1939 transport_connection_t *tconn = 0;
1940 tcp_connection_t *tc = 0;
1942 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1944 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1945 TRANSPORT_PROTO_TCP))
1948 return clib_error_return (0, "unknown input `%U'",
1949 format_unformat_error, input);
1952 if (!TCP_SCOREBOARD_TRACE)
1954 vlib_cli_output (vm, "scoreboard tracing not enabled");
1958 tc = tcp_get_connection_from_transport (tconn);
1961 vlib_cli_output (vm, "connection not found");
1964 str = tcp_scoreboard_replay (str, tc, 1);
1965 vlib_cli_output (vm, "%v", str);
1970 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1972 .path = "tcp replay scoreboard",
1973 .short_help = "tcp replay scoreboard <connection>",
1974 .function = tcp_scoreboard_trace_fn,
1978 static clib_error_t *
1979 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
1980 vlib_cli_command_t * cmd_arg)
1982 tcp_main_t *tm = vnet_get_tcp_main ();
1983 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1984 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
1986 vlib_cli_output (vm, "IPv4 TCP punt: %s",
1987 tm->punt_unknown4 ? "enabled" : "disabled");
1988 vlib_cli_output (vm, "IPv6 TCP punt: %s",
1989 tm->punt_unknown6 ? "enabled" : "disabled");
1993 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
1995 .path = "show tcp punt",
1996 .short_help = "show tcp punt",
1997 .function = show_tcp_punt_fn,
2002 * fd.io coding-style-patch-verification: ON
2005 * eval: (c-set-style "gnu")