2 * Copyright (c) 2016-2019 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/tcp/tcp_inlines.h>
23 #include <vnet/session/session.h>
24 #include <vnet/fib/fib.h>
25 #include <vnet/dpo/load_balance.h>
28 #include <vlib/stats/stats.h>
34 fib_protocol_t nh_proto;
35 vnet_link_t link_type;
39 } tcp_add_del_adj_args_t;
42 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
47 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
52 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
54 if (ai != ADJ_INDEX_INVALID)
60 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
62 tcp_add_del_adj_args_t args = {
63 .nh_proto = FIB_PROTOCOL_IP6,
64 .link_type = VNET_LINK_IP6,
66 .sw_if_index = tc->sw_if_index,
69 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
74 tcp_cc_init (tcp_connection_t * tc)
76 /* As per RFC 6582 initialize "recover" to iss */
77 if (tcp_opts_sack_permitted (&tc->rcv_opts))
78 tc->snd_congestion = tc->iss;
80 tc->cc_algo->init (tc);
84 tcp_cc_cleanup (tcp_connection_t * tc)
86 if (tc->cc_algo->cleanup)
87 tc->cc_algo->cleanup (tc);
91 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
92 const tcp_cc_algorithm_t * vft)
94 tcp_main_t *tm = vnet_get_tcp_main ();
95 vec_validate (tm->cc_algos, type);
97 tm->cc_algos[type] = *vft;
98 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
102 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
104 tcp_main_t *tm = vnet_get_tcp_main ();
105 return &tm->cc_algos[type];
108 tcp_cc_algorithm_type_e
109 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
111 tcp_main_t *tm = vnet_get_tcp_main ();
112 tcp_cc_algo_register (++tm->cc_last_type, vft);
113 return tm->cc_last_type;
117 tcp_connection_bind (u32 session_index, transport_endpoint_cfg_t *lcl)
119 tcp_main_t *tm = &tcp_main;
120 tcp_connection_t *listener;
123 pool_get (tm->listener_pool, listener);
124 clib_memset (listener, 0, sizeof (*listener));
126 listener->c_c_index = listener - tm->listener_pool;
127 listener->c_lcl_port = lcl->port;
129 /* If we are provided a sw_if_index, bind using one of its ips */
130 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
132 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
134 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
136 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
137 listener->c_is_ip4 = lcl->is_ip4;
138 listener->c_proto = TRANSPORT_PROTO_TCP;
139 listener->c_s_index = session_index;
140 listener->c_fib_index = lcl->fib_index;
141 listener->state = TCP_STATE_LISTEN;
142 listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
144 tcp_connection_timers_init (listener);
146 TCP_EVT (TCP_EVT_BIND, listener);
148 return listener->c_c_index;
152 tcp_session_bind (u32 session_index, transport_endpoint_cfg_t *tep)
154 return tcp_connection_bind (session_index, tep);
158 tcp_connection_unbind (u32 listener_index)
160 tcp_main_t *tm = vnet_get_tcp_main ();
161 tcp_connection_t *tc;
163 tc = pool_elt_at_index (tm->listener_pool, listener_index);
165 TCP_EVT (TCP_EVT_UNBIND, tc);
167 /* Poison the entry */
169 clib_memset (tc, 0xFA, sizeof (*tc));
171 pool_put_index (tm->listener_pool, listener_index);
175 tcp_session_unbind (u32 listener_index)
177 tcp_connection_unbind (listener_index);
181 static transport_connection_t *
182 tcp_session_get_listener (u32 listener_index)
184 tcp_main_t *tm = vnet_get_tcp_main ();
185 tcp_connection_t *tc;
186 tc = pool_elt_at_index (tm->listener_pool, listener_index);
187 return &tc->connection;
190 static tcp_connection_t *
191 tcp_half_open_connection_alloc (void)
193 return tcp_connection_alloc (transport_cl_thread ());
197 * Cleanup half-open connection
201 tcp_half_open_connection_free (tcp_connection_t * tc)
203 ASSERT (vlib_get_thread_index () == tc->c_thread_index ||
204 vlib_thread_is_main_w_barrier ());
205 return tcp_connection_free (tc);
209 * Try to cleanup half-open connection
211 * If called from a thread that doesn't own tc, the call won't have any
214 * @param tc - connection to be cleaned up
215 * @return non-zero if cleanup failed.
218 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
220 tcp_worker_ctx_t *wrk;
222 /* Make sure this is the owning thread */
223 if (tc->c_thread_index != vlib_get_thread_index ())
226 session_half_open_delete_notify (&tc->connection);
227 wrk = tcp_get_worker (tc->c_thread_index);
228 tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
229 tcp_half_open_connection_free (tc);
234 * Cleans up connection state.
239 tcp_connection_cleanup (tcp_connection_t * tc)
241 TCP_EVT (TCP_EVT_DELETE, tc);
243 /* Cleanup local endpoint if this was an active connect */
244 if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
245 transport_release_local_endpoint (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
248 /* Check if connection is not yet fully established */
249 if (tc->state == TCP_STATE_SYN_SENT)
251 /* Try to remove the half-open connection. If this is not the owning
252 * thread, tc won't be removed. Retransmit or establish timers will
253 * eventually expire and call again cleanup on the right thread. */
254 if (tcp_half_open_connection_cleanup (tc))
255 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
259 /* Make sure all timers are cleared */
260 tcp_connection_timers_reset (tc);
262 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
263 tcp_add_del_adjacency (tc, 0);
266 vec_free (tc->snd_sacks);
267 vec_free (tc->snd_sacks_fl);
268 vec_free (tc->rcv_opts.sacks);
269 pool_free (tc->sack_sb.holes);
271 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
274 tcp_connection_free (tc);
279 * Connection removal.
281 * This should be called only once connection enters CLOSED state. Note
282 * that it notifies the session of the removal event, so if the goal is to
283 * just remove the connection, call tcp_connection_cleanup instead.
286 tcp_connection_del (tcp_connection_t * tc)
288 session_transport_delete_notify (&tc->connection);
289 tcp_connection_cleanup (tc);
293 tcp_connection_alloc (u8 thread_index)
295 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
296 tcp_connection_t *tc;
298 pool_get_aligned_safe (wrk->connections, tc, CLIB_CACHE_LINE_BYTES);
299 clib_memset (tc, 0, sizeof (*tc));
300 tc->c_c_index = tc - wrk->connections;
301 tc->c_thread_index = thread_index;
306 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t **base)
308 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
309 tcp_connection_t *tc;
311 /* Make sure connection is still valid if pool moves */
312 if ((*base)->c_thread_index == thread_index)
314 u32 base_index = (*base)->c_c_index;
315 pool_get_aligned_safe (wrk->connections, tc, CLIB_CACHE_LINE_BYTES);
316 *base = tcp_connection_get (base_index, thread_index);
320 pool_get_aligned_safe (wrk->connections, tc, CLIB_CACHE_LINE_BYTES);
322 clib_memcpy_fast (tc, *base, sizeof (*tc));
323 tc->c_c_index = tc - wrk->connections;
324 tc->c_thread_index = thread_index;
329 tcp_connection_free (tcp_connection_t * tc)
331 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
334 clib_memset (tc, 0xFA, sizeof (*tc));
335 pool_put (wrk->connections, tc);
338 pool_put (wrk->connections, tc);
342 tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
344 tcp_cleanup_req_t *req;
345 clib_time_type_t now;
347 now = tcp_time_now_us (tc->c_thread_index);
348 clib_fifo_add2 (wrk->pending_cleanups, req);
349 req->connection_index = tc->c_c_index;
350 req->free_time = now + tcp_cfg.cleanup_time;
354 * Begin connection closing procedure.
356 * If at the end the connection is not in CLOSED state, it is not removed.
357 * Instead, we rely on on TCP to advance through state machine to either
358 * 1) LAST_ACK (passive close) whereby when the last ACK is received
359 * tcp_connection_del is called. This notifies session of the delete and
361 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
362 * and cleanup is called.
366 tcp_connection_close (tcp_connection_t * tc)
368 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
370 TCP_EVT (TCP_EVT_CLOSE, tc);
372 /* Send/Program FIN if needed and switch state */
375 case TCP_STATE_SYN_SENT:
376 /* Try to cleanup. If not on the right thread, mark as half-open done.
377 * Connection will be cleaned up when establish timer pops */
378 tcp_connection_cleanup (tc);
380 case TCP_STATE_SYN_RCVD:
381 tcp_connection_timers_reset (tc);
383 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
384 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
385 tcp_cfg.finwait1_time);
387 case TCP_STATE_ESTABLISHED:
388 /* If closing with unread data, reset the connection */
389 if (transport_max_rx_dequeue (&tc->connection))
392 tcp_connection_timers_reset (tc);
393 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
394 session_transport_closed_notify (&tc->connection);
395 tcp_program_cleanup (tcp_get_worker (tc->c_thread_index), tc);
396 tcp_worker_stats_inc (wrk, rst_unread, 1);
399 if (!transport_max_tx_dequeue (&tc->connection))
402 tc->flags |= TCP_CONN_FINPNDG;
403 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
404 /* Set a timer in case the peer stops responding. Otherwise the
405 * connection will be stuck here forever. */
406 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
407 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
408 tcp_cfg.finwait1_time);
410 case TCP_STATE_CLOSE_WAIT:
411 if (!transport_max_tx_dequeue (&tc->connection))
414 tcp_connection_timers_reset (tc);
415 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
416 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
417 tcp_cfg.lastack_time);
420 tc->flags |= TCP_CONN_FINPNDG;
422 case TCP_STATE_FIN_WAIT_1:
423 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
424 tcp_cfg.finwait1_time);
426 case TCP_STATE_CLOSED:
427 /* Cleanup should've been programmed already */
430 TCP_DBG ("state: %u", tc->state);
435 tcp_session_half_close (u32 conn_index, u32 thread_index)
437 tcp_worker_ctx_t *wrk;
438 tcp_connection_t *tc;
440 tc = tcp_connection_get (conn_index, thread_index);
441 wrk = tcp_get_worker (tc->c_thread_index);
443 /* If the connection is not in ESTABLISHED state, ignore it */
444 if (tc->state != TCP_STATE_ESTABLISHED)
446 if (!transport_max_tx_dequeue (&tc->connection))
449 tc->flags |= TCP_CONN_FINPNDG;
450 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
451 /* Set a timer in case the peer stops responding. Otherwise the
452 * connection will be stuck here forever. */
453 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
454 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
455 tcp_cfg.finwait1_time);
459 tcp_session_close (u32 conn_index, u32 thread_index)
461 tcp_connection_t *tc;
462 tc = tcp_connection_get (conn_index, thread_index);
463 tcp_connection_close (tc);
467 tcp_session_cleanup (u32 conn_index, u32 thread_index)
469 tcp_connection_t *tc;
470 tc = tcp_connection_get (conn_index, thread_index);
473 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
474 tcp_connection_cleanup (tc);
478 tcp_session_cleanup_ho (u32 conn_index)
480 tcp_worker_ctx_t *wrk;
481 tcp_connection_t *tc;
483 tc = tcp_half_open_connection_get (conn_index);
484 wrk = tcp_get_worker (tc->c_thread_index);
485 tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
486 tcp_half_open_connection_free (tc);
490 tcp_session_reset (u32 conn_index, u32 thread_index)
492 tcp_connection_t *tc;
493 tc = tcp_connection_get (conn_index, thread_index);
495 /* For half-opens just cleanup */
496 if (tc->state == TCP_STATE_SYN_SENT)
498 tcp_connection_cleanup (tc);
503 tcp_connection_timers_reset (tc);
504 tcp_cong_recovery_off (tc);
505 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
506 session_transport_closed_notify (&tc->connection);
507 tcp_program_cleanup (tcp_get_worker (thread_index), tc);
511 * Initialize all connection timers as invalid
514 tcp_connection_timers_init (tcp_connection_t * tc)
518 /* Set all to invalid */
519 for (i = 0; i < TCP_N_TIMERS; i++)
521 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
524 tc->rto = TCP_RTO_INIT;
528 * Stop all connection timers
531 tcp_connection_timers_reset (tcp_connection_t * tc)
533 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
536 for (i = 0; i < TCP_N_TIMERS; i++)
537 tcp_timer_reset (&wrk->timer_wheel, tc, i);
541 typedef struct ip4_tcp_hdr
547 typedef struct ip6_tcp_hdr
554 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
557 const dpo_id_t *choice;
561 lb = load_balance_get (dpo->dpoi_index);
565 clib_memset (&hdr, 0, sizeof (hdr));
566 hdr.ip.protocol = IP_PROTOCOL_TCP;
567 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
568 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
569 hdr.tcp.src_port = tc->c_lcl_port;
570 hdr.tcp.dst_port = tc->c_rmt_port;
571 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
576 clib_memset (&hdr, 0, sizeof (hdr));
577 hdr.ip.protocol = IP_PROTOCOL_TCP;
578 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
579 sizeof (ip6_address_t));
580 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
581 sizeof (ip6_address_t));
582 hdr.tcp.src_port = tc->c_lcl_port;
583 hdr.tcp.dst_port = tc->c_rmt_port;
584 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
586 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
587 dpo_copy (result, choice);
591 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
596 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
597 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
598 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
599 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
600 return fib_table_lookup (fib_index, &prefix);
604 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
606 dpo_id_t choice = DPO_INVALID;
607 u32 output_node_index;
610 fe = fib_entry_get (tc->c_rmt_fei);
611 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
614 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
617 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
618 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
622 /** Stack tcp connection on peer's fib entry.
624 * This ultimately populates the dpo the connection will use to send packets.
627 tcp_connection_fib_attach (tcp_connection_t * tc)
629 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
631 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
633 tcp_connection_stack_on_fib_entry (tc);
638 * Generate random iss as per rfc6528
641 tcp_generate_random_iss (tcp_connection_t * tc)
643 tcp_main_t *tm = &tcp_main;
647 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
649 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
650 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
652 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
653 tmp ^= tm->iss_seed.second;
654 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
655 return ((tmp >> 32) ^ (tmp & 0xffffffff));
659 * Initialize max segment size we're able to process.
661 * The value is constrained by the output interface's MTU and by the size
662 * of the IP and TCP headers (see RFC6691). It is also what we advertise
666 tcp_init_rcv_mss (tcp_connection_t * tc)
670 /* Already provided at connection init time */
674 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
675 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
679 tcp_init_mss (tcp_connection_t * tc)
681 u16 default_min_mss = 536;
683 tcp_init_rcv_mss (tc);
685 /* TODO consider PMTU discovery */
686 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
688 if (tc->snd_mss < 45)
690 /* Assume that at least the min default mss works */
691 tc->snd_mss = default_min_mss;
692 tc->rcv_opts.mss = default_min_mss;
695 /* We should have enough space for 40 bytes of options */
696 ASSERT (tc->snd_mss > 45);
698 /* If we use timestamp option, account for it and make sure
699 * the options are 4-byte aligned */
700 if (tcp_opts_tstamp (&tc->rcv_opts))
701 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP + 2 /* alignment */;
705 * Initialize connection send variables.
708 tcp_init_snd_vars (tcp_connection_t * tc)
711 * We use the time to randomize iss and for setting up the initial
712 * timestamp. Make sure it's updated otherwise syn and ack in the
713 * handshake may make it look as if time has flown in the opposite
716 tcp_update_time_now (tcp_get_worker (vlib_get_thread_index ()));
718 tcp_init_rcv_mss (tc);
720 * In special case of early-kill of timewait socket, the iss will already
721 * be initialized to ensure it is greater than the last incarnation of the
722 * connection. see syn_during_timewait() for more details.
725 tc->iss = tcp_generate_random_iss (tc);
726 tc->snd_una = tc->iss;
727 tc->snd_nxt = tc->iss + 1;
728 tc->srtt = 0.1 * THZ; /* 100 ms */
730 if (!tcp_cfg.csum_offload)
731 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
735 tcp_enable_pacing (tcp_connection_t * tc)
738 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
739 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
740 tc->mrtt_us = (u32) ~ 0;
743 /** Initialize tcp connection variables
745 * Should be called after having received a msg from the peer, i.e., a SYN or
746 * a SYNACK, such that connection options have already been exchanged. */
748 tcp_connection_init_vars (tcp_connection_t * tc)
750 tcp_connection_timers_init (tc);
752 scoreboard_init (&tc->sack_sb);
753 if (tc->state == TCP_STATE_SYN_RCVD)
754 tcp_init_snd_vars (tc);
758 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
759 tcp_add_del_adjacency (tc, 1);
761 /* tcp_connection_fib_attach (tc); */
763 if (transport_connection_is_tx_paced (&tc->connection)
764 || tcp_cfg.enable_tx_pacing)
765 tcp_enable_pacing (tc);
767 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
770 if (!tcp_cfg.allow_tso)
771 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
773 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
777 tcp_alloc_custom_local_endpoint (ip46_address_t *lcl_addr, u16 *lcl_port,
778 transport_endpoint_cfg_t *rmt)
780 tcp_main_t *tm = vnet_get_tcp_main ();
785 index = tm->last_v4_addr_rotor++;
786 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
787 tm->last_v4_addr_rotor = 0;
788 clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
789 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
793 index = tm->last_v6_addr_rotor++;
794 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
795 tm->last_v6_addr_rotor = 0;
796 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
797 sizeof (ip6_address_t));
799 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr, rmt);
801 return SESSION_E_NOPORT;
807 tcp_session_open (transport_endpoint_cfg_t * rmt)
809 tcp_connection_t *tc;
810 ip46_address_t lcl_addr;
815 * Allocate local endpoint
817 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
818 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
819 rv = tcp_alloc_custom_local_endpoint (&lcl_addr, &lcl_port, rmt);
821 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP, rmt, &lcl_addr,
828 * Create connection and send SYN
830 tc = tcp_half_open_connection_alloc ();
831 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
832 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
833 tc->c_rmt_port = rmt->port;
834 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
835 tc->c_is_ip4 = rmt->is_ip4;
836 tc->c_proto = TRANSPORT_PROTO_TCP;
837 tc->c_fib_index = rmt->fib_index;
838 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
839 /* The other connection vars will be initialized after SYN ACK */
840 tcp_connection_timers_init (tc);
842 if (rmt->peer.sw_if_index != ENDPOINT_INVALID_INDEX)
843 tc->sw_if_index = rmt->peer.sw_if_index;
844 tc->next_node_index = rmt->next_node_index;
845 tc->next_node_opaque = rmt->next_node_opaque;
847 TCP_EVT (TCP_EVT_OPEN, tc);
848 tc->state = TCP_STATE_SYN_SENT;
849 tcp_init_snd_vars (tc);
852 return tc->c_c_index;
856 format_tcp_session (u8 * s, va_list * args)
858 u32 tci = va_arg (*args, u32);
859 u32 thread_index = va_arg (*args, u32);
860 u32 verbose = va_arg (*args, u32);
861 tcp_connection_t *tc;
863 tc = tcp_connection_get (tci, thread_index);
865 s = format (s, "%U", format_tcp_connection, tc, verbose);
867 s = format (s, "empty\n");
872 format_tcp_listener_session (u8 * s, va_list * args)
874 u32 tci = va_arg (*args, u32);
875 u32 __clib_unused thread_index = va_arg (*args, u32);
876 u32 verbose = va_arg (*args, u32);
877 tcp_connection_t *tc = tcp_listener_get (tci);
878 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tcp_connection_id, tc);
880 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tcp_state,
886 format_tcp_half_open_session (u8 * s, va_list * args)
888 u32 tci = va_arg (*args, u32);
889 u32 __clib_unused thread_index = va_arg (*args, u32);
890 u32 verbose = va_arg (*args, u32);
891 tcp_connection_t *tc;
894 tc = tcp_half_open_connection_get (tci);
895 if (tc->flags & TCP_CONN_HALF_OPEN_DONE)
896 state = format (state, "%s", "CLOSED");
898 state = format (state, "%U", format_tcp_state, tc->state);
899 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tcp_connection_id, tc);
901 s = format (s, "%-" SESSION_CLI_STATE_LEN "v", state);
906 static transport_connection_t *
907 tcp_session_get_transport (u32 conn_index, u32 thread_index)
909 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
910 if (PREDICT_FALSE (!tc))
912 return &tc->connection;
915 static transport_connection_t *
916 tcp_half_open_session_get_transport (u32 conn_index)
918 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
919 return &tc->connection;
923 tcp_set_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
929 case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
930 tc->next_node_index = attr->next_output_node & 0xffffffff;
931 tc->next_node_opaque = attr->next_output_node >> 32;
933 case TRANSPORT_ENDPT_ATTR_MSS:
935 tc->snd_mss = clib_min (tc->snd_mss, tc->mss);
937 case TRANSPORT_ENDPT_ATTR_FLAGS:
938 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD)
939 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
941 tc->cfg_flags &= ~TCP_CFG_F_NO_CSUM_OFFLOAD;
942 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_GSO)
944 if (!(tc->cfg_flags & TCP_CFG_F_TSO))
946 tc->cfg_flags &= ~TCP_CFG_F_NO_TSO;
950 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
951 tc->cfg_flags &= ~TCP_CFG_F_TSO;
953 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING)
955 if (!(tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE))
957 tc->cfg_flags |= TCP_CFG_F_RATE_SAMPLE;
961 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
963 tc->cfg_flags &= ~TCP_CFG_F_RATE_SAMPLE;
966 case TRANSPORT_ENDPT_ATTR_CC_ALGO:
967 if (tc->cc_algo == tcp_cc_algo_get (attr->cc_algo))
970 tc->cc_algo = tcp_cc_algo_get (attr->cc_algo);
982 tcp_get_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
989 case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
990 non = (u64) tc->next_node_opaque << 32 | tc->next_node_index;
991 attr->next_output_node = non;
993 case TRANSPORT_ENDPT_ATTR_MSS:
994 attr->mss = tc->snd_mss;
996 case TRANSPORT_ENDPT_ATTR_FLAGS:
998 if (!(tc->cfg_flags & TCP_CFG_F_NO_CSUM_OFFLOAD))
999 attr->flags |= TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD;
1000 if (tc->cfg_flags & TCP_CFG_F_TSO)
1001 attr->flags |= TRANSPORT_ENDPT_ATTR_F_GSO;
1002 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
1003 attr->flags |= TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING;
1005 case TRANSPORT_ENDPT_ATTR_CC_ALGO:
1006 attr->cc_algo = tc->cc_algo - tcp_main.cc_algos;
1017 tcp_session_attribute (u32 conn_index, u32 thread_index, u8 is_get,
1018 transport_endpt_attr_t *attr)
1020 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1022 if (PREDICT_FALSE (!tc))
1026 return tcp_get_attribute (tc, attr);
1028 return tcp_set_attribute (tc, attr);
1032 tcp_session_cal_goal_size (tcp_connection_t * tc)
1034 u16 goal_size = tc->snd_mss;
1036 goal_size = tcp_cfg.max_gso_size - tc->snd_mss % tcp_cfg.max_gso_size;
1037 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1039 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1043 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1045 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1047 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1050 /* If not snd_wnd constrained and we can't write at least a segment,
1051 * don't try at all */
1052 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1053 return snd_space < tc->cwnd ? 0 : snd_space;
1055 /* round down to mss multiple */
1056 return snd_space - (snd_space % tc->snd_mss);
1060 * Compute tx window session is allowed to fill.
1062 * Takes into account available send space, snd_mss and the congestion
1063 * state of the connection. If possible, the value returned is a multiple
1066 * @param tc tcp connection
1067 * @return number of bytes session is allowed to write
1070 tcp_snd_space_inline (tcp_connection_t * tc)
1074 /* Fast path is disabled when recovery is on. @ref tcp_session_custom_tx
1075 * controls both retransmits and the sending of new data while congested
1077 if (PREDICT_FALSE (tcp_in_cong_recovery (tc)
1078 || tc->state == TCP_STATE_CLOSED))
1081 snd_space = tcp_available_output_snd_space (tc);
1083 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1084 * to force the peer to send enough dupacks to start retransmitting as
1085 * per Limited Transmit (RFC3042)
1087 if (PREDICT_FALSE (tc->rcv_dupacks || tc->sack_sb.sacked_bytes))
1089 int snt_limited, n_pkts;
1091 n_pkts = tcp_opts_sack_permitted (&tc->rcv_opts)
1092 ? tc->sack_sb.reorder - 1 : 2;
1094 if ((seq_lt (tc->limited_transmit, tc->snd_nxt - n_pkts * tc->snd_mss)
1095 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1096 tc->limited_transmit = tc->snd_nxt;
1098 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1100 snt_limited = tc->snd_nxt - tc->limited_transmit;
1101 snd_space = clib_max (n_pkts * tc->snd_mss - snt_limited, 0);
1103 return tcp_round_snd_space (tc, snd_space);
1107 tcp_snd_space (tcp_connection_t * tc)
1109 return tcp_snd_space_inline (tc);
1113 tcp_session_send_params (transport_connection_t * trans_conn,
1114 transport_send_params_t * sp)
1116 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1118 /* Ensure snd_mss does accurately reflect the amount of data we can push
1119 * in a segment. This also makes sure that options are updated according to
1120 * the current state of the connection. */
1121 tcp_update_burst_snd_vars (tc);
1123 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1124 sp->snd_mss = tcp_session_cal_goal_size (tc);
1126 sp->snd_mss = tc->snd_mss;
1128 sp->snd_space = clib_min (tcp_snd_space_inline (tc),
1129 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1131 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1132 /* This still works if fast retransmit is on */
1133 sp->tx_offset = tc->snd_nxt - tc->snd_una;
1135 sp->flags = sp->snd_space ? 0 : TRANSPORT_SND_F_DESCHED;
1141 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1143 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1147 case TCP_STATE_CLOSE_WAIT:
1148 tcp_connection_timers_reset (tc);
1149 /* App never returned with a close */
1150 if (!(tc->flags & TCP_CONN_FINPNDG))
1152 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1153 session_transport_closed_notify (&tc->connection);
1154 tcp_program_cleanup (wrk, tc);
1155 tcp_worker_stats_inc (wrk, to_closewait, 1);
1159 /* Send FIN either way and switch to LAST_ACK. */
1160 tcp_cong_recovery_off (tc);
1161 /* Make sure we don't try to send unsent data */
1162 tc->snd_nxt = tc->snd_una;
1164 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1165 session_transport_closed_notify (&tc->connection);
1167 /* Make sure we don't wait in LAST ACK forever */
1168 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
1169 tcp_cfg.lastack_time);
1170 tcp_worker_stats_inc (wrk, to_closewait2, 1);
1172 /* Don't delete the connection yet */
1174 case TCP_STATE_FIN_WAIT_1:
1175 tcp_connection_timers_reset (tc);
1176 if (tc->flags & TCP_CONN_FINPNDG)
1178 /* If FIN pending, we haven't sent everything, but we did try.
1179 * Notify session layer that transport is closed. */
1180 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1181 tcp_send_reset (tc);
1182 tcp_program_cleanup (wrk, tc);
1186 /* We've sent the fin but no progress. Close the connection and
1187 * to make sure everything is flushed, setup a cleanup timer */
1188 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1189 tcp_program_cleanup (wrk, tc);
1191 session_transport_closed_notify (&tc->connection);
1192 tcp_worker_stats_inc (wrk, to_finwait1, 1);
1194 case TCP_STATE_LAST_ACK:
1195 tcp_connection_timers_reset (tc);
1196 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1197 session_transport_closed_notify (&tc->connection);
1198 tcp_program_cleanup (wrk, tc);
1199 tcp_worker_stats_inc (wrk, to_lastack, 1);
1201 case TCP_STATE_CLOSING:
1202 tcp_connection_timers_reset (tc);
1203 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1204 session_transport_closed_notify (&tc->connection);
1205 tcp_program_cleanup (wrk, tc);
1206 tcp_worker_stats_inc (wrk, to_closing, 1);
1208 case TCP_STATE_FIN_WAIT_2:
1209 tcp_send_reset (tc);
1210 tcp_connection_timers_reset (tc);
1211 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1212 session_transport_closed_notify (&tc->connection);
1213 tcp_program_cleanup (wrk, tc);
1214 tcp_worker_stats_inc (wrk, to_finwait2, 1);
1216 case TCP_STATE_TIME_WAIT:
1217 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1218 tcp_program_cleanup (wrk, tc);
1221 clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
1227 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1229 tcp_timer_retransmit_handler,
1230 tcp_timer_persist_handler,
1231 tcp_timer_waitclose_handler,
1232 tcp_timer_retransmit_syn_handler,
1237 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1239 u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1240 tcp_connection_t *tc;
1243 if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1246 thread_index = wrk->vm->thread_index;
1247 for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
1249 clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1250 connection_index = timer_handle & 0x0FFFFFFF;
1251 timer_id = timer_handle >> 28;
1253 if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1254 tc = tcp_connection_get (connection_index, thread_index);
1256 tc = tcp_half_open_connection_get (connection_index);
1258 if (PREDICT_FALSE (!tc))
1261 /* Skip if the timer is not pending. Probably it was reset while
1262 * waiting for dispatch */
1263 if (PREDICT_FALSE (!(tc->pending_timers & (1 << timer_id))))
1266 tc->pending_timers &= ~(1 << timer_id);
1268 /* Skip timer if it was rearmed while pending dispatch */
1269 if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1272 (*timer_expiration_handlers[timer_id]) (tc);
1275 if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
1276 session_queue_run_on_main_thread (wrk->vm);
1280 tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1282 u32 thread_index = wrk->vm->thread_index;
1283 tcp_cleanup_req_t *req;
1284 tcp_connection_t *tc;
1286 while (clib_fifo_elts (wrk->pending_cleanups))
1288 req = clib_fifo_head (wrk->pending_cleanups);
1289 if (req->free_time > now)
1291 clib_fifo_sub2 (wrk->pending_cleanups, req);
1292 tc = tcp_connection_get (req->connection_index, thread_index);
1293 if (PREDICT_FALSE (!tc))
1295 session_transport_delete_notify (&tc->connection);
1296 tcp_connection_cleanup (tc);
1301 tcp_update_time (f64 now, u8 thread_index)
1303 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1305 tcp_set_time_now (wrk, now);
1306 tcp_handle_cleanups (wrk, now);
1307 tcp_timer_expire_timers (&wrk->timer_wheel, now);
1308 tcp_dispatch_pending_timers (wrk);
1312 tcp_session_flush_data (transport_connection_t * tconn)
1314 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1315 if (tc->flags & TCP_CONN_PSH_PENDING)
1317 tc->flags |= TCP_CONN_PSH_PENDING;
1318 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1322 tcp_session_app_rx_evt (transport_connection_t *conn)
1324 tcp_connection_t *tc = (tcp_connection_t *) conn;
1325 u32 min_free, lo = 4 << 10, hi = 128 << 10;
1327 if (!(tc->flags & TCP_CONN_ZERO_RWND_SENT))
1330 min_free = clib_clamp (transport_rx_fifo_size (conn) >> 3, lo, hi);
1331 if (transport_max_rx_enqueue (conn) < min_free)
1333 transport_rx_fifo_req_deq_ntf (conn);
1343 const static transport_proto_vft_t tcp_proto = {
1344 .enable = vnet_tcp_enable_disable,
1345 .start_listen = tcp_session_bind,
1346 .stop_listen = tcp_session_unbind,
1347 .push_header = tcp_session_push_header,
1348 .get_connection = tcp_session_get_transport,
1349 .get_listener = tcp_session_get_listener,
1350 .get_half_open = tcp_half_open_session_get_transport,
1351 .attribute = tcp_session_attribute,
1352 .connect = tcp_session_open,
1353 .half_close = tcp_session_half_close,
1354 .close = tcp_session_close,
1355 .cleanup = tcp_session_cleanup,
1356 .cleanup_ho = tcp_session_cleanup_ho,
1357 .reset = tcp_session_reset,
1358 .send_params = tcp_session_send_params,
1359 .update_time = tcp_update_time,
1360 .flush_data = tcp_session_flush_data,
1361 .custom_tx = tcp_session_custom_tx,
1362 .app_rx_evt = tcp_session_app_rx_evt,
1363 .format_connection = format_tcp_session,
1364 .format_listener = format_tcp_listener_session,
1365 .format_half_open = format_tcp_half_open_session,
1366 .transport_options = {
1369 .tx_type = TRANSPORT_TX_PEEK,
1370 .service_type = TRANSPORT_SERVICE_VC,
1376 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1378 if (!transport_connection_is_tx_paced (&tc->connection))
1381 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1383 transport_connection_tx_pacer_update (&tc->connection,
1384 tcp_cc_get_pacing_rate (tc),
1385 srtt * CLIB_US_TIME_FREQ);
1389 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1392 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1393 transport_connection_tx_pacer_reset (&tc->connection,
1394 tcp_cc_get_pacing_rate (tc),
1396 srtt * CLIB_US_TIME_FREQ);
1400 tcp_reschedule (tcp_connection_t * tc)
1402 if (tcp_in_cong_recovery (tc) || tcp_snd_space_inline (tc))
1403 transport_connection_reschedule (&tc->connection);
1407 tcp_expired_timers_dispatch (u32 * expired_timers)
1409 u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1410 u32 connection_index, timer_id, n_expired, max_loops;
1411 tcp_worker_ctx_t *wrk;
1412 tcp_connection_t *tc;
1415 wrk = tcp_get_worker (thread_index);
1416 n_expired = vec_len (expired_timers);
1417 tcp_worker_stats_inc (wrk, timer_expirations, n_expired);
1418 n_left = clib_fifo_elts (wrk->pending_timers);
1421 * Invalidate all timer handles before dispatching. This avoids dangling
1422 * index references to timer wheel pool entries that have been freed.
1424 for (i = 0; i < n_expired; i++)
1426 connection_index = expired_timers[i] & 0x0FFFFFFF;
1427 timer_id = expired_timers[i] >> 28;
1429 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1430 tc = tcp_connection_get (connection_index, thread_index);
1432 tc = tcp_half_open_connection_get (connection_index);
1434 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1436 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1437 tc->pending_timers |= (1 << timer_id);
1440 clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1443 clib_max ((u32) 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second, 1);
1444 max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1445 max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1446 wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1449 if (thread_index == 0)
1450 session_queue_run_on_main_thread (wrk->vm);
1454 tcp_initialize_iss_seed (tcp_main_t * tm)
1456 u32 default_seed = random_default_seed ();
1457 u64 time_now = clib_cpu_time_now ();
1459 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1460 tm->iss_seed.second = random_u64 (&time_now);
1464 tcp_stats_collector_fn (vlib_stats_collector_data_t *d)
1466 tcp_main_t *tm = vnet_get_tcp_main ();
1467 counter_t **counters = d->entry->data;
1468 counter_t *cb = counters[0];
1469 tcp_wrk_stats_t acc = {};
1470 tcp_worker_ctx_t *wrk;
1472 vec_foreach (wrk, tm->wrk_ctx)
1474 #define _(name, type, str) acc.name += wrk->stats.name;
1475 foreach_tcp_wrk_stat
1479 #define _(name, type, str) cb[TCP_STAT_##name] = acc.name;
1480 foreach_tcp_wrk_stat
1485 tcp_counters_init (void)
1487 vlib_stats_collector_reg_t r = {};
1490 r.entry_index = idx = vlib_stats_add_counter_vector ("/sys/tcp");
1491 r.collect_fn = tcp_stats_collector_fn;
1492 vlib_stats_validate (idx, 0, TCP_STAT_no_buffer);
1494 #define _(name, type, str) \
1495 vlib_stats_add_symlink (idx, TCP_STAT_##name, "/sys/tcp/%s", \
1496 CLIB_STRING_MACRO (name));
1497 foreach_tcp_wrk_stat
1500 vlib_stats_register_collector_fn (&r);
1503 static clib_error_t *
1504 tcp_main_enable (vlib_main_t * vm)
1506 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1507 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1508 tcp_connection_t *tc __attribute__ ((unused));
1509 tcp_main_t *tm = vnet_get_tcp_main ();
1510 tcp_worker_ctx_t *wrk;
1511 clib_error_t *error = 0;
1514 if ((error = vlib_call_init_function (vm, ip_main_init)))
1516 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1518 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1525 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1526 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1529 * Initialize data structures
1532 num_threads = 1 /* main thread */ + vtm->n_threads;
1533 vec_validate (tm->wrk_ctx, num_threads - 1);
1534 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1535 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1537 wrk = &tm->wrk_ctx[0];
1538 wrk->tco_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1539 tcp4_output_node.index);
1540 wrk->tco_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1541 tcp6_output_node.index);
1543 for (thread = 0; thread < num_threads; thread++)
1545 wrk = &tm->wrk_ctx[thread];
1547 vec_validate (wrk->pending_deq_acked, 255);
1548 vec_validate (wrk->pending_disconnects, 255);
1549 vec_validate (wrk->pending_resets, 255);
1550 vec_reset_length (wrk->pending_deq_acked);
1551 vec_reset_length (wrk->pending_disconnects);
1552 vec_reset_length (wrk->pending_resets);
1553 wrk->vm = vlib_get_main_by_index (thread);
1554 wrk->max_timers_per_loop = 10;
1558 wrk->tco_next_node[0] = tm->wrk_ctx[0].tco_next_node[0];
1559 wrk->tco_next_node[1] = tm->wrk_ctx[0].tco_next_node[1];
1563 * Preallocate connections. Assume that thread 0 won't
1564 * use preallocated threads when running multi-core
1566 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1567 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1569 tcp_timer_initialize_wheel (&wrk->timer_wheel,
1570 tcp_expired_timers_dispatch,
1571 vlib_time_now (vm));
1574 tcp_initialize_iss_seed (tm);
1576 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1577 tm->cc_last_type = TCP_CC_LAST;
1579 tcp_counters_init ();
1585 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1589 if (tcp_main.is_enabled)
1592 return tcp_main_enable (vm);
1596 tcp_main.is_enabled = 0;
1603 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1605 tcp_main_t *tm = &tcp_main;
1607 tm->punt_unknown4 = is_add;
1609 tm->punt_unknown6 = is_add;
1613 * Initialize default values for tcp parameters
1616 tcp_configuration_init (void)
1618 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1619 * predefined value. For SYN-ACK we still want the scale to be computed in
1621 tcp_cfg.max_rx_fifo = 32 << 20;
1622 tcp_cfg.min_rx_fifo = 4 << 10;
1624 tcp_cfg.default_mtu = 1500;
1625 tcp_cfg.initial_cwnd_multiplier = 0;
1626 tcp_cfg.enable_tx_pacing = 1;
1627 tcp_cfg.allow_tso = 0;
1628 tcp_cfg.csum_offload = 1;
1629 tcp_cfg.cc_algo = TCP_CC_CUBIC;
1630 tcp_cfg.rwnd_min_update_ack = 1;
1631 tcp_cfg.max_gso_size = TCP_MAX_GSO_SZ;
1633 /* Time constants defined as timer tick (100us) multiples */
1634 tcp_cfg.closewait_time = 20000; /* 2s */
1635 tcp_cfg.timewait_time = 100000; /* 10s */
1636 tcp_cfg.finwait1_time = 600000; /* 60s */
1637 tcp_cfg.lastack_time = 300000; /* 30s */
1638 tcp_cfg.finwait2_time = 300000; /* 30s */
1639 tcp_cfg.closing_time = 300000; /* 30s */
1640 tcp_cfg.alloc_err_timeout = 1000; /* 100ms */
1642 /* This value is seconds */
1643 tcp_cfg.cleanup_time = 0.1; /* 100ms */
1646 static clib_error_t *
1647 tcp_init (vlib_main_t * vm)
1649 tcp_main_t *tm = vnet_get_tcp_main ();
1650 ip_main_t *im = &ip_main;
1651 ip_protocol_info_t *pi;
1653 /* Session layer, and by implication tcp, are disabled by default */
1656 /* Register with IP for header parsing */
1657 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1659 return clib_error_return (0, "TCP protocol info AWOL");
1660 pi->format_header = format_tcp_header;
1661 pi->unformat_pg_edit = unformat_pg_tcp_header;
1663 /* Register as transport with session layer */
1664 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1665 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1666 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1667 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1669 tcp_configuration_init ();
1671 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1676 VLIB_INIT_FUNCTION (tcp_init);
1679 * fd.io coding-style-patch-verification: ON
1682 * eval: (c-set-style "gnu")