2 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
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>
25 #include <vnet/tcp/tcp_debug.h>
27 #define TCP_TICK 0.001 /**< TCP tick period (s) */
28 #define THZ (u32) (1/TCP_TICK) /**< TCP tick frequency */
29 #define TCP_TSTAMP_RESOLUTION TCP_TICK /**< Time stamp resolution */
30 #define TCP_PAWS_IDLE 24 * 24 * 60 * 60 * THZ /**< 24 days */
31 #define TCP_FIB_RECHECK_PERIOD 1 * THZ /**< Recheck every 1s */
32 #define TCP_MAX_OPTION_SPACE 40
33 #define TCP_CC_DATA_SZ 24
35 #define TCP_DUPACK_THRESHOLD 3
36 #define TCP_MAX_RX_FIFO_SIZE 32 << 20
37 #define TCP_MIN_RX_FIFO_SIZE 4 << 10
38 #define TCP_IW_N_SEGMENTS 10
39 #define TCP_ALWAYS_ACK 1 /**< On/off delayed acks */
40 #define TCP_USE_SACKS 1 /**< Disable only for testing */
42 /** TCP FSM state definitions as per RFC793. */
43 #define foreach_tcp_fsm_state \
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")
56 typedef enum _tcp_state
58 #define _(sym, str) TCP_STATE_##sym,
64 format_function_t format_tcp_state;
65 format_function_t format_tcp_flags;
66 format_function_t format_tcp_sacks;
67 format_function_t format_tcp_rcv_sacks;
70 #define foreach_tcp_timer \
71 _(RETRANSMIT, "RETRANSMIT") \
72 _(DELACK, "DELAYED ACK") \
73 _(PERSIST, "PERSIST") \
75 _(WAITCLOSE, "WAIT CLOSE") \
76 _(RETRANSMIT_SYN, "RETRANSMIT SYN") \
77 _(ESTABLISH, "ESTABLISH") \
78 _(ESTABLISH_AO, "ESTABLISH_AO") \
80 typedef enum _tcp_timers
82 #define _(sym, str) TCP_TIMER_##sym,
88 typedef void (timer_expiration_handler) (u32 index);
90 extern timer_expiration_handler tcp_timer_delack_handler;
91 extern timer_expiration_handler tcp_timer_retransmit_handler;
92 extern timer_expiration_handler tcp_timer_persist_handler;
93 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
95 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
97 /* Timer delays as multiples of 100ms */
98 #define TCP_TO_TIMER_TICK TCP_TICK*10 /* Period for converting from TCP
99 * ticks to timer units */
100 #define TCP_DELACK_TIME 1 /* 0.1s */
101 #define TCP_ESTABLISH_TIME 750 /* 75s */
102 #define TCP_SYN_RCVD_TIME 600 /* 60s */
103 #define TCP_2MSL_TIME 300 /* 30s */
104 #define TCP_CLOSEWAIT_TIME 20 /* 2s */
105 #define TCP_TIMEWAIT_TIME 100 /* 10s */
106 #define TCP_FINWAIT1_TIME 600 /* 60s */
107 #define TCP_CLEANUP_TIME 1 /* 0.1s */
108 #define TCP_TIMER_PERSIST_MIN 2 /* 0.2s */
110 #define TCP_RTO_MAX 60 * THZ /* Min max RTO (60s) as per RFC6298 */
111 #define TCP_RTO_MIN 0.2 * THZ /* Min RTO (200ms) - lower than standard */
112 #define TCP_RTT_MAX 30 * THZ /* 30s (probably too much) */
113 #define TCP_RTO_SYN_RETRIES 3 /* SYN retries without doubling RTO */
114 #define TCP_RTO_INIT 1 * THZ /* Initial retransmit timer */
115 #define TCP_RTO_BOFF_MAX 8 /* Max number of retries before reset */
117 /** TCP connection flags */
118 #define foreach_tcp_connection_flag \
119 _(SNDACK, "Send ACK") \
120 _(FINSNT, "FIN sent") \
121 _(RECOVERY, "Recovery") \
122 _(FAST_RECOVERY, "Fast Recovery") \
123 _(DCNT_PENDING, "Disconnect pending") \
124 _(HALF_OPEN_DONE, "Half-open completed") \
125 _(FINPNDG, "FIN pending") \
126 _(FRXT_PENDING, "Fast-retransmit pending") \
127 _(FRXT_FIRST, "Fast-retransmit first again") \
128 _(DEQ_PENDING, "Pending dequeue acked") \
129 _(PSH_PENDING, "PSH pending") \
130 _(FINRCVD, "FIN received") \
131 _(RATE_SAMPLE, "Conn does rate sampling") \
132 _(TRACK_BURST, "Track burst") \
133 _(ZERO_RWND_SENT, "Zero RWND sent") \
135 typedef enum _tcp_connection_flag_bits
137 #define _(sym, str) TCP_CONN_##sym##_BIT,
138 foreach_tcp_connection_flag
141 } tcp_connection_flag_bits_e;
143 typedef enum _tcp_connection_flag
145 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
146 foreach_tcp_connection_flag
149 } tcp_connection_flags_e;
151 #define TCP_SCOREBOARD_TRACE (0)
152 #define TCP_MAX_SACK_BLOCKS 256 /**< Max number of SACK blocks stored */
153 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
155 typedef struct _scoreboard_trace_elt
162 } scoreboard_trace_elt_t;
164 typedef struct _sack_scoreboard_hole
166 u32 next; /**< Index for next entry in linked list */
167 u32 prev; /**< Index for previous entry in linked list */
168 u32 start; /**< Start sequence number */
169 u32 end; /**< End sequence number */
170 u8 is_lost; /**< Mark hole as lost */
171 } sack_scoreboard_hole_t;
173 typedef struct _sack_scoreboard
175 sack_scoreboard_hole_t *holes; /**< Pool of holes */
176 u32 head; /**< Index of first entry */
177 u32 tail; /**< Index of last entry */
178 u32 sacked_bytes; /**< Number of bytes sacked in sb */
179 u32 last_sacked_bytes; /**< Number of bytes last sacked */
180 u32 last_bytes_delivered; /**< Sack bytes delivered to app */
181 u32 snd_una_adv; /**< Bytes to add to snd_una */
182 u32 high_sacked; /**< Highest byte sacked (fack) */
183 u32 high_rxt; /**< Highest retransmitted sequence */
184 u32 rescue_rxt; /**< Rescue sequence number */
185 u32 lost_bytes; /**< Bytes lost as per RFC6675 */
186 u32 last_lost_bytes; /**< Number of bytes last lost */
187 u32 cur_rxt_hole; /**< Retransmitting from this hole */
189 #if TCP_SCOREBOARD_TRACE
190 scoreboard_trace_elt_t *trace;
195 #if TCP_SCOREBOARD_TRACE
196 #define tcp_scoreboard_trace_add(_tc, _ack) \
198 static u64 _group = 0; \
199 sack_scoreboard_t *_sb = &_tc->sack_sb; \
200 sack_block_t *_sack, *_sacks; \
201 scoreboard_trace_elt_t *_elt; \
204 _sacks = _tc->rcv_opts.sacks; \
205 for (i = 0; i < vec_len (_sacks); i++) \
207 _sack = &_sacks[i]; \
208 vec_add2 (_sb->trace, _elt, 1); \
209 _elt->start = _sack->start; \
210 _elt->end = _sack->end; \
211 _elt->ack = _elt->end == _ack ? _ack : 0; \
212 _elt->snd_una_max = _elt->end == _ack ? _tc->snd_una_max : 0; \
213 _elt->group = _group; \
217 #define tcp_scoreboard_trace_add(_tc, _ack)
220 sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
221 sack_scoreboard_hole_t *
222 start, u8 have_sent_1_smss,
225 sack_scoreboard_hole_t *scoreboard_get_hole (sack_scoreboard_t * sb,
228 sack_scoreboard_hole_t *scoreboard_next_hole (sack_scoreboard_t * sb,
229 sack_scoreboard_hole_t * hole);
230 sack_scoreboard_hole_t *scoreboard_prev_hole (sack_scoreboard_t * sb,
231 sack_scoreboard_hole_t * hole);
232 sack_scoreboard_hole_t *scoreboard_first_hole (sack_scoreboard_t * sb);
233 sack_scoreboard_hole_t *scoreboard_last_hole (sack_scoreboard_t * sb);
234 void scoreboard_clear (sack_scoreboard_t * sb);
235 void scoreboard_init (sack_scoreboard_t * sb);
236 u8 *format_tcp_scoreboard (u8 * s, va_list * args);
238 #define TCP_BTS_INVALID_INDEX ((u32)~0)
240 typedef enum tcp_bts_flags_
243 TCP_BTS_IS_APP_LIMITED = 1 << 1,
244 } __clib_packed tcp_bts_flags_t;
246 typedef struct tcp_bt_sample_
248 u32 next; /**< Next sample index in list */
249 u32 prev; /**< Previous sample index in list */
250 u32 min_seq; /**< Min seq number in sample */
251 u32 max_seq; /**< Max seq number. Set for rxt samples */
252 u64 delivered; /**< Total delivered bytes for sample */
253 f64 delivered_time; /**< Delivered time when sample taken */
254 f64 tx_time; /**< Transmit time for the burst */
255 u64 tx_rate; /**< Tx pacing rate */
256 tcp_bts_flags_t flags; /**< Sample flag */
259 typedef struct tcp_rate_sample_
261 u64 prior_delivered; /**< Delivered of sample used for rate, i.e.,
262 total bytes delivered at prior_time */
263 f64 prior_time; /**< Delivered time of sample used for rate */
264 f64 interval_time; /**< Time to ack the bytes delivered */
265 f64 rtt_time; /**< RTT for sample */
266 u64 tx_rate; /**< Tx pacing rate */
267 u32 delivered; /**< Bytes delivered in interval_time */
268 u32 acked_and_sacked; /**< Bytes acked + sacked now */
269 u32 lost; /**< Bytes lost now */
270 tcp_bts_flags_t flags; /**< Rate sample flags from bt sample */
273 typedef struct tcp_byte_tracker_
275 tcp_bt_sample_t *samples; /**< Pool of samples */
276 rb_tree_t sample_lookup; /**< Rbtree for sample lookup by min_seq */
277 u32 head; /**< Head of samples linked list */
278 u32 tail; /**< Tail of samples linked list */
279 u32 last_ooo; /**< Cached last ooo sample */
280 } tcp_byte_tracker_t;
282 typedef enum _tcp_cc_algorithm_type
286 TCP_CC_LAST = TCP_CC_CUBIC
287 } tcp_cc_algorithm_type_e;
289 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
291 typedef enum _tcp_cc_ack_t
298 typedef enum tcp_cc_event_
303 typedef struct _tcp_connection
305 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
306 transport_connection_t connection; /**< Common transport data. First! */
308 u8 state; /**< TCP state as per tcp_state_t */
309 u16 flags; /**< Connection flags (see tcp_conn_flags_e) */
310 u32 timers[TCP_N_TIMERS]; /**< Timer handles into timer wheel */
314 /** Send sequence variables RFC793 */
315 u32 snd_una; /**< oldest unacknowledged sequence number */
316 u32 snd_una_max; /**< newest unacknowledged sequence number + 1*/
317 u32 snd_wnd; /**< send window */
318 u32 snd_wl1; /**< seq number used for last snd.wnd update */
319 u32 snd_wl2; /**< ack number used for last snd.wnd update */
320 u32 snd_nxt; /**< next seq number to be sent */
321 u16 snd_mss; /**< Effective send max seg (data) size */
323 /** Receive sequence variables RFC793 */
324 u32 rcv_nxt; /**< next sequence number expected */
325 u32 rcv_wnd; /**< receive window we expect */
327 u32 rcv_las; /**< rcv_nxt at last ack sent/rcv_wnd update */
328 u32 iss; /**< initial sent sequence */
329 u32 irs; /**< initial remote sequence */
332 u8 snd_opts_len; /**< Tx options len */
333 u8 rcv_wscale; /**< Window scale to advertise to peer */
334 u8 snd_wscale; /**< Window scale to use when sending */
335 u32 tsval_recent; /**< Last timestamp received */
336 u32 tsval_recent_age; /**< When last updated tstamp_recent*/
337 tcp_options_t snd_opts; /**< Tx options for connection */
338 tcp_options_t rcv_opts; /**< Rx options for connection */
340 sack_block_t *snd_sacks; /**< Vector of SACKs to send. XXX Fixed size? */
341 u8 snd_sack_pos; /**< Position in vec of first block to send */
342 sack_block_t *snd_sacks_fl; /**< Vector for building new list */
343 sack_scoreboard_t sack_sb; /**< SACK "scoreboard" that tracks holes */
345 u16 rcv_dupacks; /**< Number of DUPACKs received */
346 u8 pending_dupacks; /**< Number of DUPACKs to be sent */
348 /* Congestion control */
349 u32 cwnd; /**< Congestion window */
350 u32 cwnd_acc_bytes; /**< Bytes accumulated for cwnd increment */
351 u32 ssthresh; /**< Slow-start threshold */
352 u32 prev_ssthresh; /**< ssthresh before congestion */
353 u32 prev_cwnd; /**< ssthresh before congestion */
354 u32 bytes_acked; /**< Bytes acknowledged by current segment */
355 u32 burst_acked; /**< Bytes acknowledged in current burst */
356 u32 snd_rxt_bytes; /**< Retransmitted bytes */
357 u32 snd_rxt_ts; /**< Timestamp when first packet is retransmitted */
358 u32 tsecr_last_ack; /**< Timestamp echoed to us in last healthy ACK */
359 u32 snd_congestion; /**< snd_una_max when congestion is detected */
360 u32 tx_fifo_size; /**< Tx fifo size. Used to constrain cwnd */
361 tcp_cc_algorithm_t *cc_algo; /**< Congestion control algorithm */
362 u8 cc_data[TCP_CC_DATA_SZ]; /**< Congestion control algo private data */
365 u32 rto; /**< Retransmission timeout */
366 u32 rto_boff; /**< Index for RTO backoff */
367 u32 srtt; /**< Smoothed RTT */
368 u32 rttvar; /**< Smoothed mean RTT difference. Approximates variance */
369 u32 rtt_seq; /**< Sequence number for tracked ACK */
370 f64 rtt_ts; /**< Timestamp for tracked ACK */
371 f64 mrtt_us; /**< High precision mrtt from tracked acks */
373 u32 psh_seq; /**< Add psh header for seg that includes this */
374 u32 next_node_index; /**< Can be used to control next node in output */
375 u32 next_node_opaque; /**< Opaque to pass to next node */
376 u32 limited_transmit; /**< snd_nxt when limited transmit starts */
377 u32 sw_if_index; /**< Interface for the connection */
379 /* Delivery rate estimation */
380 u64 delivered; /**< Total bytes delivered to peer */
381 u64 app_limited; /**< Delivered when app-limited detected */
382 f64 delivered_time; /**< Time last bytes were acked */
383 tcp_byte_tracker_t *bt; /**< Tx byte tracker */
385 u32 last_fib_check; /**< Last time we checked fib route for peer */
386 u16 mss; /**< Our max seg size that includes options */
391 struct _tcp_cc_algorithm
394 uword (*unformat_cfg) (unformat_input_t * input);
395 void (*init) (tcp_connection_t * tc);
396 void (*cleanup) (tcp_connection_t * tc);
397 void (*rcv_ack) (tcp_connection_t * tc, tcp_rate_sample_t *rs);
398 void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack,
399 tcp_rate_sample_t *rs);
400 void (*congestion) (tcp_connection_t * tc);
401 void (*loss) (tcp_connection_t * tc);
402 void (*recovered) (tcp_connection_t * tc);
403 void (*undo_recovery) (tcp_connection_t * tc);
404 void (*event) (tcp_connection_t *tc, tcp_cc_event_t evt);
408 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
409 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
410 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
411 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
412 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
413 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
414 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
415 #define tcp_disconnect_pending(tc) ((tc)->flags & TCP_CONN_DCNT_PENDING)
416 #define tcp_disconnect_pending_on(tc) ((tc)->flags |= TCP_CONN_DCNT_PENDING)
417 #define tcp_disconnect_pending_off(tc) ((tc)->flags &= ~TCP_CONN_DCNT_PENDING)
418 #define tcp_fastrecovery_first(tc) ((tc)->flags & TCP_CONN_FRXT_FIRST)
419 #define tcp_fastrecovery_first_on(tc) ((tc)->flags |= TCP_CONN_FRXT_FIRST)
420 #define tcp_fastrecovery_first_off(tc) ((tc)->flags &= ~TCP_CONN_FRXT_FIRST)
422 #define tcp_in_cong_recovery(tc) ((tc)->flags & \
423 (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
426 tcp_cong_recovery_off (tcp_connection_t * tc)
428 tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
429 tcp_fastrecovery_first_off (tc);
432 #define tcp_zero_rwnd_sent(tc) (tc)->flags &= TCP_CONN_ZERO_RWND_SENT
433 #define tcp_zero_rwnd_sent_on(tc) (tc)->flags |= TCP_CONN_ZERO_RWND_SENT
434 #define tcp_zero_rwnd_sent_off(tc) (tc)->flags &= ~TCP_CONN_ZERO_RWND_SENT
436 typedef enum _tcp_error
438 #define tcp_error(n,s) TCP_ERROR_##n,
439 #include <vnet/tcp/tcp_error.def>
444 typedef struct _tcp_lookup_dispatch
447 } tcp_lookup_dispatch_t;
449 typedef struct tcp_worker_ctx_
451 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
455 /** worker timer wheel */
456 tw_timer_wheel_16t_2w_512sl_t timer_wheel;
458 /** tx buffer free list */
461 /** tx frames for tcp 4/6 output nodes */
462 vlib_frame_t *tx_frames[2];
464 /** tx frames for ip 4/6 lookup nodes */
465 vlib_frame_t *ip_lookup_tx_frames[2];
467 /** vector of pending ack dequeues */
468 u32 *pending_deq_acked;
470 /** vector of pending disconnect notifications */
471 u32 *pending_disconnects;
473 /** convenience pointer to this thread's vlib main */
476 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
478 /** cached 'on the wire' options for bursts */
483 typedef struct tcp_iss_seed_
489 typedef struct _tcp_main
491 /* Per-worker thread tcp connection pools */
492 tcp_connection_t **connections;
494 /* Pool of listeners. */
495 tcp_connection_t *listener_pool;
497 /** Dispatch table by state and flags */
498 tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
500 u8 log2_tstamp_clocks_per_tick;
501 f64 tstamp_ticks_per_clock;
503 /** per-worker context */
504 tcp_worker_ctx_t *wrk_ctx;
506 /* Pool of half-open connections on which we've sent a SYN */
507 tcp_connection_t *half_open_connections;
508 clib_spinlock_t half_open_lock;
510 /** vlib buffer size */
511 u32 bytes_per_buffer;
513 /* Seed used to generate random iss */
514 tcp_iss_seed_t iss_seed;
516 /* Congestion control algorithms registered */
517 tcp_cc_algorithm_t *cc_algos;
519 /** Hash table of cc algorithms by name */
520 uword *cc_algo_by_name;
522 /** Last cc algo registered */
523 tcp_cc_algorithm_type_e cc_last_type;
529 /* Flag that indicates if stack is on or off */
532 /** Max rx fifo size for a session. It is used in to compute the
533 * rfc 7323 window scaling factor */
536 /** Default MTU to be used when establishing connections */
539 /** Initial CWND multiplier, which multiplies MSS to determine initial CWND.
540 * Set 0 to determine the initial CWND by another way */
541 u16 initial_cwnd_multiplier;
543 /** Number of preallocated connections */
544 u32 preallocated_connections;
545 u32 preallocated_half_open_connections;
547 /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
548 ip4_address_t *ip4_src_addresses;
549 u32 last_v4_address_rotor;
550 u32 last_v6_address_rotor;
551 ip6_address_t *ip6_src_addresses;
553 /** Enable tx pacing for new connections */
559 /** fault-injection */
560 f64 buffer_fail_fraction;
562 /** Default congestion control algorithm type */
563 tcp_cc_algorithm_type_e cc_algo;
566 extern tcp_main_t tcp_main;
567 extern vlib_node_registration_t tcp4_input_node;
568 extern vlib_node_registration_t tcp6_input_node;
569 extern vlib_node_registration_t tcp4_output_node;
570 extern vlib_node_registration_t tcp6_output_node;
571 extern vlib_node_registration_t tcp4_established_node;
572 extern vlib_node_registration_t tcp6_established_node;
573 extern vlib_node_registration_t tcp4_syn_sent_node;
574 extern vlib_node_registration_t tcp6_syn_sent_node;
575 extern vlib_node_registration_t tcp4_rcv_process_node;
576 extern vlib_node_registration_t tcp6_rcv_process_node;
577 extern vlib_node_registration_t tcp4_listen_node;
578 extern vlib_node_registration_t tcp6_listen_node;
580 always_inline tcp_main_t *
586 always_inline tcp_worker_ctx_t *
587 tcp_get_worker (u32 thread_index)
589 return &tcp_main.wrk_ctx[thread_index];
592 always_inline tcp_header_t *
593 tcp_buffer_hdr (vlib_buffer_t * b)
595 ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
596 return (tcp_header_t *) (b->data + b->current_data
597 + vnet_buffer (b)->tcp.hdr_offset);
600 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
601 #define tcp_trajectory_add_start(b, start) \
603 (*vlib_buffer_trace_trajectory_cb) (b, start); \
606 #define tcp_trajectory_add_start(b, start)
609 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
611 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
613 always_inline tcp_connection_t *
614 tcp_connection_get (u32 conn_index, u32 thread_index)
617 (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
619 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
622 always_inline tcp_connection_t *
623 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
625 if (tcp_main.connections[thread_index] == 0)
627 if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
629 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
632 always_inline tcp_connection_t *
633 tcp_get_connection_from_transport (transport_connection_t * tconn)
635 return (tcp_connection_t *) tconn;
639 tcp_connection_set_state (tcp_connection_t * tc, tcp_state_t state)
642 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
645 void tcp_connection_close (tcp_connection_t * tc);
646 void tcp_connection_cleanup (tcp_connection_t * tc);
647 void tcp_connection_del (tcp_connection_t * tc);
648 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
649 tcp_connection_t *tcp_connection_alloc (u8 thread_index);
650 void tcp_connection_free (tcp_connection_t * tc);
651 void tcp_connection_reset (tcp_connection_t * tc);
652 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
653 ip4_address_t * start,
654 ip4_address_t * end, u32 table_id);
655 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
656 ip6_address_t * start,
657 ip6_address_t * end, u32 table_id);
658 void tcp_api_reference (void);
659 u8 *format_tcp_connection (u8 * s, va_list * args);
661 always_inline tcp_connection_t *
662 tcp_listener_get (u32 tli)
664 return pool_elt_at_index (tcp_main.listener_pool, tli);
667 always_inline tcp_connection_t *
668 tcp_half_open_connection_get (u32 conn_index)
670 tcp_connection_t *tc = 0;
671 clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
672 if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
673 tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
674 clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
678 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
679 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
680 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
681 u32 thread_index, u8 is_ip4);
682 void tcp_send_reset (tcp_connection_t * tc);
683 void tcp_send_syn (tcp_connection_t * tc);
684 void tcp_send_synack (tcp_connection_t * tc);
685 void tcp_send_fin (tcp_connection_t * tc);
686 void tcp_init_mss (tcp_connection_t * tc);
687 void tcp_update_burst_snd_vars (tcp_connection_t * tc);
688 void tcp_update_rto (tcp_connection_t * tc);
689 void tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4);
690 void tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk);
691 void tcp_send_window_update_ack (tcp_connection_t * tc);
693 void tcp_program_ack (tcp_connection_t * tc);
694 void tcp_program_dupack (tcp_connection_t * tc);
695 void tcp_program_fastretransmit (tcp_connection_t * tc);
702 * Byte tracker initialize
704 * @param tc connection for which the byte tracker should be allocated and
707 void tcp_bt_init (tcp_connection_t * tc);
709 * Byte tracker cleanup
711 * @param tc connection for which the byte tracker should be cleaned up
713 void tcp_bt_cleanup (tcp_connection_t * tc);
715 * Flush byte tracker samples
717 * @param tc tcp connection for which samples should be flushed
719 void tcp_bt_flush_samples (tcp_connection_t * tc);
721 * Track a tcp tx burst
723 * @param tc tcp connection
725 void tcp_bt_track_tx (tcp_connection_t * tc);
727 * Track a tcp retransmission
729 * @param tc tcp connection
730 * @param start start sequence number
731 * @param end end sequence number
733 void tcp_bt_track_rxt (tcp_connection_t * tc, u32 start, u32 end);
735 * Generate a delivery rate sample from recently acked bytes
737 * @param tc tcp connection
738 * @param rs resulting rate sample
740 void tcp_bt_sample_delivery_rate (tcp_connection_t * tc,
741 tcp_rate_sample_t * rs);
743 * Check if sample to be generated is app limited
745 * @param tc tcp connection
747 void tcp_bt_check_app_limited (tcp_connection_t * tc);
749 * Check if the byte tracker is in sane state
751 * Should be used only for testing
753 * @param bt byte tracker
755 int tcp_bt_is_sane (tcp_byte_tracker_t * bt);
758 tcp_end_seq (tcp_header_t * th, u32 len)
760 return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
763 /* Modulo arithmetic for TCP sequence numbers */
764 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
765 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
766 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
767 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
768 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
770 /* Modulo arithmetic for timestamps */
771 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
772 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
775 * Our estimate of the number of bytes that have left the network
778 tcp_bytes_out (const tcp_connection_t * tc)
780 if (tcp_opts_sack_permitted (&tc->rcv_opts))
781 return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
783 return tc->rcv_dupacks * tc->snd_mss;
787 * Our estimate of the number of bytes in flight (pipe size)
790 tcp_flight_size (const tcp_connection_t * tc)
794 flight_size = (int) (tc->snd_nxt - tc->snd_una) - tcp_bytes_out (tc)
801 ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
802 tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
803 tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
812 * Initial cwnd as per RFC5681
815 tcp_initial_cwnd (const tcp_connection_t * tc)
817 if (tcp_main.initial_cwnd_multiplier > 0)
818 return tcp_main.initial_cwnd_multiplier * tc->snd_mss;
820 if (tc->snd_mss > 2190)
821 return 2 * tc->snd_mss;
822 else if (tc->snd_mss > 1095)
823 return 3 * tc->snd_mss;
825 return 4 * tc->snd_mss;
829 * Accumulate acked bytes for cwnd increase
831 * Once threshold bytes are accumulated, snd_mss bytes are added
835 tcp_cwnd_accumulate (tcp_connection_t * tc, u32 thresh, u32 bytes)
837 tc->cwnd_acc_bytes += bytes;
838 if (tc->cwnd_acc_bytes >= thresh)
840 u32 inc = tc->cwnd_acc_bytes / thresh;
841 tc->cwnd_acc_bytes -= inc * thresh;
842 tc->cwnd += inc * tc->snd_mss;
843 tc->cwnd = clib_min (tc->cwnd, tc->tx_fifo_size);
848 tcp_loss_wnd (const tcp_connection_t * tc)
854 tcp_available_snd_wnd (const tcp_connection_t * tc)
856 return clib_min (tc->cwnd, tc->snd_wnd);
860 tcp_available_output_snd_space (const tcp_connection_t * tc)
862 u32 available_wnd = tcp_available_snd_wnd (tc);
863 int flight_size = (int) (tc->snd_nxt - tc->snd_una);
865 if (available_wnd <= flight_size)
868 return available_wnd - flight_size;
872 * Estimate of how many bytes we can still push into the network
875 tcp_available_cc_snd_space (const tcp_connection_t * tc)
877 u32 available_wnd = tcp_available_snd_wnd (tc);
878 u32 flight_size = tcp_flight_size (tc);
880 if (available_wnd <= flight_size)
883 return available_wnd - flight_size;
887 tcp_is_lost_fin (tcp_connection_t * tc)
889 if ((tc->flags & TCP_CONN_FINSNT) && tc->snd_una_max - tc->snd_una == 1)
894 u32 tcp_snd_space (tcp_connection_t * tc);
895 int tcp_retransmit_first_unacked (tcp_worker_ctx_t * wrk,
896 tcp_connection_t * tc);
897 int tcp_fast_retransmit_no_sack (tcp_worker_ctx_t * wrk,
898 tcp_connection_t * tc, u32 burst_size);
899 int tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
901 int tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
903 void tcp_cc_init_congestion (tcp_connection_t * tc);
904 void tcp_cc_fastrecovery_clear (tcp_connection_t * tc);
906 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
908 /* Made public for unit testing only */
909 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
910 u32 tcp_sack_list_bytes (tcp_connection_t * tc);
915 return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
919 tcp_time_now_w_thread (u32 thread_index)
921 return tcp_main.wrk_ctx[thread_index].time_now;
925 * Generate timestamp for tcp connection
928 tcp_tstamp (tcp_connection_t * tc)
930 return (tcp_main.wrk_ctx[tc->c_thread_index].time_now -
931 tc->timestamp_delta);
935 tcp_time_now_us (u32 thread_index)
937 return transport_time_now (thread_index);
941 tcp_set_time_now (tcp_worker_ctx_t * wrk)
943 wrk->time_now = clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
944 return wrk->time_now;
947 u32 tcp_session_push_header (transport_connection_t * tconn,
949 int tcp_session_custom_tx (void *conn, u32 max_burst_size);
951 void tcp_connection_timers_init (tcp_connection_t * tc);
952 void tcp_connection_timers_reset (tcp_connection_t * tc);
953 void tcp_init_snd_vars (tcp_connection_t * tc);
954 void tcp_connection_init_vars (tcp_connection_t * tc);
955 void tcp_connection_tx_pacer_update (tcp_connection_t * tc);
956 void tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
960 tcp_cc_rcv_ack (tcp_connection_t * tc, tcp_rate_sample_t * rs)
962 tc->cc_algo->rcv_ack (tc, rs);
963 tc->tsecr_last_ack = tc->rcv_opts.tsecr;
967 tcp_cc_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
968 tcp_rate_sample_t * rs)
970 tc->cc_algo->rcv_cong_ack (tc, ack_type, rs);
974 tcp_cc_loss (tcp_connection_t * tc)
976 tc->cc_algo->loss (tc);
980 tcp_cc_recovered (tcp_connection_t * tc)
982 tc->cc_algo->recovered (tc);
986 tcp_cc_undo_recovery (tcp_connection_t * tc)
988 if (tc->cc_algo->undo_recovery)
989 tc->cc_algo->undo_recovery (tc);
993 tcp_cc_event (tcp_connection_t * tc, tcp_cc_event_t evt)
995 if (tc->cc_algo->event)
996 tc->cc_algo->event (tc, evt);
1000 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
1002 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1003 ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
1004 tc->timers[timer_id] =
1005 tw_timer_start_16t_2w_512sl (&tcp_main.
1006 wrk_ctx[tc->c_thread_index].timer_wheel,
1007 tc->c_c_index, timer_id, interval);
1011 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
1013 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1014 if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
1017 tw_timer_stop_16t_2w_512sl (&tcp_main.
1018 wrk_ctx[tc->c_thread_index].timer_wheel,
1019 tc->timers[timer_id]);
1020 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1024 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
1026 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1027 if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
1028 tw_timer_update_16t_2w_512sl (&tcp_main.
1029 wrk_ctx[tc->c_thread_index].timer_wheel,
1030 tc->timers[timer_id], interval);
1032 tc->timers[timer_id] =
1033 tw_timer_start_16t_2w_512sl (&tcp_main.
1034 wrk_ctx[tc->c_thread_index].timer_wheel,
1035 tc->c_c_index, timer_id, interval);
1039 tcp_retransmit_timer_set (tcp_connection_t * tc)
1041 ASSERT (tc->snd_una != tc->snd_una_max);
1042 tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
1043 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1047 tcp_retransmit_timer_reset (tcp_connection_t * tc)
1049 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
1053 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
1055 tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1056 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1060 tcp_persist_timer_set (tcp_connection_t * tc)
1062 /* Reuse RTO. It's backed off in handler */
1063 tcp_timer_set (tc, TCP_TIMER_PERSIST,
1064 clib_max (tc->rto * TCP_TO_TIMER_TICK,
1065 TCP_TIMER_PERSIST_MIN));
1069 tcp_persist_timer_update (tcp_connection_t * tc)
1071 tcp_timer_update (tc, TCP_TIMER_PERSIST,
1072 clib_max (tc->rto * TCP_TO_TIMER_TICK,
1073 TCP_TIMER_PERSIST_MIN));
1077 tcp_persist_timer_reset (tcp_connection_t * tc)
1079 tcp_timer_reset (tc, TCP_TIMER_PERSIST);
1083 tcp_retransmit_timer_update (tcp_connection_t * tc)
1085 if (tc->snd_una == tc->snd_nxt)
1087 tcp_retransmit_timer_reset (tc);
1088 if (tc->snd_wnd < tc->snd_mss)
1089 tcp_persist_timer_update (tc);
1092 tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1093 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1097 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
1099 return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
1102 #define tcp_validate_txf_size(_tc, _a) \
1103 ASSERT(_tc->state != TCP_STATE_ESTABLISHED \
1104 || transport_max_tx_dequeue (&_tc->connection) >= _a)
1106 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
1107 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
1110 * Register exiting cc algo type
1112 void tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
1113 const tcp_cc_algorithm_t * vft);
1116 * Register new cc algo type
1118 tcp_cc_algorithm_type_e tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft);
1119 tcp_cc_algorithm_t *tcp_cc_algo_get (tcp_cc_algorithm_type_e type);
1121 static inline void *
1122 tcp_cc_data (tcp_connection_t * tc)
1124 return (void *) tc->cc_data;
1127 void newreno_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
1128 tcp_rate_sample_t * rs);
1131 * Push TCP header to buffer
1133 * @param vm - vlib_main
1134 * @param b - buffer to write the header to
1135 * @param sp_net - source port net order
1136 * @param dp_net - destination port net order
1137 * @param seq - sequence number net order
1138 * @param ack - ack number net order
1139 * @param tcp_hdr_opts_len - header and options length in bytes
1140 * @param flags - header flags
1141 * @param wnd - window size
1143 * @return - pointer to start of TCP header
1145 always_inline void *
1146 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
1147 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
1152 th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
1156 th->seq_number = seq;
1157 th->ack_number = ack;
1158 th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
1162 th->urgent_pointer = 0;
1167 * Push TCP header to buffer
1169 * @param b - buffer to write the header to
1170 * @param sp_net - source port net order
1171 * @param dp_net - destination port net order
1172 * @param seq - sequence number host order
1173 * @param ack - ack number host order
1174 * @param tcp_hdr_opts_len - header and options length in bytes
1175 * @param flags - header flags
1176 * @param wnd - window size
1178 * @return - pointer to start of TCP header
1180 always_inline void *
1181 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
1182 u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
1184 return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
1185 clib_host_to_net_u32 (seq),
1186 clib_host_to_net_u32 (ack),
1187 tcp_hdr_opts_len, flags,
1188 clib_host_to_net_u16 (wnd));
1191 #endif /* _vnet_tcp_h_ */
1194 * fd.io coding-style-patch-verification: ON
1197 * eval: (c-set-style "gnu")