2 * Copyright (c) 2018-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.
16 #include <vnet/tcp/tcp.h>
19 #define beta_cubic 0.7
21 #define west_const (3 * (1 - beta_cubic) / (1 + beta_cubic))
23 typedef struct cubic_cfg_
28 static cubic_cfg_t cubic_cfg = {
29 .fast_convergence = 1,
32 typedef struct cubic_data_
34 /** time period (in seconds) needed to increase the current window
35 * size to W_max if there are no further congestion events */
38 /** time (in sec) since the start of current congestion avoidance */
41 /** Inflection point of the cubic function (in snd_mss segments) */
44 } __clib_packed cubic_data_t;
46 STATIC_ASSERT (sizeof (cubic_data_t) <= TCP_CC_DATA_SZ, "cubic data len");
49 cubic_time (u32 thread_index)
51 return transport_time_now (thread_index);
57 * CUBIC window increase function. Time and K need to be provided in seconds.
60 W_cubic (cubic_data_t * cd, f64 t)
64 /* W_cubic(t) = C*(t-K)^3 + W_max */
65 return cubic_c * diff * diff * diff + cd->w_max;
72 K_cubic (cubic_data_t * cd, u32 wnd)
74 /* K = cubic_root(W_max*(1-beta_cubic)/C)
75 * Because the current window may be less than W_max * beta_cubic because
76 * of fast convergence, we pass it as parameter */
77 return pow ((f64) (cd->w_max - wnd) / cubic_c, 1 / 3.0);
83 * Estimates the window size of AIMD(alpha_aimd, beta_aimd) for
84 * alpha_aimd=3*(1-beta_cubic)/(1+beta_cubic) and beta_aimd=beta_cubic.
85 * Time (t) and rtt should be provided in seconds
88 W_est (cubic_data_t * cd, f64 t, f64 rtt)
90 /* W_est(t) = W_max*beta_cubic+[3*(1-beta_cubic)/(1+beta_cubic)]*(t/RTT) */
91 return cd->w_max * beta_cubic + west_const * (t / rtt);
95 cubic_congestion (tcp_connection_t * tc)
97 cubic_data_t *cd = (cubic_data_t *) tcp_cc_data (tc);
100 w_max = tc->cwnd / tc->snd_mss;
101 if (cubic_cfg.fast_convergence && w_max < cd->w_max)
102 w_max = w_max * ((1.0 + beta_cubic) / 2.0);
105 tc->ssthresh = clib_max (tc->cwnd * beta_cubic, 2 * tc->snd_mss);
106 tc->cwnd = tc->ssthresh;
110 cubic_loss (tcp_connection_t * tc)
112 cubic_data_t *cd = (cubic_data_t *) tcp_cc_data (tc);
114 tc->cwnd = tcp_loss_wnd (tc);
115 cd->t_start = cubic_time (tc->c_thread_index);
117 cd->w_max = tc->cwnd / tc->snd_mss;
121 cubic_recovered (tcp_connection_t * tc)
123 cubic_data_t *cd = (cubic_data_t *) tcp_cc_data (tc);
124 cd->t_start = cubic_time (tc->c_thread_index);
125 tc->cwnd = tc->ssthresh;
126 cd->K = K_cubic (cd, tc->cwnd / tc->snd_mss);
130 cubic_cwnd_accumulate (tcp_connection_t * tc, u32 thresh, u32 bytes_acked)
132 /* We just updated the threshold and don't know how large the previous
133 * one was. Still, optimistically increase cwnd by one segment and
134 * clear the accumulated bytes. */
135 if (tc->cwnd_acc_bytes > thresh)
137 tc->cwnd += tc->snd_mss;
138 tc->cwnd_acc_bytes = 0;
141 tcp_cwnd_accumulate (tc, thresh, tc->bytes_acked);
145 cubic_rcv_ack (tcp_connection_t * tc, tcp_rate_sample_t * rs)
147 cubic_data_t *cd = (cubic_data_t *) tcp_cc_data (tc);
152 /* Constrained by tx fifo, can't grow further */
153 if (tc->cwnd >= tc->tx_fifo_size)
156 if (tcp_in_slowstart (tc))
158 tc->cwnd += tc->bytes_acked;
162 t = cubic_time (tc->c_thread_index) - cd->t_start;
163 rtt_sec = clib_min (tc->mrtt_us, (f64) tc->srtt * TCP_TICK);
165 w_cubic = W_cubic (cd, t + rtt_sec) * tc->snd_mss;
166 w_aimd = (u64) W_est (cd, t, rtt_sec) * tc->snd_mss;
167 if (w_cubic < w_aimd)
169 cubic_cwnd_accumulate (tc, tc->cwnd, tc->bytes_acked);
173 if (w_cubic > tc->cwnd)
175 /* For NewReno and slow start, we increment cwnd based on the
176 * number of bytes acked, not the number of acks received. In
177 * particular, for NewReno we increment the cwnd by 1 snd_mss
178 * only after we accumulate 1 cwnd of acked bytes (RFC 3465).
180 * For Cubic, as per RFC 8312 we should increment cwnd by
181 * (w_cubic - cwnd)/cwnd for each ack. Instead of using that,
182 * we compute the number of packets that need to be acked
183 * before adding snd_mss to cwnd and compute the threshold
185 thresh = (tc->snd_mss * tc->cwnd) / (w_cubic - tc->cwnd);
187 /* Make sure we don't increase cwnd more often than every segment */
188 thresh = clib_max (thresh, tc->snd_mss);
192 /* Practically we can't increment so just inflate threshold */
193 thresh = 50 * tc->cwnd;
195 cubic_cwnd_accumulate (tc, thresh, tc->bytes_acked);
200 cubic_conn_init (tcp_connection_t * tc)
202 cubic_data_t *cd = (cubic_data_t *) tcp_cc_data (tc);
203 tc->ssthresh = tc->snd_wnd;
204 tc->cwnd = tcp_initial_cwnd (tc);
207 cd->t_start = cubic_time (tc->c_thread_index);
211 cubic_unformat_config (unformat_input_t * input)
216 unformat_skip_white_space (input);
218 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
220 if (unformat (input, "no-fast-convergence"))
221 cubic_cfg.fast_convergence = 0;
228 const static tcp_cc_algorithm_t tcp_cubic = {
230 .unformat_cfg = cubic_unformat_config,
231 .congestion = cubic_congestion,
233 .recovered = cubic_recovered,
234 .rcv_ack = cubic_rcv_ack,
235 .rcv_cong_ack = newreno_rcv_cong_ack,
236 .init = cubic_conn_init,
240 cubic_init (vlib_main_t * vm)
242 clib_error_t *error = 0;
244 tcp_cc_algo_register (TCP_CC_CUBIC, &tcp_cubic);
249 VLIB_INIT_FUNCTION (cubic_init);
252 * fd.io coding-style-patch-verification: ON
255 * eval: (c-set-style "gnu")