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>
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
34 #define TCP_DUPACK_THRESHOLD 3
35 #define TCP_MAX_RX_FIFO_SIZE 4 << 20
36 #define TCP_MIN_RX_FIFO_SIZE 4 << 10
37 #define TCP_IW_N_SEGMENTS 10
38 #define TCP_ALWAYS_ACK 1 /**< On/off delayed acks */
39 #define TCP_USE_SACKS 1 /**< Disable only for testing */
41 /** TCP FSM state definitions as per RFC793. */
42 #define foreach_tcp_fsm_state \
45 _(SYN_SENT, "SYN_SENT") \
46 _(SYN_RCVD, "SYN_RCVD") \
47 _(ESTABLISHED, "ESTABLISHED") \
48 _(CLOSE_WAIT, "CLOSE_WAIT") \
49 _(FIN_WAIT_1, "FIN_WAIT_1") \
50 _(LAST_ACK, "LAST_ACK") \
51 _(CLOSING, "CLOSING") \
52 _(FIN_WAIT_2, "FIN_WAIT_2") \
53 _(TIME_WAIT, "TIME_WAIT")
55 typedef enum _tcp_state
57 #define _(sym, str) TCP_STATE_##sym,
63 format_function_t format_tcp_state;
64 format_function_t format_tcp_flags;
65 format_function_t format_tcp_sacks;
66 format_function_t format_tcp_rcv_sacks;
69 #define foreach_tcp_timer \
70 _(RETRANSMIT, "RETRANSMIT") \
71 _(DELACK, "DELAYED ACK") \
72 _(PERSIST, "PERSIST") \
74 _(WAITCLOSE, "WAIT CLOSE") \
75 _(RETRANSMIT_SYN, "RETRANSMIT SYN") \
76 _(ESTABLISH, "ESTABLISH")
78 typedef enum _tcp_timers
80 #define _(sym, str) TCP_TIMER_##sym,
86 typedef void (timer_expiration_handler) (u32 index);
88 extern timer_expiration_handler tcp_timer_delack_handler;
89 extern timer_expiration_handler tcp_timer_retransmit_handler;
90 extern timer_expiration_handler tcp_timer_persist_handler;
91 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
93 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
95 /* Timer delays as multiples of 100ms */
96 #define TCP_TO_TIMER_TICK TCP_TICK*10 /* Period for converting from TCP
97 * ticks to timer units */
98 #define TCP_DELACK_TIME 1 /* 0.1s */
99 #define TCP_ESTABLISH_TIME 750 /* 75s */
100 #define TCP_SYN_RCVD_TIME 600 /* 60s */
101 #define TCP_2MSL_TIME 300 /* 30s */
102 #define TCP_CLOSEWAIT_TIME 20 /* 2s */
103 #define TCP_TIMEWAIT_TIME 100 /* 10s */
104 #define TCP_CLEANUP_TIME 10 /* 1s Time to wait before cleanup */
105 #define TCP_TIMER_PERSIST_MIN 2 /* 0.2s */
107 #define TCP_RTO_MAX 60 * THZ /* Min max RTO (60s) as per RFC6298 */
108 #define TCP_RTO_MIN 0.2 * THZ /* Min RTO (200ms) - lower than standard */
109 #define TCP_RTT_MAX 30 * THZ /* 30s (probably too much) */
110 #define TCP_RTO_SYN_RETRIES 3 /* SYN retries without doubling RTO */
111 #define TCP_RTO_INIT 1 * THZ /* Initial retransmit timer */
113 /** TCP connection flags */
114 #define foreach_tcp_connection_flag \
115 _(SNDACK, "Send ACK") \
116 _(FINSNT, "FIN sent") \
117 _(SENT_RCV_WND0, "Sent 0 rcv_wnd") \
118 _(RECOVERY, "Recovery") \
119 _(FAST_RECOVERY, "Fast Recovery") \
120 _(FR_1_SMSS, "Sent 1 SMSS") \
121 _(HALF_OPEN_DONE, "Half-open completed") \
122 _(FINPNDG, "FIN pending") \
124 typedef enum _tcp_connection_flag_bits
126 #define _(sym, str) TCP_CONN_##sym##_BIT,
127 foreach_tcp_connection_flag
130 } tcp_connection_flag_bits_e;
132 typedef enum _tcp_connection_flag
134 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
135 foreach_tcp_connection_flag
138 } tcp_connection_flags_e;
140 /** TCP buffer flags */
141 #define foreach_tcp_buf_flag \
142 _ (ACK) /**< Sending ACK. */ \
143 _ (DUPACK) /**< Sending DUPACK. */ \
147 #define _(f) TCP_BUF_BIT_##f,
155 #define _(f) TCP_BUF_FLAG_##f = 1 << TCP_BUF_BIT_##f,
160 #define TCP_SCOREBOARD_TRACE (0)
161 #define TCP_MAX_SACK_BLOCKS 15 /**< Max number of SACK blocks stored */
162 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
164 typedef struct _scoreboard_trace_elt
171 } scoreboard_trace_elt_t;
173 typedef struct _sack_scoreboard_hole
175 u32 next; /**< Index for next entry in linked list */
176 u32 prev; /**< Index for previous entry in linked list */
177 u32 start; /**< Start sequence number */
178 u32 end; /**< End sequence number */
179 u8 is_lost; /**< Mark hole as lost */
180 } sack_scoreboard_hole_t;
182 typedef struct _sack_scoreboard
184 sack_scoreboard_hole_t *holes; /**< Pool of holes */
185 u32 head; /**< Index of first entry */
186 u32 tail; /**< Index of last entry */
187 u32 sacked_bytes; /**< Number of bytes sacked in sb */
188 u32 last_sacked_bytes; /**< Number of bytes last sacked */
189 u32 last_bytes_delivered; /**< Number of sack bytes delivered */
190 u32 snd_una_adv; /**< Bytes to add to snd_una */
191 u32 high_sacked; /**< Highest byte sacked (fack) */
192 u32 high_rxt; /**< Highest retransmitted sequence */
193 u32 rescue_rxt; /**< Rescue sequence number */
194 u32 lost_bytes; /**< Bytes lost as per RFC6675 */
195 u32 cur_rxt_hole; /**< Retransmitting from this hole */
197 #if TCP_SCOREBOARD_TRACE
198 scoreboard_trace_elt_t *trace;
203 #if TCP_SCOREBOARD_TRACE
204 #define tcp_scoreboard_trace_add(_tc, _ack) \
206 static u64 _group = 0; \
207 sack_scoreboard_t *_sb = &_tc->sack_sb; \
208 sack_block_t *_sack, *_sacks; \
209 scoreboard_trace_elt_t *_elt; \
212 _sacks = _tc->rcv_opts.sacks; \
213 for (i = 0; i < vec_len (_sacks); i++) \
215 _sack = &_sacks[i]; \
216 vec_add2 (_sb->trace, _elt, 1); \
217 _elt->start = _sack->start; \
218 _elt->end = _sack->end; \
219 _elt->ack = _elt->end == _ack ? _ack : 0; \
220 _elt->snd_una_max = _elt->end == _ack ? _tc->snd_una_max : 0; \
221 _elt->group = _group; \
225 #define tcp_scoreboard_trace_add(_tc, _ack)
228 typedef enum _tcp_cc_algorithm_type
231 } tcp_cc_algorithm_type_e;
233 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
235 typedef enum _tcp_cc_ack_t
242 typedef struct _tcp_connection
244 transport_connection_t connection; /**< Common transport data. First! */
246 u8 state; /**< TCP state as per tcp_state_t */
247 u16 flags; /**< Connection flags (see tcp_conn_flags_e) */
248 u32 timers[TCP_N_TIMERS]; /**< Timer handles into timer wheel */
252 /** Send sequence variables RFC793 */
253 u32 snd_una; /**< oldest unacknowledged sequence number */
254 u32 snd_una_max; /**< newest unacknowledged sequence number + 1*/
255 u32 snd_wnd; /**< send window */
256 u32 snd_wl1; /**< seq number used for last snd.wnd update */
257 u32 snd_wl2; /**< ack number used for last snd.wnd update */
258 u32 snd_nxt; /**< next seq number to be sent */
259 u16 snd_mss; /**< Effective send max seg (data) size */
261 /** Receive sequence variables RFC793 */
262 u32 rcv_nxt; /**< next sequence number expected */
263 u32 rcv_wnd; /**< receive window we expect */
265 u32 rcv_las; /**< rcv_nxt at last ack sent/rcv_wnd update */
266 u32 iss; /**< initial sent sequence */
267 u32 irs; /**< initial remote sequence */
270 tcp_options_t rcv_opts; /**< Rx options for connection */
271 tcp_options_t snd_opts; /**< Tx options for connection */
272 u8 snd_opts_len; /**< Tx options len */
273 u8 rcv_wscale; /**< Window scale to advertise to peer */
274 u8 snd_wscale; /**< Window scale to use when sending */
275 u32 tsval_recent; /**< Last timestamp received */
276 u32 tsval_recent_age; /**< When last updated tstamp_recent*/
278 sack_block_t *snd_sacks; /**< Vector of SACKs to send. XXX Fixed size? */
279 sack_scoreboard_t sack_sb; /**< SACK "scoreboard" that tracks holes */
281 u16 rcv_dupacks; /**< Number of DUPACKs received */
282 u8 snt_dupacks; /**< Number of DUPACKs sent in a burst */
284 /* Congestion control */
285 u32 cwnd; /**< Congestion window */
286 u32 cwnd_acc_bytes; /**< Bytes accumulated for cwnd increment */
287 u32 ssthresh; /**< Slow-start threshold */
288 u32 prev_ssthresh; /**< ssthresh before congestion */
289 u32 prev_cwnd; /**< ssthresh before congestion */
290 u32 bytes_acked; /**< Bytes acknowledged by current segment */
291 u32 snd_rxt_bytes; /**< Retransmitted bytes */
292 u32 snd_rxt_ts; /**< Timestamp when first packet is retransmitted */
293 u32 tsecr_last_ack; /**< Timestamp echoed to us in last healthy ACK */
294 u32 snd_congestion; /**< snd_una_max when congestion is detected */
295 tcp_cc_algorithm_t *cc_algo; /**< Congestion control algorithm */
298 u32 rto; /**< Retransmission timeout */
299 u32 rto_boff; /**< Index for RTO backoff */
300 u32 srtt; /**< Smoothed RTT */
301 u32 rttvar; /**< Smoothed mean RTT difference. Approximates variance */
302 u32 rtt_ts; /**< Timestamp for tracked ACK */
303 u32 rtt_seq; /**< Sequence number for tracked ACK */
305 u16 mss; /**< Our max seg size that includes options */
306 u32 limited_transmit; /**< snd_nxt when limited transmit starts */
307 u32 last_fib_check; /**< Last time we checked fib route for peer */
308 u32 sw_if_index; /**< Interface for the connection */
311 struct _tcp_cc_algorithm
313 void (*rcv_ack) (tcp_connection_t * tc);
314 void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
315 void (*congestion) (tcp_connection_t * tc);
316 void (*recovered) (tcp_connection_t * tc);
317 void (*init) (tcp_connection_t * tc);
320 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
321 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
322 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
323 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
324 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
325 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
326 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
327 #define tcp_fastrecovery_sent_1_smss(tc) ((tc)->flags & TCP_CONN_FR_1_SMSS)
328 #define tcp_fastrecovery_1_smss_on(tc) ((tc)->flags |= TCP_CONN_FR_1_SMSS)
329 #define tcp_fastrecovery_1_smss_off(tc) ((tc)->flags &= ~TCP_CONN_FR_1_SMSS)
331 #define tcp_in_cong_recovery(tc) ((tc)->flags & \
332 (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
335 tcp_cong_recovery_off (tcp_connection_t * tc)
337 tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
338 tcp_fastrecovery_1_smss_off (tc);
348 typedef enum _tcp_error
350 #define tcp_error(n,s) TCP_ERROR_##n,
351 #include <vnet/tcp/tcp_error.def>
356 typedef struct _tcp_lookup_dispatch
359 } tcp_lookup_dispatch_t;
361 typedef struct tcp_worker_ctx_
363 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
364 u32 time_now; /**< worker time */
365 tw_timer_wheel_16t_2w_512sl_t timer_wheel; /**< worker timer wheel */
366 u32 *tx_buffers; /**< tx buffer free list */
367 vlib_frame_t *tx_frames[2]; /**< tx frames for tcp 4/6
369 vlib_frame_t *ip_lookup_tx_frames[2]; /**< tx frames for ip 4/6
373 typedef struct _tcp_main
375 /* Per-worker thread tcp connection pools */
376 tcp_connection_t **connections;
378 /* Pool of listeners. */
379 tcp_connection_t *listener_pool;
381 /** Dispatch table by state and flags */
382 tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
384 u8 log2_tstamp_clocks_per_tick;
385 f64 tstamp_ticks_per_clock;
387 /** per-worker context */
388 tcp_worker_ctx_t *wrk_ctx;
390 /* Pool of half-open connections on which we've sent a SYN */
391 tcp_connection_t *half_open_connections;
392 clib_spinlock_t half_open_lock;
394 /* Congestion control algorithms registered */
395 tcp_cc_algorithm_t *cc_algos;
397 /* Flag that indicates if stack is on or off */
400 /** Number of preallocated connections */
401 u32 preallocated_connections;
402 u32 preallocated_half_open_connections;
404 /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
405 ip4_address_t *ip4_src_addresses;
406 u32 last_v4_address_rotor;
407 u32 last_v6_address_rotor;
408 ip6_address_t *ip6_src_addresses;
410 /** vlib buffer size */
411 u32 bytes_per_buffer;
416 /** fault-injection */
417 f64 buffer_fail_fraction;
420 extern tcp_main_t tcp_main;
421 extern vlib_node_registration_t tcp4_input_node;
422 extern vlib_node_registration_t tcp6_input_node;
423 extern vlib_node_registration_t tcp4_output_node;
424 extern vlib_node_registration_t tcp6_output_node;
426 always_inline tcp_main_t *
432 always_inline tcp_header_t *
433 tcp_buffer_hdr (vlib_buffer_t * b)
435 ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
436 return (tcp_header_t *) (b->data + b->current_data
437 + vnet_buffer (b)->tcp.hdr_offset);
440 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
441 #define tcp_trajectory_add_start(b, start) \
443 (*vlib_buffer_trace_trajectory_cb) (b, start); \
446 #define tcp_trajectory_add_start(b, start)
449 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
451 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
453 always_inline tcp_connection_t *
454 tcp_connection_get (u32 conn_index, u32 thread_index)
457 (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
459 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
462 always_inline tcp_connection_t *
463 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
465 if (tcp_main.connections[thread_index] == 0)
467 if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
469 return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
472 always_inline tcp_connection_t *
473 tcp_get_connection_from_transport (transport_connection_t * tconn)
475 return (tcp_connection_t *) tconn;
478 void tcp_connection_close (tcp_connection_t * tc);
479 void tcp_connection_cleanup (tcp_connection_t * tc);
480 void tcp_connection_del (tcp_connection_t * tc);
481 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
482 tcp_connection_t *tcp_connection_new (u8 thread_index);
483 void tcp_connection_reset (tcp_connection_t * tc);
484 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
485 ip4_address_t * start,
486 ip4_address_t * end, u32 table_id);
487 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
488 ip6_address_t * start,
489 ip6_address_t * end, u32 table_id);
490 void tcp_api_reference (void);
491 u8 *format_tcp_connection_id (u8 * s, va_list * args);
492 u8 *format_tcp_connection (u8 * s, va_list * args);
493 u8 *format_tcp_scoreboard (u8 * s, va_list * args);
495 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
497 always_inline tcp_connection_t *
498 tcp_listener_get (u32 tli)
500 return pool_elt_at_index (tcp_main.listener_pool, tli);
503 always_inline tcp_connection_t *
504 tcp_half_open_connection_get (u32 conn_index)
506 tcp_connection_t *tc = 0;
507 clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
508 if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
509 tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
510 clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
514 void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
515 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
516 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
517 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
519 void tcp_send_reset (tcp_connection_t * tc);
520 void tcp_send_syn (tcp_connection_t * tc);
521 void tcp_send_fin (tcp_connection_t * tc);
522 void tcp_init_mss (tcp_connection_t * tc);
523 void tcp_update_snd_mss (tcp_connection_t * tc);
524 void tcp_update_rto (tcp_connection_t * tc);
525 void tcp_flush_frame_to_output (vlib_main_t * vm, u8 thread_index, u8 is_ip4);
526 void tcp_flush_frames_to_output (u8 thread_index);
529 tcp_end_seq (tcp_header_t * th, u32 len)
531 return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
534 /* Modulo arithmetic for TCP sequence numbers */
535 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
536 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
537 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
538 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
539 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
541 /* Modulo arithmetic for timestamps */
542 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
543 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
546 * Our estimate of the number of bytes that have left the network
549 tcp_bytes_out (const tcp_connection_t * tc)
551 if (tcp_opts_sack_permitted (&tc->rcv_opts))
552 return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
554 return tc->rcv_dupacks * tc->snd_mss;
558 * Our estimate of the number of bytes in flight (pipe size)
561 tcp_flight_size (const tcp_connection_t * tc)
565 flight_size = (int) (tc->snd_una_max - tc->snd_una) - tcp_bytes_out (tc)
572 ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
573 tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
574 tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
583 * Initial cwnd as per RFC5681
586 tcp_initial_cwnd (const tcp_connection_t * tc)
588 if (tc->snd_mss > 2190)
589 return 2 * tc->snd_mss;
590 else if (tc->snd_mss > 1095)
591 return 3 * tc->snd_mss;
593 return 4 * tc->snd_mss;
597 tcp_loss_wnd (const tcp_connection_t * tc)
603 tcp_available_snd_wnd (const tcp_connection_t * tc)
605 return clib_min (tc->cwnd, tc->snd_wnd);
609 tcp_available_output_snd_space (const tcp_connection_t * tc)
611 u32 available_wnd = tcp_available_snd_wnd (tc);
612 int flight_size = (int) (tc->snd_nxt - tc->snd_una);
614 if (available_wnd <= flight_size)
617 return available_wnd - flight_size;
621 * Estimate of how many bytes we can still push into the network
624 tcp_available_cc_snd_space (const tcp_connection_t * tc)
626 u32 available_wnd = tcp_available_snd_wnd (tc);
627 u32 flight_size = tcp_flight_size (tc);
629 if (available_wnd <= flight_size)
632 return available_wnd - flight_size;
636 tcp_is_lost_fin (tcp_connection_t * tc)
638 if ((tc->flags & TCP_CONN_FINSNT) && tc->snd_una_max - tc->snd_una == 1)
643 i32 tcp_rcv_wnd_available (tcp_connection_t * tc);
644 u32 tcp_snd_space (tcp_connection_t * tc);
645 void tcp_update_rcv_wnd (tcp_connection_t * tc);
647 void tcp_retransmit_first_unacked (tcp_connection_t * tc);
648 void tcp_fast_retransmit_no_sack (tcp_connection_t * tc);
649 void tcp_fast_retransmit_sack (tcp_connection_t * tc);
650 void tcp_fast_retransmit (tcp_connection_t * tc);
651 void tcp_cc_init_congestion (tcp_connection_t * tc);
652 int tcp_cc_recover (tcp_connection_t * tc);
653 void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
655 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
657 /* Made public for unit testing only */
658 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
659 u32 tcp_sack_list_bytes (tcp_connection_t * tc);
664 return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
668 tcp_set_time_now (u32 thread_index)
670 tcp_main.wrk_ctx[thread_index].time_now = clib_cpu_time_now ()
671 * tcp_main.tstamp_ticks_per_clock;
672 return tcp_main.wrk_ctx[thread_index].time_now;
675 u32 tcp_session_push_header (transport_connection_t * tconn,
679 tcp_prepare_retransmit_segment (tcp_connection_t * tc, u32 offset,
680 u32 max_bytes, vlib_buffer_t ** b);
682 void tcp_connection_timers_init (tcp_connection_t * tc);
683 void tcp_connection_timers_reset (tcp_connection_t * tc);
684 void tcp_init_snd_vars (tcp_connection_t * tc);
685 void tcp_connection_init_vars (tcp_connection_t * tc);
688 tcp_connection_force_ack (tcp_connection_t * tc, vlib_buffer_t * b)
690 /* Reset flags, make sure ack is sent */
691 tc->flags = TCP_CONN_SNDACK;
692 vnet_buffer (b)->tcp.flags &= ~TCP_BUF_FLAG_DUPACK;
696 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
698 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
699 ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
700 tc->timers[timer_id] =
701 tw_timer_start_16t_2w_512sl (&tcp_main.
702 wrk_ctx[tc->c_thread_index].timer_wheel,
703 tc->c_c_index, timer_id, interval);
707 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
709 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
710 if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
713 tw_timer_stop_16t_2w_512sl (&tcp_main.
714 wrk_ctx[tc->c_thread_index].timer_wheel,
715 tc->timers[timer_id]);
716 tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
720 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
722 ASSERT (tc->c_thread_index == vlib_get_thread_index ());
723 if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
724 tw_timer_update_16t_2w_512sl (&tcp_main.
725 wrk_ctx[tc->c_thread_index].timer_wheel,
726 tc->timers[timer_id], interval);
728 tc->timers[timer_id] =
729 tw_timer_start_16t_2w_512sl (&tcp_main.
730 wrk_ctx[tc->c_thread_index].timer_wheel,
731 tc->c_c_index, timer_id, interval);
735 tcp_retransmit_timer_set (tcp_connection_t * tc)
737 ASSERT (tc->snd_una != tc->snd_una_max);
738 tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
739 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
743 tcp_retransmit_timer_reset (tcp_connection_t * tc)
745 tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
749 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
751 tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
752 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
756 tcp_persist_timer_set (tcp_connection_t * tc)
758 /* Reuse RTO. It's backed off in handler */
759 tcp_timer_set (tc, TCP_TIMER_PERSIST,
760 clib_max (tc->rto * TCP_TO_TIMER_TICK,
761 TCP_TIMER_PERSIST_MIN));
765 tcp_persist_timer_update (tcp_connection_t * tc)
767 tcp_timer_update (tc, TCP_TIMER_PERSIST,
768 clib_max (tc->rto * TCP_TO_TIMER_TICK,
769 TCP_TIMER_PERSIST_MIN));
773 tcp_persist_timer_reset (tcp_connection_t * tc)
775 tcp_timer_reset (tc, TCP_TIMER_PERSIST);
779 tcp_retransmit_timer_update (tcp_connection_t * tc)
781 if (tc->snd_una == tc->snd_una_max)
783 tcp_retransmit_timer_reset (tc);
784 if (tc->snd_wnd < tc->snd_mss)
785 tcp_persist_timer_update (tc);
788 tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
789 clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
793 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
795 return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
798 #define tcp_validate_txf_size(_tc, _a) \
799 ASSERT(_tc->state != TCP_STATE_ESTABLISHED \
800 || session_tx_fifo_max_dequeue (&_tc->connection) >= _a)
803 scoreboard_remove_hole (sack_scoreboard_t * sb,
804 sack_scoreboard_hole_t * hole);
805 sack_scoreboard_hole_t *scoreboard_insert_hole (sack_scoreboard_t * sb,
806 u32 prev_index, u32 start,
808 sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
809 sack_scoreboard_hole_t *
810 start, u8 have_sent_1_smss,
813 void scoreboard_init_high_rxt (sack_scoreboard_t * sb, u32 seq);
815 always_inline sack_scoreboard_hole_t *
816 scoreboard_get_hole (sack_scoreboard_t * sb, u32 index)
818 if (index != TCP_INVALID_SACK_HOLE_INDEX)
819 return pool_elt_at_index (sb->holes, index);
823 always_inline sack_scoreboard_hole_t *
824 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
826 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
827 return pool_elt_at_index (sb->holes, hole->next);
831 always_inline sack_scoreboard_hole_t *
832 scoreboard_prev_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
834 if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
835 return pool_elt_at_index (sb->holes, hole->prev);
839 always_inline sack_scoreboard_hole_t *
840 scoreboard_first_hole (sack_scoreboard_t * sb)
842 if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
843 return pool_elt_at_index (sb->holes, sb->head);
847 always_inline sack_scoreboard_hole_t *
848 scoreboard_last_hole (sack_scoreboard_t * sb)
850 if (sb->tail != TCP_INVALID_SACK_HOLE_INDEX)
851 return pool_elt_at_index (sb->holes, sb->tail);
856 scoreboard_clear (sack_scoreboard_t * sb)
858 sack_scoreboard_hole_t *hole;
859 while ((hole = scoreboard_first_hole (sb)))
861 scoreboard_remove_hole (sb, hole);
863 ASSERT (sb->head == sb->tail && sb->head == TCP_INVALID_SACK_HOLE_INDEX);
864 ASSERT (pool_elts (sb->holes) == 0);
865 sb->sacked_bytes = 0;
866 sb->last_sacked_bytes = 0;
867 sb->last_bytes_delivered = 0;
872 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
876 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
878 return hole->end - hole->start;
882 scoreboard_hole_index (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
884 ASSERT (!pool_is_free_index (sb->holes, hole - sb->holes));
885 return hole - sb->holes;
889 scoreboard_init (sack_scoreboard_t * sb)
891 sb->head = TCP_INVALID_SACK_HOLE_INDEX;
892 sb->tail = TCP_INVALID_SACK_HOLE_INDEX;
893 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
896 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
899 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
900 const tcp_cc_algorithm_t * vft)
902 tcp_main_t *tm = vnet_get_tcp_main ();
903 vec_validate (tm->cc_algos, type);
905 tm->cc_algos[type] = *vft;
908 always_inline tcp_cc_algorithm_t *
909 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
911 tcp_main_t *tm = vnet_get_tcp_main ();
912 return &tm->cc_algos[type];
915 void tcp_cc_init (tcp_connection_t * tc);
918 * Push TCP header to buffer
920 * @param vm - vlib_main
921 * @param b - buffer to write the header to
922 * @param sp_net - source port net order
923 * @param dp_net - destination port net order
924 * @param seq - sequence number net order
925 * @param ack - ack number net order
926 * @param tcp_hdr_opts_len - header and options length in bytes
927 * @param flags - header flags
928 * @param wnd - window size
930 * @return - pointer to start of TCP header
933 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
934 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
939 th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
943 th->seq_number = seq;
944 th->ack_number = ack;
945 th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
949 th->urgent_pointer = 0;
954 * Push TCP header to buffer
956 * @param b - buffer to write the header to
957 * @param sp_net - source port net order
958 * @param dp_net - destination port net order
959 * @param seq - sequence number host order
960 * @param ack - ack number host order
961 * @param tcp_hdr_opts_len - header and options length in bytes
962 * @param flags - header flags
963 * @param wnd - window size
965 * @return - pointer to start of TCP header
968 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
969 u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
971 return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
972 clib_host_to_net_u32 (seq),
973 clib_host_to_net_u32 (ack),
974 tcp_hdr_opts_len, flags,
975 clib_host_to_net_u16 (wnd));
978 #endif /* _vnet_tcp_h_ */
981 * fd.io coding-style-patch-verification: ON
984 * eval: (c-set-style "gnu")