blob: bd0fa9a72047a817aa1435dc21b3742b48fe41e1 [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
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
16#ifndef _vnet_tcp_h_
17#define _vnet_tcp_h_
18
19#include <vnet/vnet.h>
20#include <vnet/ip/ip.h>
21#include <vnet/tcp/tcp_packet.h>
22#include <vnet/tcp/tcp_timer.h>
23#include <vnet/session/transport.h>
24#include <vnet/session/session.h>
Florin Corase69f4952017-03-07 10:06:24 -080025#include <vnet/tcp/tcp_debug.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050026
Florin Coras3af90fc2017-05-03 21:09:42 -070027#define TCP_TICK 0.001 /**< TCP tick period (s) */
28#define THZ (u32) (1/TCP_TICK) /**< TCP tick frequency */
Dave Barach68b0fb02017-02-28 15:15:56 -050029#define TCP_TSTAMP_RESOLUTION TCP_TICK /**< Time stamp resolution */
30#define TCP_PAWS_IDLE 24 * 24 * 60 * 60 * THZ /**< 24 days */
Florin Corasf6359c82017-06-19 12:26:09 -040031#define TCP_FIB_RECHECK_PERIOD 1 * THZ /**< Recheck every 1s */
Dave Barach68b0fb02017-02-28 15:15:56 -050032#define TCP_MAX_OPTION_SPACE 40
Florin Corasaa01abb2018-11-12 09:13:10 -080033#define TCP_CC_DATA_SZ 24
Dave Barach68b0fb02017-02-28 15:15:56 -050034
Florin Coras6792ec02017-03-13 03:49:51 -070035#define TCP_DUPACK_THRESHOLD 3
Florin Corasca031862018-09-24 13:58:05 -070036#define TCP_MAX_RX_FIFO_SIZE 32 << 20
Florin Coras6534b7a2017-07-18 05:38:03 -040037#define TCP_MIN_RX_FIFO_SIZE 4 << 10
Florin Coras6792ec02017-03-13 03:49:51 -070038#define TCP_IW_N_SEGMENTS 10
Florin Corasf03a59a2017-06-09 21:07:32 -070039#define TCP_ALWAYS_ACK 1 /**< On/off delayed acks */
Florin Coras93992a92017-05-24 18:03:56 -070040#define TCP_USE_SACKS 1 /**< Disable only for testing */
Dave Barach68b0fb02017-02-28 15:15:56 -050041
42/** TCP FSM state definitions as per RFC793. */
43#define foreach_tcp_fsm_state \
44 _(CLOSED, "CLOSED") \
45 _(LISTEN, "LISTEN") \
46 _(SYN_SENT, "SYN_SENT") \
47 _(SYN_RCVD, "SYN_RCVD") \
48 _(ESTABLISHED, "ESTABLISHED") \
49 _(CLOSE_WAIT, "CLOSE_WAIT") \
50 _(FIN_WAIT_1, "FIN_WAIT_1") \
51 _(LAST_ACK, "LAST_ACK") \
52 _(CLOSING, "CLOSING") \
53 _(FIN_WAIT_2, "FIN_WAIT_2") \
54 _(TIME_WAIT, "TIME_WAIT")
55
56typedef enum _tcp_state
57{
58#define _(sym, str) TCP_STATE_##sym,
59 foreach_tcp_fsm_state
60#undef _
61 TCP_N_STATES
62} tcp_state_t;
63
64format_function_t format_tcp_state;
Dave Barach1f75cfd2017-04-14 16:46:44 -040065format_function_t format_tcp_flags;
Florin Coras45d34962017-04-25 00:05:27 -070066format_function_t format_tcp_sacks;
Florin Coras3eb50622017-07-13 01:24:57 -040067format_function_t format_tcp_rcv_sacks;
Dave Barach68b0fb02017-02-28 15:15:56 -050068
69/** TCP timers */
70#define foreach_tcp_timer \
71 _(RETRANSMIT, "RETRANSMIT") \
72 _(DELACK, "DELAYED ACK") \
73 _(PERSIST, "PERSIST") \
74 _(KEEP, "KEEP") \
Florin Corasd79b41e2017-03-04 05:37:52 -080075 _(WAITCLOSE, "WAIT CLOSE") \
76 _(RETRANSMIT_SYN, "RETRANSMIT SYN") \
Dave Barach68b0fb02017-02-28 15:15:56 -050077 _(ESTABLISH, "ESTABLISH")
78
79typedef enum _tcp_timers
80{
81#define _(sym, str) TCP_TIMER_##sym,
82 foreach_tcp_timer
83#undef _
84 TCP_N_TIMERS
85} tcp_timers_e;
86
87typedef void (timer_expiration_handler) (u32 index);
88
89extern timer_expiration_handler tcp_timer_delack_handler;
90extern timer_expiration_handler tcp_timer_retransmit_handler;
Florin Coras3e350af2017-03-30 02:54:28 -070091extern timer_expiration_handler tcp_timer_persist_handler;
Dave Barach68b0fb02017-02-28 15:15:56 -050092extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
93
94#define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
95
96/* Timer delays as multiples of 100ms */
97#define TCP_TO_TIMER_TICK TCP_TICK*10 /* Period for converting from TCP
98 * ticks to timer units */
99#define TCP_DELACK_TIME 1 /* 0.1s */
100#define TCP_ESTABLISH_TIME 750 /* 75s */
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400101#define TCP_SYN_RCVD_TIME 600 /* 60s */
Dave Barach68b0fb02017-02-28 15:15:56 -0500102#define TCP_2MSL_TIME 300 /* 30s */
Florin Coras9d063042017-09-14 03:08:00 -0400103#define TCP_CLOSEWAIT_TIME 20 /* 2s */
Florin Corasa096f2d2017-09-28 23:49:42 -0400104#define TCP_TIMEWAIT_TIME 100 /* 10s */
Florin Corase96bf632018-12-18 22:44:27 -0800105#define TCP_FINWAIT1_TIME 600 /* 60s */
106#define TCP_CLEANUP_TIME 1 /* 0.1s */
Florin Coras5921f982017-04-03 18:00:00 -0700107#define TCP_TIMER_PERSIST_MIN 2 /* 0.2s */
Dave Barach68b0fb02017-02-28 15:15:56 -0500108
109#define TCP_RTO_MAX 60 * THZ /* Min max RTO (60s) as per RFC6298 */
Florin Corasf03a59a2017-06-09 21:07:32 -0700110#define TCP_RTO_MIN 0.2 * THZ /* Min RTO (200ms) - lower than standard */
Dave Barach68b0fb02017-02-28 15:15:56 -0500111#define TCP_RTT_MAX 30 * THZ /* 30s (probably too much) */
112#define TCP_RTO_SYN_RETRIES 3 /* SYN retries without doubling RTO */
113#define TCP_RTO_INIT 1 * THZ /* Initial retransmit timer */
114
Dave Barach68b0fb02017-02-28 15:15:56 -0500115/** TCP connection flags */
116#define foreach_tcp_connection_flag \
Dave Barach68b0fb02017-02-28 15:15:56 -0500117 _(SNDACK, "Send ACK") \
Florin Corasd79b41e2017-03-04 05:37:52 -0800118 _(FINSNT, "FIN sent") \
Florin Corasa096f2d2017-09-28 23:49:42 -0400119 _(SENT_RCV_WND0, "Sent 0 rcv_wnd") \
120 _(RECOVERY, "Recovery") \
121 _(FAST_RECOVERY, "Fast Recovery") \
Florin Corasb11175d2018-11-09 14:34:08 -0800122 _(DCNT_PENDING, "Disconnect pending") \
Florin Corasb2215d62017-08-01 16:56:58 -0700123 _(HALF_OPEN_DONE, "Half-open completed") \
Florin Corasca1c8f32018-05-23 21:01:30 -0700124 _(FINPNDG, "FIN pending") \
Florin Corasbf4d5ce2018-10-19 16:26:24 -0700125 _(FRXT_PENDING, "Fast-retransmit pending") \
126 _(FRXT_FIRST, "Fast-retransmit first again") \
Florin Coras9ece3c02018-11-05 11:06:53 -0800127 _(DEQ_PENDING, "Pending dequeue acked") \
Florin Corase96bf632018-12-18 22:44:27 -0800128 _(PSH_PENDING, "PSH pending") \
Dave Barach68b0fb02017-02-28 15:15:56 -0500129
130typedef enum _tcp_connection_flag_bits
131{
132#define _(sym, str) TCP_CONN_##sym##_BIT,
133 foreach_tcp_connection_flag
134#undef _
135 TCP_CONN_N_FLAG_BITS
136} tcp_connection_flag_bits_e;
137
138typedef enum _tcp_connection_flag
139{
140#define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
141 foreach_tcp_connection_flag
142#undef _
143 TCP_CONN_N_FLAGS
144} tcp_connection_flags_e;
145
146/** TCP buffer flags */
147#define foreach_tcp_buf_flag \
148 _ (ACK) /**< Sending ACK. */ \
149 _ (DUPACK) /**< Sending DUPACK. */ \
150
151enum
152{
153#define _(f) TCP_BUF_BIT_##f,
154 foreach_tcp_buf_flag
155#undef _
156 TCP_N_BUF_BITS,
157};
158
159enum
160{
161#define _(f) TCP_BUF_FLAG_##f = 1 << TCP_BUF_BIT_##f,
162 foreach_tcp_buf_flag
163#undef _
164};
165
Florin Coras3eb50622017-07-13 01:24:57 -0400166#define TCP_SCOREBOARD_TRACE (0)
Florin Corase55a6d72018-10-31 23:09:22 -0700167#define TCP_MAX_SACK_BLOCKS 256 /**< Max number of SACK blocks stored */
Dave Barach68b0fb02017-02-28 15:15:56 -0500168#define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
169
Florin Coras3eb50622017-07-13 01:24:57 -0400170typedef struct _scoreboard_trace_elt
171{
172 u32 start;
173 u32 end;
174 u32 ack;
175 u32 snd_una_max;
176 u32 group;
177} scoreboard_trace_elt_t;
178
Dave Barach68b0fb02017-02-28 15:15:56 -0500179typedef struct _sack_scoreboard_hole
180{
181 u32 next; /**< Index for next entry in linked list */
182 u32 prev; /**< Index for previous entry in linked list */
183 u32 start; /**< Start sequence number */
184 u32 end; /**< End sequence number */
Florin Coras93992a92017-05-24 18:03:56 -0700185 u8 is_lost; /**< Mark hole as lost */
Dave Barach68b0fb02017-02-28 15:15:56 -0500186} sack_scoreboard_hole_t;
187
188typedef struct _sack_scoreboard
189{
190 sack_scoreboard_hole_t *holes; /**< Pool of holes */
Florin Coras6792ec02017-03-13 03:49:51 -0700191 u32 head; /**< Index of first entry */
192 u32 tail; /**< Index of last entry */
Dave Barach68b0fb02017-02-28 15:15:56 -0500193 u32 sacked_bytes; /**< Number of bytes sacked in sb */
Florin Coras6792ec02017-03-13 03:49:51 -0700194 u32 last_sacked_bytes; /**< Number of bytes last sacked */
Florin Coras93992a92017-05-24 18:03:56 -0700195 u32 last_bytes_delivered; /**< Number of sack bytes delivered */
Florin Coras6792ec02017-03-13 03:49:51 -0700196 u32 snd_una_adv; /**< Bytes to add to snd_una */
Florin Coras93992a92017-05-24 18:03:56 -0700197 u32 high_sacked; /**< Highest byte sacked (fack) */
198 u32 high_rxt; /**< Highest retransmitted sequence */
199 u32 rescue_rxt; /**< Rescue sequence number */
200 u32 lost_bytes; /**< Bytes lost as per RFC6675 */
201 u32 cur_rxt_hole; /**< Retransmitting from this hole */
Florin Coras3eb50622017-07-13 01:24:57 -0400202
203#if TCP_SCOREBOARD_TRACE
204 scoreboard_trace_elt_t *trace;
205#endif
206
Dave Barach68b0fb02017-02-28 15:15:56 -0500207} sack_scoreboard_t;
208
Florin Coras3eb50622017-07-13 01:24:57 -0400209#if TCP_SCOREBOARD_TRACE
210#define tcp_scoreboard_trace_add(_tc, _ack) \
211{ \
212 static u64 _group = 0; \
213 sack_scoreboard_t *_sb = &_tc->sack_sb; \
214 sack_block_t *_sack, *_sacks; \
215 scoreboard_trace_elt_t *_elt; \
216 int i; \
217 _group++; \
218 _sacks = _tc->rcv_opts.sacks; \
219 for (i = 0; i < vec_len (_sacks); i++) \
220 { \
221 _sack = &_sacks[i]; \
222 vec_add2 (_sb->trace, _elt, 1); \
223 _elt->start = _sack->start; \
224 _elt->end = _sack->end; \
225 _elt->ack = _elt->end == _ack ? _ack : 0; \
226 _elt->snd_una_max = _elt->end == _ack ? _tc->snd_una_max : 0; \
227 _elt->group = _group; \
228 } \
229}
230#else
231#define tcp_scoreboard_trace_add(_tc, _ack)
232#endif
233
Florin Coras0dbd5172018-06-25 16:19:34 -0700234sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
235 sack_scoreboard_hole_t *
236 start, u8 have_sent_1_smss,
237 u8 * can_rescue,
238 u8 * snd_limited);
239sack_scoreboard_hole_t *scoreboard_get_hole (sack_scoreboard_t * sb,
240 u32 index);
241
242sack_scoreboard_hole_t *scoreboard_next_hole (sack_scoreboard_t * sb,
243 sack_scoreboard_hole_t * hole);
244sack_scoreboard_hole_t *scoreboard_prev_hole (sack_scoreboard_t * sb,
245 sack_scoreboard_hole_t * hole);
246sack_scoreboard_hole_t *scoreboard_first_hole (sack_scoreboard_t * sb);
247sack_scoreboard_hole_t *scoreboard_last_hole (sack_scoreboard_t * sb);
248void scoreboard_clear (sack_scoreboard_t * sb);
249void scoreboard_init (sack_scoreboard_t * sb);
250u8 *format_tcp_scoreboard (u8 * s, va_list * args);
251
Dave Barach68b0fb02017-02-28 15:15:56 -0500252typedef enum _tcp_cc_algorithm_type
253{
254 TCP_CC_NEWRENO,
Florin Coras2e31cc32018-09-25 14:00:34 -0700255 TCP_CC_CUBIC,
Dave Barach68b0fb02017-02-28 15:15:56 -0500256} tcp_cc_algorithm_type_e;
257
258typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
259
260typedef enum _tcp_cc_ack_t
261{
262 TCP_CC_ACK,
263 TCP_CC_DUPACK,
264 TCP_CC_PARTIALACK
265} tcp_cc_ack_t;
266
267typedef struct _tcp_connection
268{
Florin Coras2e31cc32018-09-25 14:00:34 -0700269 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Dave Barach68b0fb02017-02-28 15:15:56 -0500270 transport_connection_t connection; /**< Common transport data. First! */
271
272 u8 state; /**< TCP state as per tcp_state_t */
273 u16 flags; /**< Connection flags (see tcp_conn_flags_e) */
274 u32 timers[TCP_N_TIMERS]; /**< Timer handles into timer wheel */
275
276 /* TODO RFC4898 */
277
278 /** Send sequence variables RFC793 */
279 u32 snd_una; /**< oldest unacknowledged sequence number */
280 u32 snd_una_max; /**< newest unacknowledged sequence number + 1*/
281 u32 snd_wnd; /**< send window */
282 u32 snd_wl1; /**< seq number used for last snd.wnd update */
283 u32 snd_wl2; /**< ack number used for last snd.wnd update */
284 u32 snd_nxt; /**< next seq number to be sent */
Florin Corasf03a59a2017-06-09 21:07:32 -0700285 u16 snd_mss; /**< Effective send max seg (data) size */
Dave Barach68b0fb02017-02-28 15:15:56 -0500286
287 /** Receive sequence variables RFC793 */
288 u32 rcv_nxt; /**< next sequence number expected */
289 u32 rcv_wnd; /**< receive window we expect */
290
291 u32 rcv_las; /**< rcv_nxt at last ack sent/rcv_wnd update */
292 u32 iss; /**< initial sent sequence */
293 u32 irs; /**< initial remote sequence */
294
295 /* Options */
Florin Corasc8343412017-05-04 14:25:50 -0700296 u8 snd_opts_len; /**< Tx options len */
Florin Coras0dbd5172018-06-25 16:19:34 -0700297 u8 rcv_wscale; /**< Window scale to advertise to peer */
298 u8 snd_wscale; /**< Window scale to use when sending */
299 u32 tsval_recent; /**< Last timestamp received */
300 u32 tsval_recent_age; /**< When last updated tstamp_recent*/
301 tcp_options_t snd_opts; /**< Tx options for connection */
302 tcp_options_t rcv_opts; /**< Rx options for connection */
Dave Barach68b0fb02017-02-28 15:15:56 -0500303
304 sack_block_t *snd_sacks; /**< Vector of SACKs to send. XXX Fixed size? */
305 sack_scoreboard_t sack_sb; /**< SACK "scoreboard" that tracks holes */
306
Florin Coras6792ec02017-03-13 03:49:51 -0700307 u16 rcv_dupacks; /**< Number of DUPACKs received */
Florin Coras7ac053b2018-11-05 15:57:21 -0800308 u8 pending_dupacks; /**< Number of DUPACKs to be sent */
Dave Barach68b0fb02017-02-28 15:15:56 -0500309
310 /* Congestion control */
311 u32 cwnd; /**< Congestion window */
Florin Coras62166002018-04-18 16:40:55 -0700312 u32 cwnd_acc_bytes; /**< Bytes accumulated for cwnd increment */
Dave Barach68b0fb02017-02-28 15:15:56 -0500313 u32 ssthresh; /**< Slow-start threshold */
314 u32 prev_ssthresh; /**< ssthresh before congestion */
Florin Coras93992a92017-05-24 18:03:56 -0700315 u32 prev_cwnd; /**< ssthresh before congestion */
Dave Barach68b0fb02017-02-28 15:15:56 -0500316 u32 bytes_acked; /**< Bytes acknowledged by current segment */
Florin Coras9ece3c02018-11-05 11:06:53 -0800317 u32 burst_acked; /**< Bytes acknowledged in current burst */
Florin Coras93992a92017-05-24 18:03:56 -0700318 u32 snd_rxt_bytes; /**< Retransmitted bytes */
319 u32 snd_rxt_ts; /**< Timestamp when first packet is retransmitted */
Florin Corase69f4952017-03-07 10:06:24 -0800320 u32 tsecr_last_ack; /**< Timestamp echoed to us in last healthy ACK */
Florin Coras6792ec02017-03-13 03:49:51 -0700321 u32 snd_congestion; /**< snd_una_max when congestion is detected */
Dave Barach68b0fb02017-02-28 15:15:56 -0500322 tcp_cc_algorithm_t *cc_algo; /**< Congestion control algorithm */
Florin Coras2e31cc32018-09-25 14:00:34 -0700323 u8 cc_data[TCP_CC_DATA_SZ]; /**< Congestion control algo private data */
Dave Barach68b0fb02017-02-28 15:15:56 -0500324
325 /* RTT and RTO */
326 u32 rto; /**< Retransmission timeout */
327 u32 rto_boff; /**< Index for RTO backoff */
328 u32 srtt; /**< Smoothed RTT */
329 u32 rttvar; /**< Smoothed mean RTT difference. Approximates variance */
Dave Barach68b0fb02017-02-28 15:15:56 -0500330 u32 rtt_seq; /**< Sequence number for tracked ACK */
Florin Corasd67f1122018-05-21 17:47:40 -0700331 f64 rtt_ts; /**< Timestamp for tracked ACK */
332 f64 mrtt_us; /**< High precision mrtt from tracked acks */
Dave Barach68b0fb02017-02-28 15:15:56 -0500333
Florin Corasc8343412017-05-04 14:25:50 -0700334 u16 mss; /**< Our max seg size that includes options */
Florin Corasf03a59a2017-06-09 21:07:32 -0700335 u32 limited_transmit; /**< snd_nxt when limited transmit starts */
Florin Corasf6359c82017-06-19 12:26:09 -0400336 u32 last_fib_check; /**< Last time we checked fib route for peer */
Florin Corasf9d05682018-04-26 08:26:52 -0700337 u32 sw_if_index; /**< Interface for the connection */
Florin Coras2e31cc32018-09-25 14:00:34 -0700338 u32 tx_fifo_size; /**< Tx fifo size. Used to constrain cwnd */
Florin Coras42ceddb2018-12-12 10:56:01 -0800339
340 u32 psh_seq; /**< Add psh header for seg that includes this */
Dave Barach68b0fb02017-02-28 15:15:56 -0500341} tcp_connection_t;
342
Florin Corasaa01abb2018-11-12 09:13:10 -0800343/* *INDENT-OFF* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500344struct _tcp_cc_algorithm
345{
Florin Corasaa01abb2018-11-12 09:13:10 -0800346 const char *name;
347 uword (*unformat_cfg) (unformat_input_t * input);
Dave Barach68b0fb02017-02-28 15:15:56 -0500348 void (*rcv_ack) (tcp_connection_t * tc);
349 void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
350 void (*congestion) (tcp_connection_t * tc);
351 void (*recovered) (tcp_connection_t * tc);
352 void (*init) (tcp_connection_t * tc);
353};
Florin Corasaa01abb2018-11-12 09:13:10 -0800354/* *INDENT-ON* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500355
356#define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
357#define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
Florin Coras3e350af2017-03-30 02:54:28 -0700358#define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
359#define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
Dave Barach68b0fb02017-02-28 15:15:56 -0500360#define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
Florin Coras3e350af2017-03-30 02:54:28 -0700361#define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
Dave Barach68b0fb02017-02-28 15:15:56 -0500362#define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
Florin Corasb11175d2018-11-09 14:34:08 -0800363#define tcp_disconnect_pending(tc) ((tc)->flags & TCP_CONN_DCNT_PENDING)
364#define tcp_disconnect_pending_on(tc) ((tc)->flags |= TCP_CONN_DCNT_PENDING)
365#define tcp_disconnect_pending_off(tc) ((tc)->flags &= ~TCP_CONN_DCNT_PENDING)
Florin Corasbf4d5ce2018-10-19 16:26:24 -0700366#define tcp_fastrecovery_first(tc) ((tc)->flags & TCP_CONN_FRXT_FIRST)
367#define tcp_fastrecovery_first_on(tc) ((tc)->flags |= TCP_CONN_FRXT_FIRST)
368#define tcp_fastrecovery_first_off(tc) ((tc)->flags &= ~TCP_CONN_FRXT_FIRST)
Dave Barach68b0fb02017-02-28 15:15:56 -0500369
Florin Coras3e350af2017-03-30 02:54:28 -0700370#define tcp_in_cong_recovery(tc) ((tc)->flags & \
371 (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
372
373always_inline void
374tcp_cong_recovery_off (tcp_connection_t * tc)
375{
376 tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
Florin Corasbf4d5ce2018-10-19 16:26:24 -0700377 tcp_fastrecovery_first_off (tc);
Florin Coras3e350af2017-03-30 02:54:28 -0700378}
379
Dave Barach68b0fb02017-02-28 15:15:56 -0500380typedef enum _tcp_error
381{
382#define tcp_error(n,s) TCP_ERROR_##n,
383#include <vnet/tcp/tcp_error.def>
384#undef tcp_error
385 TCP_N_ERROR,
386} tcp_error_t;
387
388typedef struct _tcp_lookup_dispatch
389{
390 u8 next, error;
391} tcp_lookup_dispatch_t;
392
Florin Coras2c414432018-06-19 09:58:04 -0700393typedef struct tcp_worker_ctx_
394{
395 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Florin Corasb11175d2018-11-09 14:34:08 -0800396 /** worker time */
397 u32 time_now;
398
399 /** worker timer wheel */
400 tw_timer_wheel_16t_2w_512sl_t timer_wheel;
401
402 /** tx buffer free list */
403 u32 *tx_buffers;
404
405 /** tx frames for tcp 4/6 output nodes */
406 vlib_frame_t *tx_frames[2];
407
408 /** tx frames for ip 4/6 lookup nodes */
409 vlib_frame_t *ip_lookup_tx_frames[2];
410
411 /** vector of connections needing fast rxt */
412 u32 *pending_fast_rxt;
413
414 /** vector of connections now doing fast rxt */
415 u32 *ongoing_fast_rxt;
416
417 /** vector of connections that will do fast rxt */
418 u32 *postponed_fast_rxt;
419
420 /** vector of pending ack dequeues */
Florin Coras9ece3c02018-11-05 11:06:53 -0800421 u32 *pending_deq_acked;
Florin Corasb11175d2018-11-09 14:34:08 -0800422
423 /** vector of pending acks */
Florin Coras7ac053b2018-11-05 15:57:21 -0800424 u32 *pending_acks;
Florin Corasb11175d2018-11-09 14:34:08 -0800425
426 /** vector of pending disconnect notifications */
427 u32 *pending_disconnects;
428
429 /** convenience pointer to this thread's vlib main */
430 vlib_main_t *vm;
Florin Corasbf4d5ce2018-10-19 16:26:24 -0700431
Florin Corasb26743d2018-06-26 09:31:04 -0700432 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
Florin Corasb11175d2018-11-09 14:34:08 -0800433
434 /** cached 'on the wire' options for bursts */
435 u8 cached_opts[40];
Florin Corasbf4d5ce2018-10-19 16:26:24 -0700436
Florin Coras2c414432018-06-19 09:58:04 -0700437} tcp_worker_ctx_t;
438
Dave Barach68b0fb02017-02-28 15:15:56 -0500439typedef struct _tcp_main
440{
441 /* Per-worker thread tcp connection pools */
442 tcp_connection_t **connections;
443
444 /* Pool of listeners. */
445 tcp_connection_t *listener_pool;
446
447 /** Dispatch table by state and flags */
448 tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
449
450 u8 log2_tstamp_clocks_per_tick;
451 f64 tstamp_ticks_per_clock;
452
Florin Coras2c414432018-06-19 09:58:04 -0700453 /** per-worker context */
454 tcp_worker_ctx_t *wrk_ctx;
Dave Barach68b0fb02017-02-28 15:15:56 -0500455
Dave Barach68b0fb02017-02-28 15:15:56 -0500456 /* Pool of half-open connections on which we've sent a SYN */
457 tcp_connection_t *half_open_connections;
Florin Coras6534b7a2017-07-18 05:38:03 -0400458 clib_spinlock_t half_open_lock;
Dave Barach68b0fb02017-02-28 15:15:56 -0500459
Dave Barach68b0fb02017-02-28 15:15:56 -0500460 /* Congestion control algorithms registered */
461 tcp_cc_algorithm_t *cc_algos;
462
Florin Corasca031862018-09-24 13:58:05 -0700463 /** vlib buffer size */
464 u32 bytes_per_buffer;
465
466 /*
467 * Configuration
468 */
469
Florin Corasa0b34a72017-03-07 01:20:52 -0800470 /* Flag that indicates if stack is on or off */
471 u8 is_enabled;
472
Florin Corasca031862018-09-24 13:58:05 -0700473 /** Max rx fifo size for a session. It is used in to compute the
474 * rfc 7323 window scaling factor */
475 u32 max_rx_fifo;
476
Dave Barach2c25a622017-06-26 11:35:07 -0400477 /** Number of preallocated connections */
478 u32 preallocated_connections;
479 u32 preallocated_half_open_connections;
480
481 /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
482 ip4_address_t *ip4_src_addresses;
483 u32 last_v4_address_rotor;
484 u32 last_v6_address_rotor;
485 ip6_address_t *ip6_src_addresses;
486
Florin Corasd67f1122018-05-21 17:47:40 -0700487 /** Enable tx pacing for new connections */
488 u8 tx_pacing;
489
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200490 u8 punt_unknown4;
491 u8 punt_unknown6;
Florin Corasf988e692017-11-27 04:34:14 -0500492
493 /** fault-injection */
494 f64 buffer_fail_fraction;
Florin Coras2e31cc32018-09-25 14:00:34 -0700495
Florin Corasaa01abb2018-11-12 09:13:10 -0800496 /** Default congestion control algorithm type */
497 tcp_cc_algorithm_type_e cc_algo;
498
Dave Barach68b0fb02017-02-28 15:15:56 -0500499} tcp_main_t;
500
501extern tcp_main_t tcp_main;
502extern vlib_node_registration_t tcp4_input_node;
503extern vlib_node_registration_t tcp6_input_node;
504extern vlib_node_registration_t tcp4_output_node;
505extern vlib_node_registration_t tcp6_output_node;
506
507always_inline tcp_main_t *
508vnet_get_tcp_main ()
509{
510 return &tcp_main;
511}
512
Florin Corasbe72ae62018-11-01 11:23:03 -0700513always_inline tcp_worker_ctx_t *
514tcp_get_worker (u32 thread_index)
515{
516 return &tcp_main.wrk_ctx[thread_index];
517}
518
Florin Coras82b13a82017-04-25 11:58:06 -0700519always_inline tcp_header_t *
520tcp_buffer_hdr (vlib_buffer_t * b)
521{
522 ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
523 return (tcp_header_t *) (b->data + b->current_data
524 + vnet_buffer (b)->tcp.hdr_offset);
525}
526
Florin Corasf988e692017-11-27 04:34:14 -0500527#if (VLIB_BUFFER_TRACE_TRAJECTORY)
528#define tcp_trajectory_add_start(b, start) \
529{ \
530 (*vlib_buffer_trace_trajectory_cb) (b, start); \
531}
532#else
533#define tcp_trajectory_add_start(b, start)
534#endif
535
Florin Corasa0b34a72017-03-07 01:20:52 -0800536clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
537
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200538void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
539
Dave Barach68b0fb02017-02-28 15:15:56 -0500540always_inline tcp_connection_t *
541tcp_connection_get (u32 conn_index, u32 thread_index)
542{
Florin Coras68810622017-07-24 17:40:28 -0700543 if (PREDICT_FALSE
544 (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
Florin Corasd79b41e2017-03-04 05:37:52 -0800545 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500546 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
547}
548
549always_inline tcp_connection_t *
550tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
551{
552 if (tcp_main.connections[thread_index] == 0)
553 return 0;
554 if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
555 return 0;
556 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
557}
558
Florin Coras3eb50622017-07-13 01:24:57 -0400559always_inline tcp_connection_t *
560tcp_get_connection_from_transport (transport_connection_t * tconn)
561{
562 return (tcp_connection_t *) tconn;
563}
564
Florin Coras54ddf432018-12-21 13:54:09 -0800565always_inline void
566tcp_connection_set_state (tcp_connection_t * tc, tcp_state_t state)
567{
568 tc->state = state;
569 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
570}
571
Dave Barach68b0fb02017-02-28 15:15:56 -0500572void tcp_connection_close (tcp_connection_t * tc);
573void tcp_connection_cleanup (tcp_connection_t * tc);
574void tcp_connection_del (tcp_connection_t * tc);
Florin Coras68810622017-07-24 17:40:28 -0700575int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
Florin Coras8124cb72018-12-16 20:57:29 -0800576tcp_connection_t *tcp_connection_alloc (u8 thread_index);
577void tcp_connection_free (tcp_connection_t * tc);
Florin Corasd79b41e2017-03-04 05:37:52 -0800578void tcp_connection_reset (tcp_connection_t * tc);
Dave Barach3bbcfab2017-08-15 19:03:44 -0400579int tcp_configure_v4_source_address_range (vlib_main_t * vm,
580 ip4_address_t * start,
581 ip4_address_t * end, u32 table_id);
582int tcp_configure_v6_source_address_range (vlib_main_t * vm,
583 ip6_address_t * start,
584 ip6_address_t * end, u32 table_id);
585void tcp_api_reference (void);
Florin Corase69f4952017-03-07 10:06:24 -0800586u8 *format_tcp_connection (u8 * s, va_list * args);
Florin Coras3eb50622017-07-13 01:24:57 -0400587
Dave Barach68b0fb02017-02-28 15:15:56 -0500588always_inline tcp_connection_t *
589tcp_listener_get (u32 tli)
590{
591 return pool_elt_at_index (tcp_main.listener_pool, tli);
592}
593
594always_inline tcp_connection_t *
595tcp_half_open_connection_get (u32 conn_index)
596{
Florin Coras68810622017-07-24 17:40:28 -0700597 tcp_connection_t *tc = 0;
598 clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
599 if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
600 tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
601 clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
602 return tc;
Dave Barach68b0fb02017-02-28 15:15:56 -0500603}
604
605void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
Florin Corasd79b41e2017-03-04 05:37:52 -0800606void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
Dave Barach68b0fb02017-02-28 15:15:56 -0500607void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
Florin Coras1f152cd2017-08-18 19:28:03 -0700608void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
609 u8 is_ip4);
610void tcp_send_reset (tcp_connection_t * tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500611void tcp_send_syn (tcp_connection_t * tc);
Florin Coras7ac053b2018-11-05 15:57:21 -0800612void tcp_send_synack (tcp_connection_t * tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500613void tcp_send_fin (tcp_connection_t * tc);
Florin Corasc8343412017-05-04 14:25:50 -0700614void tcp_init_mss (tcp_connection_t * tc);
Florin Corasb26743d2018-06-26 09:31:04 -0700615void tcp_update_burst_snd_vars (tcp_connection_t * tc);
Florin Coras93992a92017-05-24 18:03:56 -0700616void tcp_update_rto (tcp_connection_t * tc);
Florin Corasbe72ae62018-11-01 11:23:03 -0700617void tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4);
618void tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk);
619void tcp_program_fastretransmit (tcp_worker_ctx_t * wrk,
620 tcp_connection_t * tc);
621void tcp_do_fastretransmits (tcp_worker_ctx_t * wrk);
Dave Barach68b0fb02017-02-28 15:15:56 -0500622
Florin Coras7ac053b2018-11-05 15:57:21 -0800623void tcp_program_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
624void tcp_program_dupack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
625void tcp_send_acks (tcp_worker_ctx_t * wrk);
626
Dave Barach68b0fb02017-02-28 15:15:56 -0500627always_inline u32
628tcp_end_seq (tcp_header_t * th, u32 len)
629{
630 return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
631}
632
633/* Modulo arithmetic for TCP sequence numbers */
634#define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
635#define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
636#define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
637#define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
Florin Corasf03a59a2017-06-09 21:07:32 -0700638#define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
Dave Barach68b0fb02017-02-28 15:15:56 -0500639
640/* Modulo arithmetic for timestamps */
641#define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
642#define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
643
Florin Coras93992a92017-05-24 18:03:56 -0700644/**
645 * Our estimate of the number of bytes that have left the network
646 */
647always_inline u32
648tcp_bytes_out (const tcp_connection_t * tc)
649{
650 if (tcp_opts_sack_permitted (&tc->rcv_opts))
651 return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
652 else
653 return tc->rcv_dupacks * tc->snd_mss;
654}
655
656/**
657 * Our estimate of the number of bytes in flight (pipe size)
658 */
Dave Barach68b0fb02017-02-28 15:15:56 -0500659always_inline u32
660tcp_flight_size (const tcp_connection_t * tc)
661{
Florin Coras6792ec02017-03-13 03:49:51 -0700662 int flight_size;
663
Florin Coras93992a92017-05-24 18:03:56 -0700664 flight_size = (int) (tc->snd_una_max - tc->snd_una) - tcp_bytes_out (tc)
665 + tc->snd_rxt_bytes;
Florin Coras6792ec02017-03-13 03:49:51 -0700666
Florin Coras6792ec02017-03-13 03:49:51 -0700667 if (flight_size < 0)
Florin Coras93992a92017-05-24 18:03:56 -0700668 {
669 if (0)
670 clib_warning
671 ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
672 tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
673 tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
674 tc->rcv_opts.flags);
675 return 0;
676 }
Florin Coras6792ec02017-03-13 03:49:51 -0700677
678 return flight_size;
Dave Barach68b0fb02017-02-28 15:15:56 -0500679}
680
681/**
682 * Initial cwnd as per RFC5681
683 */
684always_inline u32
685tcp_initial_cwnd (const tcp_connection_t * tc)
686{
687 if (tc->snd_mss > 2190)
688 return 2 * tc->snd_mss;
689 else if (tc->snd_mss > 1095)
690 return 3 * tc->snd_mss;
691 else
692 return 4 * tc->snd_mss;
693}
694
Florin Coras2e31cc32018-09-25 14:00:34 -0700695/*
696 * Accumulate acked bytes for cwnd increase
697 *
698 * Once threshold bytes are accumulated, snd_mss bytes are added
699 * to the cwnd.
700 */
701always_inline void
702tcp_cwnd_accumulate (tcp_connection_t * tc, u32 thresh, u32 bytes)
703{
704 tc->cwnd_acc_bytes += bytes;
705 if (tc->cwnd_acc_bytes >= thresh)
706 {
707 u32 inc = tc->cwnd_acc_bytes / thresh;
708 tc->cwnd_acc_bytes -= inc * thresh;
709 tc->cwnd += inc * tc->snd_mss;
710 tc->cwnd = clib_min (tc->cwnd, tc->tx_fifo_size);
711 }
712}
713
Dave Barach68b0fb02017-02-28 15:15:56 -0500714always_inline u32
715tcp_loss_wnd (const tcp_connection_t * tc)
716{
717 return tc->snd_mss;
718}
719
720always_inline u32
Florin Coras1f152cd2017-08-18 19:28:03 -0700721tcp_available_snd_wnd (const tcp_connection_t * tc)
Dave Barach68b0fb02017-02-28 15:15:56 -0500722{
723 return clib_min (tc->cwnd, tc->snd_wnd);
724}
725
726always_inline u32
Florin Coras1f152cd2017-08-18 19:28:03 -0700727tcp_available_output_snd_space (const tcp_connection_t * tc)
728{
729 u32 available_wnd = tcp_available_snd_wnd (tc);
730 int flight_size = (int) (tc->snd_nxt - tc->snd_una);
731
732 if (available_wnd <= flight_size)
733 return 0;
734
735 return available_wnd - flight_size;
736}
737
738/**
739 * Estimate of how many bytes we can still push into the network
740 */
741always_inline u32
Florin Corasca1c8f32018-05-23 21:01:30 -0700742tcp_available_cc_snd_space (const tcp_connection_t * tc)
Dave Barach68b0fb02017-02-28 15:15:56 -0500743{
Florin Coras1f152cd2017-08-18 19:28:03 -0700744 u32 available_wnd = tcp_available_snd_wnd (tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500745 u32 flight_size = tcp_flight_size (tc);
746
747 if (available_wnd <= flight_size)
748 return 0;
749
750 return available_wnd - flight_size;
751}
752
Florin Corasb2215d62017-08-01 16:56:58 -0700753always_inline u8
754tcp_is_lost_fin (tcp_connection_t * tc)
755{
756 if ((tc->flags & TCP_CONN_FINSNT) && tc->snd_una_max - tc->snd_una == 1)
757 return 1;
758 return 0;
759}
760
Florin Coras45ca73f2018-09-27 09:19:29 -0700761u32 tcp_snd_space (tcp_connection_t * tc);
Florin Corasbe72ae62018-11-01 11:23:03 -0700762int tcp_retransmit_first_unacked (tcp_worker_ctx_t * wrk,
763 tcp_connection_t * tc);
764int tcp_fast_retransmit_no_sack (tcp_worker_ctx_t * wrk,
765 tcp_connection_t * tc, u32 burst_size);
766int tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
767 u32 burst_size);
768int tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
769 u32 burst_size);
Florin Coras93992a92017-05-24 18:03:56 -0700770void tcp_cc_init_congestion (tcp_connection_t * tc);
Florin Coras93992a92017-05-24 18:03:56 -0700771void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500772
Florin Corasf6359c82017-06-19 12:26:09 -0400773fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
774
Florin Coras45d34962017-04-25 00:05:27 -0700775/* Made public for unit testing only */
776void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
Florin Corasca1c8f32018-05-23 21:01:30 -0700777u32 tcp_sack_list_bytes (tcp_connection_t * tc);
Florin Coras45d34962017-04-25 00:05:27 -0700778
Dave Barach68b0fb02017-02-28 15:15:56 -0500779always_inline u32
780tcp_time_now (void)
781{
Florin Coras2c414432018-06-19 09:58:04 -0700782 return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
Florin Coras82d3ec82017-08-14 08:10:42 -0700783}
784
Florin Corasbe72ae62018-11-01 11:23:03 -0700785always_inline u32
786tcp_time_now_w_thread (u32 thread_index)
787{
788 return tcp_main.wrk_ctx[thread_index].time_now;
789}
790
Florin Corasd67f1122018-05-21 17:47:40 -0700791always_inline f64
792tcp_time_now_us (u32 thread_index)
793{
794 return transport_time_now (thread_index);
795}
796
Florin Coras82d3ec82017-08-14 08:10:42 -0700797always_inline u32
Florin Corasbe72ae62018-11-01 11:23:03 -0700798tcp_set_time_now (tcp_worker_ctx_t * wrk)
Florin Coras82d3ec82017-08-14 08:10:42 -0700799{
Florin Corasbe72ae62018-11-01 11:23:03 -0700800 wrk->time_now = clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
801 return wrk->time_now;
Dave Barach68b0fb02017-02-28 15:15:56 -0500802}
803
Florin Coras0dbd5172018-06-25 16:19:34 -0700804u32 tcp_push_header (tcp_connection_t * tconn, vlib_buffer_t * b);
Dave Barach68b0fb02017-02-28 15:15:56 -0500805
806void tcp_connection_timers_init (tcp_connection_t * tc);
807void tcp_connection_timers_reset (tcp_connection_t * tc);
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400808void tcp_init_snd_vars (tcp_connection_t * tc);
Dave Barach68b0fb02017-02-28 15:15:56 -0500809void tcp_connection_init_vars (tcp_connection_t * tc);
Florin Corasc44a5582018-11-01 16:30:54 -0700810void tcp_connection_tx_pacer_update (tcp_connection_t * tc);
811void tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
812 u32 start_bucket);
Florin Corasd67f1122018-05-21 17:47:40 -0700813
814always_inline void
815tcp_cc_rcv_ack (tcp_connection_t * tc)
816{
817 tc->cc_algo->rcv_ack (tc);
Florin Corasd67f1122018-05-21 17:47:40 -0700818 tc->tsecr_last_ack = tc->rcv_opts.tsecr;
819}
Dave Barach68b0fb02017-02-28 15:15:56 -0500820
821always_inline void
Dave Barach68b0fb02017-02-28 15:15:56 -0500822tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
823{
Dave Barach2c25a622017-06-26 11:35:07 -0400824 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400825 ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
Florin Coras2c414432018-06-19 09:58:04 -0700826 tc->timers[timer_id] =
827 tw_timer_start_16t_2w_512sl (&tcp_main.
828 wrk_ctx[tc->c_thread_index].timer_wheel,
829 tc->c_c_index, timer_id, interval);
Dave Barach68b0fb02017-02-28 15:15:56 -0500830}
831
832always_inline void
Dave Barach68b0fb02017-02-28 15:15:56 -0500833tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
834{
Dave Barach2c25a622017-06-26 11:35:07 -0400835 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
Dave Barach68b0fb02017-02-28 15:15:56 -0500836 if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
837 return;
838
Florin Coras2c414432018-06-19 09:58:04 -0700839 tw_timer_stop_16t_2w_512sl (&tcp_main.
840 wrk_ctx[tc->c_thread_index].timer_wheel,
Dave Barach68b0fb02017-02-28 15:15:56 -0500841 tc->timers[timer_id]);
842 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
843}
844
845always_inline void
846tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
847{
Dave Barach2c25a622017-06-26 11:35:07 -0400848 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
Dave Barach68b0fb02017-02-28 15:15:56 -0500849 if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
Florin Corasadb5bd52018-06-22 15:29:38 -0700850 tw_timer_update_16t_2w_512sl (&tcp_main.
851 wrk_ctx[tc->c_thread_index].timer_wheel,
852 tc->timers[timer_id], interval);
853 else
854 tc->timers[timer_id] =
855 tw_timer_start_16t_2w_512sl (&tcp_main.
856 wrk_ctx[tc->c_thread_index].timer_wheel,
857 tc->c_c_index, timer_id, interval);
Dave Barach68b0fb02017-02-28 15:15:56 -0500858}
859
Florin Coras6792ec02017-03-13 03:49:51 -0700860always_inline void
861tcp_retransmit_timer_set (tcp_connection_t * tc)
862{
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400863 ASSERT (tc->snd_una != tc->snd_una_max);
Florin Coras6792ec02017-03-13 03:49:51 -0700864 tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
865 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
866}
867
868always_inline void
Florin Coras6792ec02017-03-13 03:49:51 -0700869tcp_retransmit_timer_reset (tcp_connection_t * tc)
870{
871 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
872}
873
Florin Coras3e350af2017-03-30 02:54:28 -0700874always_inline void
Florin Coras93992a92017-05-24 18:03:56 -0700875tcp_retransmit_timer_force_update (tcp_connection_t * tc)
876{
877 tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
878 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
879}
880
881always_inline void
Florin Coras3e350af2017-03-30 02:54:28 -0700882tcp_persist_timer_set (tcp_connection_t * tc)
883{
884 /* Reuse RTO. It's backed off in handler */
885 tcp_timer_set (tc, TCP_TIMER_PERSIST,
Florin Coras5921f982017-04-03 18:00:00 -0700886 clib_max (tc->rto * TCP_TO_TIMER_TICK,
887 TCP_TIMER_PERSIST_MIN));
Florin Coras3e350af2017-03-30 02:54:28 -0700888}
889
890always_inline void
891tcp_persist_timer_update (tcp_connection_t * tc)
892{
893 tcp_timer_update (tc, TCP_TIMER_PERSIST,
Florin Coras5921f982017-04-03 18:00:00 -0700894 clib_max (tc->rto * TCP_TO_TIMER_TICK,
895 TCP_TIMER_PERSIST_MIN));
Florin Coras3e350af2017-03-30 02:54:28 -0700896}
897
898always_inline void
899tcp_persist_timer_reset (tcp_connection_t * tc)
900{
901 tcp_timer_reset (tc, TCP_TIMER_PERSIST);
902}
903
Florin Coras93992a92017-05-24 18:03:56 -0700904always_inline void
905tcp_retransmit_timer_update (tcp_connection_t * tc)
906{
907 if (tc->snd_una == tc->snd_una_max)
908 {
909 tcp_retransmit_timer_reset (tc);
910 if (tc->snd_wnd < tc->snd_mss)
Florin Coras4eeeaaf2017-09-05 14:03:37 -0400911 tcp_persist_timer_update (tc);
Florin Coras93992a92017-05-24 18:03:56 -0700912 }
913 else
914 tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
915 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
916}
917
Dave Barach68b0fb02017-02-28 15:15:56 -0500918always_inline u8
919tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
920{
921 return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
922}
923
Florin Coras93992a92017-05-24 18:03:56 -0700924#define tcp_validate_txf_size(_tc, _a) \
925 ASSERT(_tc->state != TCP_STATE_ESTABLISHED \
Florin Coras25579b42018-06-06 17:55:02 -0700926 || session_tx_fifo_max_dequeue (&_tc->connection) >= _a)
Florin Coras93992a92017-05-24 18:03:56 -0700927
Florin Coras6792ec02017-03-13 03:49:51 -0700928void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
Florin Coras0dbd5172018-06-25 16:19:34 -0700929u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
Florin Coras6792ec02017-03-13 03:49:51 -0700930
Florin Coras0dbd5172018-06-25 16:19:34 -0700931void tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
932 const tcp_cc_algorithm_t * vft);
Dave Barach68b0fb02017-02-28 15:15:56 -0500933
Florin Coras0dbd5172018-06-25 16:19:34 -0700934tcp_cc_algorithm_t *tcp_cc_algo_get (tcp_cc_algorithm_type_e type);
Dave Barach68b0fb02017-02-28 15:15:56 -0500935
Florin Coras2e31cc32018-09-25 14:00:34 -0700936static inline void *
937tcp_cc_data (tcp_connection_t * tc)
938{
939 return (void *) tc->cc_data;
940}
941
942void newreno_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type);
943
Dave Barach68b0fb02017-02-28 15:15:56 -0500944/**
945 * Push TCP header to buffer
946 *
947 * @param vm - vlib_main
948 * @param b - buffer to write the header to
949 * @param sp_net - source port net order
950 * @param dp_net - destination port net order
951 * @param seq - sequence number net order
952 * @param ack - ack number net order
953 * @param tcp_hdr_opts_len - header and options length in bytes
954 * @param flags - header flags
955 * @param wnd - window size
956 *
957 * @return - pointer to start of TCP header
958 */
959always_inline void *
960vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
961 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
962 u16 wnd)
963{
964 tcp_header_t *th;
965
966 th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
967
968 th->src_port = sp;
969 th->dst_port = dp;
970 th->seq_number = seq;
971 th->ack_number = ack;
972 th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
973 th->flags = flags;
974 th->window = wnd;
975 th->checksum = 0;
976 th->urgent_pointer = 0;
977 return th;
978}
979
980/**
981 * Push TCP header to buffer
982 *
Dave Barach68b0fb02017-02-28 15:15:56 -0500983 * @param b - buffer to write the header to
984 * @param sp_net - source port net order
985 * @param dp_net - destination port net order
986 * @param seq - sequence number host order
987 * @param ack - ack number host order
988 * @param tcp_hdr_opts_len - header and options length in bytes
989 * @param flags - header flags
990 * @param wnd - window size
991 *
992 * @return - pointer to start of TCP header
993 */
994always_inline void *
995vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
996 u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
997{
998 return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
999 clib_host_to_net_u32 (seq),
1000 clib_host_to_net_u32 (ack),
1001 tcp_hdr_opts_len, flags,
1002 clib_host_to_net_u16 (wnd));
1003}
1004
1005#endif /* _vnet_tcp_h_ */
1006
1007/*
1008 * fd.io coding-style-patch-verification: ON
1009 *
1010 * Local Variables:
1011 * eval: (c-set-style "gnu")
1012 * End:
1013 */