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.
16 #include <vnet/tcp/tcp.h>
17 #include <vnet/session/session.h>
18 #include <vnet/fib/fib.h>
19 #include <vnet/dpo/load_balance.h>
25 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
27 tcp_main_t *tm = &tcp_main;
28 tcp_connection_t *listener;
30 pool_get (tm->listener_pool, listener);
31 memset (listener, 0, sizeof (*listener));
33 listener->c_c_index = listener - tm->listener_pool;
34 listener->c_lcl_port = clib_host_to_net_u16 (lcl->port);
38 listener->c_lcl_ip4.as_u32 = lcl->ip.ip4.as_u32;
39 listener->c_is_ip4 = 1;
43 clib_memcpy (&listener->c_lcl_ip6, &lcl->ip.ip6,
44 sizeof (ip6_address_t));
47 listener->c_transport_proto = TRANSPORT_PROTO_TCP;
48 listener->c_s_index = session_index;
49 listener->state = TCP_STATE_LISTEN;
51 tcp_connection_timers_init (listener);
53 TCP_EVT_DBG (TCP_EVT_BIND, listener);
55 return listener->c_c_index;
59 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
61 return tcp_connection_bind (session_index, tep);
65 tcp_connection_unbind (u32 listener_index)
67 tcp_main_t *tm = vnet_get_tcp_main ();
70 tc = pool_elt_at_index (tm->listener_pool, listener_index);
72 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
74 /* Poison the entry */
76 memset (tc, 0xFA, sizeof (*tc));
78 pool_put_index (tm->listener_pool, listener_index);
82 tcp_session_unbind (u32 listener_index)
84 tcp_connection_unbind (listener_index);
88 transport_connection_t *
89 tcp_session_get_listener (u32 listener_index)
91 tcp_main_t *tm = vnet_get_tcp_main ();
93 tc = pool_elt_at_index (tm->listener_pool, listener_index);
94 return &tc->connection;
98 transport_endpoint_del (u32 tepi)
100 tcp_main_t *tm = vnet_get_tcp_main ();
101 clib_spinlock_lock_if_init (&tm->local_endpoints_lock);
102 pool_put_index (tm->local_endpoints, tepi);
103 clib_spinlock_unlock_if_init (&tm->local_endpoints_lock);
106 always_inline transport_endpoint_t *
107 transport_endpoint_new (void)
109 tcp_main_t *tm = vnet_get_tcp_main ();
110 transport_endpoint_t *tep;
111 pool_get (tm->local_endpoints, tep);
116 * Cleanup half-open connection
120 tcp_half_open_connection_del (tcp_connection_t * tc)
122 tcp_main_t *tm = vnet_get_tcp_main ();
123 clib_spinlock_lock_if_init (&tm->half_open_lock);
124 pool_put_index (tm->half_open_connections, tc->c_c_index);
126 memset (tc, 0xFA, sizeof (*tc));
127 clib_spinlock_unlock_if_init (&tm->half_open_lock);
131 * Try to cleanup half-open connection
133 * If called from a thread that doesn't own tc, the call won't have any
136 * @param tc - connection to be cleaned up
137 * @return non-zero if cleanup failed.
140 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
142 /* Make sure this is the owning thread */
143 if (tc->c_thread_index != vlib_get_thread_index ())
145 tcp_timer_reset (tc, TCP_TIMER_ESTABLISH);
146 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
147 tcp_half_open_connection_del (tc);
152 tcp_half_open_connection_new (void)
154 tcp_main_t *tm = vnet_get_tcp_main ();
155 tcp_connection_t *tc = 0;
156 pool_get (tm->half_open_connections, tc);
157 memset (tc, 0, sizeof (*tc));
158 tc->c_c_index = tc - tm->half_open_connections;
163 * Cleans up connection state.
168 tcp_connection_cleanup (tcp_connection_t * tc)
170 tcp_main_t *tm = &tcp_main;
172 transport_endpoint_t *tep;
174 /* Cleanup local endpoint if this was an active connect */
175 tepi = transport_endpoint_lookup (&tm->local_endpoints_table, &tc->c_lcl_ip,
176 clib_net_to_host_u16 (tc->c_lcl_port));
177 if (tepi != TRANSPORT_ENDPOINT_INVALID_INDEX)
179 tep = pool_elt_at_index (tm->local_endpoints, tepi);
180 transport_endpoint_table_del (&tm->local_endpoints_table, tep);
181 transport_endpoint_del (tepi);
184 /* Check if connection is not yet fully established */
185 if (tc->state == TCP_STATE_SYN_SENT)
187 /* Try to remove the half-open connection. If this is not the owning
188 * thread, tc won't be removed. Retransmit or establish timers will
189 * eventually expire and call again cleanup on the right thread. */
190 tcp_half_open_connection_cleanup (tc);
194 int thread_index = tc->c_thread_index;
196 /* Make sure all timers are cleared */
197 tcp_connection_timers_reset (tc);
199 /* Poison the entry */
201 memset (tc, 0xFA, sizeof (*tc));
202 pool_put (tm->connections[thread_index], tc);
207 * Connection removal.
209 * This should be called only once connection enters CLOSED state. Note
210 * that it notifies the session of the removal event, so if the goal is to
211 * just remove the connection, call tcp_connection_cleanup instead.
214 tcp_connection_del (tcp_connection_t * tc)
216 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
217 stream_session_delete_notify (&tc->connection);
218 tcp_connection_cleanup (tc);
222 tcp_connection_new (u8 thread_index)
224 tcp_main_t *tm = vnet_get_tcp_main ();
225 tcp_connection_t *tc;
227 pool_get (tm->connections[thread_index], tc);
228 memset (tc, 0, sizeof (*tc));
229 tc->c_c_index = tc - tm->connections[thread_index];
230 tc->c_thread_index = thread_index;
234 /** Notify session that connection has been reset.
236 * Switch state to closed and wait for session to call cleanup.
239 tcp_connection_reset (tcp_connection_t * tc)
241 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
244 case TCP_STATE_SYN_RCVD:
245 /* Cleanup everything. App wasn't notified yet */
246 stream_session_delete_notify (&tc->connection);
247 tcp_connection_cleanup (tc);
249 case TCP_STATE_SYN_SENT:
250 stream_session_connect_notify (&tc->connection, 1 /* fail */ );
251 tcp_connection_cleanup (tc);
253 case TCP_STATE_ESTABLISHED:
254 case TCP_STATE_CLOSE_WAIT:
255 case TCP_STATE_FIN_WAIT_1:
256 case TCP_STATE_FIN_WAIT_2:
257 case TCP_STATE_CLOSING:
258 tc->state = TCP_STATE_CLOSED;
259 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
261 /* Make sure all timers are cleared */
262 tcp_connection_timers_reset (tc);
263 stream_session_reset_notify (&tc->connection);
265 /* Wait for cleanup from session layer but not forever */
266 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
268 case TCP_STATE_CLOSED:
274 * Begin connection closing procedure.
276 * If at the end the connection is not in CLOSED state, it is not removed.
277 * Instead, we rely on on TCP to advance through state machine to either
278 * 1) LAST_ACK (passive close) whereby when the last ACK is received
279 * tcp_connection_del is called. This notifies session of the delete and
281 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
282 * and cleanup is called.
284 * N.B. Half-close connections are not supported
287 tcp_connection_close (tcp_connection_t * tc)
289 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
291 /* Send FIN if needed */
292 if (tc->state == TCP_STATE_ESTABLISHED
293 || tc->state == TCP_STATE_SYN_RCVD || tc->state == TCP_STATE_CLOSE_WAIT)
297 if (tc->state == TCP_STATE_ESTABLISHED || tc->state == TCP_STATE_SYN_RCVD)
298 tc->state = TCP_STATE_FIN_WAIT_1;
299 else if (tc->state == TCP_STATE_SYN_SENT)
300 tc->state = TCP_STATE_CLOSED;
301 else if (tc->state == TCP_STATE_CLOSE_WAIT)
302 tc->state = TCP_STATE_LAST_ACK;
303 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
305 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
306 if (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID
307 && tc->state == TCP_STATE_CLOSED)
308 tcp_connection_del (tc);
312 tcp_session_close (u32 conn_index, u32 thread_index)
314 tcp_connection_t *tc;
315 tc = tcp_connection_get (conn_index, thread_index);
316 tcp_connection_close (tc);
320 tcp_session_cleanup (u32 conn_index, u32 thread_index)
322 tcp_connection_t *tc;
323 tc = tcp_connection_get (conn_index, thread_index);
325 /* Wait for the session tx events to clear */
326 tc->state = TCP_STATE_CLOSED;
327 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
328 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
332 ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4)
334 ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
335 ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
336 ip_interface_address_t *ia = 0;
341 foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
343 return ip_interface_address_get_address (lm4, ia);
350 foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
352 return ip_interface_address_get_address (lm6, ia);
360 #define PORT_MASK ((1 << 16)- 1)
362 * Allocate local port and add if successful add entry to local endpoint
363 * table to mark the pair as used.
366 tcp_allocate_local_port (ip46_address_t * ip)
368 tcp_main_t *tm = vnet_get_tcp_main ();
369 transport_endpoint_t *tep;
371 u16 min = 1024, max = 65535; /* XXX configurable ? */
376 /* Only support active opens from thread 0 */
377 ASSERT (vlib_get_thread_index () == 0);
379 /* Search for first free slot */
380 for (tries = 0; tries < limit; tries++)
384 /* Find a port in the specified range */
387 port = random_u32 (&tm->port_allocator_seed) & PORT_MASK;
388 if (PREDICT_TRUE (port >= min && port < max))
393 tei = transport_endpoint_lookup (&tm->local_endpoints_table, ip, port);
394 /* If not found, we're done */
395 if (tei == TRANSPORT_ENDPOINT_INVALID_INDEX)
397 clib_spinlock_lock_if_init (&tm->local_endpoints_lock);
398 tep = transport_endpoint_new ();
399 clib_memcpy (&tep->ip, ip, sizeof (*ip));
401 transport_endpoint_table_add (&tm->local_endpoints_table, tep,
402 tep - tm->local_endpoints);
403 clib_spinlock_unlock_if_init (&tm->local_endpoints_lock);
412 * Initialize all connection timers as invalid
415 tcp_connection_timers_init (tcp_connection_t * tc)
419 /* Set all to invalid */
420 for (i = 0; i < TCP_N_TIMERS; i++)
422 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
425 tc->rto = TCP_RTO_INIT;
429 * Stop all connection timers
432 tcp_connection_timers_reset (tcp_connection_t * tc)
435 for (i = 0; i < TCP_N_TIMERS; i++)
437 tcp_timer_reset (tc, i);
442 typedef struct ip4_tcp_hdr
448 typedef struct ip6_tcp_hdr
455 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
458 const dpo_id_t *choice;
462 lb = load_balance_get (dpo->dpoi_index);
466 memset (&hdr, 0, sizeof (hdr));
467 hdr.ip.protocol = IP_PROTOCOL_TCP;
468 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
469 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
470 hdr.tcp.src_port = tc->c_lcl_port;
471 hdr.tcp.dst_port = tc->c_rmt_port;
472 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
477 memset (&hdr, 0, sizeof (hdr));
478 hdr.ip.protocol = IP_PROTOCOL_TCP;
479 clib_memcpy (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
480 sizeof (ip6_address_t));
481 clib_memcpy (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
482 sizeof (ip6_address_t));
483 hdr.tcp.src_port = tc->c_lcl_port;
484 hdr.tcp.dst_port = tc->c_rmt_port;
485 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
487 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
488 dpo_copy (result, choice);
492 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
497 clib_memcpy (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
498 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
499 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
500 fib_index = fib_table_find (prefix.fp_proto, tc->c_vrf);
501 return fib_table_lookup (fib_index, &prefix);
505 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
507 dpo_id_t choice = DPO_INVALID;
508 u32 output_node_index;
511 fe = fib_entry_get (tc->c_rmt_fei);
512 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
515 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
518 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
519 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
523 /** Stack tcp connection on peer's fib entry.
525 * This ultimately populates the dpo the connection will use to send packets.
528 tcp_connection_fib_attach (tcp_connection_t * tc)
530 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
532 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
534 tcp_connection_stack_on_fib_entry (tc);
538 /** Initialize tcp connection variables
540 * Should be called after having received a msg from the peer, i.e., a SYN or
541 * a SYNACK, such that connection options have already been exchanged. */
543 tcp_connection_init_vars (tcp_connection_t * tc)
545 tcp_connection_timers_init (tc);
547 scoreboard_init (&tc->sack_sb);
549 // tcp_connection_fib_attach (tc);
553 tcp_connection_open (transport_endpoint_t * rmt)
555 tcp_main_t *tm = vnet_get_tcp_main ();
556 tcp_connection_t *tc;
558 fib_node_index_t fei;
559 u32 sw_if_index, fib_index;
560 ip46_address_t lcl_addr;
564 * Find the local address and allocate port
566 memset (&lcl_addr, 0, sizeof (lcl_addr));
568 /* Find a FIB path to the destination */
569 clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
570 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
571 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
573 fib_index = fib_table_find (prefix.fp_proto, rmt->vrf);
574 fei = fib_table_lookup (fib_index, &prefix);
576 /* Couldn't find route to destination. Bail out. */
577 if (fei == FIB_NODE_INDEX_INVALID)
579 clib_warning ("no route to destination");
583 sw_if_index = fib_entry_get_resolving_interface (fei);
585 if (sw_if_index == (u32) ~ 0)
587 clib_warning ("no resolving interface for %U", format_ip46_address,
588 &rmt->ip, IP46_TYPE_IP4);
596 if (vec_len (tm->ip4_src_addresses))
598 index = tm->last_v4_address_rotor++;
599 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
600 tm->last_v4_address_rotor = 0;
601 lcl_addr.ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
605 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
606 lcl_addr.ip4.as_u32 = ip4->as_u32;
614 if (vec_len (tm->ip6_src_addresses))
616 index = tm->last_v6_address_rotor++;
617 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
618 tm->last_v6_address_rotor = 0;
619 clib_memcpy (&lcl_addr.ip6, &tm->ip6_src_addresses[index],
624 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
625 clib_memcpy (&lcl_addr.ip6, ip6, sizeof (*ip6));
629 /* Allocate source port */
630 lcl_port = tcp_allocate_local_port (&lcl_addr);
633 clib_warning ("Failed to allocate src port");
638 * Create connection and send SYN
640 clib_spinlock_lock_if_init (&tm->half_open_lock);
641 tc = tcp_half_open_connection_new ();
642 clib_memcpy (&tc->c_rmt_ip, &rmt->ip, sizeof (ip46_address_t));
643 clib_memcpy (&tc->c_lcl_ip, &lcl_addr, sizeof (ip46_address_t));
644 tc->c_rmt_port = clib_host_to_net_u16 (rmt->port);
645 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
646 tc->c_is_ip4 = rmt->is_ip4;
647 tc->c_transport_proto = TRANSPORT_PROTO_TCP;
648 tc->c_vrf = rmt->vrf;
649 /* The other connection vars will be initialized after SYN ACK */
650 tcp_connection_timers_init (tc);
652 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
653 tc->state = TCP_STATE_SYN_SENT;
655 clib_spinlock_unlock_if_init (&tm->half_open_lock);
657 return tc->c_c_index;
661 tcp_session_open (transport_endpoint_t * tep)
663 return tcp_connection_open (tep);
666 const char *tcp_dbg_evt_str[] = {
667 #define _(sym, str) str,
672 const char *tcp_fsm_states[] = {
673 #define _(sym, str) str,
674 foreach_tcp_fsm_state
679 format_tcp_state (u8 * s, va_list * args)
681 u32 state = va_arg (*args, u32);
683 if (state < TCP_N_STATES)
684 s = format (s, "%s", tcp_fsm_states[state]);
686 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
690 const char *tcp_conn_timers[] = {
691 #define _(sym, str) str,
697 format_tcp_timers (u8 * s, va_list * args)
699 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
702 for (i = 0; i < TCP_N_TIMERS; i++)
703 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
707 for (i = 0; i < last; i++)
709 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
710 s = format (s, "%s,", tcp_conn_timers[i]);
714 s = format (s, "%s]", tcp_conn_timers[i]);
722 format_tcp_congestion_status (u8 * s, va_list * args)
724 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
725 if (tcp_in_recovery (tc))
726 s = format (s, "recovery");
727 else if (tcp_in_fastrecovery (tc))
728 s = format (s, "fastrecovery");
730 s = format (s, "none");
735 format_tcp_vars (u8 * s, va_list * args)
737 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
738 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
739 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
740 tc->snd_una_max - tc->iss);
741 s = format (s, " rcv_nxt %u rcv_las %u\n",
742 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
743 s = format (s, " snd_wnd %u rcv_wnd %u snd_wl1 %u snd_wl2 %u\n",
744 tc->snd_wnd, tc->rcv_wnd, tc->snd_wl1 - tc->irs,
745 tc->snd_wl2 - tc->iss);
746 s = format (s, " flight size %u send space %u rcv_wnd_av %d\n",
747 tcp_flight_size (tc), tcp_available_snd_space (tc),
748 tcp_rcv_wnd_available (tc));
749 s = format (s, " cong %U ", format_tcp_congestion_status, tc);
750 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
751 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
752 s = format (s, " prev_ssthresh %u snd_congestion %u dupack %u",
753 tc->prev_ssthresh, tc->snd_congestion - tc->iss,
755 s = format (s, " limited_transmit %u\n", tc->limited_transmit - tc->iss);
756 s = format (s, " tsecr %u tsecr_last_ack %u\n", tc->rcv_opts.tsecr,
758 s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %u ", tc->rto,
759 tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
760 s = format (s, "rtt_seq %u\n", tc->rtt_seq);
761 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
762 tcp_time_now () - tc->tsval_recent_age);
763 s = format (s, " scoreboard: %U\n", format_tcp_scoreboard, &tc->sack_sb);
764 if (vec_len (tc->snd_sacks))
765 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
771 format_tcp_connection_id (u8 * s, va_list * args)
773 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
778 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
779 format_ip4_address, &tc->c_lcl_ip4,
780 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
781 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
785 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
786 format_ip6_address, &tc->c_lcl_ip6,
787 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
788 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
795 format_tcp_connection (u8 * s, va_list * args)
797 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
798 u32 verbose = va_arg (*args, u32);
800 s = format (s, "%-50U", format_tcp_connection_id, tc);
803 s = format (s, "%-15U", format_tcp_state, tc->state);
805 s = format (s, " %U\n%U", format_tcp_timers, tc, format_tcp_vars, tc);
812 format_tcp_session (u8 * s, va_list * args)
814 u32 tci = va_arg (*args, u32);
815 u32 thread_index = va_arg (*args, u32);
816 u32 verbose = va_arg (*args, u32);
817 tcp_connection_t *tc;
819 tc = tcp_connection_get (tci, thread_index);
821 s = format (s, "%U", format_tcp_connection, tc, verbose);
823 s = format (s, "empty");
828 format_tcp_listener_session (u8 * s, va_list * args)
830 u32 tci = va_arg (*args, u32);
831 tcp_connection_t *tc = tcp_listener_get (tci);
832 return format (s, "%U", format_tcp_connection_id, tc);
836 format_tcp_half_open_session (u8 * s, va_list * args)
838 u32 tci = va_arg (*args, u32);
839 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
840 return format (s, "%U", format_tcp_connection_id, tc);
844 format_tcp_sacks (u8 * s, va_list * args)
846 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
847 sack_block_t *sacks = tc->snd_sacks;
851 len = vec_len (sacks);
852 for (i = 0; i < len - 1; i++)
855 s = format (s, " start %u end %u\n", block->start - tc->irs,
856 block->end - tc->irs);
860 block = &sacks[len - 1];
861 s = format (s, " start %u end %u", block->start - tc->irs,
862 block->end - tc->irs);
868 format_tcp_rcv_sacks (u8 * s, va_list * args)
870 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
871 sack_block_t *sacks = tc->rcv_opts.sacks;
875 len = vec_len (sacks);
876 for (i = 0; i < len - 1; i++)
879 s = format (s, " start %u end %u\n", block->start - tc->iss,
880 block->end - tc->iss);
884 block = &sacks[len - 1];
885 s = format (s, " start %u end %u", block->start - tc->iss,
886 block->end - tc->iss);
892 format_tcp_sack_hole (u8 * s, va_list * args)
894 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
895 s = format (s, "[%u, %u]", hole->start, hole->end);
900 format_tcp_scoreboard (u8 * s, va_list * args)
902 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
903 sack_scoreboard_hole_t *hole;
904 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
905 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
906 s = format (s, " last_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
907 sb->last_bytes_delivered, sb->high_sacked, sb->snd_una_adv);
908 s = format (s, " cur_rxt_hole %u high_rxt %u rescue_rxt %u",
909 sb->cur_rxt_hole, sb->high_rxt, sb->rescue_rxt);
911 hole = scoreboard_first_hole (sb);
913 s = format (s, "\n head %u tail %u holes:\n", sb->head, sb->tail);
917 s = format (s, "%U", format_tcp_sack_hole, hole);
918 hole = scoreboard_next_hole (sb, hole);
924 transport_connection_t *
925 tcp_session_get_transport (u32 conn_index, u32 thread_index)
927 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
928 return &tc->connection;
931 transport_connection_t *
932 tcp_half_open_session_get_transport (u32 conn_index)
934 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
935 return &tc->connection;
939 * Compute maximum segment size for session layer.
941 * Since the result needs to be the actual data length, it first computes
942 * the tcp options to be used in the next burst and subtracts their
943 * length from the connection's snd_mss.
946 tcp_session_send_mss (transport_connection_t * trans_conn)
948 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
950 /* Ensure snd_mss does accurately reflect the amount of data we can push
951 * in a segment. This also makes sure that options are updated according to
952 * the current state of the connection. */
953 tcp_update_snd_mss (tc);
959 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
961 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
963 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
966 /* If we can't write at least a segment, don't try at all */
967 if (PREDICT_FALSE (snd_space < tc->snd_mss))
969 if (snd_space > clib_min (tc->mss, tc->rcv_opts.mss) - TCP_HDR_LEN_MAX)
974 /* round down to mss multiple */
975 return snd_space - (snd_space % tc->snd_mss);
979 * Compute tx window session is allowed to fill.
981 * Takes into account available send space, snd_mss and the congestion
982 * state of the connection. If possible, the value returned is a multiple
985 * @param tc tcp connection
986 * @return number of bytes session is allowed to write
989 tcp_snd_space (tcp_connection_t * tc)
991 int snd_space, snt_limited;
993 if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0))
995 snd_space = tcp_available_snd_space (tc);
997 /* If we haven't gotten dupacks or if we did and have gotten sacked
998 * bytes then we can still send as per Limited Transmit (RFC3042) */
999 if (PREDICT_FALSE (tc->rcv_dupacks != 0
1000 && (tcp_opts_sack_permitted (tc)
1001 && tc->sack_sb.last_sacked_bytes == 0)))
1003 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1004 tc->limited_transmit = tc->snd_nxt;
1005 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1007 snt_limited = tc->snd_nxt - tc->limited_transmit;
1008 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1010 return tcp_round_snd_space (tc, snd_space);
1013 if (tcp_in_recovery (tc))
1015 tc->snd_nxt = tc->snd_una_max;
1016 snd_space = tcp_available_wnd (tc) - tc->snd_rxt_bytes
1017 - (tc->snd_una_max - tc->snd_congestion);
1018 if (snd_space <= 0 || (tc->snd_una_max - tc->snd_una) >= tc->snd_wnd)
1020 return tcp_round_snd_space (tc, snd_space);
1023 /* If in fast recovery, send 1 SMSS if wnd allows */
1024 if (tcp_in_fastrecovery (tc)
1025 && tcp_available_snd_space (tc) && !tcp_fastrecovery_sent_1_smss (tc))
1027 tcp_fastrecovery_1_smss_on (tc);
1035 tcp_session_send_space (transport_connection_t * trans_conn)
1037 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1038 return tcp_snd_space (tc);
1042 tcp_rcv_wnd_available (tcp_connection_t * tc)
1044 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
1048 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1050 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1052 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1054 /* This still works if fast retransmit is on */
1055 return (tc->snd_nxt - tc->snd_una);
1059 const static transport_proto_vft_t tcp_proto = {
1060 .bind = tcp_session_bind,
1061 .unbind = tcp_session_unbind,
1062 .push_header = tcp_push_header,
1063 .get_connection = tcp_session_get_transport,
1064 .get_listener = tcp_session_get_listener,
1065 .get_half_open = tcp_half_open_session_get_transport,
1066 .open = tcp_session_open,
1067 .close = tcp_session_close,
1068 .cleanup = tcp_session_cleanup,
1069 .send_mss = tcp_session_send_mss,
1070 .send_space = tcp_session_send_space,
1071 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1072 .format_connection = format_tcp_session,
1073 .format_listener = format_tcp_listener_session,
1074 .format_half_open = format_tcp_half_open_session,
1079 tcp_timer_keep_handler (u32 conn_index)
1081 u32 thread_index = vlib_get_thread_index ();
1082 tcp_connection_t *tc;
1084 tc = tcp_connection_get (conn_index, thread_index);
1085 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1087 tcp_connection_close (tc);
1091 tcp_timer_establish_handler (u32 conn_index)
1093 tcp_connection_t *tc;
1095 tc = tcp_half_open_connection_get (conn_index);
1096 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1098 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1099 stream_session_connect_notify (&tc->connection, 1 /* fail */ );
1100 tcp_connection_cleanup (tc);
1104 tcp_timer_waitclose_handler (u32 conn_index)
1106 u32 thread_index = vlib_get_thread_index ();
1107 tcp_connection_t *tc;
1109 tc = tcp_connection_get (conn_index, thread_index);
1112 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1114 /* Session didn't come back with a close(). Send FIN either way
1115 * and switch to LAST_ACK. */
1116 if (tc->state == TCP_STATE_CLOSE_WAIT)
1118 if (tc->flags & TCP_CONN_FINSNT)
1120 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1124 tc->state = TCP_STATE_LAST_ACK;
1126 /* Make sure we don't wait in LAST ACK forever */
1127 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1129 /* Don't delete the connection yet */
1133 tcp_connection_del (tc);
1137 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1139 tcp_timer_retransmit_handler,
1140 tcp_timer_delack_handler,
1141 tcp_timer_persist_handler,
1142 tcp_timer_keep_handler,
1143 tcp_timer_waitclose_handler,
1144 tcp_timer_retransmit_syn_handler,
1145 tcp_timer_establish_handler
1150 tcp_expired_timers_dispatch (u32 * expired_timers)
1153 u32 connection_index, timer_id;
1155 for (i = 0; i < vec_len (expired_timers); i++)
1157 /* Get session index and timer id */
1158 connection_index = expired_timers[i] & 0x0FFFFFFF;
1159 timer_id = expired_timers[i] >> 28;
1161 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1163 /* Handle expiration */
1164 (*timer_expiration_handlers[timer_id]) (connection_index);
1169 tcp_initialize_timer_wheels (tcp_main_t * tm)
1171 tw_timer_wheel_16t_2w_512sl_t *tw;
1173 foreach_vlib_main (({
1174 tw = &tm->timer_wheels[ii];
1175 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1176 100e-3 /* timer period 100ms */ , ~0);
1177 tw->last_run_time = vlib_time_now (this_vlib_main);
1183 tcp_main_enable (vlib_main_t * vm)
1185 tcp_main_t *tm = vnet_get_tcp_main ();
1186 ip_protocol_info_t *pi;
1187 ip_main_t *im = &ip_main;
1188 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1189 clib_error_t *error = 0;
1192 tcp_connection_t *tc __attribute__ ((unused));
1193 u32 preallocated_connections_per_thread;
1195 if ((error = vlib_call_init_function (vm, ip_main_init)))
1197 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1199 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1206 /* Register with IP */
1207 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1209 return clib_error_return (0, "TCP protocol info AWOL");
1210 pi->format_header = format_tcp_header;
1211 pi->unformat_pg_edit = unformat_pg_tcp_header;
1213 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1215 /* Register as transport with session layer */
1216 session_register_transport (TRANSPORT_PROTO_TCP, 1, &tcp_proto);
1217 session_register_transport (TRANSPORT_PROTO_TCP, 0, &tcp_proto);
1220 * Initialize data structures
1223 num_threads = 1 /* main thread */ + vtm->n_threads;
1224 vec_validate (tm->connections, num_threads - 1);
1227 * Preallocate connections. Assume that thread 0 won't
1228 * use preallocated threads when running multi-core
1230 if (num_threads == 1)
1233 preallocated_connections_per_thread = tm->preallocated_connections;
1238 preallocated_connections_per_thread =
1239 tm->preallocated_connections / (num_threads - 1);
1241 for (; thread < num_threads; thread++)
1243 for (i = 0; i < preallocated_connections_per_thread; i++)
1244 pool_get (tm->connections[thread], tc);
1246 for (i = 0; i < preallocated_connections_per_thread; i++)
1247 pool_put_index (tm->connections[thread], i);
1251 * Preallocate half-open connections
1253 for (i = 0; i < tm->preallocated_half_open_connections; i++)
1254 pool_get (tm->half_open_connections, tc);
1256 for (i = 0; i < tm->preallocated_half_open_connections; i++)
1257 pool_put_index (tm->half_open_connections, i);
1259 /* Initialize per worker thread tx buffers (used for control messages) */
1260 vec_validate (tm->tx_buffers, num_threads - 1);
1262 /* Initialize timer wheels */
1263 vec_validate (tm->timer_wheels, num_threads - 1);
1264 tcp_initialize_timer_wheels (tm);
1266 /* Initialize clocks per tick for TCP timestamp. Used to compute
1267 * monotonically increasing timestamps. */
1268 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1269 / TCP_TSTAMP_RESOLUTION;
1271 clib_bihash_init_24_8 (&tm->local_endpoints_table, "local endpoint table",
1272 1000000 /* $$$$ config parameter nbuckets */ ,
1273 (512 << 20) /*$$$ config parameter table size */ );
1275 /* Initialize [port-allocator] random number seed */
1276 tm->port_allocator_seed = (u32) clib_cpu_time_now ();
1278 if (num_threads > 1)
1280 clib_spinlock_init (&tm->half_open_lock);
1281 clib_spinlock_init (&tm->local_endpoints_lock);
1284 vec_validate (tm->tx_frames[0], num_threads - 1);
1285 vec_validate (tm->tx_frames[1], num_threads - 1);
1291 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1295 if (tcp_main.is_enabled)
1298 return tcp_main_enable (vm);
1302 tcp_main.is_enabled = 0;
1309 tcp_init (vlib_main_t * vm)
1311 tcp_main_t *tm = vnet_get_tcp_main ();
1316 VLIB_INIT_FUNCTION (tcp_init);
1318 static clib_error_t *
1319 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1321 tcp_main_t *tm = vnet_get_tcp_main ();
1323 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1326 (input, "preallocated-connections %d",
1327 &tm->preallocated_connections))
1329 else if (unformat (input, "preallocated-half-open-connections %d",
1330 &tm->preallocated_half_open_connections))
1333 return clib_error_return (0, "unknown input `%U'",
1334 format_unformat_error, input);
1339 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1341 static clib_error_t *
1342 tcp_src_address (vlib_main_t * vm,
1343 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1345 tcp_main_t *tm = vnet_get_tcp_main ();
1346 ip4_address_t v4start, v4end;
1347 ip6_address_t v6start, v6end;
1351 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1353 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1354 unformat_ip4_address, &v4end))
1356 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1358 memcpy (&v4end, &v4start, sizeof (v4start));
1361 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1362 unformat_ip4_address, &v6end))
1364 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1366 memcpy (&v6end, &v6start, sizeof (v4start));
1373 if (!v4set && !v6set)
1374 return clib_error_return (0, "at least one v4 or v6 address required");
1382 vec_add1 (tm->ip4_src_addresses, v4start);
1383 tmp = clib_net_to_host_u32 (v4start.as_u32);
1385 v4start.as_u32 = clib_host_to_net_u32 (tmp);
1387 while (clib_host_to_net_u32 (v4start.as_u32) <=
1388 clib_host_to_net_u32 (v4end.as_u32));
1392 clib_warning ("v6 src address list unimplemented...");
1398 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1400 .path = "tcp src-address",
1401 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1402 .function = tcp_src_address,
1407 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1409 #if TCP_SCOREBOARD_TRACE
1411 scoreboard_trace_elt_t *block;
1417 s = format (s, "scoreboard trace:");
1418 vec_foreach (block, sb->trace)
1420 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1421 block->ack, block->snd_una_max, block->group);
1423 s = format (s, "\n");
1431 static clib_error_t *
1432 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1433 vlib_cli_command_t * cmd_arg)
1435 transport_connection_t *tconn = 0;
1436 tcp_connection_t *tc;
1438 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1440 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1441 TRANSPORT_PROTO_TCP))
1444 return clib_error_return (0, "unknown input `%U'",
1445 format_unformat_error, input);
1448 if (!TCP_SCOREBOARD_TRACE)
1450 vlib_cli_output (vm, "scoreboard tracing not enabled");
1454 tc = tcp_get_connection_from_transport (tconn);
1455 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1456 vlib_cli_output (vm, "%v", s);
1461 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1463 .path = "show tcp scoreboard trace",
1464 .short_help = "show tcp scoreboard trace <connection>",
1465 .function = tcp_show_scoreboard_trace_fn,
1470 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1473 scoreboard_trace_elt_t *trace;
1474 u32 next_ack, left, group, has_new_ack = 0;
1475 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1476 sack_block_t *block;
1481 memset (dummy_tc, 0, sizeof (*dummy_tc));
1482 tcp_connection_timers_init (dummy_tc);
1483 scoreboard_init (&dummy_tc->sack_sb);
1484 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1486 #if TCP_SCOREBOARD_TRACE
1487 trace = tc->sack_sb.trace;
1488 trace_len = vec_len (tc->sack_sb.trace);
1494 for (i = 0; i < trace_len; i++)
1496 if (trace[i].ack != 0)
1498 dummy_tc->snd_una = trace[i].ack - 1448;
1499 dummy_tc->snd_una_max = trace[i].ack;
1504 while (left < trace_len)
1506 group = trace[left].group;
1507 vec_reset_length (dummy_tc->rcv_opts.sacks);
1509 while (trace[left].group == group)
1511 if (trace[left].ack != 0)
1514 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1515 trace[left].ack, trace[left].snd_una_max);
1516 dummy_tc->snd_una_max = trace[left].snd_una_max;
1517 next_ack = trace[left].ack;
1523 s = format (s, "[%u, %u], ", trace[left].start,
1525 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1526 block->start = trace[left].start;
1527 block->end = trace[left].end;
1533 tcp_rcv_sacks (dummy_tc, next_ack);
1535 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1538 s = format (s, "result: %U", format_tcp_scoreboard,
1539 &dummy_tc->sack_sb);
1542 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1547 static clib_error_t *
1548 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1549 vlib_cli_command_t * cmd_arg)
1551 transport_connection_t *tconn = 0;
1552 tcp_connection_t *tc = 0;
1554 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1556 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1557 TRANSPORT_PROTO_TCP))
1560 return clib_error_return (0, "unknown input `%U'",
1561 format_unformat_error, input);
1564 if (!TCP_SCOREBOARD_TRACE)
1566 vlib_cli_output (vm, "scoreboard tracing not enabled");
1570 tc = tcp_get_connection_from_transport (tconn);
1573 vlib_cli_output (vm, "connection not found");
1576 str = tcp_scoreboard_replay (str, tc, 1);
1577 vlib_cli_output (vm, "%v", str);
1582 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1584 .path = "tcp replay scoreboard",
1585 .short_help = "tcp replay scoreboard <connection>",
1586 .function = tcp_scoreboard_trace_fn,
1591 * fd.io coding-style-patch-verification: ON
1594 * eval: (c-set-style "gnu")