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:
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>
26 #define TCP_TICK 10e-3 /**< TCP tick period (s) */
27 #define THZ 1/TCP_TICK /**< TCP tick frequency */
28 #define TCP_TSTAMP_RESOLUTION TCP_TICK /**< Time stamp resolution */
29 #define TCP_PAWS_IDLE 24 * 24 * 60 * 60 * THZ /**< 24 days */
30 #define TCP_MAX_OPTION_SPACE 40
32 #define TCP_DUPACK_THRESHOLD 3
33 #define TCP_MAX_RX_FIFO_SIZE 2 << 20
34 #define TCP_IW_N_SEGMENTS 10
36 /** TCP FSM state definitions as per RFC793. */
37 #define foreach_tcp_fsm_state \
40 _(SYN_SENT, "SYN_SENT") \
41 _(SYN_RCVD, "SYN_RCVD") \
42 _(ESTABLISHED, "ESTABLISHED") \
43 _(CLOSE_WAIT, "CLOSE_WAIT") \
44 _(FIN_WAIT_1, "FIN_WAIT_1") \
45 _(LAST_ACK, "LAST_ACK") \
46 _(CLOSING, "CLOSING") \
47 _(FIN_WAIT_2, "FIN_WAIT_2") \
48 _(TIME_WAIT, "TIME_WAIT")
50 typedef enum _tcp_state
52 #define _(sym, str) TCP_STATE_##sym,
58 format_function_t format_tcp_state;
61 #define foreach_tcp_timer \
62 _(RETRANSMIT, "RETRANSMIT") \
63 _(DELACK, "DELAYED ACK") \
64 _(PERSIST, "PERSIST") \
66 _(WAITCLOSE, "WAIT CLOSE") \
67 _(RETRANSMIT_SYN, "RETRANSMIT SYN") \
68 _(ESTABLISH, "ESTABLISH")
70 typedef enum _tcp_timers
72 #define _(sym, str) TCP_TIMER_##sym,
78 typedef void (timer_expiration_handler) (u32 index);
80 extern timer_expiration_handler tcp_timer_delack_handler;
81 extern timer_expiration_handler tcp_timer_retransmit_handler;
82 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
84 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
86 /* Timer delays as multiples of 100ms */
87 #define TCP_TO_TIMER_TICK TCP_TICK*10 /* Period for converting from TCP
88 * ticks to timer units */
89 #define TCP_DELACK_TIME 1 /* 0.1s */
90 #define TCP_ESTABLISH_TIME 750 /* 75s */
91 #define TCP_2MSL_TIME 300 /* 30s */
92 #define TCP_CLOSEWAIT_TIME 1 /* 0.1s */
93 #define TCP_CLEANUP_TIME 5 /* 0.5s Time to wait before cleanup */
95 #define TCP_RTO_MAX 60 * THZ /* Min max RTO (60s) as per RFC6298 */
96 #define TCP_RTT_MAX 30 * THZ /* 30s (probably too much) */
97 #define TCP_RTO_SYN_RETRIES 3 /* SYN retries without doubling RTO */
98 #define TCP_RTO_INIT 1 * THZ /* Initial retransmit timer */
100 void tcp_update_time (f64 now, u32 thread_index);
102 /** TCP connection flags */
103 #define foreach_tcp_connection_flag \
104 _(DELACK, "Delay ACK") \
105 _(SNDACK, "Send ACK") \
106 _(BURSTACK, "Burst ACK set") \
107 _(FINSNT, "FIN sent") \
108 _(SENT_RCV_WND0, "Sent 0 receive window") \
109 _(RECOVERY, "Recovery on") \
110 _(FAST_RECOVERY, "Fast Recovery on")
112 typedef enum _tcp_connection_flag_bits
114 #define _(sym, str) TCP_CONN_##sym##_BIT,
115 foreach_tcp_connection_flag
118 } tcp_connection_flag_bits_e;
120 typedef enum _tcp_connection_flag
122 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
123 foreach_tcp_connection_flag
126 } tcp_connection_flags_e;
128 /** TCP buffer flags */
129 #define foreach_tcp_buf_flag \
130 _ (ACK) /**< Sending ACK. */ \
131 _ (DUPACK) /**< Sending DUPACK. */ \
135 #define _(f) TCP_BUF_BIT_##f,
143 #define _(f) TCP_BUF_FLAG_##f = 1 << TCP_BUF_BIT_##f,
148 #define TCP_MAX_SACK_BLOCKS 5 /**< Max number of SACK blocks stored */
149 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
151 typedef struct _sack_scoreboard_hole
153 u32 next; /**< Index for next entry in linked list */
154 u32 prev; /**< Index for previous entry in linked list */
155 u32 start; /**< Start sequence number */
156 u32 end; /**< End sequence number */
157 } sack_scoreboard_hole_t;
159 typedef struct _sack_scoreboard
161 sack_scoreboard_hole_t *holes; /**< Pool of holes */
162 u32 head; /**< Index to first entry */
163 u32 sacked_bytes; /**< Number of bytes sacked in sb */
166 typedef enum _tcp_cc_algorithm_type
169 } tcp_cc_algorithm_type_e;
171 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
173 typedef enum _tcp_cc_ack_t
180 typedef struct _tcp_connection
182 transport_connection_t connection; /**< Common transport data. First! */
184 u8 state; /**< TCP state as per tcp_state_t */
185 u16 flags; /**< Connection flags (see tcp_conn_flags_e) */
186 u32 timers[TCP_N_TIMERS]; /**< Timer handles into timer wheel */
190 /** Send sequence variables RFC793 */
191 u32 snd_una; /**< oldest unacknowledged sequence number */
192 u32 snd_una_max; /**< newest unacknowledged sequence number + 1*/
193 u32 snd_wnd; /**< send window */
194 u32 snd_wl1; /**< seq number used for last snd.wnd update */
195 u32 snd_wl2; /**< ack number used for last snd.wnd update */
196 u32 snd_nxt; /**< next seq number to be sent */
198 /** Receive sequence variables RFC793 */
199 u32 rcv_nxt; /**< next sequence number expected */
200 u32 rcv_wnd; /**< receive window we expect */
202 u32 rcv_las; /**< rcv_nxt at last ack sent/rcv_wnd update */
203 u32 iss; /**< initial sent sequence */
204 u32 irs; /**< initial remote sequence */
207 tcp_options_t opt; /**< TCP connection options parsed */
208 u8 rcv_wscale; /**< Window scale to advertise to peer */
209 u8 snd_wscale; /**< Window scale to use when sending */
210 u32 tsval_recent; /**< Last timestamp received */
211 u32 tsval_recent_age; /**< When last updated tstamp_recent*/
213 sack_block_t *snd_sacks; /**< Vector of SACKs to send. XXX Fixed size? */
214 sack_scoreboard_t sack_sb; /**< SACK "scoreboard" that tracks holes */
216 u8 rcv_dupacks; /**< Number of DUPACKs received */
217 u8 snt_dupacks; /**< Number of DUPACKs sent in a burst */
219 /* Congestion control */
220 u32 cwnd; /**< Congestion window */
221 u32 ssthresh; /**< Slow-start threshold */
222 u32 prev_ssthresh; /**< ssthresh before congestion */
223 u32 bytes_acked; /**< Bytes acknowledged by current segment */
224 u32 rtx_bytes; /**< Retransmitted bytes */
225 u32 tsecr_last_ack; /**< Timestamp echoed to us in last health ACK */
226 tcp_cc_algorithm_t *cc_algo; /**< Congestion control algorithm */
229 u32 rto; /**< Retransmission timeout */
230 u32 rto_boff; /**< Index for RTO backoff */
231 u32 srtt; /**< Smoothed RTT */
232 u32 rttvar; /**< Smoothed mean RTT difference. Approximates variance */
233 u32 rtt_ts; /**< Timestamp for tracked ACK */
234 u32 rtt_seq; /**< Sequence number for tracked ACK */
236 u16 snd_mss; /**< Send MSS */
239 struct _tcp_cc_algorithm
241 void (*rcv_ack) (tcp_connection_t * tc);
242 void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
243 void (*congestion) (tcp_connection_t * tc);
244 void (*recovered) (tcp_connection_t * tc);
245 void (*init) (tcp_connection_t * tc);
248 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
249 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
250 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
251 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
252 #define tcp_recovery_off(tc) ((tc)->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
253 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
262 typedef enum _tcp_error
264 #define tcp_error(n,s) TCP_ERROR_##n,
265 #include <vnet/tcp/tcp_error.def>
270 typedef struct _tcp_lookup_dispatch
273 } tcp_lookup_dispatch_t;
275 typedef struct _tcp_main
277 /* Per-worker thread tcp connection pools */
278 tcp_connection_t **connections;
280 /* Pool of listeners. */
281 tcp_connection_t *listener_pool;
283 /** Dispatch table by state and flags */
284 tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
286 u8 log2_tstamp_clocks_per_tick;
287 f64 tstamp_ticks_per_clock;
289 /** per-worker tx buffer free lists */
292 /* Per worker-thread timer wheel for connections timers */
293 tw_timer_wheel_16t_2w_512sl_t *timer_wheels;
295 /* Convenience per worker-thread vector of connections to DELACK */
296 u32 **delack_connections;
298 /* Pool of half-open connections on which we've sent a SYN */
299 tcp_connection_t *half_open_connections;
301 /* Pool of local TCP endpoints */
302 transport_endpoint_t *local_endpoints;
304 /* Local endpoints lookup table */
305 transport_endpoint_table_t local_endpoints_table;
307 /* Congestion control algorithms registered */
308 tcp_cc_algorithm_t *cc_algos;
310 /* Flag that indicates if stack is on or off */
314 vlib_main_t *vlib_main;
315 vnet_main_t *vnet_main;
316 ip4_main_t *ip4_main;
317 ip6_main_t *ip6_main;
320 extern tcp_main_t tcp_main;
321 extern vlib_node_registration_t tcp4_input_node;
322 extern vlib_node_registration_t tcp6_input_node;
323 extern vlib_node_registration_t tcp4_output_node;
324 extern vlib_node_registration_t tcp6_output_node;
326 always_inline tcp_main_t *
332 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
334 always_inline tcp_connection_t *
335 tcp_connection_get (u32 conn_index, u32 thread_index)
337 if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
339 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
342 always_inline tcp_connection_t *
343 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
345 if (tcp_main.connections[thread_index] == 0)
347 if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
349 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
352 void tcp_connection_close (tcp_connection_t * tc);
353 void tcp_connection_cleanup (tcp_connection_t * tc);
354 void tcp_connection_del (tcp_connection_t * tc);
355 void tcp_connection_reset (tcp_connection_t * tc);
357 always_inline tcp_connection_t *
358 tcp_listener_get (u32 tli)
360 return pool_elt_at_index (tcp_main.listener_pool, tli);
363 always_inline tcp_connection_t *
364 tcp_half_open_connection_get (u32 conn_index)
366 return pool_elt_at_index (tcp_main.half_open_connections, conn_index);
369 void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
370 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
371 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
372 void tcp_send_reset (vlib_buffer_t * pkt, u8 is_ip4);
373 void tcp_send_syn (tcp_connection_t * tc);
374 void tcp_send_fin (tcp_connection_t * tc);
375 void tcp_set_snd_mss (tcp_connection_t * tc);
378 tcp_end_seq (tcp_header_t * th, u32 len)
380 return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
383 /* Modulo arithmetic for TCP sequence numbers */
384 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
385 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
386 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
387 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
389 /* Modulo arithmetic for timestamps */
390 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
391 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
394 tcp_flight_size (const tcp_connection_t * tc)
396 return tc->snd_una_max - tc->snd_una - tc->sack_sb.sacked_bytes
401 * Initial cwnd as per RFC5681
404 tcp_initial_cwnd (const tcp_connection_t * tc)
406 if (tc->snd_mss > 2190)
407 return 2 * tc->snd_mss;
408 else if (tc->snd_mss > 1095)
409 return 3 * tc->snd_mss;
411 return 4 * tc->snd_mss;
415 tcp_loss_wnd (const tcp_connection_t * tc)
421 tcp_available_wnd (const tcp_connection_t * tc)
423 return clib_min (tc->cwnd, tc->snd_wnd);
427 tcp_available_snd_space (const tcp_connection_t * tc)
429 u32 available_wnd = tcp_available_wnd (tc);
430 u32 flight_size = tcp_flight_size (tc);
432 if (available_wnd <= flight_size)
435 return available_wnd - flight_size;
438 void tcp_retransmit_first_unacked (tcp_connection_t * tc);
440 void tcp_fast_retransmit (tcp_connection_t * tc);
445 return clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
448 u32 tcp_push_header (transport_connection_t * tconn, vlib_buffer_t * b);
451 tcp_prepare_retransmit_segment (tcp_connection_t * tc, vlib_buffer_t * b,
454 void tcp_connection_timers_init (tcp_connection_t * tc);
455 void tcp_connection_timers_reset (tcp_connection_t * tc);
457 void tcp_connection_init_vars (tcp_connection_t * tc);
460 tcp_connection_force_ack (tcp_connection_t * tc, vlib_buffer_t * b)
462 /* Reset flags, make sure ack is sent */
463 tc->flags = TCP_CONN_SNDACK;
464 vnet_buffer (b)->tcp.flags &= ~TCP_BUF_FLAG_DUPACK;
468 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
471 = tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
472 tc->c_c_index, timer_id, interval);
476 tcp_retransmit_timer_set (tcp_connection_t * tc)
478 /* XXX Switch to faster TW */
479 tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
480 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
484 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
486 if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
489 tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
490 tc->timers[timer_id]);
491 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
495 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
497 if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
498 tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
499 tc->timers[timer_id]);
500 tc->timers[timer_id] =
501 tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
502 tc->c_c_index, timer_id, interval);
506 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
508 return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
512 scoreboard_remove_hole (sack_scoreboard_t * sb,
513 sack_scoreboard_hole_t * hole);
515 always_inline sack_scoreboard_hole_t *
516 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
518 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
519 return pool_elt_at_index (sb->holes, hole->next);
523 always_inline sack_scoreboard_hole_t *
524 scoreboard_first_hole (sack_scoreboard_t * sb)
526 if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
527 return pool_elt_at_index (sb->holes, sb->head);
532 scoreboard_clear (sack_scoreboard_t * sb)
534 sack_scoreboard_hole_t *hole = scoreboard_first_hole (sb);
535 while ((hole = scoreboard_first_hole (sb)))
537 scoreboard_remove_hole (sb, hole);
542 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
544 return hole->end - hole->start;
548 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
549 const tcp_cc_algorithm_t * vft)
551 tcp_main_t *tm = vnet_get_tcp_main ();
552 vec_validate (tm->cc_algos, type);
554 tm->cc_algos[type] = *vft;
557 always_inline tcp_cc_algorithm_t *
558 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
560 tcp_main_t *tm = vnet_get_tcp_main ();
561 return &tm->cc_algos[type];
564 void tcp_cc_init (tcp_connection_t * tc);
567 * Push TCP header to buffer
569 * @param vm - vlib_main
570 * @param b - buffer to write the header to
571 * @param sp_net - source port net order
572 * @param dp_net - destination port net order
573 * @param seq - sequence number net order
574 * @param ack - ack number net order
575 * @param tcp_hdr_opts_len - header and options length in bytes
576 * @param flags - header flags
577 * @param wnd - window size
579 * @return - pointer to start of TCP header
582 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
583 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
588 th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
592 th->seq_number = seq;
593 th->ack_number = ack;
594 th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
598 th->urgent_pointer = 0;
603 * Push TCP header to buffer
605 * @param b - buffer to write the header to
606 * @param sp_net - source port net order
607 * @param dp_net - destination port net order
608 * @param seq - sequence number host order
609 * @param ack - ack number host order
610 * @param tcp_hdr_opts_len - header and options length in bytes
611 * @param flags - header flags
612 * @param wnd - window size
614 * @return - pointer to start of TCP header
617 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
618 u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
620 return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
621 clib_host_to_net_u32 (seq),
622 clib_host_to_net_u32 (ack),
623 tcp_hdr_opts_len, flags,
624 clib_host_to_net_u16 (wnd));
627 #endif /* _vnet_tcp_h_ */
630 * fd.io coding-style-patch-verification: ON
633 * eval: (c-set-style "gnu")