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, ip46_address_t * ip,
26 u16 port_host_byte_order, u8 is_ip4)
28 tcp_main_t *tm = &tcp_main;
29 tcp_connection_t *listener;
31 pool_get (tm->listener_pool, listener);
32 memset (listener, 0, sizeof (*listener));
34 listener->c_c_index = listener - tm->listener_pool;
35 listener->c_lcl_port = clib_host_to_net_u16 (port_host_byte_order);
39 listener->c_lcl_ip4.as_u32 = ip->ip4.as_u32;
40 listener->c_is_ip4 = 1;
41 listener->c_proto = SESSION_TYPE_IP4_TCP;
45 clib_memcpy (&listener->c_lcl_ip6, &ip->ip6, sizeof (ip6_address_t));
46 listener->c_proto = SESSION_TYPE_IP6_TCP;
49 listener->c_s_index = session_index;
50 listener->state = TCP_STATE_LISTEN;
52 tcp_connection_timers_init (listener);
54 TCP_EVT_DBG (TCP_EVT_BIND, listener);
56 return listener->c_c_index;
60 tcp_session_bind_ip4 (u32 session_index, ip46_address_t * ip,
61 u16 port_host_byte_order)
63 return tcp_connection_bind (session_index, ip, port_host_byte_order, 1);
67 tcp_session_bind_ip6 (u32 session_index, ip46_address_t * ip,
68 u16 port_host_byte_order)
70 return tcp_connection_bind (session_index, ip, port_host_byte_order, 0);
74 tcp_connection_unbind (u32 listener_index)
76 tcp_main_t *tm = vnet_get_tcp_main ();
79 tc = pool_elt_at_index (tm->listener_pool, listener_index);
81 TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
83 /* Poison the entry */
85 memset (tc, 0xFA, sizeof (*tc));
87 pool_put_index (tm->listener_pool, listener_index);
91 tcp_session_unbind (u32 listener_index)
93 tcp_connection_unbind (listener_index);
97 transport_connection_t *
98 tcp_session_get_listener (u32 listener_index)
100 tcp_main_t *tm = vnet_get_tcp_main ();
101 tcp_connection_t *tc;
102 tc = pool_elt_at_index (tm->listener_pool, listener_index);
103 return &tc->connection;
107 * Cleans up connection state.
112 tcp_connection_cleanup (tcp_connection_t * tc)
114 tcp_main_t *tm = &tcp_main;
116 transport_endpoint_t *tep;
118 /* Cleanup local endpoint if this was an active connect */
119 tepi = transport_endpoint_lookup (&tm->local_endpoints_table, &tc->c_lcl_ip,
123 if (tepi != TRANSPORT_ENDPOINT_INVALID_INDEX)
125 tep = pool_elt_at_index (tm->local_endpoints, tepi);
126 transport_endpoint_table_del (&tm->local_endpoints_table, tep);
127 pool_put (tm->local_endpoints, tep);
130 /* Make sure all timers are cleared */
131 tcp_connection_timers_reset (tc);
133 /* Check if half-open */
134 if (tc->state == TCP_STATE_SYN_SENT)
136 /* Poison the entry */
138 memset (tc, 0xFA, sizeof (*tc));
139 pool_put (tm->half_open_connections, tc);
143 int thread_index = tc->c_thread_index;
144 /* Poison the entry */
146 memset (tc, 0xFA, sizeof (*tc));
147 pool_put (tm->connections[thread_index], tc);
152 * Connection removal.
154 * This should be called only once connection enters CLOSED state. Note
155 * that it notifies the session of the removal event, so if the goal is to
156 * just remove the connection, call tcp_connection_cleanup instead.
159 tcp_connection_del (tcp_connection_t * tc)
161 TCP_EVT_DBG (TCP_EVT_DELETE, tc);
162 stream_session_delete_notify (&tc->connection);
163 tcp_connection_cleanup (tc);
167 * Cleanup half-open connection
170 tcp_half_open_connection_del (tcp_connection_t * tc)
172 tcp_main_t *tm = vnet_get_tcp_main ();
174 memset (tc, 0xFA, sizeof (*tc));
175 clib_spinlock_lock (&tm->half_open_lock);
176 pool_put (tm->half_open_connections, tc);
177 clib_spinlock_unlock (&tm->half_open_lock);
181 tcp_connection_new (u8 thread_index)
183 tcp_main_t *tm = vnet_get_tcp_main ();
184 tcp_connection_t *tc;
186 pool_get (tm->connections[thread_index], tc);
187 memset (tc, 0, sizeof (*tc));
188 tc->c_c_index = tc - tm->connections[thread_index];
189 tc->c_thread_index = thread_index;
193 /** Notify session that connection has been reset.
195 * Switch state to closed and wait for session to call cleanup.
198 tcp_connection_reset (tcp_connection_t * tc)
200 TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
203 case TCP_STATE_SYN_RCVD:
204 /* Cleanup everything. App wasn't notified yet */
205 stream_session_delete_notify (&tc->connection);
206 tcp_connection_cleanup (tc);
208 case TCP_STATE_SYN_SENT:
209 /* XXX remove sst from call */
210 stream_session_connect_notify (&tc->connection, tc->connection.proto,
212 tcp_connection_cleanup (tc);
214 case TCP_STATE_ESTABLISHED:
215 case TCP_STATE_CLOSE_WAIT:
216 case TCP_STATE_FIN_WAIT_1:
217 case TCP_STATE_FIN_WAIT_2:
218 case TCP_STATE_CLOSING:
219 tc->state = TCP_STATE_CLOSED;
220 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
222 /* Make sure all timers are cleared */
223 tcp_connection_timers_reset (tc);
224 stream_session_reset_notify (&tc->connection);
226 /* Wait for cleanup from session layer but not forever */
227 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
229 case TCP_STATE_CLOSED:
235 * Begin connection closing procedure.
237 * If at the end the connection is not in CLOSED state, it is not removed.
238 * Instead, we rely on on TCP to advance through state machine to either
239 * 1) LAST_ACK (passive close) whereby when the last ACK is received
240 * tcp_connection_del is called. This notifies session of the delete and
242 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
243 * and cleanup is called.
245 * N.B. Half-close connections are not supported
248 tcp_connection_close (tcp_connection_t * tc)
250 TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
252 /* Send FIN if needed */
253 if (tc->state == TCP_STATE_ESTABLISHED
254 || tc->state == TCP_STATE_SYN_RCVD || tc->state == TCP_STATE_CLOSE_WAIT)
258 if (tc->state == TCP_STATE_ESTABLISHED || tc->state == TCP_STATE_SYN_RCVD)
259 tc->state = TCP_STATE_FIN_WAIT_1;
260 else if (tc->state == TCP_STATE_SYN_SENT)
261 tc->state = TCP_STATE_CLOSED;
262 else if (tc->state == TCP_STATE_CLOSE_WAIT)
263 tc->state = TCP_STATE_LAST_ACK;
264 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
266 /* If in CLOSED and WAITCLOSE timer is not set, delete connection now */
267 if (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID
268 && tc->state == TCP_STATE_CLOSED)
269 tcp_connection_del (tc);
273 tcp_session_close (u32 conn_index, u32 thread_index)
275 tcp_connection_t *tc;
276 tc = tcp_connection_get (conn_index, thread_index);
277 tcp_connection_close (tc);
281 tcp_session_cleanup (u32 conn_index, u32 thread_index)
283 tcp_connection_t *tc;
284 tc = tcp_connection_get (conn_index, thread_index);
286 /* Wait for the session tx events to clear */
287 tc->state = TCP_STATE_CLOSED;
288 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
289 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
293 ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4)
295 ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
296 ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
297 ip_interface_address_t *ia = 0;
302 foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
304 return ip_interface_address_get_address (lm4, ia);
311 foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
313 return ip_interface_address_get_address (lm6, ia);
321 #define PORT_MASK ((1 << 16)- 1)
323 * Allocate local port and add if successful add entry to local endpoint
324 * table to mark the pair as used.
327 tcp_allocate_local_port (tcp_main_t * tm, ip46_address_t * ip)
329 transport_endpoint_t *tep;
331 u16 min = 1024, max = 65535; /* XXX configurable ? */
335 time_now = tcp_time_now ();
337 /* Only support active opens from thread 0 */
338 ASSERT (vlib_get_thread_index () == 0);
340 /* Start at random point or max */
341 pool_get (tm->local_endpoints, tep);
342 clib_memcpy (&tep->ip, ip, sizeof (*ip));
344 /* Search for first free slot */
345 for (; tries >= 0; tries--)
349 /* Find a port in the specified range */
352 port = random_u32 (&time_now) & PORT_MASK;
353 if (PREDICT_TRUE (port >= min && port < max))
360 tei = transport_endpoint_lookup (&tm->local_endpoints_table, &tep->ip,
362 /* If not found, we're done */
363 if (tei == TRANSPORT_ENDPOINT_INVALID_INDEX)
365 transport_endpoint_table_add (&tm->local_endpoints_table, tep,
366 tep - tm->local_endpoints);
371 pool_put (tm->local_endpoints, tep);
376 * Initialize all connection timers as invalid
379 tcp_connection_timers_init (tcp_connection_t * tc)
383 /* Set all to invalid */
384 for (i = 0; i < TCP_N_TIMERS; i++)
386 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
389 tc->rto = TCP_RTO_INIT;
393 * Stop all connection timers
396 tcp_connection_timers_reset (tcp_connection_t * tc)
399 for (i = 0; i < TCP_N_TIMERS; i++)
401 tcp_timer_reset (tc, i);
406 typedef struct ip4_tcp_hdr
412 typedef struct ip6_tcp_hdr
419 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
422 const dpo_id_t *choice;
426 lb = load_balance_get (dpo->dpoi_index);
430 memset (&hdr, 0, sizeof (hdr));
431 hdr.ip.protocol = IP_PROTOCOL_TCP;
432 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
433 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
434 hdr.tcp.src_port = tc->c_lcl_port;
435 hdr.tcp.dst_port = tc->c_rmt_port;
436 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
441 memset (&hdr, 0, sizeof (hdr));
442 hdr.ip.protocol = IP_PROTOCOL_TCP;
443 clib_memcpy (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
444 sizeof (ip6_address_t));
445 clib_memcpy (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
446 sizeof (ip6_address_t));
447 hdr.tcp.src_port = tc->c_lcl_port;
448 hdr.tcp.dst_port = tc->c_rmt_port;
449 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
451 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
452 dpo_copy (result, choice);
456 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
460 clib_memcpy (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
461 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
462 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
463 return fib_table_lookup (0, &prefix);
467 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
469 dpo_id_t choice = DPO_INVALID;
470 u32 output_node_index;
473 fe = fib_entry_get (tc->c_rmt_fei);
474 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
477 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
480 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
481 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
485 /** Stack tcp connection on peer's fib entry.
487 * This ultimately populates the dpo the connection will use to send packets.
490 tcp_connection_fib_attach (tcp_connection_t * tc)
492 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
494 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
496 tcp_connection_stack_on_fib_entry (tc);
500 /** Initialize tcp connection variables
502 * Should be called after having received a msg from the peer, i.e., a SYN or
503 * a SYNACK, such that connection options have already been exchanged. */
505 tcp_connection_init_vars (tcp_connection_t * tc)
507 tcp_connection_timers_init (tc);
509 scoreboard_init (&tc->sack_sb);
511 // tcp_connection_fib_attach (tc);
515 tcp_connection_open (ip46_address_t * rmt_addr, u16 rmt_port, u8 is_ip4)
517 tcp_main_t *tm = vnet_get_tcp_main ();
518 tcp_connection_t *tc;
520 fib_node_index_t fei;
522 ip46_address_t lcl_addr;
526 * Find the local address and allocate port
528 memset (&lcl_addr, 0, sizeof (lcl_addr));
530 /* Find a FIB path to the destination */
531 clib_memcpy (&prefix.fp_addr, rmt_addr, sizeof (*rmt_addr));
532 prefix.fp_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
533 prefix.fp_len = is_ip4 ? 32 : 128;
535 fei = fib_table_lookup (0, &prefix);
537 /* Couldn't find route to destination. Bail out. */
538 if (fei == FIB_NODE_INDEX_INVALID)
540 clib_warning ("no route to destination");
544 sw_if_index = fib_entry_get_resolving_interface (fei);
546 if (sw_if_index == (u32) ~ 0)
548 clib_warning ("no resolving interface for %U", format_ip46_address,
549 rmt_addr, IP46_TYPE_IP4);
557 if (vec_len (tm->ip4_src_addresses))
559 index = tm->last_v4_address_rotor++;
560 if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
561 tm->last_v4_address_rotor = 0;
562 lcl_addr.ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
566 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
567 lcl_addr.ip4.as_u32 = ip4->as_u32;
575 if (vec_len (tm->ip6_src_addresses))
577 index = tm->last_v6_address_rotor++;
578 if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
579 tm->last_v6_address_rotor = 0;
580 clib_memcpy (&lcl_addr.ip6, &tm->ip6_src_addresses[index],
585 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
586 clib_memcpy (&lcl_addr.ip6, ip6, sizeof (*ip6));
590 /* Allocate source port */
591 lcl_port = tcp_allocate_local_port (tm, &lcl_addr);
594 clib_warning ("Failed to allocate src port");
599 * Create connection and send SYN
602 pool_get (tm->half_open_connections, tc);
603 memset (tc, 0, sizeof (*tc));
605 clib_memcpy (&tc->c_rmt_ip, rmt_addr, sizeof (ip46_address_t));
606 clib_memcpy (&tc->c_lcl_ip, &lcl_addr, sizeof (ip46_address_t));
607 tc->c_rmt_port = clib_host_to_net_u16 (rmt_port);
608 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
609 tc->c_c_index = tc - tm->half_open_connections;
610 tc->c_is_ip4 = is_ip4;
611 tc->c_proto = is_ip4 ? SESSION_TYPE_IP4_TCP : SESSION_TYPE_IP6_TCP;
613 /* The other connection vars will be initialized after SYN ACK */
614 tcp_connection_timers_init (tc);
616 TCP_EVT_DBG (TCP_EVT_OPEN, tc);
617 tc->state = TCP_STATE_SYN_SENT;
620 return tc->c_c_index;
624 tcp_session_open_ip4 (ip46_address_t * addr, u16 port)
626 return tcp_connection_open (addr, port, 1);
630 tcp_session_open_ip6 (ip46_address_t * addr, u16 port)
632 return tcp_connection_open (addr, port, 0);
635 const char *tcp_dbg_evt_str[] = {
636 #define _(sym, str) str,
641 const char *tcp_fsm_states[] = {
642 #define _(sym, str) str,
643 foreach_tcp_fsm_state
648 format_tcp_state (u8 * s, va_list * args)
650 u32 state = va_arg (*args, u32);
652 if (state < TCP_N_STATES)
653 s = format (s, "%s", tcp_fsm_states[state]);
655 s = format (s, "UNKNOWN (%d (0x%x))", state, state);
659 const char *tcp_conn_timers[] = {
660 #define _(sym, str) str,
666 format_tcp_timers (u8 * s, va_list * args)
668 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
671 for (i = 0; i < TCP_N_TIMERS; i++)
672 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
676 for (i = 0; i < last; i++)
678 if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
679 s = format (s, "%s,", tcp_conn_timers[i]);
683 s = format (s, "%s]", tcp_conn_timers[i]);
691 format_tcp_congestion_status (u8 * s, va_list * args)
693 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
694 if (tcp_in_recovery (tc))
695 s = format (s, "recovery");
696 else if (tcp_in_fastrecovery (tc))
697 s = format (s, "fastrecovery");
699 s = format (s, "none");
704 format_tcp_vars (u8 * s, va_list * args)
706 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
707 s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
708 tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
709 tc->snd_una_max - tc->iss);
710 s = format (s, " rcv_nxt %u rcv_las %u\n",
711 tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
712 s = format (s, " snd_wnd %u rcv_wnd %u snd_wl1 %u snd_wl2 %u\n",
713 tc->snd_wnd, tc->rcv_wnd, tc->snd_wl1 - tc->irs,
714 tc->snd_wl2 - tc->iss);
715 s = format (s, " flight size %u send space %u rcv_wnd_av %d\n",
716 tcp_flight_size (tc), tcp_available_snd_space (tc),
717 tcp_rcv_wnd_available (tc));
718 s = format (s, " cong %U ", format_tcp_congestion_status, tc);
719 s = format (s, "cwnd %u ssthresh %u rtx_bytes %u bytes_acked %u\n",
720 tc->cwnd, tc->ssthresh, tc->snd_rxt_bytes, tc->bytes_acked);
721 s = format (s, " prev_ssthresh %u snd_congestion %u dupack %u",
722 tc->prev_ssthresh, tc->snd_congestion - tc->iss,
724 s = format (s, " limited_transmit %u\n", tc->limited_transmit - tc->iss);
725 s = format (s, " tsecr %u tsecr_last_ack %u\n", tc->rcv_opts.tsecr,
727 s = format (s, " rto %u rto_boff %u srtt %u rttvar %u rtt_ts %u ", tc->rto,
728 tc->rto_boff, tc->srtt, tc->rttvar, tc->rtt_ts);
729 s = format (s, "rtt_seq %u\n", tc->rtt_seq);
730 s = format (s, " tsval_recent %u tsval_recent_age %u\n", tc->tsval_recent,
731 tcp_time_now () - tc->tsval_recent_age);
732 s = format (s, " scoreboard: %U\n", format_tcp_scoreboard, &tc->sack_sb);
733 if (vec_len (tc->snd_sacks))
734 s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
740 format_tcp_connection_id (u8 * s, va_list * args)
742 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
747 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
748 format_ip4_address, &tc->c_lcl_ip4,
749 clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
750 &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
754 s = format (s, "[#%d][%s] %U:%d->%U:%d", tc->c_thread_index, "T",
755 format_ip6_address, &tc->c_lcl_ip6,
756 clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
757 &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
764 format_tcp_connection (u8 * s, va_list * args)
766 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
767 u32 verbose = va_arg (*args, u32);
769 s = format (s, "%-50U", format_tcp_connection_id, tc);
772 s = format (s, "%-15U", format_tcp_state, tc->state);
774 s = format (s, " %U\n%U", format_tcp_timers, tc, format_tcp_vars, tc);
781 format_tcp_session (u8 * s, va_list * args)
783 u32 tci = va_arg (*args, u32);
784 u32 thread_index = va_arg (*args, u32);
785 u32 verbose = va_arg (*args, u32);
786 tcp_connection_t *tc;
788 tc = tcp_connection_get (tci, thread_index);
790 s = format (s, "%U", format_tcp_connection, tc, verbose);
792 s = format (s, "empty");
797 format_tcp_listener_session (u8 * s, va_list * args)
799 u32 tci = va_arg (*args, u32);
800 tcp_connection_t *tc = tcp_listener_get (tci);
801 return format (s, "%U", format_tcp_connection_id, tc);
805 format_tcp_half_open_session (u8 * s, va_list * args)
807 u32 tci = va_arg (*args, u32);
808 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
809 return format (s, "%U", format_tcp_connection_id, tc);
813 format_tcp_sacks (u8 * s, va_list * args)
815 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
816 sack_block_t *sacks = tc->snd_sacks;
820 len = vec_len (sacks);
821 for (i = 0; i < len - 1; i++)
824 s = format (s, " start %u end %u\n", block->start - tc->irs,
825 block->end - tc->irs);
829 block = &sacks[len - 1];
830 s = format (s, " start %u end %u", block->start - tc->irs,
831 block->end - tc->irs);
837 format_tcp_rcv_sacks (u8 * s, va_list * args)
839 tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
840 sack_block_t *sacks = tc->rcv_opts.sacks;
844 len = vec_len (sacks);
845 for (i = 0; i < len - 1; i++)
848 s = format (s, " start %u end %u\n", block->start - tc->iss,
849 block->end - tc->iss);
853 block = &sacks[len - 1];
854 s = format (s, " start %u end %u", block->start - tc->iss,
855 block->end - tc->iss);
861 format_tcp_sack_hole (u8 * s, va_list * args)
863 sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
864 s = format (s, "[%u, %u]", hole->start, hole->end);
869 format_tcp_scoreboard (u8 * s, va_list * args)
871 sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
872 sack_scoreboard_hole_t *hole;
873 s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
874 sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
875 s = format (s, " last_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
876 sb->last_bytes_delivered, sb->high_sacked, sb->snd_una_adv);
877 s = format (s, " cur_rxt_hole %u high_rxt %u rescue_rxt %u",
878 sb->cur_rxt_hole, sb->high_rxt, sb->rescue_rxt);
880 hole = scoreboard_first_hole (sb);
882 s = format (s, "\n head %u tail %u holes:\n", sb->head, sb->tail);
886 s = format (s, "%U", format_tcp_sack_hole, hole);
887 hole = scoreboard_next_hole (sb, hole);
893 transport_connection_t *
894 tcp_session_get_transport (u32 conn_index, u32 thread_index)
896 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
897 return &tc->connection;
900 transport_connection_t *
901 tcp_half_open_session_get_transport (u32 conn_index)
903 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
904 return &tc->connection;
908 * Compute maximum segment size for session layer.
910 * Since the result needs to be the actual data length, it first computes
911 * the tcp options to be used in the next burst and subtracts their
912 * length from the connection's snd_mss.
915 tcp_session_send_mss (transport_connection_t * trans_conn)
917 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
919 /* Ensure snd_mss does accurately reflect the amount of data we can push
920 * in a segment. This also makes sure that options are updated according to
921 * the current state of the connection. */
922 tcp_update_snd_mss (tc);
928 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
930 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
932 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
935 /* If we can't write at least a segment, don't try at all */
936 if (PREDICT_FALSE (snd_space < tc->snd_mss))
938 if (snd_space > clib_min (tc->mss, tc->rcv_opts.mss) - TCP_HDR_LEN_MAX)
943 /* round down to mss multiple */
944 return snd_space - (snd_space % tc->snd_mss);
948 * Compute tx window session is allowed to fill.
950 * Takes into account available send space, snd_mss and the congestion
951 * state of the connection. If possible, the value returned is a multiple
954 * @param tc tcp connection
955 * @return number of bytes session is allowed to write
958 tcp_snd_space (tcp_connection_t * tc)
960 int snd_space, snt_limited;
962 if (PREDICT_TRUE (tcp_in_cong_recovery (tc) == 0))
964 snd_space = tcp_available_snd_space (tc);
966 /* If we haven't gotten dupacks or if we did and have gotten sacked
967 * bytes then we can still send as per Limited Transmit (RFC3042) */
968 if (PREDICT_FALSE (tc->rcv_dupacks != 0
969 && (tcp_opts_sack_permitted (tc)
970 && tc->sack_sb.last_sacked_bytes == 0)))
972 if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
973 tc->limited_transmit = tc->snd_nxt;
974 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
976 snt_limited = tc->snd_nxt - tc->limited_transmit;
977 snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
979 return tcp_round_snd_space (tc, snd_space);
982 if (tcp_in_recovery (tc))
984 tc->snd_nxt = tc->snd_una_max;
985 snd_space = tcp_available_wnd (tc) - tc->snd_rxt_bytes
986 - (tc->snd_una_max - tc->snd_congestion);
987 if (snd_space <= 0 || (tc->snd_una_max - tc->snd_una) >= tc->snd_wnd)
989 return tcp_round_snd_space (tc, snd_space);
992 /* If in fast recovery, send 1 SMSS if wnd allows */
993 if (tcp_in_fastrecovery (tc)
994 && tcp_available_snd_space (tc) && !tcp_fastrecovery_sent_1_smss (tc))
996 tcp_fastrecovery_1_smss_on (tc);
1004 tcp_session_send_space (transport_connection_t * trans_conn)
1006 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1007 return tcp_snd_space (tc);
1011 tcp_rcv_wnd_available (tcp_connection_t * tc)
1013 return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
1017 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1019 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1021 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1023 /* This still works if fast retransmit is on */
1024 return (tc->snd_nxt - tc->snd_una);
1028 const static transport_proto_vft_t tcp4_proto = {
1029 .bind = tcp_session_bind_ip4,
1030 .unbind = tcp_session_unbind,
1031 .push_header = tcp_push_header,
1032 .get_connection = tcp_session_get_transport,
1033 .get_listener = tcp_session_get_listener,
1034 .get_half_open = tcp_half_open_session_get_transport,
1035 .open = tcp_session_open_ip4,
1036 .close = tcp_session_close,
1037 .cleanup = tcp_session_cleanup,
1038 .send_mss = tcp_session_send_mss,
1039 .send_space = tcp_session_send_space,
1040 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1041 .format_connection = format_tcp_session,
1042 .format_listener = format_tcp_listener_session,
1043 .format_half_open = format_tcp_half_open_session,
1046 const static transport_proto_vft_t tcp6_proto = {
1047 .bind = tcp_session_bind_ip6,
1048 .unbind = tcp_session_unbind,
1049 .push_header = tcp_push_header,
1050 .get_connection = tcp_session_get_transport,
1051 .get_listener = tcp_session_get_listener,
1052 .get_half_open = tcp_half_open_session_get_transport,
1053 .open = tcp_session_open_ip6,
1054 .close = tcp_session_close,
1055 .cleanup = tcp_session_cleanup,
1056 .send_mss = tcp_session_send_mss,
1057 .send_space = tcp_session_send_space,
1058 .tx_fifo_offset = tcp_session_tx_fifo_offset,
1059 .format_connection = format_tcp_session,
1060 .format_listener = format_tcp_listener_session,
1061 .format_half_open = format_tcp_half_open_session,
1066 tcp_timer_keep_handler (u32 conn_index)
1068 u32 thread_index = vlib_get_thread_index ();
1069 tcp_connection_t *tc;
1071 tc = tcp_connection_get (conn_index, thread_index);
1072 tc->timers[TCP_TIMER_KEEP] = TCP_TIMER_HANDLE_INVALID;
1074 tcp_connection_close (tc);
1078 tcp_timer_establish_handler (u32 conn_index)
1080 tcp_connection_t *tc;
1083 tc = tcp_half_open_connection_get (conn_index);
1084 tc->timers[TCP_TIMER_ESTABLISH] = TCP_TIMER_HANDLE_INVALID;
1086 ASSERT (tc->state == TCP_STATE_SYN_SENT);
1088 sst = tc->c_is_ip4 ? SESSION_TYPE_IP4_TCP : SESSION_TYPE_IP6_TCP;
1089 stream_session_connect_notify (&tc->connection, sst, 1 /* fail */ );
1091 tcp_connection_cleanup (tc);
1095 tcp_timer_waitclose_handler (u32 conn_index)
1097 u32 thread_index = vlib_get_thread_index ();
1098 tcp_connection_t *tc;
1100 tc = tcp_connection_get (conn_index, thread_index);
1101 tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1103 /* Session didn't come back with a close(). Send FIN either way
1104 * and switch to LAST_ACK. */
1105 if (tc->state == TCP_STATE_CLOSE_WAIT)
1107 if (tc->flags & TCP_CONN_FINSNT)
1109 clib_warning ("FIN was sent and still in CLOSE WAIT. Weird!");
1113 tc->state = TCP_STATE_LAST_ACK;
1115 /* Make sure we don't wait in LAST ACK forever */
1116 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
1118 /* Don't delete the connection yet */
1122 tcp_connection_del (tc);
1126 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1128 tcp_timer_retransmit_handler,
1129 tcp_timer_delack_handler,
1130 tcp_timer_persist_handler,
1131 tcp_timer_keep_handler,
1132 tcp_timer_waitclose_handler,
1133 tcp_timer_retransmit_syn_handler,
1134 tcp_timer_establish_handler
1139 tcp_expired_timers_dispatch (u32 * expired_timers)
1142 u32 connection_index, timer_id;
1144 for (i = 0; i < vec_len (expired_timers); i++)
1146 /* Get session index and timer id */
1147 connection_index = expired_timers[i] & 0x0FFFFFFF;
1148 timer_id = expired_timers[i] >> 28;
1150 TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1152 /* Handle expiration */
1153 (*timer_expiration_handlers[timer_id]) (connection_index);
1158 tcp_initialize_timer_wheels (tcp_main_t * tm)
1160 tw_timer_wheel_16t_2w_512sl_t *tw;
1162 foreach_vlib_main (({
1163 tw = &tm->timer_wheels[ii];
1164 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1165 100e-3 /* timer period 100ms */ , ~0);
1166 tw->last_run_time = vlib_time_now (this_vlib_main);
1172 tcp_main_enable (vlib_main_t * vm)
1174 tcp_main_t *tm = vnet_get_tcp_main ();
1175 ip_protocol_info_t *pi;
1176 ip_main_t *im = &ip_main;
1177 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1178 clib_error_t *error = 0;
1181 tcp_connection_t *tc __attribute__ ((unused));
1183 if ((error = vlib_call_init_function (vm, ip_main_init)))
1185 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1187 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1194 /* Register with IP */
1195 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1197 return clib_error_return (0, "TCP protocol info AWOL");
1198 pi->format_header = format_tcp_header;
1199 pi->unformat_pg_edit = unformat_pg_tcp_header;
1201 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1203 /* Register as transport with URI */
1204 session_register_transport (SESSION_TYPE_IP4_TCP, &tcp4_proto);
1205 session_register_transport (SESSION_TYPE_IP6_TCP, &tcp6_proto);
1208 * Initialize data structures
1211 num_threads = 1 /* main thread */ + vtm->n_threads;
1212 vec_validate (tm->connections, num_threads - 1);
1215 * Preallocate connections
1217 for (thread = 0; thread < num_threads; thread++)
1219 for (i = 0; i < tm->preallocated_connections; i++)
1220 pool_get (tm->connections[thread], tc);
1222 for (i = 0; i < tm->preallocated_connections; i++)
1223 pool_put_index (tm->connections[thread], i);
1227 * Preallocate half-open connections
1229 for (i = 0; i < tm->preallocated_half_open_connections; i++)
1230 pool_get (tm->half_open_connections, tc);
1232 for (i = 0; i < tm->preallocated_half_open_connections; i++)
1233 pool_put_index (tm->half_open_connections, i);
1235 /* Initialize per worker thread tx buffers (used for control messages) */
1236 vec_validate (tm->tx_buffers, num_threads - 1);
1238 /* Initialize timer wheels */
1239 vec_validate (tm->timer_wheels, num_threads - 1);
1240 tcp_initialize_timer_wheels (tm);
1242 /* Initialize clocks per tick for TCP timestamp. Used to compute
1243 * monotonically increasing timestamps. */
1244 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1245 / TCP_TSTAMP_RESOLUTION;
1247 clib_bihash_init_24_8 (&tm->local_endpoints_table, "local endpoint table",
1248 200000 /* $$$$ config parameter nbuckets */ ,
1249 (64 << 20) /*$$$ config parameter table size */ );
1250 clib_spinlock_init (&tm->half_open_lock);
1255 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1259 if (tcp_main.is_enabled)
1262 return tcp_main_enable (vm);
1266 tcp_main.is_enabled = 0;
1273 tcp_init (vlib_main_t * vm)
1275 tcp_main_t *tm = vnet_get_tcp_main ();
1277 tm->vnet_main = vnet_get_main ();
1283 VLIB_INIT_FUNCTION (tcp_init);
1286 static clib_error_t *
1287 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1289 tcp_main_t *tm = vnet_get_tcp_main ();
1291 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1294 (input, "preallocated-connections %d",
1295 &tm->preallocated_connections))
1297 else if (unformat (input, "preallocated-half-open-connections %d",
1298 &tm->preallocated_half_open_connections))
1301 return clib_error_return (0, "unknown input `%U'",
1302 format_unformat_error, input);
1307 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1309 static clib_error_t *
1310 tcp_src_address (vlib_main_t * vm,
1311 unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1313 tcp_main_t *tm = vnet_get_tcp_main ();
1314 ip4_address_t v4start, v4end;
1315 ip6_address_t v6start, v6end;
1319 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1321 if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1322 unformat_ip4_address, &v4end))
1324 else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1326 memcpy (&v4end, &v4start, sizeof (v4start));
1329 else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1330 unformat_ip4_address, &v6end))
1332 else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1334 memcpy (&v6end, &v6start, sizeof (v4start));
1341 if (!v4set && !v6set)
1342 return clib_error_return (0, "at least one v4 or v6 address required");
1350 vec_add1 (tm->ip4_src_addresses, v4start);
1351 tmp = clib_net_to_host_u32 (v4start.as_u32);
1353 v4start.as_u32 = clib_host_to_net_u32 (tmp);
1355 while (clib_host_to_net_u32 (v4start.as_u32) <=
1356 clib_host_to_net_u32 (v4end.as_u32));
1360 clib_warning ("v6 src address list unimplemented...");
1366 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1368 .path = "tcp src-address",
1369 .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1370 .function = tcp_src_address,
1375 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1377 #if TCP_SCOREBOARD_TRACE
1379 scoreboard_trace_elt_t *block;
1385 s = format (s, "scoreboard trace:");
1386 vec_foreach (block, sb->trace)
1388 s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1389 block->ack, block->snd_una_max, block->group);
1391 s = format (s, "\n");
1399 static clib_error_t *
1400 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1401 vlib_cli_command_t * cmd_arg)
1403 transport_connection_t *tconn = 0;
1404 tcp_connection_t *tc;
1406 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1408 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1409 TRANSPORT_PROTO_TCP))
1412 return clib_error_return (0, "unknown input `%U'",
1413 format_unformat_error, input);
1416 if (!TCP_SCOREBOARD_TRACE)
1418 vlib_cli_output (vm, "scoreboard tracing not enabled");
1422 tc = tcp_get_connection_from_transport (tconn);
1423 s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
1424 vlib_cli_output (vm, "%v", s);
1429 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
1431 .path = "show tcp scoreboard trace",
1432 .short_help = "show tcp scoreboard trace <connection>",
1433 .function = tcp_show_scoreboard_trace_fn,
1438 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
1441 scoreboard_trace_elt_t *trace;
1442 u32 next_ack, left, group, has_new_ack = 0;
1443 tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
1444 sack_block_t *block;
1449 memset (dummy_tc, 0, sizeof (*dummy_tc));
1450 tcp_connection_timers_init (dummy_tc);
1451 scoreboard_init (&dummy_tc->sack_sb);
1452 dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
1454 #if TCP_SCOREBOARD_TRACE
1455 trace = tc->sack_sb.trace;
1456 trace_len = vec_len (tc->sack_sb.trace);
1462 for (i = 0; i < trace_len; i++)
1464 if (trace[i].ack != 0)
1466 dummy_tc->snd_una = trace[i].ack - 1448;
1467 dummy_tc->snd_una_max = trace[i].ack;
1472 while (left < trace_len)
1474 group = trace[left].group;
1475 vec_reset_length (dummy_tc->rcv_opts.sacks);
1477 while (trace[left].group == group)
1479 if (trace[left].ack != 0)
1482 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
1483 trace[left].ack, trace[left].snd_una_max);
1484 dummy_tc->snd_una_max = trace[left].snd_una_max;
1485 next_ack = trace[left].ack;
1491 s = format (s, "[%u, %u], ", trace[left].start,
1493 vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
1494 block->start = trace[left].start;
1495 block->end = trace[left].end;
1501 tcp_rcv_sacks (dummy_tc, next_ack);
1503 dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
1506 s = format (s, "result: %U", format_tcp_scoreboard,
1507 &dummy_tc->sack_sb);
1510 s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
1515 static clib_error_t *
1516 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1517 vlib_cli_command_t * cmd_arg)
1519 transport_connection_t *tconn = 0;
1520 tcp_connection_t *tc = 0;
1522 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1524 if (unformat (input, "%U", unformat_transport_connection, &tconn,
1525 TRANSPORT_PROTO_TCP))
1528 return clib_error_return (0, "unknown input `%U'",
1529 format_unformat_error, input);
1532 if (!TCP_SCOREBOARD_TRACE)
1534 vlib_cli_output (vm, "scoreboard tracing not enabled");
1538 tc = tcp_get_connection_from_transport (tconn);
1541 vlib_cli_output (vm, "connection not found");
1544 str = tcp_scoreboard_replay (str, tc, 1);
1545 vlib_cli_output (vm, "%v", str);
1550 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
1552 .path = "tcp replay scoreboard",
1553 .short_help = "tcp replay scoreboard <connection>",
1554 .function = tcp_scoreboard_trace_fn,
1559 * fd.io coding-style-patch-verification: ON
1562 * eval: (c-set-style "gnu")