blob: e447fac00b50e8052579145f442f422bad325f9f [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 Corasd50ff7f2020-04-16 04:30:22 +0000189tcp_half_open_connection_free (tcp_connection_t * tc)
Florin Coras68810622017-07-24 17:40:28 -0700190{
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{
Florin Coras0765d972020-03-18 21:26:41 +0000211 tcp_worker_ctx_t *wrk;
212
Florin Coras68810622017-07-24 17:40:28 -0700213 /* Make sure this is the owning thread */
214 if (tc->c_thread_index != vlib_get_thread_index ())
215 return 1;
Florin Coras0765d972020-03-18 21:26:41 +0000216
Florin Corasd50ff7f2020-04-16 04:30:22 +0000217 session_half_open_delete_notify (TRANSPORT_PROTO_TCP, tc->c_s_ho_handle);
Florin Coras0765d972020-03-18 21:26:41 +0000218 wrk = tcp_get_worker (tc->c_thread_index);
219 tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
Florin Corasd50ff7f2020-04-16 04:30:22 +0000220 tcp_half_open_connection_free (tc);
Florin Coras68810622017-07-24 17:40:28 -0700221 return 0;
222}
223
Florin Coras0dbd5172018-06-25 16:19:34 -0700224static tcp_connection_t *
Florin Coras68810622017-07-24 17:40:28 -0700225tcp_half_open_connection_new (void)
226{
227 tcp_main_t *tm = vnet_get_tcp_main ();
228 tcp_connection_t *tc = 0;
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400229 ASSERT (vlib_get_thread_index () == 0);
Florin Coras68810622017-07-24 17:40:28 -0700230 pool_get (tm->half_open_connections, tc);
Dave Barachb7b92992018-10-17 10:38:51 -0400231 clib_memset (tc, 0, sizeof (*tc));
Florin Coras68810622017-07-24 17:40:28 -0700232 tc->c_c_index = tc - tm->half_open_connections;
233 return tc;
234}
235
Dave Barach68b0fb02017-02-28 15:15:56 -0500236/**
237 * Cleans up connection state.
238 *
239 * No notifications.
240 */
241void
242tcp_connection_cleanup (tcp_connection_t * tc)
243{
Florin Corasa436a422019-08-20 07:09:31 -0700244 TCP_EVT (TCP_EVT_DELETE, tc);
Florin Coras070fd4b2019-04-02 19:03:23 -0700245
Dave Barach68b0fb02017-02-28 15:15:56 -0500246 /* Cleanup local endpoint if this was an active connect */
Florin Coras43818c12020-02-09 23:09:26 +0000247 if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
248 transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
249 tc->c_lcl_port);
Dave Barach68b0fb02017-02-28 15:15:56 -0500250
Florin Coras68810622017-07-24 17:40:28 -0700251 /* Check if connection is not yet fully established */
Dave Barach68b0fb02017-02-28 15:15:56 -0500252 if (tc->state == TCP_STATE_SYN_SENT)
Dave Barach2c25a622017-06-26 11:35:07 -0400253 {
Florin Coras68810622017-07-24 17:40:28 -0700254 /* Try to remove the half-open connection. If this is not the owning
255 * thread, tc won't be removed. Retransmit or establish timers will
256 * eventually expire and call again cleanup on the right thread. */
Florin Corasc5347d92018-10-17 10:41:28 -0700257 if (tcp_half_open_connection_cleanup (tc))
258 tc->flags |= TCP_CONN_HALF_OPEN_DONE;
Dave Barach2c25a622017-06-26 11:35:07 -0400259 }
Dave Barach68b0fb02017-02-28 15:15:56 -0500260 else
Dave Barach2c25a622017-06-26 11:35:07 -0400261 {
Florin Coras68810622017-07-24 17:40:28 -0700262 /* Make sure all timers are cleared */
263 tcp_connection_timers_reset (tc);
264
Florin Coras1c8ff632018-05-17 13:28:34 -0700265 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
266 tcp_add_del_adjacency (tc, 0);
267
Florin Corasd9a145f2019-06-07 09:35:20 -0700268 tcp_cc_cleanup (tc);
Florin Corasb691f762019-02-22 09:07:20 -0800269 vec_free (tc->snd_sacks);
270 vec_free (tc->snd_sacks_fl);
Florin Coras558e3e02019-09-06 12:56:58 -0700271 vec_free (tc->rcv_opts.sacks);
272 pool_free (tc->sack_sb.holes);
Florin Corasb691f762019-02-22 09:07:20 -0800273
Florin Corasbbcfaac2019-10-10 13:52:04 -0700274 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
Florin Coras52814732019-06-12 15:38:19 -0700275 tcp_bt_cleanup (tc);
276
Florin Coras04261852020-02-12 01:24:29 +0000277 tcp_connection_free (tc);
Dave Barach2c25a622017-06-26 11:35:07 -0400278 }
Dave Barach68b0fb02017-02-28 15:15:56 -0500279}
280
281/**
282 * Connection removal.
283 *
284 * This should be called only once connection enters CLOSED state. Note
285 * that it notifies the session of the removal event, so if the goal is to
286 * just remove the connection, call tcp_connection_cleanup instead.
287 */
288void
289tcp_connection_del (tcp_connection_t * tc)
290{
Florin Coras5a2ec8f2018-12-27 11:53:11 -0800291 session_transport_delete_notify (&tc->connection);
Dave Barach68b0fb02017-02-28 15:15:56 -0500292 tcp_connection_cleanup (tc);
293}
294
Florin Coras6534b7a2017-07-18 05:38:03 -0400295tcp_connection_t *
Florin Coras8124cb72018-12-16 20:57:29 -0800296tcp_connection_alloc (u8 thread_index)
Florin Coras6534b7a2017-07-18 05:38:03 -0400297{
Florin Coras04261852020-02-12 01:24:29 +0000298 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
Florin Coras6534b7a2017-07-18 05:38:03 -0400299 tcp_connection_t *tc;
300
Florin Coras04261852020-02-12 01:24:29 +0000301 pool_get (wrk->connections, tc);
Dave Barachb7b92992018-10-17 10:38:51 -0400302 clib_memset (tc, 0, sizeof (*tc));
Florin Coras04261852020-02-12 01:24:29 +0000303 tc->c_c_index = tc - wrk->connections;
Florin Coras6534b7a2017-07-18 05:38:03 -0400304 tc->c_thread_index = thread_index;
305 return tc;
306}
307
Florin Coras12f69362019-08-16 09:44:00 -0700308tcp_connection_t *
309tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
310{
Florin Coras04261852020-02-12 01:24:29 +0000311 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
Florin Coras12f69362019-08-16 09:44:00 -0700312 tcp_connection_t *tc;
313
Florin Coras04261852020-02-12 01:24:29 +0000314 pool_get (wrk->connections, tc);
Florin Coras12f69362019-08-16 09:44:00 -0700315 clib_memcpy_fast (tc, base, sizeof (*tc));
Florin Coras04261852020-02-12 01:24:29 +0000316 tc->c_c_index = tc - wrk->connections;
Florin Coras12f69362019-08-16 09:44:00 -0700317 tc->c_thread_index = thread_index;
318 return tc;
319}
320
Florin Coras8124cb72018-12-16 20:57:29 -0800321void
322tcp_connection_free (tcp_connection_t * tc)
323{
Florin Coras04261852020-02-12 01:24:29 +0000324 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
Florin Coras6416e622019-04-03 17:52:43 -0700325 if (CLIB_DEBUG)
326 {
Florin Coras6416e622019-04-03 17:52:43 -0700327 clib_memset (tc, 0xFA, sizeof (*tc));
Florin Coras04261852020-02-12 01:24:29 +0000328 pool_put (wrk->connections, tc);
Florin Coras6416e622019-04-03 17:52:43 -0700329 return;
330 }
Florin Coras04261852020-02-12 01:24:29 +0000331 pool_put (wrk->connections, tc);
Florin Coras8124cb72018-12-16 20:57:29 -0800332}
333
Florin Coras7a3a8662020-02-22 02:27:21 +0000334void
335tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
336{
337 tcp_cleanup_req_t *req;
338 clib_time_type_t now;
339
Florin Coras8f10b902021-04-02 18:32:00 -0700340 now = tcp_time_now_us (tc->c_thread_index);
Florin Coras7a3a8662020-02-22 02:27:21 +0000341 clib_fifo_add2 (wrk->pending_cleanups, req);
342 req->connection_index = tc->c_c_index;
343 req->free_time = now + tcp_cfg.cleanup_time;
344}
345
Dave Barach68b0fb02017-02-28 15:15:56 -0500346/**
347 * Begin connection closing procedure.
348 *
349 * If at the end the connection is not in CLOSED state, it is not removed.
350 * Instead, we rely on on TCP to advance through state machine to either
351 * 1) LAST_ACK (passive close) whereby when the last ACK is received
352 * tcp_connection_del is called. This notifies session of the delete and
353 * calls cleanup.
354 * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
355 * and cleanup is called.
Florin Corasd79b41e2017-03-04 05:37:52 -0800356 *
357 * N.B. Half-close connections are not supported
Dave Barach68b0fb02017-02-28 15:15:56 -0500358 */
359void
360tcp_connection_close (tcp_connection_t * tc)
361{
Florin Coras0765d972020-03-18 21:26:41 +0000362 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
363
Florin Corasa436a422019-08-20 07:09:31 -0700364 TCP_EVT (TCP_EVT_CLOSE, tc);
Florin Corase69f4952017-03-07 10:06:24 -0800365
Florin Corasb2215d62017-08-01 16:56:58 -0700366 /* Send/Program FIN if needed and switch state */
367 switch (tc->state)
368 {
369 case TCP_STATE_SYN_SENT:
Florin Coras85a3ddd2018-12-24 16:54:34 -0800370 /* Try to cleanup. If not on the right thread, mark as half-open done.
371 * Connection will be cleaned up when establish timer pops */
372 tcp_connection_cleanup (tc);
Florin Corasb2215d62017-08-01 16:56:58 -0700373 break;
374 case TCP_STATE_SYN_RCVD:
Florin Corasc5347d92018-10-17 10:41:28 -0700375 tcp_connection_timers_reset (tc);
Florin Corasb2215d62017-08-01 16:56:58 -0700376 tcp_send_fin (tc);
Florin Coras3c514d52018-12-22 11:39:33 -0800377 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
Florin Coras0765d972020-03-18 21:26:41 +0000378 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
379 tcp_cfg.finwait1_time);
Florin Corasb2215d62017-08-01 16:56:58 -0700380 break;
381 case TCP_STATE_ESTABLISHED:
Florin Corasf65074e2019-03-31 17:17:11 -0700382 /* If closing with unread data, reset the connection */
383 if (transport_max_rx_dequeue (&tc->connection))
384 {
385 tcp_send_reset (tc);
386 tcp_connection_timers_reset (tc);
387 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Corasa0904f02019-07-22 20:55:11 -0700388 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +0000389 tcp_program_cleanup (tcp_get_worker (tc->c_thread_index), tc);
Florin Coras0765d972020-03-18 21:26:41 +0000390 tcp_worker_stats_inc (wrk, rst_unread, 1);
Florin Corasf65074e2019-03-31 17:17:11 -0700391 break;
392 }
Florin Coras31c99552019-03-01 13:00:58 -0800393 if (!transport_max_tx_dequeue (&tc->connection))
Florin Corasb2215d62017-08-01 16:56:58 -0700394 tcp_send_fin (tc);
395 else
396 tc->flags |= TCP_CONN_FINPNDG;
Florin Coras3c514d52018-12-22 11:39:33 -0800397 tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
Florin Corase96bf632018-12-18 22:44:27 -0800398 /* Set a timer in case the peer stops responding. Otherwise the
399 * connection will be stuck here forever. */
Florin Coras85a3ddd2018-12-24 16:54:34 -0800400 ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
Florin Coras0765d972020-03-18 21:26:41 +0000401 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
402 tcp_cfg.finwait1_time);
Florin Corasb2215d62017-08-01 16:56:58 -0700403 break;
404 case TCP_STATE_CLOSE_WAIT:
Florin Coras31c99552019-03-01 13:00:58 -0800405 if (!transport_max_tx_dequeue (&tc->connection))
Florin Coras25579b42018-06-06 17:55:02 -0700406 {
407 tcp_send_fin (tc);
408 tcp_connection_timers_reset (tc);
Florin Coras3c514d52018-12-22 11:39:33 -0800409 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
Florin Coras0765d972020-03-18 21:26:41 +0000410 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
411 tcp_cfg.lastack_time);
Florin Coras25579b42018-06-06 17:55:02 -0700412 }
413 else
414 tc->flags |= TCP_CONN_FINPNDG;
Florin Corasb2215d62017-08-01 16:56:58 -0700415 break;
Florin Corasc87c91d2017-08-16 19:55:49 -0700416 case TCP_STATE_FIN_WAIT_1:
Florin Coras0765d972020-03-18 21:26:41 +0000417 tcp_timer_update (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
418 tcp_cfg.finwait1_time);
Florin Corasc87c91d2017-08-16 19:55:49 -0700419 break;
Florin Coras4af830c2018-12-04 09:21:36 -0800420 case TCP_STATE_CLOSED:
Florin Coras7a3a8662020-02-22 02:27:21 +0000421 /* Cleanup should've been programmed already */
Florin Coras4af830c2018-12-04 09:21:36 -0800422 break;
Florin Corasb2215d62017-08-01 16:56:58 -0700423 default:
Florin Corasa096f2d2017-09-28 23:49:42 -0400424 TCP_DBG ("state: %u", tc->state);
Florin Corasb2215d62017-08-01 16:56:58 -0700425 }
Dave Barach68b0fb02017-02-28 15:15:56 -0500426}
427
Florin Coras0dbd5172018-06-25 16:19:34 -0700428static void
Dave Barach68b0fb02017-02-28 15:15:56 -0500429tcp_session_close (u32 conn_index, u32 thread_index)
430{
431 tcp_connection_t *tc;
432 tc = tcp_connection_get (conn_index, thread_index);
433 tcp_connection_close (tc);
434}
435
Florin Coras0dbd5172018-06-25 16:19:34 -0700436static void
Dave Barach68b0fb02017-02-28 15:15:56 -0500437tcp_session_cleanup (u32 conn_index, u32 thread_index)
438{
439 tcp_connection_t *tc;
440 tc = tcp_connection_get (conn_index, thread_index);
Florin Coras54c93cf2019-09-24 12:45:14 -0700441 if (!tc)
442 return;
Florin Coras85a3ddd2018-12-24 16:54:34 -0800443 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras25579b42018-06-06 17:55:02 -0700444 tcp_connection_cleanup (tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500445}
446
Florin Corasdfb3b872019-08-16 17:48:44 -0700447static void
Florin Corasd50ff7f2020-04-16 04:30:22 +0000448tcp_session_cleanup_ho (u32 conn_index)
449{
450 tcp_worker_ctx_t *wrk;
451 tcp_connection_t *tc;
452
453 tc = tcp_half_open_connection_get (conn_index);
454 wrk = tcp_get_worker (tc->c_thread_index);
455 tcp_timer_reset (&wrk->timer_wheel, tc, TCP_TIMER_RETRANSMIT_SYN);
456 tcp_half_open_connection_free (tc);
457}
458
459static void
Florin Corasdfb3b872019-08-16 17:48:44 -0700460tcp_session_reset (u32 conn_index, u32 thread_index)
461{
462 tcp_connection_t *tc;
463 tc = tcp_connection_get (conn_index, thread_index);
Florin Corasdfb3b872019-08-16 17:48:44 -0700464 tcp_send_reset (tc);
465 tcp_connection_timers_reset (tc);
Florin Corasfd4c3fe2019-11-07 12:33:12 -0800466 tcp_cong_recovery_off (tc);
Florin Corasdfb3b872019-08-16 17:48:44 -0700467 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras7a3a8662020-02-22 02:27:21 +0000468 session_transport_closed_notify (&tc->connection);
469 tcp_program_cleanup (tcp_get_worker (thread_index), tc);
Florin Corasdfb3b872019-08-16 17:48:44 -0700470}
471
Dave Barach68b0fb02017-02-28 15:15:56 -0500472/**
473 * Initialize all connection timers as invalid
474 */
475void
476tcp_connection_timers_init (tcp_connection_t * tc)
477{
478 int i;
479
480 /* Set all to invalid */
481 for (i = 0; i < TCP_N_TIMERS; i++)
482 {
483 tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
484 }
485
486 tc->rto = TCP_RTO_INIT;
487}
488
489/**
490 * Stop all connection timers
491 */
492void
493tcp_connection_timers_reset (tcp_connection_t * tc)
494{
Florin Coras0765d972020-03-18 21:26:41 +0000495 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500496 int i;
Florin Coras0765d972020-03-18 21:26:41 +0000497
Dave Barach68b0fb02017-02-28 15:15:56 -0500498 for (i = 0; i < TCP_N_TIMERS; i++)
Florin Coras0765d972020-03-18 21:26:41 +0000499 tcp_timer_reset (&wrk->timer_wheel, tc, i);
Dave Barach68b0fb02017-02-28 15:15:56 -0500500}
501
Dave Barach2c25a622017-06-26 11:35:07 -0400502#if 0
Florin Corasf6359c82017-06-19 12:26:09 -0400503typedef struct ip4_tcp_hdr
504{
505 ip4_header_t ip;
506 tcp_header_t tcp;
507} ip4_tcp_hdr_t;
508
509typedef struct ip6_tcp_hdr
510{
511 ip6_header_t ip;
512 tcp_header_t tcp;
513} ip6_tcp_hdr_t;
514
515static void
516tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
517 dpo_id_t * result)
518{
519 const dpo_id_t *choice;
520 load_balance_t *lb;
521 int hash;
522
523 lb = load_balance_get (dpo->dpoi_index);
524 if (tc->c_is_ip4)
525 {
526 ip4_tcp_hdr_t hdr;
Dave Barachb7b92992018-10-17 10:38:51 -0400527 clib_memset (&hdr, 0, sizeof (hdr));
Florin Corasf6359c82017-06-19 12:26:09 -0400528 hdr.ip.protocol = IP_PROTOCOL_TCP;
529 hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
530 hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
531 hdr.tcp.src_port = tc->c_lcl_port;
532 hdr.tcp.dst_port = tc->c_rmt_port;
533 hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
534 }
535 else
536 {
537 ip6_tcp_hdr_t hdr;
Dave Barachb7b92992018-10-17 10:38:51 -0400538 clib_memset (&hdr, 0, sizeof (hdr));
Florin Corasf6359c82017-06-19 12:26:09 -0400539 hdr.ip.protocol = IP_PROTOCOL_TCP;
Dave Barach178cf492018-11-13 16:34:13 -0500540 clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
541 sizeof (ip6_address_t));
542 clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
543 sizeof (ip6_address_t));
Florin Corasf6359c82017-06-19 12:26:09 -0400544 hdr.tcp.src_port = tc->c_lcl_port;
545 hdr.tcp.dst_port = tc->c_rmt_port;
546 hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
547 }
548 choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
549 dpo_copy (result, choice);
550}
551
552fib_node_index_t
553tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
554{
555 fib_prefix_t prefix;
Florin Coras04e53442017-07-16 17:12:15 -0700556 u32 fib_index;
Florin Corasf6359c82017-06-19 12:26:09 -0400557
Dave Barach178cf492018-11-13 16:34:13 -0500558 clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
Florin Corasf6359c82017-06-19 12:26:09 -0400559 prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
560 prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
Florin Corascea194d2017-10-02 00:18:51 -0700561 fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
Florin Coras04e53442017-07-16 17:12:15 -0700562 return fib_table_lookup (fib_index, &prefix);
Florin Corasf6359c82017-06-19 12:26:09 -0400563}
564
565static int
566tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
567{
568 dpo_id_t choice = DPO_INVALID;
569 u32 output_node_index;
570 fib_entry_t *fe;
571
572 fe = fib_entry_get (tc->c_rmt_fei);
573 if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
574 return -1;
575
576 tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
577
578 output_node_index =
579 tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
580 dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
581 return 0;
582}
583
584/** Stack tcp connection on peer's fib entry.
585 *
586 * This ultimately populates the dpo the connection will use to send packets.
587 */
588static void
589tcp_connection_fib_attach (tcp_connection_t * tc)
590{
591 tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
592
593 ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
594
595 tcp_connection_stack_on_fib_entry (tc);
596}
Dave Barach2c25a622017-06-26 11:35:07 -0400597#endif /* 0 */
Florin Corasf6359c82017-06-19 12:26:09 -0400598
Florin Coras18e0d4f2019-01-02 12:22:02 -0800599/**
600 * Generate random iss as per rfc6528
601 */
602static u32
603tcp_generate_random_iss (tcp_connection_t * tc)
604{
605 tcp_main_t *tm = &tcp_main;
606 u64 tmp;
607
608 if (tc->c_is_ip4)
609 tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
610 else
611 tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
612 ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
613
614 tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
615 tmp ^= tm->iss_seed.second;
616 tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
617 return ((tmp >> 32) ^ (tmp & 0xffffffff));
618}
Florin Coras0dbd5172018-06-25 16:19:34 -0700619
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400620/**
Florin Corascedcf602019-08-27 12:15:43 -0700621 * Initialize max segment size we're able to process.
622 *
623 * The value is constrained by the output interface's MTU and by the size
624 * of the IP and TCP headers (see RFC6691). It is also what we advertise
625 * to our peer.
626 */
627static void
628tcp_init_rcv_mss (tcp_connection_t * tc)
629{
630 u8 ip_hdr_len;
631
Florin Corasff19e3b2020-02-10 17:44:13 +0000632 /* Already provided at connection init time */
633 if (tc->mss)
634 return;
635
Florin Corascedcf602019-08-27 12:15:43 -0700636 ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
637 tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
638}
639
640static void
641tcp_init_mss (tcp_connection_t * tc)
642{
643 u16 default_min_mss = 536;
644
645 tcp_init_rcv_mss (tc);
646
647 /* TODO consider PMTU discovery */
648 tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
649
650 if (tc->snd_mss < 45)
651 {
652 /* Assume that at least the min default mss works */
653 tc->snd_mss = default_min_mss;
654 tc->rcv_opts.mss = default_min_mss;
655 }
656
657 /* We should have enough space for 40 bytes of options */
658 ASSERT (tc->snd_mss > 45);
659
Florin Coras7a588fc2021-03-05 13:30:18 -0800660 /* If we use timestamp option, account for it and make sure
661 * the options are 4-byte aligned */
Florin Corascedcf602019-08-27 12:15:43 -0700662 if (tcp_opts_tstamp (&tc->rcv_opts))
Florin Coras7a588fc2021-03-05 13:30:18 -0800663 tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP + 2 /* alignment */;
Florin Corascedcf602019-08-27 12:15:43 -0700664}
665
666/**
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400667 * Initialize connection send variables.
668 */
669void
670tcp_init_snd_vars (tcp_connection_t * tc)
671{
Florin Coras3cbc04b2017-10-02 00:18:51 -0700672 /*
673 * We use the time to randomize iss and for setting up the initial
674 * timestamp. Make sure it's updated otherwise syn and ack in the
675 * handshake may make it look as if time has flown in the opposite
676 * direction for us.
677 */
Florin Coras8f10b902021-04-02 18:32:00 -0700678 tcp_update_time_now (tcp_get_worker (vlib_get_thread_index ()));
Florin Coras3cbc04b2017-10-02 00:18:51 -0700679
Florin Corascedcf602019-08-27 12:15:43 -0700680 tcp_init_rcv_mss (tc);
Florin Coras18e0d4f2019-01-02 12:22:02 -0800681 tc->iss = tcp_generate_random_iss (tc);
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400682 tc->snd_una = tc->iss;
683 tc->snd_nxt = tc->iss + 1;
Florin Coraseedc74b2020-07-31 12:32:40 -0700684 tc->srtt = 0.1 * THZ; /* 100 ms */
Florin Corasf4ce6ba2019-11-20 18:34:58 -0800685
686 if (!tcp_cfg.csum_offload)
687 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400688}
689
Florin Corasd67f1122018-05-21 17:47:40 -0700690void
691tcp_enable_pacing (tcp_connection_t * tc)
692{
Florin Coras36ebcff2019-09-12 18:36:44 -0700693 u32 byte_rate;
694 byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
695 transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
Florin Corasd67f1122018-05-21 17:47:40 -0700696 tc->mrtt_us = (u32) ~ 0;
697}
698
Dave Barach68b0fb02017-02-28 15:15:56 -0500699/** Initialize tcp connection variables
700 *
701 * Should be called after having received a msg from the peer, i.e., a SYN or
702 * a SYNACK, such that connection options have already been exchanged. */
703void
704tcp_connection_init_vars (tcp_connection_t * tc)
705{
706 tcp_connection_timers_init (tc);
Florin Corasc8343412017-05-04 14:25:50 -0700707 tcp_init_mss (tc);
Florin Coras6792ec02017-03-13 03:49:51 -0700708 scoreboard_init (&tc->sack_sb);
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400709 if (tc->state == TCP_STATE_SYN_RCVD)
710 tcp_init_snd_vars (tc);
711
Florin Coras36ebcff2019-09-12 18:36:44 -0700712 tcp_cc_init (tc);
713
Florin Coras1c8ff632018-05-17 13:28:34 -0700714 if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
715 tcp_add_del_adjacency (tc, 1);
716
Florin Corasd67f1122018-05-21 17:47:40 -0700717 /* tcp_connection_fib_attach (tc); */
718
719 if (transport_connection_is_tx_paced (&tc->connection)
Florin Coras9094b5c2019-08-12 14:17:47 -0700720 || tcp_cfg.enable_tx_pacing)
Florin Corasd67f1122018-05-21 17:47:40 -0700721 tcp_enable_pacing (tc);
Florin Coras52814732019-06-12 15:38:19 -0700722
Florin Corasbbcfaac2019-10-10 13:52:04 -0700723 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
Florin Coras52814732019-06-12 15:38:19 -0700724 tcp_bt_init (tc);
Florin Corasedfe0ee2019-07-29 18:13:25 -0700725
Florin Corasbbcfaac2019-10-10 13:52:04 -0700726 if (!tcp_cfg.allow_tso)
727 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
728
Florin Corasedfe0ee2019-07-29 18:13:25 -0700729 tc->start_ts = tcp_time_now_us (tc->c_thread_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500730}
731
Florin Coras3cbc04b2017-10-02 00:18:51 -0700732static int
733tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
734 u16 * lcl_port, u8 is_ip4)
735{
736 int index, port;
737 if (is_ip4)
738 {
Florin Coras9094b5c2019-08-12 14:17:47 -0700739 index = tm->last_v4_addr_rotor++;
740 if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
741 tm->last_v4_addr_rotor = 0;
742 lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700743 }
744 else
745 {
Florin Coras9094b5c2019-08-12 14:17:47 -0700746 index = tm->last_v6_addr_rotor++;
747 if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
748 tm->last_v6_addr_rotor = 0;
749 clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
Dave Barach178cf492018-11-13 16:34:13 -0500750 sizeof (ip6_address_t));
Florin Coras3cbc04b2017-10-02 00:18:51 -0700751 }
752 port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
753 if (port < 1)
Florin Coras00e01d32019-10-21 16:07:46 -0700754 return SESSION_E_NOPORT;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700755 *lcl_port = port;
756 return 0;
757}
758
Florin Coras0dbd5172018-06-25 16:19:34 -0700759static int
Florin Coras5665ced2018-10-25 18:03:45 -0700760tcp_session_open (transport_endpoint_cfg_t * rmt)
Dave Barach68b0fb02017-02-28 15:15:56 -0500761{
762 tcp_main_t *tm = vnet_get_tcp_main ();
763 tcp_connection_t *tc;
Dave Barach68b0fb02017-02-28 15:15:56 -0500764 ip46_address_t lcl_addr;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700765 u16 lcl_port;
766 int rv;
Dave Barach68b0fb02017-02-28 15:15:56 -0500767
768 /*
Florin Coras3cbc04b2017-10-02 00:18:51 -0700769 * Allocate local endpoint
Dave Barach68b0fb02017-02-28 15:15:56 -0500770 */
Florin Coras9094b5c2019-08-12 14:17:47 -0700771 if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
772 || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
Florin Coras3cbc04b2017-10-02 00:18:51 -0700773 rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
774 rmt->is_ip4);
Dave Barach68b0fb02017-02-28 15:15:56 -0500775 else
Florin Coras3cbc04b2017-10-02 00:18:51 -0700776 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
777 rmt, &lcl_addr, &lcl_port);
Dave Barach2c25a622017-06-26 11:35:07 -0400778
Florin Coras3cbc04b2017-10-02 00:18:51 -0700779 if (rv)
Florin Coras1e8d9492020-04-10 14:51:46 +0000780 {
781 if (rv != SESSION_E_PORTINUSE)
782 return rv;
783
784 if (session_lookup_connection (rmt->fib_index, &lcl_addr, &rmt->ip,
785 lcl_port, rmt->port, TRANSPORT_PROTO_UDP,
786 rmt->is_ip4))
787 return SESSION_E_PORTINUSE;
788
789 /* 5-tuple is available so increase lcl endpoint refcount and proceed
790 * with connection allocation */
791 transport_share_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
792 lcl_port);
793 }
Dave Barach68b0fb02017-02-28 15:15:56 -0500794
795 /*
796 * Create connection and send SYN
797 */
Florin Coras68810622017-07-24 17:40:28 -0700798 clib_spinlock_lock_if_init (&tm->half_open_lock);
Florin Coras04e53442017-07-16 17:12:15 -0700799 tc = tcp_half_open_connection_new ();
Florin Coras3cbc04b2017-10-02 00:18:51 -0700800 ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
801 ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
Florin Coras0e495682017-09-19 22:27:18 -0700802 tc->c_rmt_port = rmt->port;
Dave Barach68b0fb02017-02-28 15:15:56 -0500803 tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
Florin Coras04e53442017-07-16 17:12:15 -0700804 tc->c_is_ip4 = rmt->is_ip4;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700805 tc->c_proto = TRANSPORT_PROTO_TCP;
Florin Corascea194d2017-10-02 00:18:51 -0700806 tc->c_fib_index = rmt->fib_index;
Florin Coras12f69362019-08-16 09:44:00 -0700807 tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
Dave Barach68b0fb02017-02-28 15:15:56 -0500808 /* The other connection vars will be initialized after SYN ACK */
809 tcp_connection_timers_init (tc);
Florin Corasff19e3b2020-02-10 17:44:13 +0000810 tc->mss = rmt->mss;
Dave Barach68b0fb02017-02-28 15:15:56 -0500811
Florin Corasa436a422019-08-20 07:09:31 -0700812 TCP_EVT (TCP_EVT_OPEN, tc);
Florin Coras6534b7a2017-07-18 05:38:03 -0400813 tc->state = TCP_STATE_SYN_SENT;
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400814 tcp_init_snd_vars (tc);
Florin Coras6534b7a2017-07-18 05:38:03 -0400815 tcp_send_syn (tc);
Florin Coras68810622017-07-24 17:40:28 -0700816 clib_spinlock_unlock_if_init (&tm->half_open_lock);
Florin Corase69f4952017-03-07 10:06:24 -0800817
Dave Barach68b0fb02017-02-28 15:15:56 -0500818 return tc->c_c_index;
819}
820
Florin Coras0dbd5172018-06-25 16:19:34 -0700821static u8 *
Florin Corase69f4952017-03-07 10:06:24 -0800822format_tcp_session (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500823{
824 u32 tci = va_arg (*args, u32);
825 u32 thread_index = va_arg (*args, u32);
Florin Corasbb292f42017-05-19 09:49:19 -0700826 u32 verbose = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500827 tcp_connection_t *tc;
828
829 tc = tcp_connection_get (tci, thread_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700830 if (tc)
Florin Coras93992a92017-05-24 18:03:56 -0700831 s = format (s, "%U", format_tcp_connection, tc, verbose);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700832 else
Florin Coras1f152cd2017-08-18 19:28:03 -0700833 s = format (s, "empty\n");
Florin Coras93992a92017-05-24 18:03:56 -0700834 return s;
Dave Barach68b0fb02017-02-28 15:15:56 -0500835}
836
Florin Coras0dbd5172018-06-25 16:19:34 -0700837static u8 *
Florin Corase69f4952017-03-07 10:06:24 -0800838format_tcp_listener_session (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500839{
840 u32 tci = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +0200841 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Coras3389dd22019-02-01 18:00:05 -0800842 u32 verbose = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500843 tcp_connection_t *tc = tcp_listener_get (tci);
Florin Coras7bf6ed62020-09-23 12:02:08 -0700844 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tcp_connection_id, tc);
Florin Coras3389dd22019-02-01 18:00:05 -0800845 if (verbose)
Florin Coras7bf6ed62020-09-23 12:02:08 -0700846 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tcp_state,
847 tc->state);
Florin Coras3389dd22019-02-01 18:00:05 -0800848 return s;
Dave Barach68b0fb02017-02-28 15:15:56 -0500849}
850
Florin Coras0dbd5172018-06-25 16:19:34 -0700851static u8 *
Florin Corase69f4952017-03-07 10:06:24 -0800852format_tcp_half_open_session (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500853{
854 u32 tci = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +0200855 u32 __clib_unused thread_index = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500856 tcp_connection_t *tc = tcp_half_open_connection_get (tci);
Florin Corasbb292f42017-05-19 09:49:19 -0700857 return format (s, "%U", format_tcp_connection_id, tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500858}
859
Florin Coras0dbd5172018-06-25 16:19:34 -0700860static transport_connection_t *
Dave Barach68b0fb02017-02-28 15:15:56 -0500861tcp_session_get_transport (u32 conn_index, u32 thread_index)
862{
863 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
Florin Coras5bb23ec2019-08-31 09:45:13 -0700864 if (PREDICT_FALSE (!tc))
865 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500866 return &tc->connection;
867}
868
Florin Coras0dbd5172018-06-25 16:19:34 -0700869static transport_connection_t *
Dave Barach68b0fb02017-02-28 15:15:56 -0500870tcp_half_open_session_get_transport (u32 conn_index)
871{
872 tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
873 return &tc->connection;
874}
875
Florin Coras04ae8272021-04-12 19:55:37 -0700876static int
877tcp_set_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
878{
879 int rv = 0;
880
881 switch (attr->type)
882 {
883 case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
884 tc->next_node_index = attr->next_output_node & 0xffffffff;
885 tc->next_node_opaque = attr->next_output_node >> 32;
886 break;
887 case TRANSPORT_ENDPT_ATTR_MSS:
888 tc->mss = attr->mss;
889 tc->snd_mss = clib_min (tc->snd_mss, tc->mss);
890 break;
891 case TRANSPORT_ENDPT_ATTR_FLAGS:
892 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD)
893 tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
894 else
895 tc->cfg_flags &= ~TCP_CFG_F_NO_CSUM_OFFLOAD;
896 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_GSO)
897 {
898 if (!(tc->cfg_flags & TCP_CFG_F_TSO))
899 tcp_check_gso (tc);
900 tc->cfg_flags &= ~TCP_CFG_F_NO_TSO;
901 }
902 else
903 {
904 tc->cfg_flags |= TCP_CFG_F_NO_TSO;
905 tc->cfg_flags &= ~TCP_CFG_F_TSO;
906 }
Florin Coras7fdf8b22021-04-15 08:50:00 -0700907 if (attr->flags & TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING)
908 {
909 if (!(tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE))
910 tcp_bt_init (tc);
911 tc->cfg_flags |= TCP_CFG_F_RATE_SAMPLE;
912 }
913 else
914 {
915 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
916 tcp_bt_cleanup (tc);
917 tc->cfg_flags &= ~TCP_CFG_F_RATE_SAMPLE;
918 }
Florin Coras04ae8272021-04-12 19:55:37 -0700919 break;
920 case TRANSPORT_ENDPT_ATTR_CC_ALGO:
921 if (tc->cc_algo == tcp_cc_algo_get (attr->cc_algo))
922 break;
923 tcp_cc_cleanup (tc);
924 tc->cc_algo = tcp_cc_algo_get (attr->cc_algo);
925 tcp_cc_init (tc);
926 break;
927 default:
928 rv = -1;
929 break;
930 }
931
932 return rv;
933}
934
935static int
936tcp_get_attribute (tcp_connection_t *tc, transport_endpt_attr_t *attr)
937{
938 int rv = 0;
939 u64 non;
940
941 switch (attr->type)
942 {
943 case TRANSPORT_ENDPT_ATTR_NEXT_OUTPUT_NODE:
944 non = (u64) tc->next_node_opaque << 32 | tc->next_node_index;
945 attr->next_output_node = non;
946 break;
947 case TRANSPORT_ENDPT_ATTR_MSS:
948 attr->mss = tc->snd_mss;
949 break;
950 case TRANSPORT_ENDPT_ATTR_FLAGS:
951 attr->flags = 0;
952 if (!(tc->cfg_flags & TCP_CFG_F_NO_CSUM_OFFLOAD))
953 attr->flags |= TRANSPORT_ENDPT_ATTR_F_CSUM_OFFLOAD;
954 if (tc->cfg_flags & TCP_CFG_F_TSO)
955 attr->flags |= TRANSPORT_ENDPT_ATTR_F_GSO;
Florin Coras7fdf8b22021-04-15 08:50:00 -0700956 if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
957 attr->flags |= TRANSPORT_ENDPT_ATTR_F_RATE_SAMPLING;
Florin Coras04ae8272021-04-12 19:55:37 -0700958 break;
959 case TRANSPORT_ENDPT_ATTR_CC_ALGO:
960 attr->cc_algo = tc->cc_algo - tcp_main.cc_algos;
961 break;
962 default:
963 rv = -1;
964 break;
965 }
966
967 return rv;
968}
969
970static int
971tcp_session_attribute (u32 conn_index, u32 thread_index, u8 is_get,
972 transport_endpt_attr_t *attr)
973{
974 tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
975
976 if (PREDICT_FALSE (!tc))
977 return -1;
978
979 if (is_get)
980 return tcp_get_attribute (tc, attr);
981 else
982 return tcp_set_attribute (tc, attr);
983}
984
Simon Zhang1146ff42019-09-02 22:54:00 +0800985static u16
986tcp_session_cal_goal_size (tcp_connection_t * tc)
987{
988 u16 goal_size = tc->snd_mss;
989
Simon Zhang23c3d342020-09-15 23:40:28 +0800990 goal_size = tcp_cfg.max_gso_size - tc->snd_mss % tcp_cfg.max_gso_size;
Simon Zhang1146ff42019-09-02 22:54:00 +0800991 goal_size = clib_min (goal_size, tc->snd_wnd / 2);
992
Simon Zhang8a047ed2019-09-24 21:16:56 +0800993 return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
Simon Zhang1146ff42019-09-02 22:54:00 +0800994}
995
Florin Coras3af90fc2017-05-03 21:09:42 -0700996always_inline u32
997tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
998{
Dave Barach2c25a622017-06-26 11:35:07 -0400999 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
Florin Coras3af90fc2017-05-03 21:09:42 -07001000 {
Florin Corasdb84e572017-05-09 18:54:52 -07001001 return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
Florin Coras3af90fc2017-05-03 21:09:42 -07001002 }
1003
Florin Coras1f152cd2017-08-18 19:28:03 -07001004 /* If not snd_wnd constrained and we can't write at least a segment,
1005 * don't try at all */
Dave Barach2c25a622017-06-26 11:35:07 -04001006 if (PREDICT_FALSE (snd_space < tc->snd_mss))
Florin Coras9d063042017-09-14 03:08:00 -04001007 return snd_space < tc->cwnd ? 0 : snd_space;
Florin Coras3af90fc2017-05-03 21:09:42 -07001008
1009 /* round down to mss multiple */
1010 return snd_space - (snd_space % tc->snd_mss);
1011}
1012
Florin Coras6792ec02017-03-13 03:49:51 -07001013/**
1014 * Compute tx window session is allowed to fill.
Florin Corasbb292f42017-05-19 09:49:19 -07001015 *
1016 * Takes into account available send space, snd_mss and the congestion
1017 * state of the connection. If possible, the value returned is a multiple
1018 * of snd_mss.
1019 *
1020 * @param tc tcp connection
1021 * @return number of bytes session is allowed to write
Florin Coras6792ec02017-03-13 03:49:51 -07001022 */
Florin Coras45ca73f2018-09-27 09:19:29 -07001023static inline u32
1024tcp_snd_space_inline (tcp_connection_t * tc)
Dave Barach68b0fb02017-02-28 15:15:56 -05001025{
Florin Coras36ebcff2019-09-12 18:36:44 -07001026 int snd_space;
Florin Coras6792ec02017-03-13 03:49:51 -07001027
Florin Coras7d8100f2020-10-21 23:24:53 -07001028 /* Fast path is disabled when recovery is on. @ref tcp_session_custom_tx
1029 * controls both retransmits and the sending of new data while congested
1030 */
1031 if (PREDICT_FALSE (tcp_in_cong_recovery (tc)
Florin Coras4af830c2018-12-04 09:21:36 -08001032 || tc->state == TCP_STATE_CLOSED))
Florin Coras36ee9f12018-11-02 12:52:10 -07001033 return 0;
1034
1035 snd_space = tcp_available_output_snd_space (tc);
1036
Florin Coras36ebcff2019-09-12 18:36:44 -07001037 /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1038 * to force the peer to send enough dupacks to start retransmitting as
1039 * per Limited Transmit (RFC3042)
1040 */
Florin Corascc4d6d02020-07-29 23:03:39 -07001041 if (PREDICT_FALSE (tc->rcv_dupacks || tc->sack_sb.sacked_bytes))
Florin Coras6792ec02017-03-13 03:49:51 -07001042 {
Florin Corascc4d6d02020-07-29 23:03:39 -07001043 int snt_limited, n_pkts;
1044
1045 n_pkts = tcp_opts_sack_permitted (&tc->rcv_opts)
1046 ? tc->sack_sb.reorder - 1 : 2;
1047
1048 if ((seq_lt (tc->limited_transmit, tc->snd_nxt - n_pkts * tc->snd_mss)
1049 || seq_gt (tc->limited_transmit, tc->snd_nxt)))
Florin Coras36ee9f12018-11-02 12:52:10 -07001050 tc->limited_transmit = tc->snd_nxt;
Florin Coras36ebcff2019-09-12 18:36:44 -07001051
Florin Coras36ee9f12018-11-02 12:52:10 -07001052 ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
Florin Corasf03a59a2017-06-09 21:07:32 -07001053
Florin Corascc4d6d02020-07-29 23:03:39 -07001054 snt_limited = tc->snd_nxt - tc->limited_transmit;
1055 snd_space = clib_max (n_pkts * tc->snd_mss - snt_limited, 0);
Florin Coras3af90fc2017-05-03 21:09:42 -07001056 }
Florin Coras36ee9f12018-11-02 12:52:10 -07001057 return tcp_round_snd_space (tc, snd_space);
Dave Barach68b0fb02017-02-28 15:15:56 -05001058}
1059
Florin Coras45ca73f2018-09-27 09:19:29 -07001060u32
1061tcp_snd_space (tcp_connection_t * tc)
1062{
1063 return tcp_snd_space_inline (tc);
1064}
1065
Florin Coras70f879d2020-03-13 17:54:42 +00001066static int
1067tcp_session_send_params (transport_connection_t * trans_conn,
1068 transport_send_params_t * sp)
Florin Corasbb292f42017-05-19 09:49:19 -07001069{
1070 tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
Florin Corasbb292f42017-05-19 09:49:19 -07001071
Florin Coras70f879d2020-03-13 17:54:42 +00001072 /* Ensure snd_mss does accurately reflect the amount of data we can push
1073 * in a segment. This also makes sure that options are updated according to
1074 * the current state of the connection. */
1075 tcp_update_burst_snd_vars (tc);
1076
1077 if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1078 sp->snd_mss = tcp_session_cal_goal_size (tc);
1079 else
1080 sp->snd_mss = tc->snd_mss;
1081
1082 sp->snd_space = clib_min (tcp_snd_space_inline (tc),
1083 tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
Florin Coras6792ec02017-03-13 03:49:51 -07001084
1085 ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
Florin Coras6792ec02017-03-13 03:49:51 -07001086 /* This still works if fast retransmit is on */
Florin Coras70f879d2020-03-13 17:54:42 +00001087 sp->tx_offset = tc->snd_nxt - tc->snd_una;
1088
Florin Coras6080e0d2020-03-13 20:39:43 +00001089 sp->flags = sp->snd_space ? 0 : TRANSPORT_SND_F_DESCHED;
Florin Coras70f879d2020-03-13 17:54:42 +00001090
1091 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -05001092}
1093
Florin Coras0dbd5172018-06-25 16:19:34 -07001094static void
Florin Corasaa388692020-02-14 23:41:25 +00001095tcp_timer_waitclose_handler (tcp_connection_t * tc)
1096{
Florin Coras7a3a8662020-02-22 02:27:21 +00001097 tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1098
Florin Corasaa388692020-02-14 23:41:25 +00001099 switch (tc->state)
1100 {
1101 case TCP_STATE_CLOSE_WAIT:
1102 tcp_connection_timers_reset (tc);
Florin Corasaa388692020-02-14 23:41:25 +00001103 /* App never returned with a close */
1104 if (!(tc->flags & TCP_CONN_FINPNDG))
1105 {
1106 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras7a3a8662020-02-22 02:27:21 +00001107 session_transport_closed_notify (&tc->connection);
1108 tcp_program_cleanup (wrk, tc);
Florin Coras0765d972020-03-18 21:26:41 +00001109 tcp_worker_stats_inc (wrk, to_closewait, 1);
Florin Corasaa388692020-02-14 23:41:25 +00001110 break;
1111 }
1112
1113 /* Send FIN either way and switch to LAST_ACK. */
1114 tcp_cong_recovery_off (tc);
1115 /* Make sure we don't try to send unsent data */
1116 tc->snd_nxt = tc->snd_una;
1117 tcp_send_fin (tc);
1118 tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
Florin Coras7a3a8662020-02-22 02:27:21 +00001119 session_transport_closed_notify (&tc->connection);
Florin Corasaa388692020-02-14 23:41:25 +00001120
1121 /* Make sure we don't wait in LAST ACK forever */
Florin Coras0765d972020-03-18 21:26:41 +00001122 tcp_timer_set (&wrk->timer_wheel, tc, TCP_TIMER_WAITCLOSE,
1123 tcp_cfg.lastack_time);
1124 tcp_worker_stats_inc (wrk, to_closewait2, 1);
Florin Corasaa388692020-02-14 23:41:25 +00001125
1126 /* Don't delete the connection yet */
1127 break;
1128 case TCP_STATE_FIN_WAIT_1:
1129 tcp_connection_timers_reset (tc);
Florin Corasaa388692020-02-14 23:41:25 +00001130 if (tc->flags & TCP_CONN_FINPNDG)
1131 {
1132 /* If FIN pending, we haven't sent everything, but we did try.
1133 * Notify session layer that transport is closed. */
1134 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1135 tcp_send_reset (tc);
Florin Coras7a3a8662020-02-22 02:27:21 +00001136 tcp_program_cleanup (wrk, tc);
Florin Corasaa388692020-02-14 23:41:25 +00001137 }
1138 else
1139 {
1140 /* We've sent the fin but no progress. Close the connection and
1141 * to make sure everything is flushed, setup a cleanup timer */
1142 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Coras7a3a8662020-02-22 02:27:21 +00001143 tcp_program_cleanup (wrk, tc);
Florin Corasaa388692020-02-14 23:41:25 +00001144 }
Florin Coras7a3a8662020-02-22 02:27:21 +00001145 session_transport_closed_notify (&tc->connection);
Florin Coras0765d972020-03-18 21:26:41 +00001146 tcp_worker_stats_inc (wrk, to_finwait1, 1);
Florin Corasaa388692020-02-14 23:41:25 +00001147 break;
1148 case TCP_STATE_LAST_ACK:
1149 tcp_connection_timers_reset (tc);
1150 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Corasaa388692020-02-14 23:41:25 +00001151 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +00001152 tcp_program_cleanup (wrk, tc);
Florin Coras0765d972020-03-18 21:26:41 +00001153 tcp_worker_stats_inc (wrk, to_lastack, 1);
Florin Corasaa388692020-02-14 23:41:25 +00001154 break;
1155 case TCP_STATE_CLOSING:
1156 tcp_connection_timers_reset (tc);
1157 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
Florin Corasaa388692020-02-14 23:41:25 +00001158 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +00001159 tcp_program_cleanup (wrk, tc);
Florin Coras0765d972020-03-18 21:26:41 +00001160 tcp_worker_stats_inc (wrk, to_closing, 1);
Florin Corasaa388692020-02-14 23:41:25 +00001161 break;
1162 case TCP_STATE_FIN_WAIT_2:
1163 tcp_send_reset (tc);
1164 tcp_connection_timers_reset (tc);
1165 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1166 session_transport_closed_notify (&tc->connection);
Florin Coras7a3a8662020-02-22 02:27:21 +00001167 tcp_program_cleanup (wrk, tc);
Florin Coras0765d972020-03-18 21:26:41 +00001168 tcp_worker_stats_inc (wrk, to_finwait2, 1);
Florin Coras7a3a8662020-02-22 02:27:21 +00001169 break;
1170 case TCP_STATE_TIME_WAIT:
1171 tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1172 tcp_program_cleanup (wrk, tc);
Florin Corasaa388692020-02-14 23:41:25 +00001173 break;
1174 default:
Florin Coras7a3a8662020-02-22 02:27:21 +00001175 clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
Florin Corasaa388692020-02-14 23:41:25 +00001176 break;
1177 }
1178}
1179
1180/* *INDENT-OFF* */
1181static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1182{
1183 tcp_timer_retransmit_handler,
Florin Corasaa388692020-02-14 23:41:25 +00001184 tcp_timer_persist_handler,
1185 tcp_timer_waitclose_handler,
1186 tcp_timer_retransmit_syn_handler,
1187};
1188/* *INDENT-ON* */
1189
1190static void
1191tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1192{
1193 u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1194 tcp_connection_t *tc;
1195 int i;
1196
1197 if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1198 return;
1199
1200 thread_index = wrk->vm->thread_index;
Florin Corasa9d8cb42020-02-20 05:45:31 +00001201 for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
Florin Corasaa388692020-02-14 23:41:25 +00001202 {
1203 clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1204 connection_index = timer_handle & 0x0FFFFFFF;
1205 timer_id = timer_handle >> 28;
1206
1207 if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1208 tc = tcp_connection_get (connection_index, thread_index);
1209 else
1210 tc = tcp_half_open_connection_get (connection_index);
1211
1212 if (PREDICT_FALSE (!tc))
1213 continue;
1214
Florin Coras1caf7f12020-07-16 10:05:02 -07001215 /* Skip if the timer is not pending. Probably it was reset while
Florin Corasaa043952020-10-08 13:33:20 -07001216 * waiting for dispatch */
Florin Coras1caf7f12020-07-16 10:05:02 -07001217 if (PREDICT_FALSE (!(tc->pending_timers & (1 << timer_id))))
1218 continue;
1219
1220 tc->pending_timers &= ~(1 << timer_id);
1221
Florin Corasaa388692020-02-14 23:41:25 +00001222 /* Skip timer if it was rearmed while pending dispatch */
1223 if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1224 continue;
1225
1226 (*timer_expiration_handlers[timer_id]) (tc);
1227 }
Florin Corasa9d8cb42020-02-20 05:45:31 +00001228
1229 if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
Florin Coras5484daa2020-03-27 23:55:06 +00001230 session_queue_run_on_main_thread (wrk->vm);
Florin Corasaa388692020-02-14 23:41:25 +00001231}
1232
1233static void
Florin Coras7a3a8662020-02-22 02:27:21 +00001234tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1235{
1236 u32 thread_index = wrk->vm->thread_index;
1237 tcp_cleanup_req_t *req;
1238 tcp_connection_t *tc;
1239
1240 while (clib_fifo_elts (wrk->pending_cleanups))
1241 {
1242 req = clib_fifo_head (wrk->pending_cleanups);
1243 if (req->free_time > now)
1244 break;
1245 clib_fifo_sub2 (wrk->pending_cleanups, req);
1246 tc = tcp_connection_get (req->connection_index, thread_index);
Florin Coras9f4db3c2020-03-10 19:34:28 +00001247 if (PREDICT_FALSE (!tc))
1248 continue;
Florin Coras7a3a8662020-02-22 02:27:21 +00001249 session_transport_delete_notify (&tc->connection);
1250 tcp_connection_cleanup (tc);
1251 }
1252}
1253
1254static void
Florin Coras561af9b2017-12-09 10:19:43 -08001255tcp_update_time (f64 now, u8 thread_index)
1256{
Florin Corasbe72ae62018-11-01 11:23:03 -07001257 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1258
Florin Coras8f10b902021-04-02 18:32:00 -07001259 tcp_set_time_now (wrk, now);
Florin Coras7a3a8662020-02-22 02:27:21 +00001260 tcp_handle_cleanups (wrk, now);
Florin Coras49036a52020-10-08 09:28:32 -07001261 tcp_timer_expire_timers (&wrk->timer_wheel, now);
Florin Corasaa388692020-02-14 23:41:25 +00001262 tcp_dispatch_pending_timers (wrk);
Florin Coras561af9b2017-12-09 10:19:43 -08001263}
1264
Florin Coras42ceddb2018-12-12 10:56:01 -08001265static void
1266tcp_session_flush_data (transport_connection_t * tconn)
1267{
1268 tcp_connection_t *tc = (tcp_connection_t *) tconn;
1269 if (tc->flags & TCP_CONN_PSH_PENDING)
1270 return;
1271 tc->flags |= TCP_CONN_PSH_PENDING;
Florin Coras47596832019-03-12 18:58:54 -07001272 tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
Florin Coras42ceddb2018-12-12 10:56:01 -08001273}
1274
Dave Barach68b0fb02017-02-28 15:15:56 -05001275/* *INDENT-OFF* */
Florin Coras04e53442017-07-16 17:12:15 -07001276const static transport_proto_vft_t tcp_proto = {
Florin Coras561af9b2017-12-09 10:19:43 -08001277 .enable = vnet_tcp_enable_disable,
Florin Coras1ee78302019-02-05 15:51:15 -08001278 .start_listen = tcp_session_bind,
1279 .stop_listen = tcp_session_unbind,
Florin Coras8b20bf52018-06-14 14:55:50 -07001280 .push_header = tcp_session_push_header,
Dave Barach68b0fb02017-02-28 15:15:56 -05001281 .get_connection = tcp_session_get_transport,
1282 .get_listener = tcp_session_get_listener,
1283 .get_half_open = tcp_half_open_session_get_transport,
Florin Coras04ae8272021-04-12 19:55:37 -07001284 .attribute = tcp_session_attribute,
Florin Coras1ee78302019-02-05 15:51:15 -08001285 .connect = tcp_session_open,
Dave Barach68b0fb02017-02-28 15:15:56 -05001286 .close = tcp_session_close,
1287 .cleanup = tcp_session_cleanup,
Florin Corasd50ff7f2020-04-16 04:30:22 +00001288 .cleanup_ho = tcp_session_cleanup_ho,
Florin Corasdfb3b872019-08-16 17:48:44 -07001289 .reset = tcp_session_reset,
Florin Coras70f879d2020-03-13 17:54:42 +00001290 .send_params = tcp_session_send_params,
Florin Coras561af9b2017-12-09 10:19:43 -08001291 .update_time = tcp_update_time,
Florin Coras42ceddb2018-12-12 10:56:01 -08001292 .flush_data = tcp_session_flush_data,
Florin Coras26dd6de2019-07-23 23:54:47 -07001293 .custom_tx = tcp_session_custom_tx,
Florin Corase69f4952017-03-07 10:06:24 -08001294 .format_connection = format_tcp_session,
1295 .format_listener = format_tcp_listener_session,
1296 .format_half_open = format_tcp_half_open_session,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001297 .transport_options = {
Florin Coras07063b82020-03-13 04:44:51 +00001298 .name = "tcp",
1299 .short_name = "T",
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001300 .tx_type = TRANSPORT_TX_PEEK,
1301 .service_type = TRANSPORT_SERVICE_VC,
1302 },
Dave Barach68b0fb02017-02-28 15:15:56 -05001303};
1304/* *INDENT-ON* */
1305
Florin Corasd67f1122018-05-21 17:47:40 -07001306void
Florin Corasc44a5582018-11-01 16:30:54 -07001307tcp_connection_tx_pacer_update (tcp_connection_t * tc)
Florin Corasd67f1122018-05-21 17:47:40 -07001308{
Florin Corasd67f1122018-05-21 17:47:40 -07001309 if (!transport_connection_is_tx_paced (&tc->connection))
1310 return;
1311
Florin Coras11e9e352019-11-13 19:09:47 -08001312 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1313
Florin Corasd2067242019-08-16 10:33:49 -07001314 transport_connection_tx_pacer_update (&tc->connection,
Florin Coras11e9e352019-11-13 19:09:47 -08001315 tcp_cc_get_pacing_rate (tc),
1316 srtt * CLIB_US_TIME_FREQ);
Florin Corasd67f1122018-05-21 17:47:40 -07001317}
1318
Florin Corasc44a5582018-11-01 16:30:54 -07001319void
1320tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1321 u32 start_bucket)
1322{
Florin Coras36ebcff2019-09-12 18:36:44 -07001323 f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
Florin Coras599db9e2019-11-25 09:41:37 -08001324 transport_connection_tx_pacer_reset (&tc->connection,
1325 tcp_cc_get_pacing_rate (tc),
1326 start_bucket,
Florin Coras11e9e352019-11-13 19:09:47 -08001327 srtt * CLIB_US_TIME_FREQ);
Florin Corasc44a5582018-11-01 16:30:54 -07001328}
1329
Florin Coras6080e0d2020-03-13 20:39:43 +00001330void
1331tcp_reschedule (tcp_connection_t * tc)
1332{
1333 if (tcp_in_cong_recovery (tc) || tcp_snd_space_inline (tc))
1334 transport_connection_reschedule (&tc->connection);
1335}
1336
Florin Coras0dbd5172018-06-25 16:19:34 -07001337static void
Dave Barach68b0fb02017-02-28 15:15:56 -05001338tcp_expired_timers_dispatch (u32 * expired_timers)
1339{
Florin Corasa9d8cb42020-02-20 05:45:31 +00001340 u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1341 u32 connection_index, timer_id, n_expired, max_loops;
Florin Corasaa388692020-02-14 23:41:25 +00001342 tcp_worker_ctx_t *wrk;
Florin Corasb72a0ff2019-11-22 17:38:25 -08001343 tcp_connection_t *tc;
1344 int i;
Dave Barach68b0fb02017-02-28 15:15:56 -05001345
Florin Corasaa388692020-02-14 23:41:25 +00001346 wrk = tcp_get_worker (thread_index);
Florin Coras5e6305f2020-02-12 07:42:01 +00001347 n_expired = vec_len (expired_timers);
Florin Coras0765d972020-03-18 21:26:41 +00001348 tcp_worker_stats_inc (wrk, timer_expirations, n_expired);
Florin Corasa9d8cb42020-02-20 05:45:31 +00001349 n_left = clib_fifo_elts (wrk->pending_timers);
Florin Coras5e6305f2020-02-12 07:42:01 +00001350
Florin Corasb72a0ff2019-11-22 17:38:25 -08001351 /*
1352 * Invalidate all timer handles before dispatching. This avoids dangling
1353 * index references to timer wheel pool entries that have been freed.
1354 */
Florin Coras5e6305f2020-02-12 07:42:01 +00001355 for (i = 0; i < n_expired; i++)
Dave Barach68b0fb02017-02-28 15:15:56 -05001356 {
Dave Barach68b0fb02017-02-28 15:15:56 -05001357 connection_index = expired_timers[i] & 0x0FFFFFFF;
1358 timer_id = expired_timers[i] >> 28;
1359
Florin Corasb72a0ff2019-11-22 17:38:25 -08001360 if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1361 tc = tcp_connection_get (connection_index, thread_index);
1362 else
1363 tc = tcp_half_open_connection_get (connection_index);
1364
Florin Corasa436a422019-08-20 07:09:31 -07001365 TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
Florin Corase69f4952017-03-07 10:06:24 -08001366
Florin Corasb72a0ff2019-11-22 17:38:25 -08001367 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
Florin Coras1caf7f12020-07-16 10:05:02 -07001368 tc->pending_timers |= (1 << timer_id);
Florin Corasb72a0ff2019-11-22 17:38:25 -08001369 }
1370
Florin Corasaa388692020-02-14 23:41:25 +00001371 clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
Florin Corasa9d8cb42020-02-20 05:45:31 +00001372
1373 max_loops = clib_max (1, 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second);
1374 max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1375 max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1376 wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1377 max_per_loop);
1378
1379 if (thread_index == 0)
Florin Coras5484daa2020-03-27 23:55:06 +00001380 session_queue_run_on_main_thread (wrk->vm);
Dave Barach68b0fb02017-02-28 15:15:56 -05001381}
1382
Florin Coras0dbd5172018-06-25 16:19:34 -07001383static void
Florin Coras18e0d4f2019-01-02 12:22:02 -08001384tcp_initialize_iss_seed (tcp_main_t * tm)
1385{
1386 u32 default_seed = random_default_seed ();
1387 u64 time_now = clib_cpu_time_now ();
1388
1389 tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1390 tm->iss_seed.second = random_u64 (&time_now);
1391}
1392
Florin Coras0dbd5172018-06-25 16:19:34 -07001393static clib_error_t *
Florin Corasa0b34a72017-03-07 01:20:52 -08001394tcp_main_enable (vlib_main_t * vm)
Dave Barach68b0fb02017-02-28 15:15:56 -05001395{
Dave Barach68b0fb02017-02-28 15:15:56 -05001396 vlib_thread_main_t *vtm = vlib_get_thread_main ();
Florin Corasbe72ae62018-11-01 11:23:03 -07001397 u32 num_threads, n_workers, prealloc_conn_per_wrk;
Dave Barach2c25a622017-06-26 11:35:07 -04001398 tcp_connection_t *tc __attribute__ ((unused));
Florin Corasbe72ae62018-11-01 11:23:03 -07001399 tcp_main_t *tm = vnet_get_tcp_main ();
Florin Coras04261852020-02-12 01:24:29 +00001400 tcp_worker_ctx_t *wrk;
Florin Corasbe72ae62018-11-01 11:23:03 -07001401 clib_error_t *error = 0;
1402 int thread;
Dave Barach68b0fb02017-02-28 15:15:56 -05001403
Dave Barach68b0fb02017-02-28 15:15:56 -05001404 if ((error = vlib_call_init_function (vm, ip_main_init)))
1405 return error;
1406 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1407 return error;
1408 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1409 return error;
1410
1411 /*
1412 * Registrations
1413 */
1414
Dave Barach68b0fb02017-02-28 15:15:56 -05001415 ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
rootc9d1c5b2017-08-15 12:58:31 -04001416 ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
Dave Barach68b0fb02017-02-28 15:15:56 -05001417
Dave Barach68b0fb02017-02-28 15:15:56 -05001418 /*
1419 * Initialize data structures
1420 */
1421
1422 num_threads = 1 /* main thread */ + vtm->n_threads;
Florin Corase55a6d72018-10-31 23:09:22 -07001423 vec_validate (tm->wrk_ctx, num_threads - 1);
Florin Corasbe72ae62018-11-01 11:23:03 -07001424 n_workers = num_threads == 1 ? 1 : vtm->n_threads;
Florin Coras9094b5c2019-08-12 14:17:47 -07001425 prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
Dave Barach68b0fb02017-02-28 15:15:56 -05001426
Florin Coras5484daa2020-03-27 23:55:06 +00001427 wrk = &tm->wrk_ctx[0];
1428 wrk->tco_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1429 tcp4_output_node.index);
1430 wrk->tco_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1431 tcp6_output_node.index);
1432
Florin Corasbe72ae62018-11-01 11:23:03 -07001433 for (thread = 0; thread < num_threads; thread++)
Dave Barach2c25a622017-06-26 11:35:07 -04001434 {
Florin Coras04261852020-02-12 01:24:29 +00001435 wrk = &tm->wrk_ctx[thread];
1436
1437 vec_validate (wrk->pending_deq_acked, 255);
1438 vec_validate (wrk->pending_disconnects, 255);
1439 vec_validate (wrk->pending_resets, 255);
1440 vec_reset_length (wrk->pending_deq_acked);
1441 vec_reset_length (wrk->pending_disconnects);
1442 vec_reset_length (wrk->pending_resets);
Damjan Marion6ffb7c62021-03-26 13:06:13 +01001443 wrk->vm = vlib_get_main_by_index (thread);
Florin Corasa9d8cb42020-02-20 05:45:31 +00001444 wrk->max_timers_per_loop = 10;
Florin Corasbe72ae62018-11-01 11:23:03 -07001445
Florin Coras5484daa2020-03-27 23:55:06 +00001446 if (thread > 0)
1447 {
1448 wrk->tco_next_node[0] = tm->wrk_ctx[0].tco_next_node[0];
1449 wrk->tco_next_node[1] = tm->wrk_ctx[0].tco_next_node[1];
1450 }
1451
Florin Corasbe72ae62018-11-01 11:23:03 -07001452 /*
1453 * Preallocate connections. Assume that thread 0 won't
1454 * use preallocated threads when running multi-core
1455 */
1456 if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
Florin Coras04261852020-02-12 01:24:29 +00001457 pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
Florin Coras49036a52020-10-08 09:28:32 -07001458
1459 tcp_timer_initialize_wheel (&wrk->timer_wheel,
1460 tcp_expired_timers_dispatch,
1461 vlib_time_now (vm));
Dave Barach2c25a622017-06-26 11:35:07 -04001462 }
1463
1464 /*
Dave Barachb7f1faa2017-08-29 11:43:37 -04001465 * Use a preallocated half-open connection pool?
Dave Barach2c25a622017-06-26 11:35:07 -04001466 */
Florin Coras9094b5c2019-08-12 14:17:47 -07001467 if (tcp_cfg.preallocated_half_open_connections)
Dave Barachb7f1faa2017-08-29 11:43:37 -04001468 pool_init_fixed (tm->half_open_connections,
Florin Coras9094b5c2019-08-12 14:17:47 -07001469 tcp_cfg.preallocated_half_open_connections);
Dave Barach2c25a622017-06-26 11:35:07 -04001470
Florin Coras04e53442017-07-16 17:12:15 -07001471 if (num_threads > 1)
Florin Coras68810622017-07-24 17:40:28 -07001472 {
1473 clib_spinlock_init (&tm->half_open_lock);
Florin Coras68810622017-07-24 17:40:28 -07001474 }
Florin Coras66b11312017-07-31 17:18:03 -07001475
Florin Coras18e0d4f2019-01-02 12:22:02 -08001476 tcp_initialize_iss_seed (tm);
Florin Coras66b11312017-07-31 17:18:03 -07001477
Damjan Marion8934a042019-02-09 23:29:26 +01001478 tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
Florin Coras4e116fb2019-06-10 08:33:50 -07001479 tm->cc_last_type = TCP_CC_LAST;
Florin Coras5484daa2020-03-27 23:55:06 +00001480
1481 tm->ipl_next_node[0] = vlib_node_get_next (vm, session_queue_node.index,
1482 ip4_lookup_node.index);
1483 tm->ipl_next_node[1] = vlib_node_get_next (vm, session_queue_node.index,
1484 ip6_lookup_node.index);
Dave Barach68b0fb02017-02-28 15:15:56 -05001485 return error;
1486}
1487
Florin Corasa0b34a72017-03-07 01:20:52 -08001488clib_error_t *
1489vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1490{
1491 if (is_en)
1492 {
1493 if (tcp_main.is_enabled)
1494 return 0;
1495
1496 return tcp_main_enable (vm);
1497 }
1498 else
1499 {
1500 tcp_main.is_enabled = 0;
1501 }
1502
1503 return 0;
1504}
1505
Pierre Pfister7fe51f32017-09-20 08:48:36 +02001506void
1507tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1508{
1509 tcp_main_t *tm = &tcp_main;
1510 if (is_ip4)
1511 tm->punt_unknown4 = is_add;
1512 else
1513 tm->punt_unknown6 = is_add;
1514}
1515
Florin Coras9094b5c2019-08-12 14:17:47 -07001516/**
1517 * Initialize default values for tcp parameters
1518 */
1519static void
1520tcp_configuration_init (void)
1521{
1522 /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1523 * predefined value. For SYN-ACK we still want the scale to be computed in
1524 * the same way */
1525 tcp_cfg.max_rx_fifo = 32 << 20;
1526 tcp_cfg.min_rx_fifo = 4 << 10;
1527
Florin Corascedcf602019-08-27 12:15:43 -07001528 tcp_cfg.default_mtu = 1500;
Florin Coras9094b5c2019-08-12 14:17:47 -07001529 tcp_cfg.initial_cwnd_multiplier = 0;
1530 tcp_cfg.enable_tx_pacing = 1;
Florin Corasbbcfaac2019-10-10 13:52:04 -07001531 tcp_cfg.allow_tso = 0;
Florin Corasf4ce6ba2019-11-20 18:34:58 -08001532 tcp_cfg.csum_offload = 1;
Florin Corase57df7c2020-04-17 16:10:51 +00001533 tcp_cfg.cc_algo = TCP_CC_CUBIC;
Florin Coras017dc452019-08-30 11:06:35 -07001534 tcp_cfg.rwnd_min_update_ack = 1;
Simon Zhang23c3d342020-09-15 23:40:28 +08001535 tcp_cfg.max_gso_size = TCP_MAX_GSO_SZ;
Florin Coras9094b5c2019-08-12 14:17:47 -07001536
Ryujiro Shibuya6fa09882020-10-22 05:26:32 +00001537 /* Time constants defined as timer tick (100us) multiples */
Ryujiro Shibuya6fa09882020-10-22 05:26:32 +00001538 tcp_cfg.closewait_time = 20000; /* 2s */
1539 tcp_cfg.timewait_time = 100000; /* 10s */
1540 tcp_cfg.finwait1_time = 600000; /* 60s */
1541 tcp_cfg.lastack_time = 300000; /* 30s */
1542 tcp_cfg.finwait2_time = 300000; /* 30s */
1543 tcp_cfg.closing_time = 300000; /* 30s */
1544
1545 /* This value is seconds */
Florin Coras7a3a8662020-02-22 02:27:21 +00001546 tcp_cfg.cleanup_time = 0.1; /* 100ms */
Florin Coras9094b5c2019-08-12 14:17:47 -07001547}
1548
Florin Coras0dbd5172018-06-25 16:19:34 -07001549static clib_error_t *
Florin Corasa0b34a72017-03-07 01:20:52 -08001550tcp_init (vlib_main_t * vm)
1551{
1552 tcp_main_t *tm = vnet_get_tcp_main ();
Florin Coras40364272017-11-16 09:57:50 -08001553 ip_main_t *im = &ip_main;
1554 ip_protocol_info_t *pi;
1555
1556 /* Session layer, and by implication tcp, are disabled by default */
Florin Corasa0b34a72017-03-07 01:20:52 -08001557 tm->is_enabled = 0;
Florin Coras40364272017-11-16 09:57:50 -08001558
1559 /* Register with IP for header parsing */
1560 pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1561 if (pi == 0)
1562 return clib_error_return (0, "TCP protocol info AWOL");
1563 pi->format_header = format_tcp_header;
1564 pi->unformat_pg_edit = unformat_pg_tcp_header;
1565
Florin Coras561af9b2017-12-09 10:19:43 -08001566 /* Register as transport with session layer */
1567 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1568 FIB_PROTOCOL_IP4, tcp4_output_node.index);
1569 transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1570 FIB_PROTOCOL_IP6, tcp6_output_node.index);
1571
Florin Coras9094b5c2019-08-12 14:17:47 -07001572 tcp_configuration_init ();
1573
Florin Corasfbf278a2019-03-26 14:05:38 -07001574 tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
Florin Coras9094b5c2019-08-12 14:17:47 -07001575
Florin Corasa0b34a72017-03-07 01:20:52 -08001576 return 0;
1577}
1578
Dave Barach68b0fb02017-02-28 15:15:56 -05001579VLIB_INIT_FUNCTION (tcp_init);
1580
Dave Barach68b0fb02017-02-28 15:15:56 -05001581/*
1582 * fd.io coding-style-patch-verification: ON
1583 *
1584 * Local Variables:
1585 * eval: (c-set-style "gnu")
1586 * End:
1587 */