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>
32 fib_protocol_t nh_proto;
33 vnet_link_t link_type;
37 } tcp_add_del_adj_args_t;
40 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
45 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
50 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
52 if (ai != ADJ_INDEX_INVALID)
58 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
60 tcp_add_del_adj_args_t args = {
61 .nh_proto = FIB_PROTOCOL_IP6,
62 .link_type = VNET_LINK_IP6,
64 .sw_if_index = tc->sw_if_index,
67 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
72 tcp_cc_init (tcp_connection_t * tc)
74 /* As per RFC 6582 initialize "recover" to iss */
75 if (tcp_opts_sack_permitted (&tc->rcv_opts))
76 tc->snd_congestion = tc->iss;
78 tc->cc_algo->init (tc);
82 tcp_cc_cleanup (tcp_connection_t * tc)
84 if (tc->cc_algo->cleanup)
85 tc->cc_algo->cleanup (tc);
89 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
90 const tcp_cc_algorithm_t * vft)
92 tcp_main_t *tm = vnet_get_tcp_main ();
93 vec_validate (tm->cc_algos, type);
95 tm->cc_algos[type] = *vft;
96 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
100 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
102 tcp_main_t *tm = vnet_get_tcp_main ();
103 return &tm->cc_algos[type];
106 tcp_cc_algorithm_type_e
107 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
109 tcp_main_t *tm = vnet_get_tcp_main ();
110 tcp_cc_algo_register (++tm->cc_last_type, vft);
111 return tm->cc_last_type;
115 tcp_connection_bind (u32 session_index, transport_endpoint_cfg_t *lcl)
117 tcp_main_t *tm = &tcp_main;
118 tcp_connection_t *listener;
121 pool_get (tm->listener_pool, listener);
122 clib_memset (listener, 0, sizeof (*listener));
124 listener->c_c_index = listener - tm->listener_pool;
125 listener->c_lcl_port = lcl->port;
127 /* If we are provided a sw_if_index, bind using one of its ips */
128 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
130 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
132 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
134 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
135 listener->c_is_ip4 = lcl->is_ip4;
136 listener->c_proto = TRANSPORT_PROTO_TCP;
137 listener->c_s_index = session_index;
138 listener->c_fib_index = lcl->fib_index;
139 listener->state = TCP_STATE_LISTEN;
140 listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
142 tcp_connection_timers_init (listener);
144 TCP_EVT (TCP_EVT_BIND, listener);
146 return listener->c_c_index;
150 tcp_session_bind (u32 session_index, transport_endpoint_cfg_t *tep)
152 return tcp_connection_bind (session_index, tep);
156 tcp_connection_unbind (u32 listener_index)
158 tcp_main_t *tm = vnet_get_tcp_main ();
159 tcp_connection_t *tc;
161 tc = pool_elt_at_index (tm->listener_pool, listener_index);
163 TCP_EVT (TCP_EVT_UNBIND, tc);
165 /* Poison the entry */
167 clib_memset (tc, 0xFA, sizeof (*tc));
169 pool_put_index (tm->listener_pool, listener_index);
173 tcp_session_unbind (u32 listener_index)
175 tcp_connection_unbind (listener_index);
179 static transport_connection_t *
180 tcp_session_get_listener (u32 listener_index)
182 tcp_main_t *tm = vnet_get_tcp_main ();
183 tcp_connection_t *tc;
184 tc = pool_elt_at_index (tm->listener_pool, listener_index);
185 return &tc->connection;
188 static tcp_connection_t *
189 tcp_half_open_connection_alloc (void)
191 ASSERT (vlib_get_thread_index () == 0);
192 return tcp_connection_alloc (0);
196 * Cleanup half-open connection
200 tcp_half_open_connection_free (tcp_connection_t * tc)
202 ASSERT (vlib_get_thread_index () == 0);
203 return tcp_connection_free (tc);
207 * Try to cleanup half-open connection
209 * If called from a thread that doesn't own tc, the call won't have any
212 * @param tc - connection to be cleaned up
213 * @return non-zero if cleanup failed.
216 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
218 tcp_worker_ctx_t *wrk;
220 /* Make sure this is the owning thread */
221 if (tc->c_thread_index != vlib_get_thread_index ())
224 session_half_open_delete_notify (&tc->connection);
225 wrk = tcp_get_worker (tc->c_thread_index);
226 tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
227 tcp_half_open_connection_free (tc);
232 * Cleans up connection state.
237 tcp_connection_cleanup (tcp_connection_t * tc)
239 TCP_EVT (TCP_EVT_DELETE, tc);
241 /* Cleanup local endpoint if this was an active connect */
242 if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
243 transport_release_local_endpoint (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
246 /* Check if connection is not yet fully established */
247 if (tc->state == TCP_STATE_SYN_SENT)
249 /* Try to remove the half-open connection. If this is not the owning
250 * thread, tc won't be removed. Retransmit or establish timers will
251 * eventually expire and call again cleanup on the right thread. */
252 if (tcp_half_open_connection_cleanup (tc))
253 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
257 /* Make sure all timers are cleared */
258 tcp_connection_timers_reset (tc);
260 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
261 tcp_add_del_adjacency (tc, 0);
264 vec_free (tc->snd_sacks);
265 vec_free (tc->snd_sacks_fl);
266 vec_free (tc->rcv_opts.sacks);
267 pool_free (tc->sack_sb.holes);
269 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
272 tcp_connection_free (tc);
277 * Connection removal.
279 * This should be called only once connection enters CLOSED state. Note
280 * that it notifies the session of the removal event, so if the goal is to
281 * just remove the connection, call tcp_connection_cleanup instead.
284 tcp_connection_del (tcp_connection_t * tc)
286 session_transport_delete_notify (&tc->connection);
287 tcp_connection_cleanup (tc);
291 tcp_connection_alloc (u8 thread_index)
293 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
294 tcp_connection_t *tc;
296 pool_get_aligned_safe (wrk->connections, tc, CLIB_CACHE_LINE_BYTES);
297 clib_memset (tc, 0, sizeof (*tc));
298 tc->c_c_index = tc - wrk->connections;
299 tc->c_thread_index = thread_index;
304 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t **base)
306 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
307 tcp_connection_t *tc;
309 /* Make sure connection is still valid if pool moves */
310 if ((*base)->c_thread_index == thread_index)
312 u32 base_index = (*base)->c_c_index;
313 pool_get_aligned_safe (wrk->connections, tc, CLIB_CACHE_LINE_BYTES);
314 *base = tcp_connection_get (base_index, thread_index);
318 pool_get_aligned_safe (wrk->connections, tc, CLIB_CACHE_LINE_BYTES);
320 clib_memcpy_fast (tc, *base, sizeof (*tc));
321 tc->c_c_index = tc - wrk->connections;
322 tc->c_thread_index = thread_index;
327 tcp_connection_free (tcp_connection_t * tc)
329 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
332 clib_memset (tc, 0xFA, sizeof (*tc));
333 pool_put (wrk->connections, tc);
336 pool_put (wrk->connections, tc);
340 tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
342 tcp_cleanup_req_t *req;
343 clib_time_type_t now;
345 now = tcp_time_now_us (tc->c_thread_index);
346 clib_fifo_add2 (wrk->pending_cleanups, req);
347 req->connection_index = tc->c_c_index;
348 req->free_time = now + tcp_cfg.cleanup_time;
352 * Begin connection closing procedure.
354 * If at the end the connection is not in CLOSED state, it is not removed.
355 * Instead, we rely on on TCP to advance through state machine to either
356 * 1) LAST_ACK (passive close) whereby when the last ACK is received
357 * tcp_connection_del is called. This notifies session of the delete and
359 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
360 * and cleanup is called.
364 tcp_connection_close (tcp_connection_t * tc)
366 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
368 TCP_EVT (TCP_EVT_CLOSE, tc);
370 /* Send/Program FIN if needed and switch state */
373 case TCP_STATE_SYN_SENT:
374 /* Try to cleanup. If not on the right thread, mark as half-open done.
375 * Connection will be cleaned up when establish timer pops */
376 tcp_connection_cleanup (tc);
378 case TCP_STATE_SYN_RCVD:
379 tcp_connection_timers_reset (tc);
381 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
382 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
383 tcp_cfg.finwait1_time);
385 case TCP_STATE_ESTABLISHED:
386 /* If closing with unread data, reset the connection */
387 if (transport_max_rx_dequeue (&tc->connection))
390 tcp_connection_timers_reset (tc);
391 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
392 session_transport_closed_notify (&tc->connection);
393 tcp_program_cleanup (tcp_get_worker (tc->c_thread_index), tc);
394 tcp_worker_stats_inc (wrk, rst_unread, 1);
397 if (!transport_max_tx_dequeue (&tc->connection))
400 tc->flags |= TCP_CONN_FINPNDG;
401 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
402 /* Set a timer in case the peer stops responding. Otherwise the
403 * connection will be stuck here forever. */
404 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
405 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
406 tcp_cfg.finwait1_time);
408 case TCP_STATE_CLOSE_WAIT:
409 if (!transport_max_tx_dequeue (&tc->connection))
412 tcp_connection_timers_reset (tc);
413 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
414 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
415 tcp_cfg.lastack_time);
418 tc->flags |= TCP_CONN_FINPNDG;
420 case TCP_STATE_FIN_WAIT_1:
421 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
422 tcp_cfg.finwait1_time);
424 case TCP_STATE_CLOSED:
425 /* Cleanup should've been programmed already */
428 TCP_DBG ("state: %u", tc->state);
433 tcp_session_half_close (u32 conn_index, u32 thread_index)
435 tcp_worker_ctx_t *wrk;
436 tcp_connection_t *tc;
438 tc = tcp_connection_get (conn_index, thread_index);
439 wrk = tcp_get_worker (tc->c_thread_index);
441 /* If the connection is not in ESTABLISHED state, ignore it */
442 if (tc->state != TCP_STATE_ESTABLISHED)
444 if (!transport_max_tx_dequeue (&tc->connection))
447 tc->flags |= TCP_CONN_FINPNDG;
448 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
449 /* Set a timer in case the peer stops responding. Otherwise the
450 * connection will be stuck here forever. */
451 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
452 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
453 tcp_cfg.finwait1_time);
457 tcp_session_close (u32 conn_index, u32 thread_index)
459 tcp_connection_t *tc;
460 tc = tcp_connection_get (conn_index, thread_index);
461 tcp_connection_close (tc);
465 tcp_session_cleanup (u32 conn_index, u32 thread_index)
467 tcp_connection_t *tc;
468 tc = tcp_connection_get (conn_index, thread_index);
471 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
472 tcp_connection_cleanup (tc);
476 tcp_session_cleanup_ho (u32 conn_index)
478 tcp_worker_ctx_t *wrk;
479 tcp_connection_t *tc;
481 tc = tcp_half_open_connection_get (conn_index);
482 wrk = tcp_get_worker (tc->c_thread_index);
483 tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
484 tcp_half_open_connection_free (tc);
488 tcp_session_reset (u32 conn_index, u32 thread_index)
490 tcp_connection_t *tc;
491 tc = tcp_connection_get (conn_index, thread_index);
493 tcp_connection_timers_reset (tc);
494 tcp_cong_recovery_off (tc);
495 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
496 session_transport_closed_notify (&tc->connection);
497 tcp_program_cleanup (tcp_get_worker (thread_index), tc);
501 * Initialize all connection timers as invalid
504 tcp_connection_timers_init (tcp_connection_t * tc)
508 /* Set all to invalid */
509 for (i = 0; i < TCP_N_TIMERS; i++)
511 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
514 tc->rto = TCP_RTO_INIT;
518 * Stop all connection timers
521 tcp_connection_timers_reset (tcp_connection_t * tc)
523 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
526 for (i = 0; i < TCP_N_TIMERS; i++)
527 tcp_timer_reset (&wrk->timer_wheel, tc, i);
531 typedef struct ip4_tcp_hdr
537 typedef struct ip6_tcp_hdr
544 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
547 const dpo_id_t *choice;
551 lb = load_balance_get (dpo->dpoi_index);
555 clib_memset (&hdr, 0, sizeof (hdr));
556 hdr.ip.protocol = IP_PROTOCOL_TCP;
557 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
558 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
559 hdr.tcp.src_port = tc->c_lcl_port;
560 hdr.tcp.dst_port = tc->c_rmt_port;
561 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
566 clib_memset (&hdr, 0, sizeof (hdr));
567 hdr.ip.protocol = IP_PROTOCOL_TCP;
568 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
569 sizeof (ip6_address_t));
570 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
571 sizeof (ip6_address_t));
572 hdr.tcp.src_port = tc->c_lcl_port;
573 hdr.tcp.dst_port = tc->c_rmt_port;
574 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
576 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
577 dpo_copy (result, choice);
581 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
586 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
587 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
588 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
589 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
590 return fib_table_lookup (fib_index, &prefix);
594 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
596 dpo_id_t choice = DPO_INVALID;
597 u32 output_node_index;
600 fe = fib_entry_get (tc->c_rmt_fei);
601 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
604 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
607 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
608 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
612 /** Stack tcp connection on peer's fib entry.
614 * This ultimately populates the dpo the connection will use to send packets.
617 tcp_connection_fib_attach (tcp_connection_t * tc)
619 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
621 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
623 tcp_connection_stack_on_fib_entry (tc);
628 * Generate random iss as per rfc6528
631 tcp_generate_random_iss (tcp_connection_t * tc)
633 tcp_main_t *tm = &tcp_main;
637 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
639 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
640 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
642 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
643 tmp ^= tm->iss_seed.second;
644 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
645 return ((tmp >> 32) ^ (tmp & 0xffffffff));
649 * Initialize max segment size we're able to process.
651 * The value is constrained by the output interface's MTU and by the size
652 * of the IP and TCP headers (see RFC6691). It is also what we advertise
656 tcp_init_rcv_mss (tcp_connection_t * tc)
660 /* Already provided at connection init time */
664 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
665 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
669 tcp_init_mss (tcp_connection_t * tc)
671 u16 default_min_mss = 536;
673 tcp_init_rcv_mss (tc);
675 /* TODO consider PMTU discovery */
676 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
678 if (tc->snd_mss < 45)
680 /* Assume that at least the min default mss works */
681 tc->snd_mss = default_min_mss;
682 tc->rcv_opts.mss = default_min_mss;
685 /* We should have enough space for 40 bytes of options */
686 ASSERT (tc->snd_mss > 45);
688 /* If we use timestamp option, account for it and make sure
689 * the options are 4-byte aligned */
690 if (tcp_opts_tstamp (&tc->rcv_opts))
691 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP + 2 /* alignment */;
695 * Initialize connection send variables.
698 tcp_init_snd_vars (tcp_connection_t * tc)
701 * We use the time to randomize iss and for setting up the initial
702 * timestamp. Make sure it's updated otherwise syn and ack in the
703 * handshake may make it look as if time has flown in the opposite
706 tcp_update_time_now (tcp_get_worker (vlib_get_thread_index ()));
708 tcp_init_rcv_mss (tc);
710 * In special case of early-kill of timewait socket, the iss will already
711 * be initialized to ensure it is greater than the last incarnation of the
712 * connection. see syn_during_timewait() for more details.
715 tc->iss = tcp_generate_random_iss (tc);
716 tc->snd_una = tc->iss;
717 tc->snd_nxt = tc->iss + 1;
718 tc->srtt = 0.1 * THZ; /* 100 ms */
720 if (!tcp_cfg.csum_offload)
721 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
725 tcp_enable_pacing (tcp_connection_t * tc)
728 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
729 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
730 tc->mrtt_us = (u32) ~ 0;
733 /** Initialize tcp connection variables
735 * Should be called after having received a msg from the peer, i.e., a SYN or
736 * a SYNACK, such that connection options have already been exchanged. */
738 tcp_connection_init_vars (tcp_connection_t * tc)
740 tcp_connection_timers_init (tc);
742 scoreboard_init (&tc->sack_sb);
743 if (tc->state == TCP_STATE_SYN_RCVD)
744 tcp_init_snd_vars (tc);
748 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
749 tcp_add_del_adjacency (tc, 1);
751 /* tcp_connection_fib_attach (tc); */
753 if (transport_connection_is_tx_paced (&tc->connection)
754 || tcp_cfg.enable_tx_pacing)
755 tcp_enable_pacing (tc);
757 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
760 if (!tcp_cfg.allow_tso)
761 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
763 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
767 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
768 u16 * lcl_port, u8 is_ip4)
773 index = tm->last_v4_addr_rotor++;
774 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
775 tm->last_v4_addr_rotor = 0;
776 clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
777 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
781 index = tm->last_v6_addr_rotor++;
782 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
783 tm->last_v6_addr_rotor = 0;
784 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
785 sizeof (ip6_address_t));
787 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
789 return SESSION_E_NOPORT;
795 tcp_session_open (transport_endpoint_cfg_t * rmt)
797 tcp_main_t *tm = vnet_get_tcp_main ();
798 tcp_connection_t *tc;
799 ip46_address_t lcl_addr;
804 * Allocate local endpoint
806 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
807 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
808 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
811 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
812 rmt, &lcl_addr, &lcl_port);
816 if (rv != SESSION_E_PORTINUSE)
819 if (session_lookup_connection (rmt->fib_index, &lcl_addr, &rmt->ip,
820 lcl_port, rmt->port, TRANSPORT_PROTO_TCP,
822 return SESSION_E_PORTINUSE;
824 /* 5-tuple is available so increase lcl endpoint refcount and proceed
825 * with connection allocation */
826 transport_share_local_endpoint (TRANSPORT_PROTO_TCP, &lcl_addr,
831 * Create connection and send SYN
833 tc = tcp_half_open_connection_alloc ();
834 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
835 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
836 tc->c_rmt_port = rmt->port;
837 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
838 tc->c_is_ip4 = rmt->is_ip4;
839 tc->c_proto = TRANSPORT_PROTO_TCP;
840 tc->c_fib_index = rmt->fib_index;
841 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
842 /* The other connection vars will be initialized after SYN ACK */
843 tcp_connection_timers_init (tc);
845 if (rmt->peer.sw_if_index != ENDPOINT_INVALID_INDEX)
846 tc->sw_if_index = rmt->peer.sw_if_index;
847 tc->next_node_index = rmt->next_node_index;
848 tc->next_node_opaque = rmt->next_node_opaque;
850 TCP_EVT (TCP_EVT_OPEN, tc);
851 tc->state = TCP_STATE_SYN_SENT;
852 tcp_init_snd_vars (tc);
855 return tc->c_c_index;
859 format_tcp_session (u8 * s, va_list * args)
861 u32 tci = va_arg (*args, u32);
862 u32 thread_index = va_arg (*args, u32);
863 u32 verbose = va_arg (*args, u32);
864 tcp_connection_t *tc;
866 tc = tcp_connection_get (tci, thread_index);
868 s = format (s, "%U", format_tcp_connection, tc, verbose);
870 s = format (s, "empty\n");
875 format_tcp_listener_session (u8 * s, va_list * args)
877 u32 tci = va_arg (*args, u32);
878 u32 __clib_unused thread_index = va_arg (*args, u32);
879 u32 verbose = va_arg (*args, u32);
880 tcp_connection_t *tc = tcp_listener_get (tci);
881 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tcp_connection_id, tc);
883 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tcp_state,
889 format_tcp_half_open_session (u8 * s, va_list * args)
891 u32 tci = va_arg (*args, u32);
892 u32 __clib_unused thread_index = va_arg (*args, u32);
893 u32 verbose = va_arg (*args, u32);
894 tcp_connection_t *tc;
897 tc = tcp_half_open_connection_get (tci);
898 if (tc->flags & TCP_CONN_HALF_OPEN_DONE)
899 state = format (state, "%s", "CLOSED");
901 state = format (state, "%U", format_tcp_state, tc->state);
902 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tcp_connection_id, tc);
904 s = format (s, "%-" SESSION_CLI_STATE_LEN "v", state);
909 static transport_connection_t *
910 tcp_session_get_transport (u32 conn_index, u32 thread_index)
912 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
913 if (PREDICT_FALSE (!tc))
915 return &tc->connection;
918 static transport_connection_t *
919 tcp_half_open_session_get_transport (u32 conn_index)
921 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
922 return &tc->connection;
926 tcp_set_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
932 case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
933 tc->next_node_index = attr->next_output_node & 0xffffffff;
934 tc->next_node_opaque = attr->next_output_node >> 32;
936 case TRANSPORT_ENDPT_ATTR_MSS:
938 tc->snd_mss = clib_min (tc->snd_mss, tc->mss);
940 case TRANSPORT_ENDPT_ATTR_FLAGS:
941 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD)
942 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
944 tc->cfg_flags &= ~TCP_CFG_F_NO_CSUM_OFFLOAD;
945 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_GSO)
947 if (!(tc->cfg_flags & TCP_CFG_F_TSO))
949 tc->cfg_flags &= ~TCP_CFG_F_NO_TSO;
953 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
954 tc->cfg_flags &= ~TCP_CFG_F_TSO;
956 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING)
958 if (!(tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE))
960 tc->cfg_flags |= TCP_CFG_F_RATE_SAMPLE;
964 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
966 tc->cfg_flags &= ~TCP_CFG_F_RATE_SAMPLE;
969 case TRANSPORT_ENDPT_ATTR_CC_ALGO:
970 if (tc->cc_algo == tcp_cc_algo_get (attr->cc_algo))
973 tc->cc_algo = tcp_cc_algo_get (attr->cc_algo);
985 tcp_get_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
992 case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
993 non = (u64) tc->next_node_opaque << 32 | tc->next_node_index;
994 attr->next_output_node = non;
996 case TRANSPORT_ENDPT_ATTR_MSS:
997 attr->mss = tc->snd_mss;
999 case TRANSPORT_ENDPT_ATTR_FLAGS:
1001 if (!(tc->cfg_flags & TCP_CFG_F_NO_CSUM_OFFLOAD))
1002 attr->flags |= TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD;
1003 if (tc->cfg_flags & TCP_CFG_F_TSO)
1004 attr->flags |= TRANSPORT_ENDPT_ATTR_F_GSO;
1005 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
1006 attr->flags |= TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING;
1008 case TRANSPORT_ENDPT_ATTR_CC_ALGO:
1009 attr->cc_algo = tc->cc_algo - tcp_main.cc_algos;
1020 tcp_session_attribute (u32 conn_index, u32 thread_index, u8 is_get,
1021 transport_endpt_attr_t *attr)
1023 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1025 if (PREDICT_FALSE (!tc))
1029 return tcp_get_attribute (tc, attr);
1031 return tcp_set_attribute (tc, attr);
1035 tcp_session_cal_goal_size (tcp_connection_t * tc)
1037 u16 goal_size = tc->snd_mss;
1039 goal_size = tcp_cfg.max_gso_size - tc->snd_mss % tcp_cfg.max_gso_size;
1040 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1042 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1046 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1048 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1050 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1053 /* If not snd_wnd constrained and we can't write at least a segment,
1054 * don't try at all */
1055 if (PREDICT_FALSE (snd_space < tc->snd_mss))
1056 return snd_space < tc->cwnd ? 0 : snd_space;
1058 /* round down to mss multiple */
1059 return snd_space - (snd_space % tc->snd_mss);
1063 * Compute tx window session is allowed to fill.
1065 * Takes into account available send space, snd_mss and the congestion
1066 * state of the connection. If possible, the value returned is a multiple
1069 * @param tc tcp connection
1070 * @return number of bytes session is allowed to write
1073 tcp_snd_space_inline (tcp_connection_t * tc)
1077 /* Fast path is disabled when recovery is on. @ref tcp_session_custom_tx
1078 * controls both retransmits and the sending of new data while congested
1080 if (PREDICT_FALSE (tcp_in_cong_recovery (tc)
1081 || tc->state == TCP_STATE_CLOSED))
1084 snd_space = tcp_available_output_snd_space (tc);
1086 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1087 * to force the peer to send enough dupacks to start retransmitting as
1088 * per Limited Transmit (RFC3042)
1090 if (PREDICT_FALSE (tc->rcv_dupacks || tc->sack_sb.sacked_bytes))
1092 int snt_limited, n_pkts;
1094 n_pkts = tcp_opts_sack_permitted (&tc->rcv_opts)
1095 ? tc->sack_sb.reorder - 1 : 2;
1097 if ((seq_lt (tc->limited_transmit, tc->snd_nxt - n_pkts * tc->snd_mss)
1098 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1099 tc->limited_transmit = tc->snd_nxt;
1101 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1103 snt_limited = tc->snd_nxt - tc->limited_transmit;
1104 snd_space = clib_max (n_pkts * tc->snd_mss - snt_limited, 0);
1106 return tcp_round_snd_space (tc, snd_space);
1110 tcp_snd_space (tcp_connection_t * tc)
1112 return tcp_snd_space_inline (tc);
1116 tcp_session_send_params (transport_connection_t * trans_conn,
1117 transport_send_params_t * sp)
1119 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1121 /* Ensure snd_mss does accurately reflect the amount of data we can push
1122 * in a segment. This also makes sure that options are updated according to
1123 * the current state of the connection. */
1124 tcp_update_burst_snd_vars (tc);
1126 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1127 sp->snd_mss = tcp_session_cal_goal_size (tc);
1129 sp->snd_mss = tc->snd_mss;
1131 sp->snd_space = clib_min (tcp_snd_space_inline (tc),
1132 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1134 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1135 /* This still works if fast retransmit is on */
1136 sp->tx_offset = tc->snd_nxt - tc->snd_una;
1138 sp->flags = sp->snd_space ? 0 : TRANSPORT_SND_F_DESCHED;
1144 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1146 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1150 case TCP_STATE_CLOSE_WAIT:
1151 tcp_connection_timers_reset (tc);
1152 /* App never returned with a close */
1153 if (!(tc->flags & TCP_CONN_FINPNDG))
1155 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1156 session_transport_closed_notify (&tc->connection);
1157 tcp_program_cleanup (wrk, tc);
1158 tcp_worker_stats_inc (wrk, to_closewait, 1);
1162 /* Send FIN either way and switch to LAST_ACK. */
1163 tcp_cong_recovery_off (tc);
1164 /* Make sure we don't try to send unsent data */
1165 tc->snd_nxt = tc->snd_una;
1167 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1168 session_transport_closed_notify (&tc->connection);
1170 /* Make sure we don't wait in LAST ACK forever */
1171 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
1172 tcp_cfg.lastack_time);
1173 tcp_worker_stats_inc (wrk, to_closewait2, 1);
1175 /* Don't delete the connection yet */
1177 case TCP_STATE_FIN_WAIT_1:
1178 tcp_connection_timers_reset (tc);
1179 if (tc->flags & TCP_CONN_FINPNDG)
1181 /* If FIN pending, we haven't sent everything, but we did try.
1182 * Notify session layer that transport is closed. */
1183 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1184 tcp_send_reset (tc);
1185 tcp_program_cleanup (wrk, tc);
1189 /* We've sent the fin but no progress. Close the connection and
1190 * to make sure everything is flushed, setup a cleanup timer */
1191 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1192 tcp_program_cleanup (wrk, tc);
1194 session_transport_closed_notify (&tc->connection);
1195 tcp_worker_stats_inc (wrk, to_finwait1, 1);
1197 case TCP_STATE_LAST_ACK:
1198 tcp_connection_timers_reset (tc);
1199 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1200 session_transport_closed_notify (&tc->connection);
1201 tcp_program_cleanup (wrk, tc);
1202 tcp_worker_stats_inc (wrk, to_lastack, 1);
1204 case TCP_STATE_CLOSING:
1205 tcp_connection_timers_reset (tc);
1206 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1207 session_transport_closed_notify (&tc->connection);
1208 tcp_program_cleanup (wrk, tc);
1209 tcp_worker_stats_inc (wrk, to_closing, 1);
1211 case TCP_STATE_FIN_WAIT_2:
1212 tcp_send_reset (tc);
1213 tcp_connection_timers_reset (tc);
1214 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1215 session_transport_closed_notify (&tc->connection);
1216 tcp_program_cleanup (wrk, tc);
1217 tcp_worker_stats_inc (wrk, to_finwait2, 1);
1219 case TCP_STATE_TIME_WAIT:
1220 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1221 tcp_program_cleanup (wrk, tc);
1224 clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
1230 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1232 tcp_timer_retransmit_handler,
1233 tcp_timer_persist_handler,
1234 tcp_timer_waitclose_handler,
1235 tcp_timer_retransmit_syn_handler,
1240 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1242 u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1243 tcp_connection_t *tc;
1246 if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1249 thread_index = wrk->vm->thread_index;
1250 for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
1252 clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1253 connection_index = timer_handle & 0x0FFFFFFF;
1254 timer_id = timer_handle >> 28;
1256 if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1257 tc = tcp_connection_get (connection_index, thread_index);
1259 tc = tcp_half_open_connection_get (connection_index);
1261 if (PREDICT_FALSE (!tc))
1264 /* Skip if the timer is not pending. Probably it was reset while
1265 * waiting for dispatch */
1266 if (PREDICT_FALSE (!(tc->pending_timers & (1 << timer_id))))
1269 tc->pending_timers &= ~(1 << timer_id);
1271 /* Skip timer if it was rearmed while pending dispatch */
1272 if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1275 (*timer_expiration_handlers[timer_id]) (tc);
1278 if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
1279 session_queue_run_on_main_thread (wrk->vm);
1283 tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1285 u32 thread_index = wrk->vm->thread_index;
1286 tcp_cleanup_req_t *req;
1287 tcp_connection_t *tc;
1289 while (clib_fifo_elts (wrk->pending_cleanups))
1291 req = clib_fifo_head (wrk->pending_cleanups);
1292 if (req->free_time > now)
1294 clib_fifo_sub2 (wrk->pending_cleanups, req);
1295 tc = tcp_connection_get (req->connection_index, thread_index);
1296 if (PREDICT_FALSE (!tc))
1298 session_transport_delete_notify (&tc->connection);
1299 tcp_connection_cleanup (tc);
1304 tcp_update_time (f64 now, u8 thread_index)
1306 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1308 tcp_set_time_now (wrk, now);
1309 tcp_handle_cleanups (wrk, now);
1310 tcp_timer_expire_timers (&wrk->timer_wheel, now);
1311 tcp_dispatch_pending_timers (wrk);
1315 tcp_session_flush_data (transport_connection_t * tconn)
1317 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1318 if (tc->flags & TCP_CONN_PSH_PENDING)
1320 tc->flags |= TCP_CONN_PSH_PENDING;
1321 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1325 tcp_session_app_rx_evt (transport_connection_t *conn)
1327 tcp_connection_t *tc = (tcp_connection_t *) conn;
1328 u32 min_free, lo = 4 << 10, hi = 128 << 10;
1330 if (!(tc->flags & TCP_CONN_ZERO_RWND_SENT))
1333 min_free = clib_clamp (transport_rx_fifo_size (conn) >> 3, lo, hi);
1334 if (transport_max_rx_enqueue (conn) < min_free)
1336 transport_rx_fifo_req_deq_ntf (conn);
1346 const static transport_proto_vft_t tcp_proto = {
1347 .enable = vnet_tcp_enable_disable,
1348 .start_listen = tcp_session_bind,
1349 .stop_listen = tcp_session_unbind,
1350 .push_header = tcp_session_push_header,
1351 .get_connection = tcp_session_get_transport,
1352 .get_listener = tcp_session_get_listener,
1353 .get_half_open = tcp_half_open_session_get_transport,
1354 .attribute = tcp_session_attribute,
1355 .connect = tcp_session_open,
1356 .half_close = tcp_session_half_close,
1357 .close = tcp_session_close,
1358 .cleanup = tcp_session_cleanup,
1359 .cleanup_ho = tcp_session_cleanup_ho,
1360 .reset = tcp_session_reset,
1361 .send_params = tcp_session_send_params,
1362 .update_time = tcp_update_time,
1363 .flush_data = tcp_session_flush_data,
1364 .custom_tx = tcp_session_custom_tx,
1365 .app_rx_evt = tcp_session_app_rx_evt,
1366 .format_connection = format_tcp_session,
1367 .format_listener = format_tcp_listener_session,
1368 .format_half_open = format_tcp_half_open_session,
1369 .transport_options = {
1372 .tx_type = TRANSPORT_TX_PEEK,
1373 .service_type = TRANSPORT_SERVICE_VC,
1379 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1381 if (!transport_connection_is_tx_paced (&tc->connection))
1384 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1386 transport_connection_tx_pacer_update (&tc->connection,
1387 tcp_cc_get_pacing_rate (tc),
1388 srtt * CLIB_US_TIME_FREQ);
1392 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1395 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1396 transport_connection_tx_pacer_reset (&tc->connection,
1397 tcp_cc_get_pacing_rate (tc),
1399 srtt * CLIB_US_TIME_FREQ);
1403 tcp_reschedule (tcp_connection_t * tc)
1405 if (tcp_in_cong_recovery (tc) || tcp_snd_space_inline (tc))
1406 transport_connection_reschedule (&tc->connection);
1410 tcp_expired_timers_dispatch (u32 * expired_timers)
1412 u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1413 u32 connection_index, timer_id, n_expired, max_loops;
1414 tcp_worker_ctx_t *wrk;
1415 tcp_connection_t *tc;
1418 wrk = tcp_get_worker (thread_index);
1419 n_expired = vec_len (expired_timers);
1420 tcp_worker_stats_inc (wrk, timer_expirations, n_expired);
1421 n_left = clib_fifo_elts (wrk->pending_timers);
1424 * Invalidate all timer handles before dispatching. This avoids dangling
1425 * index references to timer wheel pool entries that have been freed.
1427 for (i = 0; i < n_expired; i++)
1429 connection_index = expired_timers[i] & 0x0FFFFFFF;
1430 timer_id = expired_timers[i] >> 28;
1432 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1433 tc = tcp_connection_get (connection_index, thread_index);
1435 tc = tcp_half_open_connection_get (connection_index);
1437 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1439 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1440 tc->pending_timers |= (1 << timer_id);
1443 clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1446 clib_max ((u32) 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second, 1);
1447 max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1448 max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1449 wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1452 if (thread_index == 0)
1453 session_queue_run_on_main_thread (wrk->vm);
1457 tcp_initialize_iss_seed (tcp_main_t * tm)
1459 u32 default_seed = random_default_seed ();
1460 u64 time_now = clib_cpu_time_now ();
1462 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1463 tm->iss_seed.second = random_u64 (&time_now);
1466 static clib_error_t *
1467 tcp_main_enable (vlib_main_t * vm)
1469 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1470 u32 num_threads, n_workers, prealloc_conn_per_wrk;
1471 tcp_connection_t *tc __attribute__ ((unused));
1472 tcp_main_t *tm = vnet_get_tcp_main ();
1473 tcp_worker_ctx_t *wrk;
1474 clib_error_t *error = 0;
1477 if ((error = vlib_call_init_function (vm, ip_main_init)))
1479 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1481 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1488 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1489 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1492 * Initialize data structures
1495 num_threads = 1 /* main thread */ + vtm->n_threads;
1496 vec_validate (tm->wrk_ctx, num_threads - 1);
1497 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1498 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1500 wrk = &tm->wrk_ctx[0];
1501 wrk->tco_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1502 tcp4_output_node.index);
1503 wrk->tco_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1504 tcp6_output_node.index);
1506 for (thread = 0; thread < num_threads; thread++)
1508 wrk = &tm->wrk_ctx[thread];
1510 vec_validate (wrk->pending_deq_acked, 255);
1511 vec_validate (wrk->pending_disconnects, 255);
1512 vec_validate (wrk->pending_resets, 255);
1513 vec_reset_length (wrk->pending_deq_acked);
1514 vec_reset_length (wrk->pending_disconnects);
1515 vec_reset_length (wrk->pending_resets);
1516 wrk->vm = vlib_get_main_by_index (thread);
1517 wrk->max_timers_per_loop = 10;
1521 wrk->tco_next_node[0] = tm->wrk_ctx[0].tco_next_node[0];
1522 wrk->tco_next_node[1] = tm->wrk_ctx[0].tco_next_node[1];
1526 * Preallocate connections. Assume that thread 0 won't
1527 * use preallocated threads when running multi-core
1529 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1530 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1532 tcp_timer_initialize_wheel (&wrk->timer_wheel,
1533 tcp_expired_timers_dispatch,
1534 vlib_time_now (vm));
1537 tcp_initialize_iss_seed (tm);
1539 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1540 tm->cc_last_type = TCP_CC_LAST;
1542 tm->ipl_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1543 ip4_lookup_node.index);
1544 tm->ipl_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1545 ip6_lookup_node.index);
1550 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1554 if (tcp_main.is_enabled)
1557 return tcp_main_enable (vm);
1561 tcp_main.is_enabled = 0;
1568 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1570 tcp_main_t *tm = &tcp_main;
1572 tm->punt_unknown4 = is_add;
1574 tm->punt_unknown6 = is_add;
1578 * Initialize default values for tcp parameters
1581 tcp_configuration_init (void)
1583 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1584 * predefined value. For SYN-ACK we still want the scale to be computed in
1586 tcp_cfg.max_rx_fifo = 32 << 20;
1587 tcp_cfg.min_rx_fifo = 4 << 10;
1589 tcp_cfg.default_mtu = 1500;
1590 tcp_cfg.initial_cwnd_multiplier = 0;
1591 tcp_cfg.enable_tx_pacing = 1;
1592 tcp_cfg.allow_tso = 0;
1593 tcp_cfg.csum_offload = 1;
1594 tcp_cfg.cc_algo = TCP_CC_CUBIC;
1595 tcp_cfg.rwnd_min_update_ack = 1;
1596 tcp_cfg.max_gso_size = TCP_MAX_GSO_SZ;
1598 /* Time constants defined as timer tick (100us) multiples */
1599 tcp_cfg.closewait_time = 20000; /* 2s */
1600 tcp_cfg.timewait_time = 100000; /* 10s */
1601 tcp_cfg.finwait1_time = 600000; /* 60s */
1602 tcp_cfg.lastack_time = 300000; /* 30s */
1603 tcp_cfg.finwait2_time = 300000; /* 30s */
1604 tcp_cfg.closing_time = 300000; /* 30s */
1605 tcp_cfg.alloc_err_timeout = 1000; /* 100ms */
1607 /* This value is seconds */
1608 tcp_cfg.cleanup_time = 0.1; /* 100ms */
1611 static clib_error_t *
1612 tcp_init (vlib_main_t * vm)
1614 tcp_main_t *tm = vnet_get_tcp_main ();
1615 ip_main_t *im = &ip_main;
1616 ip_protocol_info_t *pi;
1618 /* Session layer, and by implication tcp, are disabled by default */
1621 /* Register with IP for header parsing */
1622 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1624 return clib_error_return (0, "TCP protocol info AWOL");
1625 pi->format_header = format_tcp_header;
1626 pi->unformat_pg_edit = unformat_pg_tcp_header;
1628 /* Register as transport with session layer */
1629 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1630 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1631 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1632 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1634 tcp_configuration_init ();
1636 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1641 VLIB_INIT_FUNCTION (tcp_init);
1644 * fd.io coding-style-patch-verification: ON
1647 * eval: (c-set-style "gnu")