blob: 2ac938a1b1e03427704f1e2a0f902d2be8d0859b [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
Florin Coras222e1f412019-02-16 20:47:32 -08002 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
Dave Barach68b0fb02017-02-28 15:15:56 -05003 * 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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
Dave Barach3bbcfab2017-08-15 19:03:44 -040016/**
17 * @file
18 * @brief TCP host stack utilities
19 */
20
Dave Barach68b0fb02017-02-28 15:15:56 -050021#include <vnet/tcp/tcp.h>
Florin Coras999840c2020-03-18 20:31:34 +000022#include <vnet/tcp/tcp_inlines.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050023#include <vnet/session/session.h>
24#include <vnet/fib/fib.h>
Florin Corasf6359c82017-06-19 12:26:09 -040025#include <vnet/dpo/load_balance.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050026#include <math.h>
27
28tcp_main_t tcp_main;
29
Florin Coras1c8ff632018-05-17 13:28:34 -070030typedef struct
31{
32 fib_protocol_t nh_proto;
33 vnet_link_t link_type;
34 ip46_address_t ip;
35 u32 sw_if_index;
36 u8 is_add;
37} tcp_add_del_adj_args_t;
38
39static void
40tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
41{
42 u32 ai;
43 if (args->is_add)
44 {
45 adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
46 args->sw_if_index);
47 }
48 else
49 {
50 ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
51 args->sw_if_index);
52 if (ai != ADJ_INDEX_INVALID)
53 adj_unlock (ai);
54 }
55}
56
57static void
58tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
59{
60 tcp_add_del_adj_args_t args = {
61 .nh_proto = FIB_PROTOCOL_IP6,
62 .link_type = VNET_LINK_IP6,
63 .ip = tc->c_rmt_ip,
64 .sw_if_index = tc->sw_if_index,
65 .is_add = is_add
66 };
67 vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
68 sizeof (args));
69}
70
Florin Corasd9a145f2019-06-07 09:35:20 -070071static void
72tcp_cc_init (tcp_connection_t * tc)
73{
Florin Corasd9a145f2019-06-07 09:35:20 -070074 tc->cc_algo->init (tc);
75}
76
77static void
78tcp_cc_cleanup (tcp_connection_t * tc)
79{
80 if (tc->cc_algo->cleanup)
81 tc->cc_algo->cleanup (tc);
82}
83
84void
85tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
86 const tcp_cc_algorithm_t * vft)
87{
88 tcp_main_t *tm = vnet_get_tcp_main ();
89 vec_validate (tm->cc_algos, type);
90
91 tm->cc_algos[type] = *vft;
92 hash_set_mem (tm->cc_algo_by_name, vft->name, type);
93}
94
95tcp_cc_algorithm_t *
96tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
97{
98 tcp_main_t *tm = vnet_get_tcp_main ();
99 return &tm->cc_algos[type];
100}
101
Florin Coras4e116fb2019-06-10 08:33:50 -0700102tcp_cc_algorithm_type_e
103tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
104{
105 tcp_main_t *tm = vnet_get_tcp_main ();
106 tcp_cc_algo_register (++tm->cc_last_type, vft);
107 return tm->cc_last_type;
108}
109
Dave Barach68b0fb02017-02-28 15:15:56 -0500110static u32
Florin Coras04e53442017-07-16 17:12:15 -0700111tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
Dave Barach68b0fb02017-02-28 15:15:56 -0500112{
113 tcp_main_t *tm = &tcp_main;
114 tcp_connection_t *listener;
Florin Corascea194d2017-10-02 00:18:51 -0700115 void *iface_ip;
Dave Barach68b0fb02017-02-28 15:15:56 -0500116
117 pool_get (tm->listener_pool, listener);
Dave Barachb7b92992018-10-17 10:38:51 -0400118 clib_memset (listener, 0, sizeof (*listener));
Dave Barach68b0fb02017-02-28 15:15:56 -0500119
120 listener->c_c_index = listener - tm->listener_pool;
Florin Coras0e495682017-09-19 22:27:18 -0700121 listener->c_lcl_port = lcl->port;
Dave Barach68b0fb02017-02-28 15:15:56 -0500122
Florin Corascea194d2017-10-02 00:18:51 -0700123 /* If we are provided a sw_if_index, bind using one of its ips */
124 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700125 {
Florin Corascea194d2017-10-02 00:18:51 -0700126 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
127 lcl->is_ip4)))
128 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700129 }
Florin Corascea194d2017-10-02 00:18:51 -0700130 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
131 listener->c_is_ip4 = lcl->is_ip4;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700132 listener->c_proto = TRANSPORT_PROTO_TCP;
Dave Barach68b0fb02017-02-28 15:15:56 -0500133 listener->c_s_index = session_index;
Florin Corascea194d2017-10-02 00:18:51 -0700134 listener->c_fib_index = lcl->fib_index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500135 listener->state = TCP_STATE_LISTEN;
Florin Coras12f69362019-08-16 09:44:00 -0700136 listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
Dave Barach68b0fb02017-02-28 15:15:56 -0500137
Florin Corase69f4952017-03-07 10:06:24 -0800138 tcp_connection_timers_init (listener);
139
Florin Corasa436a422019-08-20 07:09:31 -0700140 TCP_EVT (TCP_EVT_BIND, listener);
Florin Corase69f4952017-03-07 10:06:24 -0800141
Dave Barach68b0fb02017-02-28 15:15:56 -0500142 return listener->c_c_index;
143}
144
Florin Coras0dbd5172018-06-25 16:19:34 -0700145static u32
Florin Coras04e53442017-07-16 17:12:15 -0700146tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
Dave Barach68b0fb02017-02-28 15:15:56 -0500147{
Florin Coras04e53442017-07-16 17:12:15 -0700148 return tcp_connection_bind (session_index, tep);
Dave Barach68b0fb02017-02-28 15:15:56 -0500149}
150
151static void
Florin Corase69f4952017-03-07 10:06:24 -0800152tcp_connection_unbind (u32 listener_index)
Dave Barach68b0fb02017-02-28 15:15:56 -0500153{
154 tcp_main_t *tm = vnet_get_tcp_main ();
Dave Barach2c25a622017-06-26 11:35:07 -0400155 tcp_connection_t *tc;
156
157 tc = pool_elt_at_index (tm->listener_pool, listener_index);
158
Florin Corasa436a422019-08-20 07:09:31 -0700159 TCP_EVT (TCP_EVT_UNBIND, tc);
Dave Barach2c25a622017-06-26 11:35:07 -0400160
161 /* Poison the entry */
162 if (CLIB_DEBUG > 0)
Dave Barachb7b92992018-10-17 10:38:51 -0400163 clib_memset (tc, 0xFA, sizeof (*tc));
Dave Barach2c25a622017-06-26 11:35:07 -0400164
Dave Barach68b0fb02017-02-28 15:15:56 -0500165 pool_put_index (tm->listener_pool, listener_index);
166}
167
Florin Coras0dbd5172018-06-25 16:19:34 -0700168static u32
Florin Corase69f4952017-03-07 10:06:24 -0800169tcp_session_unbind (u32 listener_index)
Dave Barach68b0fb02017-02-28 15:15:56 -0500170{
Florin Corase69f4952017-03-07 10:06:24 -0800171 tcp_connection_unbind (listener_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500172 return 0;
173}
174
Florin Coras0dbd5172018-06-25 16:19:34 -0700175static transport_connection_t *
Dave Barach68b0fb02017-02-28 15:15:56 -0500176tcp_session_get_listener (u32 listener_index)
177{
178 tcp_main_t *tm = vnet_get_tcp_main ();
179 tcp_connection_t *tc;
180 tc = pool_elt_at_index (tm->listener_pool, listener_index);
181 return &tc->connection;
182}
183
Florin Coras68810622017-07-24 17:40:28 -0700184/**
185 * Cleanup half-open connection
186 *
187 */
Florin Coras0dbd5172018-06-25 16:19:34 -0700188static void
Florin Coras68810622017-07-24 17:40:28 -0700189tcp_half_open_connection_del (tcp_connection_t * tc)
190{
191 tcp_main_t *tm = vnet_get_tcp_main ();
192 clib_spinlock_lock_if_init (&tm->half_open_lock);
Florin Coras68810622017-07-24 17:40:28 -0700193 if (CLIB_DEBUG)
Dave Barachb7b92992018-10-17 10:38:51 -0400194 clib_memset (tc, 0xFA, sizeof (*tc));
Benoît Ganned4aeb842019-07-18 18:38:42 +0200195 pool_put (tm->half_open_connections, tc);
Florin Coras68810622017-07-24 17:40:28 -0700196 clib_spinlock_unlock_if_init (&tm->half_open_lock);
197}
198
199/**
200 * Try to cleanup half-open connection
201 *
202 * If called from a thread that doesn't own tc, the call won't have any
203 * effect.
204 *
205 * @param tc - connection to be cleaned up
206 * @return non-zero if cleanup failed.
207 */
208int
209tcp_half_open_connection_cleanup (tcp_connection_t * tc)
210{
211 /* Make sure this is the owning thread */
212 if (tc->c_thread_index != vlib_get_thread_index ())
213 return 1;
Florin Coras68810622017-07-24 17:40:28 -0700214 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
215 tcp_half_open_connection_del (tc);
216 return 0;
217}
218
Florin Coras0dbd5172018-06-25 16:19:34 -0700219static tcp_connection_t *
Florin Coras68810622017-07-24 17:40:28 -0700220tcp_half_open_connection_new (void)
221{
222 tcp_main_t *tm = vnet_get_tcp_main ();
223 tcp_connection_t *tc = 0;
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400224 ASSERT (vlib_get_thread_index () == 0);
Florin Coras68810622017-07-24 17:40:28 -0700225 pool_get (tm->half_open_connections, tc);
Dave Barachb7b92992018-10-17 10:38:51 -0400226 clib_memset (tc, 0, sizeof (*tc));
Florin Coras68810622017-07-24 17:40:28 -0700227 tc->c_c_index = tc - tm->half_open_connections;
228 return tc;
229}
230
Dave Barach68b0fb02017-02-28 15:15:56 -0500231/**
232 * Cleans up connection state.
233 *
234 * No notifications.
235 */
236void
237tcp_connection_cleanup (tcp_connection_t * tc)
238{
Florin Corasa436a422019-08-20 07:09:31 -0700239 TCP_EVT (TCP_EVT_DELETE, tc);
Florin Coras070fd4b2019-04-02 19:03:23 -0700240
Dave Barach68b0fb02017-02-28 15:15:56 -0500241 /* Cleanup local endpoint if this was an active connect */
Florin Coras43818c12020-02-09 23:09:26 +0000242 if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
243 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
244 tc->c_lcl_port);
Dave Barach68b0fb02017-02-28 15:15:56 -0500245
Florin Coras68810622017-07-24 17:40:28 -0700246 /* Check if connection is not yet fully established */
Dave Barach68b0fb02017-02-28 15:15:56 -0500247 if (tc->state == TCP_STATE_SYN_SENT)
Dave Barach2c25a622017-06-26 11:35:07 -0400248 {
Florin Coras68810622017-07-24 17:40:28 -0700249 /* 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. */
Florin Corasc5347d92018-10-17 10:41:28 -0700252 if (tcp_half_open_connection_cleanup (tc))
253 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
Dave Barach2c25a622017-06-26 11:35:07 -0400254 }
Dave Barach68b0fb02017-02-28 15:15:56 -0500255 else
Dave Barach2c25a622017-06-26 11:35:07 -0400256 {
Florin Coras68810622017-07-24 17:40:28 -0700257 /* Make sure all timers are cleared */
258 tcp_connection_timers_reset (tc);
259
Florin Coras1c8ff632018-05-17 13:28:34 -0700260 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
261 tcp_add_del_adjacency (tc, 0);
262
Florin Corasd9a145f2019-06-07 09:35:20 -0700263 tcp_cc_cleanup (tc);
Florin Corasb691f762019-02-22 09:07:20 -0800264 vec_free (tc->snd_sacks);
265 vec_free (tc->snd_sacks_fl);
Florin Coras558e3e02019-09-06 12:56:58 -0700266 vec_free (tc->rcv_opts.sacks);
267 pool_free (tc->sack_sb.holes);
Florin Corasb691f762019-02-22 09:07:20 -0800268
Florin Corasbbcfaac2019-10-10 13:52:04 -0700269 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
Florin Coras52814732019-06-12 15:38:19 -0700270 tcp_bt_cleanup (tc);
271
Florin Coras04261852020-02-12 01:24:29 +0000272 tcp_connection_free (tc);
Dave Barach2c25a622017-06-26 11:35:07 -0400273 }
Dave Barach68b0fb02017-02-28 15:15:56 -0500274}
275
276/**
277 * Connection removal.
278 *
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.
282 */
283void
284tcp_connection_del (tcp_connection_t * tc)
285{
Florin Coras5a2ec8f2018-12-27 11:53:11 -0800286 session_transport_delete_notify (&tc->connection);
Dave Barach68b0fb02017-02-28 15:15:56 -0500287 tcp_connection_cleanup (tc);
288}
289
Florin Coras6534b7a2017-07-18 05:38:03 -0400290tcp_connection_t *
Florin Coras8124cb72018-12-16 20:57:29 -0800291tcp_connection_alloc (u8 thread_index)
Florin Coras6534b7a2017-07-18 05:38:03 -0400292{
Florin Coras04261852020-02-12 01:24:29 +0000293 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
Florin Coras6534b7a2017-07-18 05:38:03 -0400294 tcp_connection_t *tc;
295
Florin Coras04261852020-02-12 01:24:29 +0000296 pool_get (wrk->connections, tc);
Dave Barachb7b92992018-10-17 10:38:51 -0400297 clib_memset (tc, 0, sizeof (*tc));
Florin Coras04261852020-02-12 01:24:29 +0000298 tc->c_c_index = tc - wrk->connections;
Florin Coras6534b7a2017-07-18 05:38:03 -0400299 tc->c_thread_index = thread_index;
300 return tc;
301}
302
Florin Coras12f69362019-08-16 09:44:00 -0700303tcp_connection_t *
304tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
305{
Florin Coras04261852020-02-12 01:24:29 +0000306 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
Florin Coras12f69362019-08-16 09:44:00 -0700307 tcp_connection_t *tc;
308
Florin Coras04261852020-02-12 01:24:29 +0000309 pool_get (wrk->connections, tc);
Florin Coras12f69362019-08-16 09:44:00 -0700310 clib_memcpy_fast (tc, base, sizeof (*tc));
Florin Coras04261852020-02-12 01:24:29 +0000311 tc->c_c_index = tc - wrk->connections;
Florin Coras12f69362019-08-16 09:44:00 -0700312 tc->c_thread_index = thread_index;
313 return tc;
314}
315
Florin Coras8124cb72018-12-16 20:57:29 -0800316void
317tcp_connection_free (tcp_connection_t * tc)
318{
Florin Coras04261852020-02-12 01:24:29 +0000319 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
Florin Coras6416e622019-04-03 17:52:43 -0700320 if (CLIB_DEBUG)
321 {
Florin Coras6416e622019-04-03 17:52:43 -0700322 clib_memset (tc, 0xFA, sizeof (*tc));
Florin Coras04261852020-02-12 01:24:29 +0000323 pool_put (wrk->connections, tc);
Florin Coras6416e622019-04-03 17:52:43 -0700324 return;
325 }
Florin Coras04261852020-02-12 01:24:29 +0000326 pool_put (wrk->connections, tc);
Florin Coras8124cb72018-12-16 20:57:29 -0800327}
328
Florin Coras7a3a8662020-02-22 02:27:21 +0000329void
330tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
331{
332 tcp_cleanup_req_t *req;
333 clib_time_type_t now;
334
335 now = transport_time_now (tc->c_thread_index);
336 clib_fifo_add2 (wrk->pending_cleanups, req);
337 req->connection_index = tc->c_c_index;
338 req->free_time = now + tcp_cfg.cleanup_time;
339}
340
Dave Barach68b0fb02017-02-28 15:15:56 -0500341/**
342 * Begin connection closing procedure.
343 *
344 * If at the end the connection is not in CLOSED state, it is not removed.
345 * Instead, we rely on on TCP to advance through state machine to either
346 * 1) LAST_ACK (passive close) whereby when the last ACK is received
347 * tcp_connection_del is called. This notifies session of the delete and
348 * calls cleanup.
349 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
350 * and cleanup is called.
Florin Corasd79b41e2017-03-04 05:37:52 -0800351 *
352 * N.B. Half-close connections are not supported
Dave Barach68b0fb02017-02-28 15:15:56 -0500353 */
354void
355tcp_connection_close (tcp_connection_t * tc)
356{
Florin Corasa436a422019-08-20 07:09:31 -0700357 TCP_EVT (TCP_EVT_CLOSE, tc);
Florin Corase69f4952017-03-07 10:06:24 -0800358
Florin Corasb2215d62017-08-01 16:56:58 -0700359 /* Send/Program FIN if needed and switch state */
360 switch (tc->state)
361 {
362 case TCP_STATE_SYN_SENT:
Florin Coras85a3ddd2018-12-24 16:54:34 -0800363 /* Try to cleanup. If not on the right thread, mark as half-open done.
364 * Connection will be cleaned up when establish timer pops */
365 tcp_connection_cleanup (tc);
Florin Corasb2215d62017-08-01 16:56:58 -0700366 break;
367 case TCP_STATE_SYN_RCVD:
Florin Corasc5347d92018-10-17 10:41:28 -0700368 tcp_connection_timers_reset (tc);
Florin Corasb2215d62017-08-01 16:56:58 -0700369 tcp_send_fin (tc);
Florin Coras3c514d52018-12-22 11:39:33 -0800370 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
Florin Coras9094b5c2019-08-12 14:17:47 -0700371 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
Florin Corasb2215d62017-08-01 16:56:58 -0700372 break;
373 case TCP_STATE_ESTABLISHED:
Florin Corasf65074e2019-03-31 17:17:11 -0700374 /* If closing with unread data, reset the connection */
375 if (transport_max_rx_dequeue (&tc->connection))
376 {
377 tcp_send_reset (tc);
378 tcp_connection_timers_reset (tc);
379 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Corasa0904f02019-07-22 20:55:11 -0700380 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +0000381 tcp_program_cleanup (tcp_get_worker (tc->c_thread_index), tc);
Florin Coras5e6305f2020-02-12 07:42:01 +0000382 tcp_worker_stats_inc (tc->c_thread_index, rst_unread, 1);
Florin Corasf65074e2019-03-31 17:17:11 -0700383 break;
384 }
Florin Coras31c99552019-03-01 13:00:58 -0800385 if (!transport_max_tx_dequeue (&tc->connection))
Florin Corasb2215d62017-08-01 16:56:58 -0700386 tcp_send_fin (tc);
387 else
388 tc->flags |= TCP_CONN_FINPNDG;
Florin Coras3c514d52018-12-22 11:39:33 -0800389 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
Florin Corase96bf632018-12-18 22:44:27 -0800390 /* Set a timer in case the peer stops responding. Otherwise the
391 * connection will be stuck here forever. */
Florin Coras85a3ddd2018-12-24 16:54:34 -0800392 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
Florin Coras9094b5c2019-08-12 14:17:47 -0700393 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
Florin Corasb2215d62017-08-01 16:56:58 -0700394 break;
395 case TCP_STATE_CLOSE_WAIT:
Florin Coras31c99552019-03-01 13:00:58 -0800396 if (!transport_max_tx_dequeue (&tc->connection))
Florin Coras25579b42018-06-06 17:55:02 -0700397 {
398 tcp_send_fin (tc);
399 tcp_connection_timers_reset (tc);
Florin Coras3c514d52018-12-22 11:39:33 -0800400 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
Florin Coras9094b5c2019-08-12 14:17:47 -0700401 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
Florin Coras25579b42018-06-06 17:55:02 -0700402 }
403 else
404 tc->flags |= TCP_CONN_FINPNDG;
Florin Corasb2215d62017-08-01 16:56:58 -0700405 break;
Florin Corasc87c91d2017-08-16 19:55:49 -0700406 case TCP_STATE_FIN_WAIT_1:
Florin Coras9094b5c2019-08-12 14:17:47 -0700407 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
Florin Corasc87c91d2017-08-16 19:55:49 -0700408 break;
Florin Coras4af830c2018-12-04 09:21:36 -0800409 case TCP_STATE_CLOSED:
Florin Coras7a3a8662020-02-22 02:27:21 +0000410 /* Cleanup should've been programmed already */
Florin Coras4af830c2018-12-04 09:21:36 -0800411 break;
Florin Corasb2215d62017-08-01 16:56:58 -0700412 default:
Florin Corasa096f2d2017-09-28 23:49:42 -0400413 TCP_DBG ("state: %u", tc->state);
Florin Corasb2215d62017-08-01 16:56:58 -0700414 }
Dave Barach68b0fb02017-02-28 15:15:56 -0500415}
416
Florin Coras0dbd5172018-06-25 16:19:34 -0700417static void
Dave Barach68b0fb02017-02-28 15:15:56 -0500418tcp_session_close (u32 conn_index, u32 thread_index)
419{
420 tcp_connection_t *tc;
421 tc = tcp_connection_get (conn_index, thread_index);
422 tcp_connection_close (tc);
423}
424
Florin Coras0dbd5172018-06-25 16:19:34 -0700425static void
Dave Barach68b0fb02017-02-28 15:15:56 -0500426tcp_session_cleanup (u32 conn_index, u32 thread_index)
427{
428 tcp_connection_t *tc;
429 tc = tcp_connection_get (conn_index, thread_index);
Florin Coras54c93cf2019-09-24 12:45:14 -0700430 if (!tc)
431 return;
Florin Coras85a3ddd2018-12-24 16:54:34 -0800432 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras25579b42018-06-06 17:55:02 -0700433 tcp_connection_cleanup (tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500434}
435
Florin Corasdfb3b872019-08-16 17:48:44 -0700436static void
437tcp_session_reset (u32 conn_index, u32 thread_index)
438{
439 tcp_connection_t *tc;
440 tc = tcp_connection_get (conn_index, thread_index);
Florin Corasdfb3b872019-08-16 17:48:44 -0700441 tcp_send_reset (tc);
442 tcp_connection_timers_reset (tc);
Florin Corasfd4c3fe2019-11-07 12:33:12 -0800443 tcp_cong_recovery_off (tc);
Florin Corasdfb3b872019-08-16 17:48:44 -0700444 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras7a3a8662020-02-22 02:27:21 +0000445 session_transport_closed_notify (&tc->connection);
446 tcp_program_cleanup (tcp_get_worker (thread_index), tc);
Florin Corasdfb3b872019-08-16 17:48:44 -0700447}
448
Dave Barach68b0fb02017-02-28 15:15:56 -0500449/**
450 * Initialize all connection timers as invalid
451 */
452void
453tcp_connection_timers_init (tcp_connection_t * tc)
454{
455 int i;
456
457 /* Set all to invalid */
458 for (i = 0; i < TCP_N_TIMERS; i++)
459 {
460 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
461 }
462
463 tc->rto = TCP_RTO_INIT;
464}
465
466/**
467 * Stop all connection timers
468 */
469void
470tcp_connection_timers_reset (tcp_connection_t * tc)
471{
472 int i;
473 for (i = 0; i < TCP_N_TIMERS; i++)
474 {
475 tcp_timer_reset (tc, i);
476 }
477}
478
Dave Barach2c25a622017-06-26 11:35:07 -0400479#if 0
Florin Corasf6359c82017-06-19 12:26:09 -0400480typedef struct ip4_tcp_hdr
481{
482 ip4_header_t ip;
483 tcp_header_t tcp;
484} ip4_tcp_hdr_t;
485
486typedef struct ip6_tcp_hdr
487{
488 ip6_header_t ip;
489 tcp_header_t tcp;
490} ip6_tcp_hdr_t;
491
492static void
493tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
494 dpo_id_t * result)
495{
496 const dpo_id_t *choice;
497 load_balance_t *lb;
498 int hash;
499
500 lb = load_balance_get (dpo->dpoi_index);
501 if (tc->c_is_ip4)
502 {
503 ip4_tcp_hdr_t hdr;
Dave Barachb7b92992018-10-17 10:38:51 -0400504 clib_memset (&hdr, 0, sizeof (hdr));
Florin Corasf6359c82017-06-19 12:26:09 -0400505 hdr.ip.protocol = IP_PROTOCOL_TCP;
506 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
507 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
508 hdr.tcp.src_port = tc->c_lcl_port;
509 hdr.tcp.dst_port = tc->c_rmt_port;
510 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
511 }
512 else
513 {
514 ip6_tcp_hdr_t hdr;
Dave Barachb7b92992018-10-17 10:38:51 -0400515 clib_memset (&hdr, 0, sizeof (hdr));
Florin Corasf6359c82017-06-19 12:26:09 -0400516 hdr.ip.protocol = IP_PROTOCOL_TCP;
Dave Barach178cf492018-11-13 16:34:13 -0500517 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
518 sizeof (ip6_address_t));
519 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
520 sizeof (ip6_address_t));
Florin Corasf6359c82017-06-19 12:26:09 -0400521 hdr.tcp.src_port = tc->c_lcl_port;
522 hdr.tcp.dst_port = tc->c_rmt_port;
523 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
524 }
525 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
526 dpo_copy (result, choice);
527}
528
529fib_node_index_t
530tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
531{
532 fib_prefix_t prefix;
Florin Coras04e53442017-07-16 17:12:15 -0700533 u32 fib_index;
Florin Corasf6359c82017-06-19 12:26:09 -0400534
Dave Barach178cf492018-11-13 16:34:13 -0500535 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
Florin Corasf6359c82017-06-19 12:26:09 -0400536 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
537 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
Florin Corascea194d2017-10-02 00:18:51 -0700538 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
Florin Coras04e53442017-07-16 17:12:15 -0700539 return fib_table_lookup (fib_index, &prefix);
Florin Corasf6359c82017-06-19 12:26:09 -0400540}
541
542static int
543tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
544{
545 dpo_id_t choice = DPO_INVALID;
546 u32 output_node_index;
547 fib_entry_t *fe;
548
549 fe = fib_entry_get (tc->c_rmt_fei);
550 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
551 return -1;
552
553 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
554
555 output_node_index =
556 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
557 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
558 return 0;
559}
560
561/** Stack tcp connection on peer's fib entry.
562 *
563 * This ultimately populates the dpo the connection will use to send packets.
564 */
565static void
566tcp_connection_fib_attach (tcp_connection_t * tc)
567{
568 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
569
570 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
571
572 tcp_connection_stack_on_fib_entry (tc);
573}
Dave Barach2c25a622017-06-26 11:35:07 -0400574#endif /* 0 */
Florin Corasf6359c82017-06-19 12:26:09 -0400575
Florin Coras18e0d4f2019-01-02 12:22:02 -0800576/**
577 * Generate random iss as per rfc6528
578 */
579static u32
580tcp_generate_random_iss (tcp_connection_t * tc)
581{
582 tcp_main_t *tm = &tcp_main;
583 u64 tmp;
584
585 if (tc->c_is_ip4)
586 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
587 else
588 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
589 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
590
591 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
592 tmp ^= tm->iss_seed.second;
593 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
594 return ((tmp >> 32) ^ (tmp & 0xffffffff));
595}
Florin Coras0dbd5172018-06-25 16:19:34 -0700596
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400597/**
Florin Corascedcf602019-08-27 12:15:43 -0700598 * Initialize max segment size we're able to process.
599 *
600 * The value is constrained by the output interface's MTU and by the size
601 * of the IP and TCP headers (see RFC6691). It is also what we advertise
602 * to our peer.
603 */
604static void
605tcp_init_rcv_mss (tcp_connection_t * tc)
606{
607 u8 ip_hdr_len;
608
Florin Corasff19e3b2020-02-10 17:44:13 +0000609 /* Already provided at connection init time */
610 if (tc->mss)
611 return;
612
Florin Corascedcf602019-08-27 12:15:43 -0700613 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
614 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
615}
616
617static void
618tcp_init_mss (tcp_connection_t * tc)
619{
620 u16 default_min_mss = 536;
621
622 tcp_init_rcv_mss (tc);
623
624 /* TODO consider PMTU discovery */
625 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
626
627 if (tc->snd_mss < 45)
628 {
629 /* Assume that at least the min default mss works */
630 tc->snd_mss = default_min_mss;
631 tc->rcv_opts.mss = default_min_mss;
632 }
633
634 /* We should have enough space for 40 bytes of options */
635 ASSERT (tc->snd_mss > 45);
636
637 /* If we use timestamp option, account for it */
638 if (tcp_opts_tstamp (&tc->rcv_opts))
639 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
640}
641
642/**
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400643 * Initialize connection send variables.
644 */
645void
646tcp_init_snd_vars (tcp_connection_t * tc)
647{
Florin Coras3cbc04b2017-10-02 00:18:51 -0700648 /*
649 * We use the time to randomize iss and for setting up the initial
650 * timestamp. Make sure it's updated otherwise syn and ack in the
651 * handshake may make it look as if time has flown in the opposite
652 * direction for us.
653 */
Florin Corasbe72ae62018-11-01 11:23:03 -0700654 tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
Florin Coras3cbc04b2017-10-02 00:18:51 -0700655
Florin Corascedcf602019-08-27 12:15:43 -0700656 tcp_init_rcv_mss (tc);
Florin Coras18e0d4f2019-01-02 12:22:02 -0800657 tc->iss = tcp_generate_random_iss (tc);
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400658 tc->snd_una = tc->iss;
659 tc->snd_nxt = tc->iss + 1;
660 tc->snd_una_max = tc->snd_nxt;
Florin Coras36ebcff2019-09-12 18:36:44 -0700661 tc->srtt = 100; /* 100 ms */
Florin Corasf4ce6ba2019-11-20 18:34:58 -0800662
663 if (!tcp_cfg.csum_offload)
664 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400665}
666
Florin Corasd67f1122018-05-21 17:47:40 -0700667void
668tcp_enable_pacing (tcp_connection_t * tc)
669{
Florin Coras36ebcff2019-09-12 18:36:44 -0700670 u32 byte_rate;
671 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
672 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
Florin Corasd67f1122018-05-21 17:47:40 -0700673 tc->mrtt_us = (u32) ~ 0;
674}
675
Dave Barach68b0fb02017-02-28 15:15:56 -0500676/** Initialize tcp connection variables
677 *
678 * Should be called after having received a msg from the peer, i.e., a SYN or
679 * a SYNACK, such that connection options have already been exchanged. */
680void
681tcp_connection_init_vars (tcp_connection_t * tc)
682{
683 tcp_connection_timers_init (tc);
Florin Corasc8343412017-05-04 14:25:50 -0700684 tcp_init_mss (tc);
Florin Coras6792ec02017-03-13 03:49:51 -0700685 scoreboard_init (&tc->sack_sb);
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400686 if (tc->state == TCP_STATE_SYN_RCVD)
687 tcp_init_snd_vars (tc);
688
Florin Coras36ebcff2019-09-12 18:36:44 -0700689 tcp_cc_init (tc);
690
Florin Coras1c8ff632018-05-17 13:28:34 -0700691 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
692 tcp_add_del_adjacency (tc, 1);
693
Florin Corasd67f1122018-05-21 17:47:40 -0700694 /* tcp_connection_fib_attach (tc); */
695
696 if (transport_connection_is_tx_paced (&tc->connection)
Florin Coras9094b5c2019-08-12 14:17:47 -0700697 || tcp_cfg.enable_tx_pacing)
Florin Corasd67f1122018-05-21 17:47:40 -0700698 tcp_enable_pacing (tc);
Florin Coras52814732019-06-12 15:38:19 -0700699
Florin Corasbbcfaac2019-10-10 13:52:04 -0700700 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
Florin Coras52814732019-06-12 15:38:19 -0700701 tcp_bt_init (tc);
Florin Corasedfe0ee2019-07-29 18:13:25 -0700702
Florin Corasbbcfaac2019-10-10 13:52:04 -0700703 if (!tcp_cfg.allow_tso)
704 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
705
Florin Corasedfe0ee2019-07-29 18:13:25 -0700706 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500707}
708
Florin Coras3cbc04b2017-10-02 00:18:51 -0700709static int
710tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
711 u16 * lcl_port, u8 is_ip4)
712{
713 int index, port;
714 if (is_ip4)
715 {
Florin Coras9094b5c2019-08-12 14:17:47 -0700716 index = tm->last_v4_addr_rotor++;
717 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
718 tm->last_v4_addr_rotor = 0;
719 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700720 }
721 else
722 {
Florin Coras9094b5c2019-08-12 14:17:47 -0700723 index = tm->last_v6_addr_rotor++;
724 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
725 tm->last_v6_addr_rotor = 0;
726 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
Dave Barach178cf492018-11-13 16:34:13 -0500727 sizeof (ip6_address_t));
Florin Coras3cbc04b2017-10-02 00:18:51 -0700728 }
729 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
730 if (port < 1)
731 {
732 clib_warning ("Failed to allocate src port");
733 return -1;
734 }
735 *lcl_port = port;
736 return 0;
737}
738
Florin Coras0dbd5172018-06-25 16:19:34 -0700739static int
Florin Coras5665ced2018-10-25 18:03:45 -0700740tcp_session_open (transport_endpoint_cfg_t * rmt)
Dave Barach68b0fb02017-02-28 15:15:56 -0500741{
742 tcp_main_t *tm = vnet_get_tcp_main ();
743 tcp_connection_t *tc;
Dave Barach68b0fb02017-02-28 15:15:56 -0500744 ip46_address_t lcl_addr;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700745 u16 lcl_port;
746 int rv;
Dave Barach68b0fb02017-02-28 15:15:56 -0500747
748 /*
Florin Coras3cbc04b2017-10-02 00:18:51 -0700749 * Allocate local endpoint
Dave Barach68b0fb02017-02-28 15:15:56 -0500750 */
Florin Coras9094b5c2019-08-12 14:17:47 -0700751 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
752 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
Florin Coras3cbc04b2017-10-02 00:18:51 -0700753 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
754 rmt->is_ip4);
Dave Barach68b0fb02017-02-28 15:15:56 -0500755 else
Florin Coras3cbc04b2017-10-02 00:18:51 -0700756 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
757 rmt, &lcl_addr, &lcl_port);
Dave Barach2c25a622017-06-26 11:35:07 -0400758
Florin Coras3cbc04b2017-10-02 00:18:51 -0700759 if (rv)
760 return -1;
Dave Barach68b0fb02017-02-28 15:15:56 -0500761
762 /*
763 * Create connection and send SYN
764 */
Florin Coras68810622017-07-24 17:40:28 -0700765 clib_spinlock_lock_if_init (&tm->half_open_lock);
Florin Coras04e53442017-07-16 17:12:15 -0700766 tc = tcp_half_open_connection_new ();
Florin Coras3cbc04b2017-10-02 00:18:51 -0700767 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
768 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
Florin Coras0e495682017-09-19 22:27:18 -0700769 tc->c_rmt_port = rmt->port;
Dave Barach68b0fb02017-02-28 15:15:56 -0500770 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
Florin Coras04e53442017-07-16 17:12:15 -0700771 tc->c_is_ip4 = rmt->is_ip4;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700772 tc->c_proto = TRANSPORT_PROTO_TCP;
Florin Corascea194d2017-10-02 00:18:51 -0700773 tc->c_fib_index = rmt->fib_index;
Florin Coras12f69362019-08-16 09:44:00 -0700774 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
Dave Barach68b0fb02017-02-28 15:15:56 -0500775 /* The other connection vars will be initialized after SYN ACK */
776 tcp_connection_timers_init (tc);
Florin Corasff19e3b2020-02-10 17:44:13 +0000777 tc->mss = rmt->mss;
Dave Barach68b0fb02017-02-28 15:15:56 -0500778
Florin Corasa436a422019-08-20 07:09:31 -0700779 TCP_EVT (TCP_EVT_OPEN, tc);
Florin Coras6534b7a2017-07-18 05:38:03 -0400780 tc->state = TCP_STATE_SYN_SENT;
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400781 tcp_init_snd_vars (tc);
Florin Coras6534b7a2017-07-18 05:38:03 -0400782 tcp_send_syn (tc);
Florin Coras68810622017-07-24 17:40:28 -0700783 clib_spinlock_unlock_if_init (&tm->half_open_lock);
Florin Corase69f4952017-03-07 10:06:24 -0800784
Dave Barach68b0fb02017-02-28 15:15:56 -0500785 return tc->c_c_index;
786}
787
Florin Coras0dbd5172018-06-25 16:19:34 -0700788static u8 *
Florin Corase69f4952017-03-07 10:06:24 -0800789format_tcp_session (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500790{
791 u32 tci = va_arg (*args, u32);
792 u32 thread_index = va_arg (*args, u32);
Florin Corasbb292f42017-05-19 09:49:19 -0700793 u32 verbose = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500794 tcp_connection_t *tc;
795
796 tc = tcp_connection_get (tci, thread_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700797 if (tc)
Florin Coras93992a92017-05-24 18:03:56 -0700798 s = format (s, "%U", format_tcp_connection, tc, verbose);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700799 else
Florin Coras1f152cd2017-08-18 19:28:03 -0700800 s = format (s, "empty\n");
Florin Coras93992a92017-05-24 18:03:56 -0700801 return s;
Dave Barach68b0fb02017-02-28 15:15:56 -0500802}
803
Florin Coras0dbd5172018-06-25 16:19:34 -0700804static u8 *
Florin Corase69f4952017-03-07 10:06:24 -0800805format_tcp_listener_session (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500806{
807 u32 tci = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +0200808 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Coras3389dd22019-02-01 18:00:05 -0800809 u32 verbose = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500810 tcp_connection_t *tc = tcp_listener_get (tci);
Florin Coras3389dd22019-02-01 18:00:05 -0800811 s = format (s, "%-50U", format_tcp_connection_id, tc);
812 if (verbose)
813 s = format (s, "%-15U", format_tcp_state, tc->state);
814 return s;
Dave Barach68b0fb02017-02-28 15:15:56 -0500815}
816
Florin Coras0dbd5172018-06-25 16:19:34 -0700817static u8 *
Florin Corase69f4952017-03-07 10:06:24 -0800818format_tcp_half_open_session (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500819{
820 u32 tci = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +0200821 u32 __clib_unused thread_index = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500822 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
Florin Corasbb292f42017-05-19 09:49:19 -0700823 return format (s, "%U", format_tcp_connection_id, tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500824}
825
Florin Coras0dbd5172018-06-25 16:19:34 -0700826static transport_connection_t *
Dave Barach68b0fb02017-02-28 15:15:56 -0500827tcp_session_get_transport (u32 conn_index, u32 thread_index)
828{
829 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
Florin Coras5bb23ec2019-08-31 09:45:13 -0700830 if (PREDICT_FALSE (!tc))
831 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500832 return &tc->connection;
833}
834
Florin Coras0dbd5172018-06-25 16:19:34 -0700835static transport_connection_t *
Dave Barach68b0fb02017-02-28 15:15:56 -0500836tcp_half_open_session_get_transport (u32 conn_index)
837{
838 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
839 return &tc->connection;
840}
841
Simon Zhang1146ff42019-09-02 22:54:00 +0800842static u16
843tcp_session_cal_goal_size (tcp_connection_t * tc)
844{
845 u16 goal_size = tc->snd_mss;
846
847 goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
848 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
849
Simon Zhang8a047ed2019-09-24 21:16:56 +0800850 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
Simon Zhang1146ff42019-09-02 22:54:00 +0800851}
852
Florin Coras3af90fc2017-05-03 21:09:42 -0700853always_inline u32
854tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
855{
Dave Barach2c25a622017-06-26 11:35:07 -0400856 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
Florin Coras3af90fc2017-05-03 21:09:42 -0700857 {
Florin Corasdb84e572017-05-09 18:54:52 -0700858 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
Florin Coras3af90fc2017-05-03 21:09:42 -0700859 }
860
Florin Coras1f152cd2017-08-18 19:28:03 -0700861 /* If not snd_wnd constrained and we can't write at least a segment,
862 * don't try at all */
Dave Barach2c25a622017-06-26 11:35:07 -0400863 if (PREDICT_FALSE (snd_space < tc->snd_mss))
Florin Coras9d063042017-09-14 03:08:00 -0400864 return snd_space < tc->cwnd ? 0 : snd_space;
Florin Coras3af90fc2017-05-03 21:09:42 -0700865
866 /* round down to mss multiple */
867 return snd_space - (snd_space % tc->snd_mss);
868}
869
Florin Coras6792ec02017-03-13 03:49:51 -0700870/**
871 * Compute tx window session is allowed to fill.
Florin Corasbb292f42017-05-19 09:49:19 -0700872 *
873 * Takes into account available send space, snd_mss and the congestion
874 * state of the connection. If possible, the value returned is a multiple
875 * of snd_mss.
876 *
877 * @param tc tcp connection
878 * @return number of bytes session is allowed to write
Florin Coras6792ec02017-03-13 03:49:51 -0700879 */
Florin Coras45ca73f2018-09-27 09:19:29 -0700880static inline u32
881tcp_snd_space_inline (tcp_connection_t * tc)
Dave Barach68b0fb02017-02-28 15:15:56 -0500882{
Florin Coras36ebcff2019-09-12 18:36:44 -0700883 int snd_space;
Florin Coras6792ec02017-03-13 03:49:51 -0700884
Florin Coras4af830c2018-12-04 09:21:36 -0800885 if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
886 || tc->state == TCP_STATE_CLOSED))
Florin Coras36ee9f12018-11-02 12:52:10 -0700887 return 0;
888
889 snd_space = tcp_available_output_snd_space (tc);
890
Florin Coras36ebcff2019-09-12 18:36:44 -0700891 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
892 * to force the peer to send enough dupacks to start retransmitting as
893 * per Limited Transmit (RFC3042)
894 */
895 if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
Florin Coras6792ec02017-03-13 03:49:51 -0700896 {
Florin Coras36ebcff2019-09-12 18:36:44 -0700897 if (tc->limited_transmit != tc->snd_nxt
898 && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
899 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
Florin Coras36ee9f12018-11-02 12:52:10 -0700900 tc->limited_transmit = tc->snd_nxt;
Florin Coras36ebcff2019-09-12 18:36:44 -0700901
Florin Coras36ee9f12018-11-02 12:52:10 -0700902 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
Florin Corasf03a59a2017-06-09 21:07:32 -0700903
Florin Coras36ebcff2019-09-12 18:36:44 -0700904 int snt_limited = tc->snd_nxt - tc->limited_transmit;
905 snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
Florin Coras3af90fc2017-05-03 21:09:42 -0700906 }
Florin Coras36ee9f12018-11-02 12:52:10 -0700907 return tcp_round_snd_space (tc, snd_space);
Dave Barach68b0fb02017-02-28 15:15:56 -0500908}
909
Florin Coras45ca73f2018-09-27 09:19:29 -0700910u32
911tcp_snd_space (tcp_connection_t * tc)
912{
913 return tcp_snd_space_inline (tc);
914}
915
Florin Coras70f879d2020-03-13 17:54:42 +0000916static int
917tcp_session_send_params (transport_connection_t * trans_conn,
918 transport_send_params_t * sp)
Florin Corasbb292f42017-05-19 09:49:19 -0700919{
920 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
Florin Corasbb292f42017-05-19 09:49:19 -0700921
Florin Coras70f879d2020-03-13 17:54:42 +0000922 /* Ensure snd_mss does accurately reflect the amount of data we can push
923 * in a segment. This also makes sure that options are updated according to
924 * the current state of the connection. */
925 tcp_update_burst_snd_vars (tc);
926
927 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
928 sp->snd_mss = tcp_session_cal_goal_size (tc);
929 else
930 sp->snd_mss = tc->snd_mss;
931
932 sp->snd_space = clib_min (tcp_snd_space_inline (tc),
933 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
Florin Coras6792ec02017-03-13 03:49:51 -0700934
935 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
Florin Coras6792ec02017-03-13 03:49:51 -0700936 /* This still works if fast retransmit is on */
Florin Coras70f879d2020-03-13 17:54:42 +0000937 sp->tx_offset = tc->snd_nxt - tc->snd_una;
938
Florin Coras6080e0d2020-03-13 20:39:43 +0000939 sp->flags = sp->snd_space ? 0 : TRANSPORT_SND_F_DESCHED;
Florin Coras70f879d2020-03-13 17:54:42 +0000940
941 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500942}
943
Florin Coras0dbd5172018-06-25 16:19:34 -0700944static void
Florin Corasaa388692020-02-14 23:41:25 +0000945tcp_timer_waitclose_handler (tcp_connection_t * tc)
946{
Florin Coras7a3a8662020-02-22 02:27:21 +0000947 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
948
Florin Corasaa388692020-02-14 23:41:25 +0000949 switch (tc->state)
950 {
951 case TCP_STATE_CLOSE_WAIT:
952 tcp_connection_timers_reset (tc);
Florin Corasaa388692020-02-14 23:41:25 +0000953 /* App never returned with a close */
954 if (!(tc->flags & TCP_CONN_FINPNDG))
955 {
956 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras7a3a8662020-02-22 02:27:21 +0000957 session_transport_closed_notify (&tc->connection);
958 tcp_program_cleanup (wrk, tc);
959 tcp_workerp_stats_inc (wrk, to_closewait, 1);
Florin Corasaa388692020-02-14 23:41:25 +0000960 break;
961 }
962
963 /* Send FIN either way and switch to LAST_ACK. */
964 tcp_cong_recovery_off (tc);
965 /* Make sure we don't try to send unsent data */
966 tc->snd_nxt = tc->snd_una;
967 tcp_send_fin (tc);
968 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
Florin Coras7a3a8662020-02-22 02:27:21 +0000969 session_transport_closed_notify (&tc->connection);
Florin Corasaa388692020-02-14 23:41:25 +0000970
971 /* Make sure we don't wait in LAST ACK forever */
972 tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
Florin Coras7a3a8662020-02-22 02:27:21 +0000973 tcp_workerp_stats_inc (wrk, to_closewait2, 1);
Florin Corasaa388692020-02-14 23:41:25 +0000974
975 /* Don't delete the connection yet */
976 break;
977 case TCP_STATE_FIN_WAIT_1:
978 tcp_connection_timers_reset (tc);
Florin Corasaa388692020-02-14 23:41:25 +0000979 if (tc->flags & TCP_CONN_FINPNDG)
980 {
981 /* If FIN pending, we haven't sent everything, but we did try.
982 * Notify session layer that transport is closed. */
983 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
984 tcp_send_reset (tc);
Florin Coras7a3a8662020-02-22 02:27:21 +0000985 tcp_program_cleanup (wrk, tc);
Florin Corasaa388692020-02-14 23:41:25 +0000986 }
987 else
988 {
989 /* We've sent the fin but no progress. Close the connection and
990 * to make sure everything is flushed, setup a cleanup timer */
991 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras7a3a8662020-02-22 02:27:21 +0000992 tcp_program_cleanup (wrk, tc);
Florin Corasaa388692020-02-14 23:41:25 +0000993 }
Florin Coras7a3a8662020-02-22 02:27:21 +0000994 session_transport_closed_notify (&tc->connection);
995 tcp_workerp_stats_inc (wrk, to_finwait1, 1);
Florin Corasaa388692020-02-14 23:41:25 +0000996 break;
997 case TCP_STATE_LAST_ACK:
998 tcp_connection_timers_reset (tc);
999 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Corasaa388692020-02-14 23:41:25 +00001000 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +00001001 tcp_program_cleanup (wrk, tc);
1002 tcp_workerp_stats_inc (wrk, to_lastack, 1);
Florin Corasaa388692020-02-14 23:41:25 +00001003 break;
1004 case TCP_STATE_CLOSING:
1005 tcp_connection_timers_reset (tc);
1006 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Corasaa388692020-02-14 23:41:25 +00001007 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +00001008 tcp_program_cleanup (wrk, tc);
1009 tcp_workerp_stats_inc (wrk, to_closing, 1);
Florin Corasaa388692020-02-14 23:41:25 +00001010 break;
1011 case TCP_STATE_FIN_WAIT_2:
1012 tcp_send_reset (tc);
1013 tcp_connection_timers_reset (tc);
1014 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1015 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +00001016 tcp_program_cleanup (wrk, tc);
1017 tcp_workerp_stats_inc (wrk, to_finwait2, 1);
1018 break;
1019 case TCP_STATE_TIME_WAIT:
1020 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1021 tcp_program_cleanup (wrk, tc);
Florin Corasaa388692020-02-14 23:41:25 +00001022 break;
1023 default:
Florin Coras7a3a8662020-02-22 02:27:21 +00001024 clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
Florin Corasaa388692020-02-14 23:41:25 +00001025 break;
1026 }
1027}
1028
1029/* *INDENT-OFF* */
1030static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1031{
1032 tcp_timer_retransmit_handler,
1033 tcp_timer_delack_handler,
1034 tcp_timer_persist_handler,
1035 tcp_timer_waitclose_handler,
1036 tcp_timer_retransmit_syn_handler,
1037};
1038/* *INDENT-ON* */
1039
1040static void
1041tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1042{
1043 u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1044 tcp_connection_t *tc;
1045 int i;
1046
1047 if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1048 return;
1049
1050 thread_index = wrk->vm->thread_index;
Florin Corasa9d8cb42020-02-20 05:45:31 +00001051 for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
Florin Corasaa388692020-02-14 23:41:25 +00001052 {
1053 clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1054 connection_index = timer_handle & 0x0FFFFFFF;
1055 timer_id = timer_handle >> 28;
1056
1057 if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1058 tc = tcp_connection_get (connection_index, thread_index);
1059 else
1060 tc = tcp_half_open_connection_get (connection_index);
1061
1062 if (PREDICT_FALSE (!tc))
1063 continue;
1064
1065 /* Skip timer if it was rearmed while pending dispatch */
1066 if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1067 continue;
1068
1069 (*timer_expiration_handlers[timer_id]) (tc);
1070 }
Florin Corasa9d8cb42020-02-20 05:45:31 +00001071
1072 if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
Florin Coras5484daa2020-03-27 23:55:06 +00001073 session_queue_run_on_main_thread (wrk->vm);
Florin Corasaa388692020-02-14 23:41:25 +00001074}
1075
1076static void
Florin Coras7a3a8662020-02-22 02:27:21 +00001077tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1078{
1079 u32 thread_index = wrk->vm->thread_index;
1080 tcp_cleanup_req_t *req;
1081 tcp_connection_t *tc;
1082
1083 while (clib_fifo_elts (wrk->pending_cleanups))
1084 {
1085 req = clib_fifo_head (wrk->pending_cleanups);
1086 if (req->free_time > now)
1087 break;
1088 clib_fifo_sub2 (wrk->pending_cleanups, req);
1089 tc = tcp_connection_get (req->connection_index, thread_index);
Florin Coras9f4db3c2020-03-10 19:34:28 +00001090 if (PREDICT_FALSE (!tc))
1091 continue;
Florin Coras7a3a8662020-02-22 02:27:21 +00001092 session_transport_delete_notify (&tc->connection);
1093 tcp_connection_cleanup (tc);
1094 }
1095}
1096
1097static void
Florin Coras561af9b2017-12-09 10:19:43 -08001098tcp_update_time (f64 now, u8 thread_index)
1099{
Florin Corasbe72ae62018-11-01 11:23:03 -07001100 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1101
1102 tcp_set_time_now (wrk);
Florin Coras7a3a8662020-02-22 02:27:21 +00001103 tcp_handle_cleanups (wrk, now);
Florin Corasbe72ae62018-11-01 11:23:03 -07001104 tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
Florin Corasaa388692020-02-14 23:41:25 +00001105 tcp_dispatch_pending_timers (wrk);
Florin Coras561af9b2017-12-09 10:19:43 -08001106}
1107
Florin Coras42ceddb2018-12-12 10:56:01 -08001108static void
1109tcp_session_flush_data (transport_connection_t * tconn)
1110{
1111 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1112 if (tc->flags & TCP_CONN_PSH_PENDING)
1113 return;
1114 tc->flags |= TCP_CONN_PSH_PENDING;
Florin Coras47596832019-03-12 18:58:54 -07001115 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
Florin Coras42ceddb2018-12-12 10:56:01 -08001116}
1117
Dave Barach68b0fb02017-02-28 15:15:56 -05001118/* *INDENT-OFF* */
Florin Coras04e53442017-07-16 17:12:15 -07001119const static transport_proto_vft_t tcp_proto = {
Florin Coras561af9b2017-12-09 10:19:43 -08001120 .enable = vnet_tcp_enable_disable,
Florin Coras1ee78302019-02-05 15:51:15 -08001121 .start_listen = tcp_session_bind,
1122 .stop_listen = tcp_session_unbind,
Florin Coras8b20bf52018-06-14 14:55:50 -07001123 .push_header = tcp_session_push_header,
Dave Barach68b0fb02017-02-28 15:15:56 -05001124 .get_connection = tcp_session_get_transport,
1125 .get_listener = tcp_session_get_listener,
1126 .get_half_open = tcp_half_open_session_get_transport,
Florin Coras1ee78302019-02-05 15:51:15 -08001127 .connect = tcp_session_open,
Dave Barach68b0fb02017-02-28 15:15:56 -05001128 .close = tcp_session_close,
1129 .cleanup = tcp_session_cleanup,
Florin Corasdfb3b872019-08-16 17:48:44 -07001130 .reset = tcp_session_reset,
Florin Coras70f879d2020-03-13 17:54:42 +00001131 .send_params = tcp_session_send_params,
Florin Coras561af9b2017-12-09 10:19:43 -08001132 .update_time = tcp_update_time,
Florin Coras42ceddb2018-12-12 10:56:01 -08001133 .flush_data = tcp_session_flush_data,
Florin Coras26dd6de2019-07-23 23:54:47 -07001134 .custom_tx = tcp_session_custom_tx,
Florin Corase69f4952017-03-07 10:06:24 -08001135 .format_connection = format_tcp_session,
1136 .format_listener = format_tcp_listener_session,
1137 .format_half_open = format_tcp_half_open_session,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001138 .transport_options = {
Florin Coras07063b82020-03-13 04:44:51 +00001139 .name = "tcp",
1140 .short_name = "T",
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001141 .tx_type = TRANSPORT_TX_PEEK,
1142 .service_type = TRANSPORT_SERVICE_VC,
1143 },
Dave Barach68b0fb02017-02-28 15:15:56 -05001144};
1145/* *INDENT-ON* */
1146
Florin Corasd67f1122018-05-21 17:47:40 -07001147void
Florin Corasc44a5582018-11-01 16:30:54 -07001148tcp_connection_tx_pacer_update (tcp_connection_t * tc)
Florin Corasd67f1122018-05-21 17:47:40 -07001149{
Florin Corasd67f1122018-05-21 17:47:40 -07001150 if (!transport_connection_is_tx_paced (&tc->connection))
1151 return;
1152
Florin Coras11e9e352019-11-13 19:09:47 -08001153 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1154
Florin Corasd2067242019-08-16 10:33:49 -07001155 transport_connection_tx_pacer_update (&tc->connection,
Florin Coras11e9e352019-11-13 19:09:47 -08001156 tcp_cc_get_pacing_rate (tc),
1157 srtt * CLIB_US_TIME_FREQ);
Florin Corasd67f1122018-05-21 17:47:40 -07001158}
1159
Florin Corasc44a5582018-11-01 16:30:54 -07001160void
1161tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1162 u32 start_bucket)
1163{
Florin Coras36ebcff2019-09-12 18:36:44 -07001164 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
Florin Coras599db9e2019-11-25 09:41:37 -08001165 transport_connection_tx_pacer_reset (&tc->connection,
1166 tcp_cc_get_pacing_rate (tc),
1167 start_bucket,
Florin Coras11e9e352019-11-13 19:09:47 -08001168 srtt * CLIB_US_TIME_FREQ);
Florin Corasc44a5582018-11-01 16:30:54 -07001169}
1170
Florin Coras6080e0d2020-03-13 20:39:43 +00001171void
1172tcp_reschedule (tcp_connection_t * tc)
1173{
1174 if (tcp_in_cong_recovery (tc) || tcp_snd_space_inline (tc))
1175 transport_connection_reschedule (&tc->connection);
1176}
1177
Florin Coras0dbd5172018-06-25 16:19:34 -07001178static void
Dave Barach68b0fb02017-02-28 15:15:56 -05001179tcp_expired_timers_dispatch (u32 * expired_timers)
1180{
Florin Corasa9d8cb42020-02-20 05:45:31 +00001181 u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1182 u32 connection_index, timer_id, n_expired, max_loops;
Florin Corasaa388692020-02-14 23:41:25 +00001183 tcp_worker_ctx_t *wrk;
Florin Corasb72a0ff2019-11-22 17:38:25 -08001184 tcp_connection_t *tc;
1185 int i;
Dave Barach68b0fb02017-02-28 15:15:56 -05001186
Florin Corasaa388692020-02-14 23:41:25 +00001187 wrk = tcp_get_worker (thread_index);
Florin Coras5e6305f2020-02-12 07:42:01 +00001188 n_expired = vec_len (expired_timers);
Florin Corasaa388692020-02-14 23:41:25 +00001189 tcp_workerp_stats_inc (wrk, timer_expirations, n_expired);
Florin Corasa9d8cb42020-02-20 05:45:31 +00001190 n_left = clib_fifo_elts (wrk->pending_timers);
Florin Coras5e6305f2020-02-12 07:42:01 +00001191
Florin Corasb72a0ff2019-11-22 17:38:25 -08001192 /*
1193 * Invalidate all timer handles before dispatching. This avoids dangling
1194 * index references to timer wheel pool entries that have been freed.
1195 */
Florin Coras5e6305f2020-02-12 07:42:01 +00001196 for (i = 0; i < n_expired; i++)
Dave Barach68b0fb02017-02-28 15:15:56 -05001197 {
Dave Barach68b0fb02017-02-28 15:15:56 -05001198 connection_index = expired_timers[i] & 0x0FFFFFFF;
1199 timer_id = expired_timers[i] >> 28;
1200
Florin Corasb72a0ff2019-11-22 17:38:25 -08001201 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1202 tc = tcp_connection_get (connection_index, thread_index);
1203 else
1204 tc = tcp_half_open_connection_get (connection_index);
1205
Florin Corasa436a422019-08-20 07:09:31 -07001206 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
Florin Corase69f4952017-03-07 10:06:24 -08001207
Florin Corasb72a0ff2019-11-22 17:38:25 -08001208 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1209 }
1210
Florin Corasaa388692020-02-14 23:41:25 +00001211 clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
Florin Corasa9d8cb42020-02-20 05:45:31 +00001212
1213 max_loops = clib_max (1, 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second);
1214 max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1215 max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1216 wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1217 max_per_loop);
1218
1219 if (thread_index == 0)
Florin Coras5484daa2020-03-27 23:55:06 +00001220 session_queue_run_on_main_thread (wrk->vm);
Dave Barach68b0fb02017-02-28 15:15:56 -05001221}
1222
Florin Coras0dbd5172018-06-25 16:19:34 -07001223static void
Dave Barach68b0fb02017-02-28 15:15:56 -05001224tcp_initialize_timer_wheels (tcp_main_t * tm)
1225{
1226 tw_timer_wheel_16t_2w_512sl_t *tw;
Florin Corasa5464812017-04-19 13:00:05 -07001227 /* *INDENT-OFF* */
1228 foreach_vlib_main (({
Florin Coras2c414432018-06-19 09:58:04 -07001229 tw = &tm->wrk_ctx[ii].timer_wheel;
Dave Barach68b0fb02017-02-28 15:15:56 -05001230 tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
Florin Coras9094b5c2019-08-12 14:17:47 -07001231 TCP_TIMER_TICK, ~0);
Florin Corasa5464812017-04-19 13:00:05 -07001232 tw->last_run_time = vlib_time_now (this_vlib_main);
1233 }));
1234 /* *INDENT-ON* */
Dave Barach68b0fb02017-02-28 15:15:56 -05001235}
1236
Florin Coras18e0d4f2019-01-02 12:22:02 -08001237static void
1238tcp_initialize_iss_seed (tcp_main_t * tm)
1239{
1240 u32 default_seed = random_default_seed ();
1241 u64 time_now = clib_cpu_time_now ();
1242
1243 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1244 tm->iss_seed.second = random_u64 (&time_now);
1245}
1246
Florin Coras0dbd5172018-06-25 16:19:34 -07001247static clib_error_t *
Florin Corasa0b34a72017-03-07 01:20:52 -08001248tcp_main_enable (vlib_main_t * vm)
Dave Barach68b0fb02017-02-28 15:15:56 -05001249{
Dave Barach68b0fb02017-02-28 15:15:56 -05001250 vlib_thread_main_t *vtm = vlib_get_thread_main ();
Florin Corasbe72ae62018-11-01 11:23:03 -07001251 u32 num_threads, n_workers, prealloc_conn_per_wrk;
Dave Barach2c25a622017-06-26 11:35:07 -04001252 tcp_connection_t *tc __attribute__ ((unused));
Florin Corasbe72ae62018-11-01 11:23:03 -07001253 tcp_main_t *tm = vnet_get_tcp_main ();
Florin Coras04261852020-02-12 01:24:29 +00001254 tcp_worker_ctx_t *wrk;
Florin Corasbe72ae62018-11-01 11:23:03 -07001255 clib_error_t *error = 0;
1256 int thread;
Dave Barach68b0fb02017-02-28 15:15:56 -05001257
Dave Barach68b0fb02017-02-28 15:15:56 -05001258 if ((error = vlib_call_init_function (vm, ip_main_init)))
1259 return error;
1260 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1261 return error;
1262 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1263 return error;
1264
1265 /*
1266 * Registrations
1267 */
1268
Dave Barach68b0fb02017-02-28 15:15:56 -05001269 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
rootc9d1c5b2017-08-15 12:58:31 -04001270 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
Dave Barach68b0fb02017-02-28 15:15:56 -05001271
Dave Barach68b0fb02017-02-28 15:15:56 -05001272 /*
1273 * Initialize data structures
1274 */
1275
1276 num_threads = 1 /* main thread */ + vtm->n_threads;
Florin Corase55a6d72018-10-31 23:09:22 -07001277 vec_validate (tm->wrk_ctx, num_threads - 1);
Florin Corasbe72ae62018-11-01 11:23:03 -07001278 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
Florin Coras9094b5c2019-08-12 14:17:47 -07001279 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
Dave Barach68b0fb02017-02-28 15:15:56 -05001280
Florin Coras5484daa2020-03-27 23:55:06 +00001281 wrk = &tm->wrk_ctx[0];
1282 wrk->tco_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1283 tcp4_output_node.index);
1284 wrk->tco_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1285 tcp6_output_node.index);
1286
Florin Corasbe72ae62018-11-01 11:23:03 -07001287 for (thread = 0; thread < num_threads; thread++)
Dave Barach2c25a622017-06-26 11:35:07 -04001288 {
Florin Coras04261852020-02-12 01:24:29 +00001289 wrk = &tm->wrk_ctx[thread];
1290
1291 vec_validate (wrk->pending_deq_acked, 255);
1292 vec_validate (wrk->pending_disconnects, 255);
1293 vec_validate (wrk->pending_resets, 255);
1294 vec_reset_length (wrk->pending_deq_acked);
1295 vec_reset_length (wrk->pending_disconnects);
1296 vec_reset_length (wrk->pending_resets);
1297 wrk->vm = vlib_mains[thread];
Florin Corasa9d8cb42020-02-20 05:45:31 +00001298 wrk->max_timers_per_loop = 10;
Florin Corasbe72ae62018-11-01 11:23:03 -07001299
Florin Coras5484daa2020-03-27 23:55:06 +00001300 if (thread > 0)
1301 {
1302 wrk->tco_next_node[0] = tm->wrk_ctx[0].tco_next_node[0];
1303 wrk->tco_next_node[1] = tm->wrk_ctx[0].tco_next_node[1];
1304 }
1305
Florin Corasbe72ae62018-11-01 11:23:03 -07001306 /*
1307 * Preallocate connections. Assume that thread 0 won't
1308 * use preallocated threads when running multi-core
1309 */
1310 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
Florin Coras04261852020-02-12 01:24:29 +00001311 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
Dave Barach2c25a622017-06-26 11:35:07 -04001312 }
1313
1314 /*
Dave Barachb7f1faa2017-08-29 11:43:37 -04001315 * Use a preallocated half-open connection pool?
Dave Barach2c25a622017-06-26 11:35:07 -04001316 */
Florin Coras9094b5c2019-08-12 14:17:47 -07001317 if (tcp_cfg.preallocated_half_open_connections)
Dave Barachb7f1faa2017-08-29 11:43:37 -04001318 pool_init_fixed (tm->half_open_connections,
Florin Coras9094b5c2019-08-12 14:17:47 -07001319 tcp_cfg.preallocated_half_open_connections);
Dave Barach2c25a622017-06-26 11:35:07 -04001320
Dave Barach68b0fb02017-02-28 15:15:56 -05001321 /* Initialize clocks per tick for TCP timestamp. Used to compute
1322 * monotonically increasing timestamps. */
1323 tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1324 / TCP_TSTAMP_RESOLUTION;
1325
Florin Coras04e53442017-07-16 17:12:15 -07001326 if (num_threads > 1)
Florin Coras68810622017-07-24 17:40:28 -07001327 {
1328 clib_spinlock_init (&tm->half_open_lock);
Florin Coras68810622017-07-24 17:40:28 -07001329 }
Florin Coras66b11312017-07-31 17:18:03 -07001330
Florin Coras2c414432018-06-19 09:58:04 -07001331 tcp_initialize_timer_wheels (tm);
Florin Coras18e0d4f2019-01-02 12:22:02 -08001332 tcp_initialize_iss_seed (tm);
Florin Coras66b11312017-07-31 17:18:03 -07001333
Damjan Marion8934a042019-02-09 23:29:26 +01001334 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
Florin Coras4e116fb2019-06-10 08:33:50 -07001335 tm->cc_last_type = TCP_CC_LAST;
Florin Coras5484daa2020-03-27 23:55:06 +00001336
1337 tm->ipl_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1338 ip4_lookup_node.index);
1339 tm->ipl_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1340 ip6_lookup_node.index);
Dave Barach68b0fb02017-02-28 15:15:56 -05001341 return error;
1342}
1343
Florin Corasa0b34a72017-03-07 01:20:52 -08001344clib_error_t *
1345vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1346{
1347 if (is_en)
1348 {
1349 if (tcp_main.is_enabled)
1350 return 0;
1351
1352 return tcp_main_enable (vm);
1353 }
1354 else
1355 {
1356 tcp_main.is_enabled = 0;
1357 }
1358
1359 return 0;
1360}
1361
Pierre Pfister7fe51f32017-09-20 08:48:36 +02001362void
1363tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1364{
1365 tcp_main_t *tm = &tcp_main;
1366 if (is_ip4)
1367 tm->punt_unknown4 = is_add;
1368 else
1369 tm->punt_unknown6 = is_add;
1370}
1371
Florin Coras9094b5c2019-08-12 14:17:47 -07001372/**
1373 * Initialize default values for tcp parameters
1374 */
1375static void
1376tcp_configuration_init (void)
1377{
1378 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1379 * predefined value. For SYN-ACK we still want the scale to be computed in
1380 * the same way */
1381 tcp_cfg.max_rx_fifo = 32 << 20;
1382 tcp_cfg.min_rx_fifo = 4 << 10;
1383
Florin Corascedcf602019-08-27 12:15:43 -07001384 tcp_cfg.default_mtu = 1500;
Florin Coras9094b5c2019-08-12 14:17:47 -07001385 tcp_cfg.initial_cwnd_multiplier = 0;
1386 tcp_cfg.enable_tx_pacing = 1;
Florin Corasbbcfaac2019-10-10 13:52:04 -07001387 tcp_cfg.allow_tso = 0;
Florin Corasf4ce6ba2019-11-20 18:34:58 -08001388 tcp_cfg.csum_offload = 1;
Florin Coras9094b5c2019-08-12 14:17:47 -07001389 tcp_cfg.cc_algo = TCP_CC_NEWRENO;
Florin Coras017dc452019-08-30 11:06:35 -07001390 tcp_cfg.rwnd_min_update_ack = 1;
Florin Coras9094b5c2019-08-12 14:17:47 -07001391
1392 /* Time constants defined as timer tick (100ms) multiples */
1393 tcp_cfg.delack_time = 1; /* 0.1s */
1394 tcp_cfg.closewait_time = 20; /* 2s */
1395 tcp_cfg.timewait_time = 100; /* 10s */
1396 tcp_cfg.finwait1_time = 600; /* 60s */
1397 tcp_cfg.lastack_time = 300; /* 30s */
1398 tcp_cfg.finwait2_time = 300; /* 30s */
1399 tcp_cfg.closing_time = 300; /* 30s */
Florin Coras7a3a8662020-02-22 02:27:21 +00001400 tcp_cfg.cleanup_time = 0.1; /* 100ms */
Florin Coras9094b5c2019-08-12 14:17:47 -07001401}
1402
Florin Coras0dbd5172018-06-25 16:19:34 -07001403static clib_error_t *
Florin Corasa0b34a72017-03-07 01:20:52 -08001404tcp_init (vlib_main_t * vm)
1405{
1406 tcp_main_t *tm = vnet_get_tcp_main ();
Florin Coras40364272017-11-16 09:57:50 -08001407 ip_main_t *im = &ip_main;
1408 ip_protocol_info_t *pi;
1409
1410 /* Session layer, and by implication tcp, are disabled by default */
Florin Corasa0b34a72017-03-07 01:20:52 -08001411 tm->is_enabled = 0;
Florin Coras40364272017-11-16 09:57:50 -08001412
1413 /* Register with IP for header parsing */
1414 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1415 if (pi == 0)
1416 return clib_error_return (0, "TCP protocol info AWOL");
1417 pi->format_header = format_tcp_header;
1418 pi->unformat_pg_edit = unformat_pg_tcp_header;
1419
Florin Coras561af9b2017-12-09 10:19:43 -08001420 /* Register as transport with session layer */
1421 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1422 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1423 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1424 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1425
Florin Coras9094b5c2019-08-12 14:17:47 -07001426 tcp_configuration_init ();
1427
Florin Corasfbf278a2019-03-26 14:05:38 -07001428 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
Florin Coras9094b5c2019-08-12 14:17:47 -07001429
Florin Corasa0b34a72017-03-07 01:20:52 -08001430 return 0;
1431}
1432
Dave Barach68b0fb02017-02-28 15:15:56 -05001433VLIB_INIT_FUNCTION (tcp_init);
1434
Dave Barach68b0fb02017-02-28 15:15:56 -05001435/*
1436 * fd.io coding-style-patch-verification: ON
1437 *
1438 * Local Variables:
1439 * eval: (c-set-style "gnu")
1440 * End:
1441 */