GNU Linux-libre 4.19.211-gnu1
[releases.git] / net / ipv4 / tcp_bbr.c
1 /* Bottleneck Bandwidth and RTT (BBR) congestion control
2  *
3  * BBR congestion control computes the sending rate based on the delivery
4  * rate (throughput) estimated from ACKs. In a nutshell:
5  *
6  *   On each ACK, update our model of the network path:
7  *      bottleneck_bandwidth = windowed_max(delivered / elapsed, 10 round trips)
8  *      min_rtt = windowed_min(rtt, 10 seconds)
9  *   pacing_rate = pacing_gain * bottleneck_bandwidth
10  *   cwnd = max(cwnd_gain * bottleneck_bandwidth * min_rtt, 4)
11  *
12  * The core algorithm does not react directly to packet losses or delays,
13  * although BBR may adjust the size of next send per ACK when loss is
14  * observed, or adjust the sending rate if it estimates there is a
15  * traffic policer, in order to keep the drop rate reasonable.
16  *
17  * Here is a state transition diagram for BBR:
18  *
19  *             |
20  *             V
21  *    +---> STARTUP  ----+
22  *    |        |         |
23  *    |        V         |
24  *    |      DRAIN   ----+
25  *    |        |         |
26  *    |        V         |
27  *    +---> PROBE_BW ----+
28  *    |      ^    |      |
29  *    |      |    |      |
30  *    |      +----+      |
31  *    |                  |
32  *    +---- PROBE_RTT <--+
33  *
34  * A BBR flow starts in STARTUP, and ramps up its sending rate quickly.
35  * When it estimates the pipe is full, it enters DRAIN to drain the queue.
36  * In steady state a BBR flow only uses PROBE_BW and PROBE_RTT.
37  * A long-lived BBR flow spends the vast majority of its time remaining
38  * (repeatedly) in PROBE_BW, fully probing and utilizing the pipe's bandwidth
39  * in a fair manner, with a small, bounded queue. *If* a flow has been
40  * continuously sending for the entire min_rtt window, and hasn't seen an RTT
41  * sample that matches or decreases its min_rtt estimate for 10 seconds, then
42  * it briefly enters PROBE_RTT to cut inflight to a minimum value to re-probe
43  * the path's two-way propagation delay (min_rtt). When exiting PROBE_RTT, if
44  * we estimated that we reached the full bw of the pipe then we enter PROBE_BW;
45  * otherwise we enter STARTUP to try to fill the pipe.
46  *
47  * BBR is described in detail in:
48  *   "BBR: Congestion-Based Congestion Control",
49  *   Neal Cardwell, Yuchung Cheng, C. Stephen Gunn, Soheil Hassas Yeganeh,
50  *   Van Jacobson. ACM Queue, Vol. 14 No. 5, September-October 2016.
51  *
52  * There is a public e-mail list for discussing BBR development and testing:
53  *   https://groups.google.com/forum/#!forum/bbr-dev
54  *
55  * NOTE: BBR might be used with the fq qdisc ("man tc-fq") with pacing enabled,
56  * otherwise TCP stack falls back to an internal pacing using one high
57  * resolution timer per TCP socket and may use more resources.
58  */
59 #include <linux/module.h>
60 #include <net/tcp.h>
61 #include <linux/inet_diag.h>
62 #include <linux/inet.h>
63 #include <linux/random.h>
64 #include <linux/win_minmax.h>
65
66 /* Scale factor for rate in pkt/uSec unit to avoid truncation in bandwidth
67  * estimation. The rate unit ~= (1500 bytes / 1 usec / 2^24) ~= 715 bps.
68  * This handles bandwidths from 0.06pps (715bps) to 256Mpps (3Tbps) in a u32.
69  * Since the minimum window is >=4 packets, the lower bound isn't
70  * an issue. The upper bound isn't an issue with existing technologies.
71  */
72 #define BW_SCALE 24
73 #define BW_UNIT (1 << BW_SCALE)
74
75 #define BBR_SCALE 8     /* scaling factor for fractions in BBR (e.g. gains) */
76 #define BBR_UNIT (1 << BBR_SCALE)
77
78 /* BBR has the following modes for deciding how fast to send: */
79 enum bbr_mode {
80         BBR_STARTUP,    /* ramp up sending rate rapidly to fill pipe */
81         BBR_DRAIN,      /* drain any queue created during startup */
82         BBR_PROBE_BW,   /* discover, share bw: pace around estimated bw */
83         BBR_PROBE_RTT,  /* cut inflight to min to probe min_rtt */
84 };
85
86 /* BBR congestion control block */
87 struct bbr {
88         u32     min_rtt_us;             /* min RTT in min_rtt_win_sec window */
89         u32     min_rtt_stamp;          /* timestamp of min_rtt_us */
90         u32     probe_rtt_done_stamp;   /* end time for BBR_PROBE_RTT mode */
91         struct minmax bw;       /* Max recent delivery rate in pkts/uS << 24 */
92         u32     rtt_cnt;            /* count of packet-timed rounds elapsed */
93         u32     next_rtt_delivered; /* scb->tx.delivered at end of round */
94         u64     cycle_mstamp;        /* time of this cycle phase start */
95         u32     mode:3,              /* current bbr_mode in state machine */
96                 prev_ca_state:3,     /* CA state on previous ACK */
97                 packet_conservation:1,  /* use packet conservation? */
98                 round_start:1,       /* start of packet-timed tx->ack round? */
99                 idle_restart:1,      /* restarting after idle? */
100                 probe_rtt_round_done:1,  /* a BBR_PROBE_RTT round at 4 pkts? */
101                 unused:13,
102                 lt_is_sampling:1,    /* taking long-term ("LT") samples now? */
103                 lt_rtt_cnt:7,        /* round trips in long-term interval */
104                 lt_use_bw:1;         /* use lt_bw as our bw estimate? */
105         u32     lt_bw;               /* LT est delivery rate in pkts/uS << 24 */
106         u32     lt_last_delivered;   /* LT intvl start: tp->delivered */
107         u32     lt_last_stamp;       /* LT intvl start: tp->delivered_mstamp */
108         u32     lt_last_lost;        /* LT intvl start: tp->lost */
109         u32     pacing_gain:10, /* current gain for setting pacing rate */
110                 cwnd_gain:10,   /* current gain for setting cwnd */
111                 full_bw_reached:1,   /* reached full bw in Startup? */
112                 full_bw_cnt:2,  /* number of rounds without large bw gains */
113                 cycle_idx:3,    /* current index in pacing_gain cycle array */
114                 has_seen_rtt:1, /* have we seen an RTT sample yet? */
115                 unused_b:5;
116         u32     prior_cwnd;     /* prior cwnd upon entering loss recovery */
117         u32     full_bw;        /* recent bw, to estimate if pipe is full */
118
119         /* For tracking ACK aggregation: */
120         u64     ack_epoch_mstamp;       /* start of ACK sampling epoch */
121         u16     extra_acked[2];         /* max excess data ACKed in epoch */
122         u32     ack_epoch_acked:20,     /* packets (S)ACKed in sampling epoch */
123                 extra_acked_win_rtts:5, /* age of extra_acked, in round trips */
124                 extra_acked_win_idx:1,  /* current index in extra_acked array */
125                 unused_c:6;
126 };
127
128 #define CYCLE_LEN       8       /* number of phases in a pacing gain cycle */
129
130 /* Window length of bw filter (in rounds): */
131 static const int bbr_bw_rtts = CYCLE_LEN + 2;
132 /* Window length of min_rtt filter (in sec): */
133 static const u32 bbr_min_rtt_win_sec = 10;
134 /* Minimum time (in ms) spent at bbr_cwnd_min_target in BBR_PROBE_RTT mode: */
135 static const u32 bbr_probe_rtt_mode_ms = 200;
136 /* Skip TSO below the following bandwidth (bits/sec): */
137 static const int bbr_min_tso_rate = 1200000;
138
139 /* We use a high_gain value of 2/ln(2) because it's the smallest pacing gain
140  * that will allow a smoothly increasing pacing rate that will double each RTT
141  * and send the same number of packets per RTT that an un-paced, slow-starting
142  * Reno or CUBIC flow would:
143  */
144 static const int bbr_high_gain  = BBR_UNIT * 2885 / 1000 + 1;
145 /* The pacing gain of 1/high_gain in BBR_DRAIN is calculated to typically drain
146  * the queue created in BBR_STARTUP in a single round:
147  */
148 static const int bbr_drain_gain = BBR_UNIT * 1000 / 2885;
149 /* The gain for deriving steady-state cwnd tolerates delayed/stretched ACKs: */
150 static const int bbr_cwnd_gain  = BBR_UNIT * 2;
151 /* The pacing_gain values for the PROBE_BW gain cycle, to discover/share bw: */
152 static const int bbr_pacing_gain[] = {
153         BBR_UNIT * 5 / 4,       /* probe for more available bw */
154         BBR_UNIT * 3 / 4,       /* drain queue and/or yield bw to other flows */
155         BBR_UNIT, BBR_UNIT, BBR_UNIT,   /* cruise at 1.0*bw to utilize pipe, */
156         BBR_UNIT, BBR_UNIT, BBR_UNIT    /* without creating excess queue... */
157 };
158 /* Randomize the starting gain cycling phase over N phases: */
159 static const u32 bbr_cycle_rand = 7;
160
161 /* Try to keep at least this many packets in flight, if things go smoothly. For
162  * smooth functioning, a sliding window protocol ACKing every other packet
163  * needs at least 4 packets in flight:
164  */
165 static const u32 bbr_cwnd_min_target = 4;
166
167 /* To estimate if BBR_STARTUP mode (i.e. high_gain) has filled pipe... */
168 /* If bw has increased significantly (1.25x), there may be more bw available: */
169 static const u32 bbr_full_bw_thresh = BBR_UNIT * 5 / 4;
170 /* But after 3 rounds w/o significant bw growth, estimate pipe is full: */
171 static const u32 bbr_full_bw_cnt = 3;
172
173 /* "long-term" ("LT") bandwidth estimator parameters... */
174 /* The minimum number of rounds in an LT bw sampling interval: */
175 static const u32 bbr_lt_intvl_min_rtts = 4;
176 /* If lost/delivered ratio > 20%, interval is "lossy" and we may be policed: */
177 static const u32 bbr_lt_loss_thresh = 50;
178 /* If 2 intervals have a bw ratio <= 1/8, their bw is "consistent": */
179 static const u32 bbr_lt_bw_ratio = BBR_UNIT / 8;
180 /* If 2 intervals have a bw diff <= 4 Kbit/sec their bw is "consistent": */
181 static const u32 bbr_lt_bw_diff = 4000 / 8;
182 /* If we estimate we're policed, use lt_bw for this many round trips: */
183 static const u32 bbr_lt_bw_max_rtts = 48;
184
185 /* Gain factor for adding extra_acked to target cwnd: */
186 static const int bbr_extra_acked_gain = BBR_UNIT;
187 /* Window length of extra_acked window. */
188 static const u32 bbr_extra_acked_win_rtts = 5;
189 /* Max allowed val for ack_epoch_acked, after which sampling epoch is reset */
190 static const u32 bbr_ack_epoch_acked_reset_thresh = 1U << 20;
191 /* Time period for clamping cwnd increment due to ack aggregation */
192 static const u32 bbr_extra_acked_max_us = 100 * 1000;
193
194 static void bbr_check_probe_rtt_done(struct sock *sk);
195
196 /* Do we estimate that STARTUP filled the pipe? */
197 static bool bbr_full_bw_reached(const struct sock *sk)
198 {
199         const struct bbr *bbr = inet_csk_ca(sk);
200
201         return bbr->full_bw_reached;
202 }
203
204 /* Return the windowed max recent bandwidth sample, in pkts/uS << BW_SCALE. */
205 static u32 bbr_max_bw(const struct sock *sk)
206 {
207         struct bbr *bbr = inet_csk_ca(sk);
208
209         return minmax_get(&bbr->bw);
210 }
211
212 /* Return the estimated bandwidth of the path, in pkts/uS << BW_SCALE. */
213 static u32 bbr_bw(const struct sock *sk)
214 {
215         struct bbr *bbr = inet_csk_ca(sk);
216
217         return bbr->lt_use_bw ? bbr->lt_bw : bbr_max_bw(sk);
218 }
219
220 /* Return maximum extra acked in past k-2k round trips,
221  * where k = bbr_extra_acked_win_rtts.
222  */
223 static u16 bbr_extra_acked(const struct sock *sk)
224 {
225         struct bbr *bbr = inet_csk_ca(sk);
226
227         return max(bbr->extra_acked[0], bbr->extra_acked[1]);
228 }
229
230 /* Return rate in bytes per second, optionally with a gain.
231  * The order here is chosen carefully to avoid overflow of u64. This should
232  * work for input rates of up to 2.9Tbit/sec and gain of 2.89x.
233  */
234 static u64 bbr_rate_bytes_per_sec(struct sock *sk, u64 rate, int gain)
235 {
236         unsigned int mss = tcp_sk(sk)->mss_cache;
237
238         if (!tcp_needs_internal_pacing(sk))
239                 mss = tcp_mss_to_mtu(sk, mss);
240         rate *= mss;
241         rate *= gain;
242         rate >>= BBR_SCALE;
243         rate *= USEC_PER_SEC;
244         return rate >> BW_SCALE;
245 }
246
247 /* Convert a BBR bw and gain factor to a pacing rate in bytes per second. */
248 static u32 bbr_bw_to_pacing_rate(struct sock *sk, u32 bw, int gain)
249 {
250         u64 rate = bw;
251
252         rate = bbr_rate_bytes_per_sec(sk, rate, gain);
253         rate = min_t(u64, rate, sk->sk_max_pacing_rate);
254         return rate;
255 }
256
257 /* Initialize pacing rate to: high_gain * init_cwnd / RTT. */
258 static void bbr_init_pacing_rate_from_rtt(struct sock *sk)
259 {
260         struct tcp_sock *tp = tcp_sk(sk);
261         struct bbr *bbr = inet_csk_ca(sk);
262         u64 bw;
263         u32 rtt_us;
264
265         if (tp->srtt_us) {              /* any RTT sample yet? */
266                 rtt_us = max(tp->srtt_us >> 3, 1U);
267                 bbr->has_seen_rtt = 1;
268         } else {                         /* no RTT sample yet */
269                 rtt_us = USEC_PER_MSEC;  /* use nominal default RTT */
270         }
271         bw = (u64)tp->snd_cwnd * BW_UNIT;
272         do_div(bw, rtt_us);
273         sk->sk_pacing_rate = bbr_bw_to_pacing_rate(sk, bw, bbr_high_gain);
274 }
275
276 /* Pace using current bw estimate and a gain factor. In order to help drive the
277  * network toward lower queues while maintaining high utilization and low
278  * latency, the average pacing rate aims to be slightly (~1%) lower than the
279  * estimated bandwidth. This is an important aspect of the design. In this
280  * implementation this slightly lower pacing rate is achieved implicitly by not
281  * including link-layer headers in the packet size used for the pacing rate.
282  */
283 static void bbr_set_pacing_rate(struct sock *sk, u32 bw, int gain)
284 {
285         struct tcp_sock *tp = tcp_sk(sk);
286         struct bbr *bbr = inet_csk_ca(sk);
287         u32 rate = bbr_bw_to_pacing_rate(sk, bw, gain);
288
289         if (unlikely(!bbr->has_seen_rtt && tp->srtt_us))
290                 bbr_init_pacing_rate_from_rtt(sk);
291         if (bbr_full_bw_reached(sk) || rate > sk->sk_pacing_rate)
292                 sk->sk_pacing_rate = rate;
293 }
294
295 /* override sysctl_tcp_min_tso_segs */
296 static u32 bbr_min_tso_segs(struct sock *sk)
297 {
298         return sk->sk_pacing_rate < (bbr_min_tso_rate >> 3) ? 1 : 2;
299 }
300
301 static u32 bbr_tso_segs_goal(struct sock *sk)
302 {
303         struct tcp_sock *tp = tcp_sk(sk);
304         u32 segs, bytes;
305
306         /* Sort of tcp_tso_autosize() but ignoring
307          * driver provided sk_gso_max_size.
308          */
309         bytes = min_t(u32, sk->sk_pacing_rate >> sk->sk_pacing_shift,
310                       GSO_MAX_SIZE - 1 - MAX_TCP_HEADER);
311         segs = max_t(u32, bytes / tp->mss_cache, bbr_min_tso_segs(sk));
312
313         return min(segs, 0x7FU);
314 }
315
316 /* Save "last known good" cwnd so we can restore it after losses or PROBE_RTT */
317 static void bbr_save_cwnd(struct sock *sk)
318 {
319         struct tcp_sock *tp = tcp_sk(sk);
320         struct bbr *bbr = inet_csk_ca(sk);
321
322         if (bbr->prev_ca_state < TCP_CA_Recovery && bbr->mode != BBR_PROBE_RTT)
323                 bbr->prior_cwnd = tp->snd_cwnd;  /* this cwnd is good enough */
324         else  /* loss recovery or BBR_PROBE_RTT have temporarily cut cwnd */
325                 bbr->prior_cwnd = max(bbr->prior_cwnd, tp->snd_cwnd);
326 }
327
328 static void bbr_cwnd_event(struct sock *sk, enum tcp_ca_event event)
329 {
330         struct tcp_sock *tp = tcp_sk(sk);
331         struct bbr *bbr = inet_csk_ca(sk);
332
333         if (event == CA_EVENT_TX_START && tp->app_limited) {
334                 bbr->idle_restart = 1;
335                 bbr->ack_epoch_mstamp = tp->tcp_mstamp;
336                 bbr->ack_epoch_acked = 0;
337                 /* Avoid pointless buffer overflows: pace at est. bw if we don't
338                  * need more speed (we're restarting from idle and app-limited).
339                  */
340                 if (bbr->mode == BBR_PROBE_BW)
341                         bbr_set_pacing_rate(sk, bbr_bw(sk), BBR_UNIT);
342                 else if (bbr->mode == BBR_PROBE_RTT)
343                         bbr_check_probe_rtt_done(sk);
344         }
345 }
346
347 /* Calculate bdp based on min RTT and the estimated bottleneck bandwidth:
348  *
349  * bdp = bw * min_rtt * gain
350  *
351  * The key factor, gain, controls the amount of queue. While a small gain
352  * builds a smaller queue, it becomes more vulnerable to noise in RTT
353  * measurements (e.g., delayed ACKs or other ACK compression effects). This
354  * noise may cause BBR to under-estimate the rate.
355  */
356 static u32 bbr_bdp(struct sock *sk, u32 bw, int gain)
357 {
358         struct bbr *bbr = inet_csk_ca(sk);
359         u32 bdp;
360         u64 w;
361
362         /* If we've never had a valid RTT sample, cap cwnd at the initial
363          * default. This should only happen when the connection is not using TCP
364          * timestamps and has retransmitted all of the SYN/SYNACK/data packets
365          * ACKed so far. In this case, an RTO can cut cwnd to 1, in which
366          * case we need to slow-start up toward something safe: TCP_INIT_CWND.
367          */
368         if (unlikely(bbr->min_rtt_us == ~0U))    /* no valid RTT samples yet? */
369                 return TCP_INIT_CWND;  /* be safe: cap at default initial cwnd*/
370
371         w = (u64)bw * bbr->min_rtt_us;
372
373         /* Apply a gain to the given value, then remove the BW_SCALE shift. */
374         bdp = (((w * gain) >> BBR_SCALE) + BW_UNIT - 1) / BW_UNIT;
375
376         return bdp;
377 }
378
379 /* To achieve full performance in high-speed paths, we budget enough cwnd to
380  * fit full-sized skbs in-flight on both end hosts to fully utilize the path:
381  *   - one skb in sending host Qdisc,
382  *   - one skb in sending host TSO/GSO engine
383  *   - one skb being received by receiver host LRO/GRO/delayed-ACK engine
384  * Don't worry, at low rates (bbr_min_tso_rate) this won't bloat cwnd because
385  * in such cases tso_segs_goal is 1. The minimum cwnd is 4 packets,
386  * which allows 2 outstanding 2-packet sequences, to try to keep pipe
387  * full even with ACK-every-other-packet delayed ACKs.
388  */
389 static u32 bbr_quantization_budget(struct sock *sk, u32 cwnd, int gain)
390 {
391         struct bbr *bbr = inet_csk_ca(sk);
392
393         /* Allow enough full-sized skbs in flight to utilize end systems. */
394         cwnd += 3 * bbr_tso_segs_goal(sk);
395
396         /* Reduce delayed ACKs by rounding up cwnd to the next even number. */
397         cwnd = (cwnd + 1) & ~1U;
398
399         /* Ensure gain cycling gets inflight above BDP even for small BDPs. */
400         if (bbr->mode == BBR_PROBE_BW && gain > BBR_UNIT)
401                 cwnd += 2;
402
403         return cwnd;
404 }
405
406 /* Find inflight based on min RTT and the estimated bottleneck bandwidth. */
407 static u32 bbr_inflight(struct sock *sk, u32 bw, int gain)
408 {
409         u32 inflight;
410
411         inflight = bbr_bdp(sk, bw, gain);
412         inflight = bbr_quantization_budget(sk, inflight, gain);
413
414         return inflight;
415 }
416
417 /* Find the cwnd increment based on estimate of ack aggregation */
418 static u32 bbr_ack_aggregation_cwnd(struct sock *sk)
419 {
420         u32 max_aggr_cwnd, aggr_cwnd = 0;
421
422         if (bbr_extra_acked_gain && bbr_full_bw_reached(sk)) {
423                 max_aggr_cwnd = ((u64)bbr_bw(sk) * bbr_extra_acked_max_us)
424                                 / BW_UNIT;
425                 aggr_cwnd = (bbr_extra_acked_gain * bbr_extra_acked(sk))
426                              >> BBR_SCALE;
427                 aggr_cwnd = min(aggr_cwnd, max_aggr_cwnd);
428         }
429
430         return aggr_cwnd;
431 }
432
433 /* An optimization in BBR to reduce losses: On the first round of recovery, we
434  * follow the packet conservation principle: send P packets per P packets acked.
435  * After that, we slow-start and send at most 2*P packets per P packets acked.
436  * After recovery finishes, or upon undo, we restore the cwnd we had when
437  * recovery started (capped by the target cwnd based on estimated BDP).
438  *
439  * TODO(ycheng/ncardwell): implement a rate-based approach.
440  */
441 static bool bbr_set_cwnd_to_recover_or_restore(
442         struct sock *sk, const struct rate_sample *rs, u32 acked, u32 *new_cwnd)
443 {
444         struct tcp_sock *tp = tcp_sk(sk);
445         struct bbr *bbr = inet_csk_ca(sk);
446         u8 prev_state = bbr->prev_ca_state, state = inet_csk(sk)->icsk_ca_state;
447         u32 cwnd = tp->snd_cwnd;
448
449         /* An ACK for P pkts should release at most 2*P packets. We do this
450          * in two steps. First, here we deduct the number of lost packets.
451          * Then, in bbr_set_cwnd() we slow start up toward the target cwnd.
452          */
453         if (rs->losses > 0)
454                 cwnd = max_t(s32, cwnd - rs->losses, 1);
455
456         if (state == TCP_CA_Recovery && prev_state != TCP_CA_Recovery) {
457                 /* Starting 1st round of Recovery, so do packet conservation. */
458                 bbr->packet_conservation = 1;
459                 bbr->next_rtt_delivered = tp->delivered;  /* start round now */
460                 /* Cut unused cwnd from app behavior, TSQ, or TSO deferral: */
461                 cwnd = tcp_packets_in_flight(tp) + acked;
462         } else if (prev_state >= TCP_CA_Recovery && state < TCP_CA_Recovery) {
463                 /* Exiting loss recovery; restore cwnd saved before recovery. */
464                 cwnd = max(cwnd, bbr->prior_cwnd);
465                 bbr->packet_conservation = 0;
466         }
467         bbr->prev_ca_state = state;
468
469         if (bbr->packet_conservation) {
470                 *new_cwnd = max(cwnd, tcp_packets_in_flight(tp) + acked);
471                 return true;    /* yes, using packet conservation */
472         }
473         *new_cwnd = cwnd;
474         return false;
475 }
476
477 /* Slow-start up toward target cwnd (if bw estimate is growing, or packet loss
478  * has drawn us down below target), or snap down to target if we're above it.
479  */
480 static void bbr_set_cwnd(struct sock *sk, const struct rate_sample *rs,
481                          u32 acked, u32 bw, int gain)
482 {
483         struct tcp_sock *tp = tcp_sk(sk);
484         struct bbr *bbr = inet_csk_ca(sk);
485         u32 cwnd = tp->snd_cwnd, target_cwnd = 0;
486
487         if (!acked)
488                 goto done;  /* no packet fully ACKed; just apply caps */
489
490         if (bbr_set_cwnd_to_recover_or_restore(sk, rs, acked, &cwnd))
491                 goto done;
492
493         target_cwnd = bbr_bdp(sk, bw, gain);
494
495         /* Increment the cwnd to account for excess ACKed data that seems
496          * due to aggregation (of data and/or ACKs) visible in the ACK stream.
497          */
498         target_cwnd += bbr_ack_aggregation_cwnd(sk);
499         target_cwnd = bbr_quantization_budget(sk, target_cwnd, gain);
500
501         /* If we're below target cwnd, slow start cwnd toward target cwnd. */
502         if (bbr_full_bw_reached(sk))  /* only cut cwnd if we filled the pipe */
503                 cwnd = min(cwnd + acked, target_cwnd);
504         else if (cwnd < target_cwnd || tp->delivered < TCP_INIT_CWND)
505                 cwnd = cwnd + acked;
506         cwnd = max(cwnd, bbr_cwnd_min_target);
507
508 done:
509         tp->snd_cwnd = min(cwnd, tp->snd_cwnd_clamp);   /* apply global cap */
510         if (bbr->mode == BBR_PROBE_RTT)  /* drain queue, refresh min_rtt */
511                 tp->snd_cwnd = min(tp->snd_cwnd, bbr_cwnd_min_target);
512 }
513
514 /* End cycle phase if it's time and/or we hit the phase's in-flight target. */
515 static bool bbr_is_next_cycle_phase(struct sock *sk,
516                                     const struct rate_sample *rs)
517 {
518         struct tcp_sock *tp = tcp_sk(sk);
519         struct bbr *bbr = inet_csk_ca(sk);
520         bool is_full_length =
521                 tcp_stamp_us_delta(tp->delivered_mstamp, bbr->cycle_mstamp) >
522                 bbr->min_rtt_us;
523         u32 inflight, bw;
524
525         /* The pacing_gain of 1.0 paces at the estimated bw to try to fully
526          * use the pipe without increasing the queue.
527          */
528         if (bbr->pacing_gain == BBR_UNIT)
529                 return is_full_length;          /* just use wall clock time */
530
531         inflight = rs->prior_in_flight;  /* what was in-flight before ACK? */
532         bw = bbr_max_bw(sk);
533
534         /* A pacing_gain > 1.0 probes for bw by trying to raise inflight to at
535          * least pacing_gain*BDP; this may take more than min_rtt if min_rtt is
536          * small (e.g. on a LAN). We do not persist if packets are lost, since
537          * a path with small buffers may not hold that much.
538          */
539         if (bbr->pacing_gain > BBR_UNIT)
540                 return is_full_length &&
541                         (rs->losses ||  /* perhaps pacing_gain*BDP won't fit */
542                          inflight >= bbr_inflight(sk, bw, bbr->pacing_gain));
543
544         /* A pacing_gain < 1.0 tries to drain extra queue we added if bw
545          * probing didn't find more bw. If inflight falls to match BDP then we
546          * estimate queue is drained; persisting would underutilize the pipe.
547          */
548         return is_full_length ||
549                 inflight <= bbr_inflight(sk, bw, BBR_UNIT);
550 }
551
552 static void bbr_advance_cycle_phase(struct sock *sk)
553 {
554         struct tcp_sock *tp = tcp_sk(sk);
555         struct bbr *bbr = inet_csk_ca(sk);
556
557         bbr->cycle_idx = (bbr->cycle_idx + 1) & (CYCLE_LEN - 1);
558         bbr->cycle_mstamp = tp->delivered_mstamp;
559         bbr->pacing_gain = bbr->lt_use_bw ? BBR_UNIT :
560                                             bbr_pacing_gain[bbr->cycle_idx];
561 }
562
563 /* Gain cycling: cycle pacing gain to converge to fair share of available bw. */
564 static void bbr_update_cycle_phase(struct sock *sk,
565                                    const struct rate_sample *rs)
566 {
567         struct bbr *bbr = inet_csk_ca(sk);
568
569         if (bbr->mode == BBR_PROBE_BW && bbr_is_next_cycle_phase(sk, rs))
570                 bbr_advance_cycle_phase(sk);
571 }
572
573 static void bbr_reset_startup_mode(struct sock *sk)
574 {
575         struct bbr *bbr = inet_csk_ca(sk);
576
577         bbr->mode = BBR_STARTUP;
578         bbr->pacing_gain = bbr_high_gain;
579         bbr->cwnd_gain   = bbr_high_gain;
580 }
581
582 static void bbr_reset_probe_bw_mode(struct sock *sk)
583 {
584         struct bbr *bbr = inet_csk_ca(sk);
585
586         bbr->mode = BBR_PROBE_BW;
587         bbr->pacing_gain = BBR_UNIT;
588         bbr->cwnd_gain = bbr_cwnd_gain;
589         bbr->cycle_idx = CYCLE_LEN - 1 - prandom_u32_max(bbr_cycle_rand);
590         bbr_advance_cycle_phase(sk);    /* flip to next phase of gain cycle */
591 }
592
593 static void bbr_reset_mode(struct sock *sk)
594 {
595         if (!bbr_full_bw_reached(sk))
596                 bbr_reset_startup_mode(sk);
597         else
598                 bbr_reset_probe_bw_mode(sk);
599 }
600
601 /* Start a new long-term sampling interval. */
602 static void bbr_reset_lt_bw_sampling_interval(struct sock *sk)
603 {
604         struct tcp_sock *tp = tcp_sk(sk);
605         struct bbr *bbr = inet_csk_ca(sk);
606
607         bbr->lt_last_stamp = div_u64(tp->delivered_mstamp, USEC_PER_MSEC);
608         bbr->lt_last_delivered = tp->delivered;
609         bbr->lt_last_lost = tp->lost;
610         bbr->lt_rtt_cnt = 0;
611 }
612
613 /* Completely reset long-term bandwidth sampling. */
614 static void bbr_reset_lt_bw_sampling(struct sock *sk)
615 {
616         struct bbr *bbr = inet_csk_ca(sk);
617
618         bbr->lt_bw = 0;
619         bbr->lt_use_bw = 0;
620         bbr->lt_is_sampling = false;
621         bbr_reset_lt_bw_sampling_interval(sk);
622 }
623
624 /* Long-term bw sampling interval is done. Estimate whether we're policed. */
625 static void bbr_lt_bw_interval_done(struct sock *sk, u32 bw)
626 {
627         struct bbr *bbr = inet_csk_ca(sk);
628         u32 diff;
629
630         if (bbr->lt_bw) {  /* do we have bw from a previous interval? */
631                 /* Is new bw close to the lt_bw from the previous interval? */
632                 diff = abs(bw - bbr->lt_bw);
633                 if ((diff * BBR_UNIT <= bbr_lt_bw_ratio * bbr->lt_bw) ||
634                     (bbr_rate_bytes_per_sec(sk, diff, BBR_UNIT) <=
635                      bbr_lt_bw_diff)) {
636                         /* All criteria are met; estimate we're policed. */
637                         bbr->lt_bw = (bw + bbr->lt_bw) >> 1;  /* avg 2 intvls */
638                         bbr->lt_use_bw = 1;
639                         bbr->pacing_gain = BBR_UNIT;  /* try to avoid drops */
640                         bbr->lt_rtt_cnt = 0;
641                         return;
642                 }
643         }
644         bbr->lt_bw = bw;
645         bbr_reset_lt_bw_sampling_interval(sk);
646 }
647
648 /* Token-bucket traffic policers are common (see "An Internet-Wide Analysis of
649  * Traffic Policing", SIGCOMM 2016). BBR detects token-bucket policers and
650  * explicitly models their policed rate, to reduce unnecessary losses. We
651  * estimate that we're policed if we see 2 consecutive sampling intervals with
652  * consistent throughput and high packet loss. If we think we're being policed,
653  * set lt_bw to the "long-term" average delivery rate from those 2 intervals.
654  */
655 static void bbr_lt_bw_sampling(struct sock *sk, const struct rate_sample *rs)
656 {
657         struct tcp_sock *tp = tcp_sk(sk);
658         struct bbr *bbr = inet_csk_ca(sk);
659         u32 lost, delivered;
660         u64 bw;
661         u32 t;
662
663         if (bbr->lt_use_bw) {   /* already using long-term rate, lt_bw? */
664                 if (bbr->mode == BBR_PROBE_BW && bbr->round_start &&
665                     ++bbr->lt_rtt_cnt >= bbr_lt_bw_max_rtts) {
666                         bbr_reset_lt_bw_sampling(sk);    /* stop using lt_bw */
667                         bbr_reset_probe_bw_mode(sk);  /* restart gain cycling */
668                 }
669                 return;
670         }
671
672         /* Wait for the first loss before sampling, to let the policer exhaust
673          * its tokens and estimate the steady-state rate allowed by the policer.
674          * Starting samples earlier includes bursts that over-estimate the bw.
675          */
676         if (!bbr->lt_is_sampling) {
677                 if (!rs->losses)
678                         return;
679                 bbr_reset_lt_bw_sampling_interval(sk);
680                 bbr->lt_is_sampling = true;
681         }
682
683         /* To avoid underestimates, reset sampling if we run out of data. */
684         if (rs->is_app_limited) {
685                 bbr_reset_lt_bw_sampling(sk);
686                 return;
687         }
688
689         if (bbr->round_start)
690                 bbr->lt_rtt_cnt++;      /* count round trips in this interval */
691         if (bbr->lt_rtt_cnt < bbr_lt_intvl_min_rtts)
692                 return;         /* sampling interval needs to be longer */
693         if (bbr->lt_rtt_cnt > 4 * bbr_lt_intvl_min_rtts) {
694                 bbr_reset_lt_bw_sampling(sk);  /* interval is too long */
695                 return;
696         }
697
698         /* End sampling interval when a packet is lost, so we estimate the
699          * policer tokens were exhausted. Stopping the sampling before the
700          * tokens are exhausted under-estimates the policed rate.
701          */
702         if (!rs->losses)
703                 return;
704
705         /* Calculate packets lost and delivered in sampling interval. */
706         lost = tp->lost - bbr->lt_last_lost;
707         delivered = tp->delivered - bbr->lt_last_delivered;
708         /* Is loss rate (lost/delivered) >= lt_loss_thresh? If not, wait. */
709         if (!delivered || (lost << BBR_SCALE) < bbr_lt_loss_thresh * delivered)
710                 return;
711
712         /* Find average delivery rate in this sampling interval. */
713         t = div_u64(tp->delivered_mstamp, USEC_PER_MSEC) - bbr->lt_last_stamp;
714         if ((s32)t < 1)
715                 return;         /* interval is less than one ms, so wait */
716         /* Check if can multiply without overflow */
717         if (t >= ~0U / USEC_PER_MSEC) {
718                 bbr_reset_lt_bw_sampling(sk);  /* interval too long; reset */
719                 return;
720         }
721         t *= USEC_PER_MSEC;
722         bw = (u64)delivered * BW_UNIT;
723         do_div(bw, t);
724         bbr_lt_bw_interval_done(sk, bw);
725 }
726
727 /* Estimate the bandwidth based on how fast packets are delivered */
728 static void bbr_update_bw(struct sock *sk, const struct rate_sample *rs)
729 {
730         struct tcp_sock *tp = tcp_sk(sk);
731         struct bbr *bbr = inet_csk_ca(sk);
732         u64 bw;
733
734         bbr->round_start = 0;
735         if (rs->delivered < 0 || rs->interval_us <= 0)
736                 return; /* Not a valid observation */
737
738         /* See if we've reached the next RTT */
739         if (!before(rs->prior_delivered, bbr->next_rtt_delivered)) {
740                 bbr->next_rtt_delivered = tp->delivered;
741                 bbr->rtt_cnt++;
742                 bbr->round_start = 1;
743                 bbr->packet_conservation = 0;
744         }
745
746         bbr_lt_bw_sampling(sk, rs);
747
748         /* Divide delivered by the interval to find a (lower bound) bottleneck
749          * bandwidth sample. Delivered is in packets and interval_us in uS and
750          * ratio will be <<1 for most connections. So delivered is first scaled.
751          */
752         bw = div64_long((u64)rs->delivered * BW_UNIT, rs->interval_us);
753
754         /* If this sample is application-limited, it is likely to have a very
755          * low delivered count that represents application behavior rather than
756          * the available network rate. Such a sample could drag down estimated
757          * bw, causing needless slow-down. Thus, to continue to send at the
758          * last measured network rate, we filter out app-limited samples unless
759          * they describe the path bw at least as well as our bw model.
760          *
761          * So the goal during app-limited phase is to proceed with the best
762          * network rate no matter how long. We automatically leave this
763          * phase when app writes faster than the network can deliver :)
764          */
765         if (!rs->is_app_limited || bw >= bbr_max_bw(sk)) {
766                 /* Incorporate new sample into our max bw filter. */
767                 minmax_running_max(&bbr->bw, bbr_bw_rtts, bbr->rtt_cnt, bw);
768         }
769 }
770
771 /* Estimates the windowed max degree of ack aggregation.
772  * This is used to provision extra in-flight data to keep sending during
773  * inter-ACK silences.
774  *
775  * Degree of ack aggregation is estimated as extra data acked beyond expected.
776  *
777  * max_extra_acked = "maximum recent excess data ACKed beyond max_bw * interval"
778  * cwnd += max_extra_acked
779  *
780  * Max extra_acked is clamped by cwnd and bw * bbr_extra_acked_max_us (100 ms).
781  * Max filter is an approximate sliding window of 5-10 (packet timed) round
782  * trips.
783  */
784 static void bbr_update_ack_aggregation(struct sock *sk,
785                                        const struct rate_sample *rs)
786 {
787         u32 epoch_us, expected_acked, extra_acked;
788         struct bbr *bbr = inet_csk_ca(sk);
789         struct tcp_sock *tp = tcp_sk(sk);
790
791         if (!bbr_extra_acked_gain || rs->acked_sacked <= 0 ||
792             rs->delivered < 0 || rs->interval_us <= 0)
793                 return;
794
795         if (bbr->round_start) {
796                 bbr->extra_acked_win_rtts = min(0x1F,
797                                                 bbr->extra_acked_win_rtts + 1);
798                 if (bbr->extra_acked_win_rtts >= bbr_extra_acked_win_rtts) {
799                         bbr->extra_acked_win_rtts = 0;
800                         bbr->extra_acked_win_idx = bbr->extra_acked_win_idx ?
801                                                    0 : 1;
802                         bbr->extra_acked[bbr->extra_acked_win_idx] = 0;
803                 }
804         }
805
806         /* Compute how many packets we expected to be delivered over epoch. */
807         epoch_us = tcp_stamp_us_delta(tp->delivered_mstamp,
808                                       bbr->ack_epoch_mstamp);
809         expected_acked = ((u64)bbr_bw(sk) * epoch_us) / BW_UNIT;
810
811         /* Reset the aggregation epoch if ACK rate is below expected rate or
812          * significantly large no. of ack received since epoch (potentially
813          * quite old epoch).
814          */
815         if (bbr->ack_epoch_acked <= expected_acked ||
816             (bbr->ack_epoch_acked + rs->acked_sacked >=
817              bbr_ack_epoch_acked_reset_thresh)) {
818                 bbr->ack_epoch_acked = 0;
819                 bbr->ack_epoch_mstamp = tp->delivered_mstamp;
820                 expected_acked = 0;
821         }
822
823         /* Compute excess data delivered, beyond what was expected. */
824         bbr->ack_epoch_acked = min_t(u32, 0xFFFFF,
825                                      bbr->ack_epoch_acked + rs->acked_sacked);
826         extra_acked = bbr->ack_epoch_acked - expected_acked;
827         extra_acked = min(extra_acked, tp->snd_cwnd);
828         if (extra_acked > bbr->extra_acked[bbr->extra_acked_win_idx])
829                 bbr->extra_acked[bbr->extra_acked_win_idx] = extra_acked;
830 }
831
832 /* Estimate when the pipe is full, using the change in delivery rate: BBR
833  * estimates that STARTUP filled the pipe if the estimated bw hasn't changed by
834  * at least bbr_full_bw_thresh (25%) after bbr_full_bw_cnt (3) non-app-limited
835  * rounds. Why 3 rounds: 1: rwin autotuning grows the rwin, 2: we fill the
836  * higher rwin, 3: we get higher delivery rate samples. Or transient
837  * cross-traffic or radio noise can go away. CUBIC Hystart shares a similar
838  * design goal, but uses delay and inter-ACK spacing instead of bandwidth.
839  */
840 static void bbr_check_full_bw_reached(struct sock *sk,
841                                       const struct rate_sample *rs)
842 {
843         struct bbr *bbr = inet_csk_ca(sk);
844         u32 bw_thresh;
845
846         if (bbr_full_bw_reached(sk) || !bbr->round_start || rs->is_app_limited)
847                 return;
848
849         bw_thresh = (u64)bbr->full_bw * bbr_full_bw_thresh >> BBR_SCALE;
850         if (bbr_max_bw(sk) >= bw_thresh) {
851                 bbr->full_bw = bbr_max_bw(sk);
852                 bbr->full_bw_cnt = 0;
853                 return;
854         }
855         ++bbr->full_bw_cnt;
856         bbr->full_bw_reached = bbr->full_bw_cnt >= bbr_full_bw_cnt;
857 }
858
859 /* If pipe is probably full, drain the queue and then enter steady-state. */
860 static void bbr_check_drain(struct sock *sk, const struct rate_sample *rs)
861 {
862         struct bbr *bbr = inet_csk_ca(sk);
863
864         if (bbr->mode == BBR_STARTUP && bbr_full_bw_reached(sk)) {
865                 bbr->mode = BBR_DRAIN;  /* drain queue we created */
866                 bbr->pacing_gain = bbr_drain_gain;      /* pace slow to drain */
867                 bbr->cwnd_gain = bbr_high_gain; /* maintain cwnd */
868                 tcp_sk(sk)->snd_ssthresh =
869                                 bbr_inflight(sk, bbr_max_bw(sk), BBR_UNIT);
870         }       /* fall through to check if in-flight is already small: */
871         if (bbr->mode == BBR_DRAIN &&
872             tcp_packets_in_flight(tcp_sk(sk)) <=
873             bbr_inflight(sk, bbr_max_bw(sk), BBR_UNIT))
874                 bbr_reset_probe_bw_mode(sk);  /* we estimate queue is drained */
875 }
876
877 static void bbr_check_probe_rtt_done(struct sock *sk)
878 {
879         struct tcp_sock *tp = tcp_sk(sk);
880         struct bbr *bbr = inet_csk_ca(sk);
881
882         if (!(bbr->probe_rtt_done_stamp &&
883               after(tcp_jiffies32, bbr->probe_rtt_done_stamp)))
884                 return;
885
886         bbr->min_rtt_stamp = tcp_jiffies32;  /* wait a while until PROBE_RTT */
887         tp->snd_cwnd = max(tp->snd_cwnd, bbr->prior_cwnd);
888         bbr_reset_mode(sk);
889 }
890
891 /* The goal of PROBE_RTT mode is to have BBR flows cooperatively and
892  * periodically drain the bottleneck queue, to converge to measure the true
893  * min_rtt (unloaded propagation delay). This allows the flows to keep queues
894  * small (reducing queuing delay and packet loss) and achieve fairness among
895  * BBR flows.
896  *
897  * The min_rtt filter window is 10 seconds. When the min_rtt estimate expires,
898  * we enter PROBE_RTT mode and cap the cwnd at bbr_cwnd_min_target=4 packets.
899  * After at least bbr_probe_rtt_mode_ms=200ms and at least one packet-timed
900  * round trip elapsed with that flight size <= 4, we leave PROBE_RTT mode and
901  * re-enter the previous mode. BBR uses 200ms to approximately bound the
902  * performance penalty of PROBE_RTT's cwnd capping to roughly 2% (200ms/10s).
903  *
904  * Note that flows need only pay 2% if they are busy sending over the last 10
905  * seconds. Interactive applications (e.g., Web, RPCs, video chunks) often have
906  * natural silences or low-rate periods within 10 seconds where the rate is low
907  * enough for long enough to drain its queue in the bottleneck. We pick up
908  * these min RTT measurements opportunistically with our min_rtt filter. :-)
909  */
910 static void bbr_update_min_rtt(struct sock *sk, const struct rate_sample *rs)
911 {
912         struct tcp_sock *tp = tcp_sk(sk);
913         struct bbr *bbr = inet_csk_ca(sk);
914         bool filter_expired;
915
916         /* Track min RTT seen in the min_rtt_win_sec filter window: */
917         filter_expired = after(tcp_jiffies32,
918                                bbr->min_rtt_stamp + bbr_min_rtt_win_sec * HZ);
919         if (rs->rtt_us >= 0 &&
920             (rs->rtt_us < bbr->min_rtt_us ||
921              (filter_expired && !rs->is_ack_delayed))) {
922                 bbr->min_rtt_us = rs->rtt_us;
923                 bbr->min_rtt_stamp = tcp_jiffies32;
924         }
925
926         if (bbr_probe_rtt_mode_ms > 0 && filter_expired &&
927             !bbr->idle_restart && bbr->mode != BBR_PROBE_RTT) {
928                 bbr->mode = BBR_PROBE_RTT;  /* dip, drain queue */
929                 bbr->pacing_gain = BBR_UNIT;
930                 bbr->cwnd_gain = BBR_UNIT;
931                 bbr_save_cwnd(sk);  /* note cwnd so we can restore it */
932                 bbr->probe_rtt_done_stamp = 0;
933         }
934
935         if (bbr->mode == BBR_PROBE_RTT) {
936                 /* Ignore low rate samples during this mode. */
937                 tp->app_limited =
938                         (tp->delivered + tcp_packets_in_flight(tp)) ? : 1;
939                 /* Maintain min packets in flight for max(200 ms, 1 round). */
940                 if (!bbr->probe_rtt_done_stamp &&
941                     tcp_packets_in_flight(tp) <= bbr_cwnd_min_target) {
942                         bbr->probe_rtt_done_stamp = tcp_jiffies32 +
943                                 msecs_to_jiffies(bbr_probe_rtt_mode_ms);
944                         bbr->probe_rtt_round_done = 0;
945                         bbr->next_rtt_delivered = tp->delivered;
946                 } else if (bbr->probe_rtt_done_stamp) {
947                         if (bbr->round_start)
948                                 bbr->probe_rtt_round_done = 1;
949                         if (bbr->probe_rtt_round_done)
950                                 bbr_check_probe_rtt_done(sk);
951                 }
952         }
953         /* Restart after idle ends only once we process a new S/ACK for data */
954         if (rs->delivered > 0)
955                 bbr->idle_restart = 0;
956 }
957
958 static void bbr_update_model(struct sock *sk, const struct rate_sample *rs)
959 {
960         bbr_update_bw(sk, rs);
961         bbr_update_ack_aggregation(sk, rs);
962         bbr_update_cycle_phase(sk, rs);
963         bbr_check_full_bw_reached(sk, rs);
964         bbr_check_drain(sk, rs);
965         bbr_update_min_rtt(sk, rs);
966 }
967
968 static void bbr_main(struct sock *sk, const struct rate_sample *rs)
969 {
970         struct bbr *bbr = inet_csk_ca(sk);
971         u32 bw;
972
973         bbr_update_model(sk, rs);
974
975         bw = bbr_bw(sk);
976         bbr_set_pacing_rate(sk, bw, bbr->pacing_gain);
977         bbr_set_cwnd(sk, rs, rs->acked_sacked, bw, bbr->cwnd_gain);
978 }
979
980 static void bbr_init(struct sock *sk)
981 {
982         struct tcp_sock *tp = tcp_sk(sk);
983         struct bbr *bbr = inet_csk_ca(sk);
984
985         bbr->prior_cwnd = 0;
986         tp->snd_ssthresh = TCP_INFINITE_SSTHRESH;
987         bbr->rtt_cnt = 0;
988         bbr->next_rtt_delivered = tp->delivered;
989         bbr->prev_ca_state = TCP_CA_Open;
990         bbr->packet_conservation = 0;
991
992         bbr->probe_rtt_done_stamp = 0;
993         bbr->probe_rtt_round_done = 0;
994         bbr->min_rtt_us = tcp_min_rtt(tp);
995         bbr->min_rtt_stamp = tcp_jiffies32;
996
997         minmax_reset(&bbr->bw, bbr->rtt_cnt, 0);  /* init max bw to 0 */
998
999         bbr->has_seen_rtt = 0;
1000         bbr_init_pacing_rate_from_rtt(sk);
1001
1002         bbr->round_start = 0;
1003         bbr->idle_restart = 0;
1004         bbr->full_bw_reached = 0;
1005         bbr->full_bw = 0;
1006         bbr->full_bw_cnt = 0;
1007         bbr->cycle_mstamp = 0;
1008         bbr->cycle_idx = 0;
1009         bbr_reset_lt_bw_sampling(sk);
1010         bbr_reset_startup_mode(sk);
1011
1012         bbr->ack_epoch_mstamp = tp->tcp_mstamp;
1013         bbr->ack_epoch_acked = 0;
1014         bbr->extra_acked_win_rtts = 0;
1015         bbr->extra_acked_win_idx = 0;
1016         bbr->extra_acked[0] = 0;
1017         bbr->extra_acked[1] = 0;
1018
1019         cmpxchg(&sk->sk_pacing_status, SK_PACING_NONE, SK_PACING_NEEDED);
1020 }
1021
1022 static u32 bbr_sndbuf_expand(struct sock *sk)
1023 {
1024         /* Provision 3 * cwnd since BBR may slow-start even during recovery. */
1025         return 3;
1026 }
1027
1028 /* In theory BBR does not need to undo the cwnd since it does not
1029  * always reduce cwnd on losses (see bbr_main()). Keep it for now.
1030  */
1031 static u32 bbr_undo_cwnd(struct sock *sk)
1032 {
1033         struct bbr *bbr = inet_csk_ca(sk);
1034
1035         bbr->full_bw = 0;   /* spurious slow-down; reset full pipe detection */
1036         bbr->full_bw_cnt = 0;
1037         bbr_reset_lt_bw_sampling(sk);
1038         return tcp_sk(sk)->snd_cwnd;
1039 }
1040
1041 /* Entering loss recovery, so save cwnd for when we exit or undo recovery. */
1042 static u32 bbr_ssthresh(struct sock *sk)
1043 {
1044         bbr_save_cwnd(sk);
1045         return tcp_sk(sk)->snd_ssthresh;
1046 }
1047
1048 static size_t bbr_get_info(struct sock *sk, u32 ext, int *attr,
1049                            union tcp_cc_info *info)
1050 {
1051         if (ext & (1 << (INET_DIAG_BBRINFO - 1)) ||
1052             ext & (1 << (INET_DIAG_VEGASINFO - 1))) {
1053                 struct tcp_sock *tp = tcp_sk(sk);
1054                 struct bbr *bbr = inet_csk_ca(sk);
1055                 u64 bw = bbr_bw(sk);
1056
1057                 bw = bw * tp->mss_cache * USEC_PER_SEC >> BW_SCALE;
1058                 memset(&info->bbr, 0, sizeof(info->bbr));
1059                 info->bbr.bbr_bw_lo             = (u32)bw;
1060                 info->bbr.bbr_bw_hi             = (u32)(bw >> 32);
1061                 info->bbr.bbr_min_rtt           = bbr->min_rtt_us;
1062                 info->bbr.bbr_pacing_gain       = bbr->pacing_gain;
1063                 info->bbr.bbr_cwnd_gain         = bbr->cwnd_gain;
1064                 *attr = INET_DIAG_BBRINFO;
1065                 return sizeof(info->bbr);
1066         }
1067         return 0;
1068 }
1069
1070 static void bbr_set_state(struct sock *sk, u8 new_state)
1071 {
1072         struct bbr *bbr = inet_csk_ca(sk);
1073
1074         if (new_state == TCP_CA_Loss) {
1075                 struct rate_sample rs = { .losses = 1 };
1076
1077                 bbr->prev_ca_state = TCP_CA_Loss;
1078                 bbr->full_bw = 0;
1079                 bbr->round_start = 1;   /* treat RTO like end of a round */
1080                 bbr_lt_bw_sampling(sk, &rs);
1081         }
1082 }
1083
1084 static struct tcp_congestion_ops tcp_bbr_cong_ops __read_mostly = {
1085         .flags          = TCP_CONG_NON_RESTRICTED,
1086         .name           = "bbr",
1087         .owner          = THIS_MODULE,
1088         .init           = bbr_init,
1089         .cong_control   = bbr_main,
1090         .sndbuf_expand  = bbr_sndbuf_expand,
1091         .undo_cwnd      = bbr_undo_cwnd,
1092         .cwnd_event     = bbr_cwnd_event,
1093         .ssthresh       = bbr_ssthresh,
1094         .min_tso_segs   = bbr_min_tso_segs,
1095         .get_info       = bbr_get_info,
1096         .set_state      = bbr_set_state,
1097 };
1098
1099 static int __init bbr_register(void)
1100 {
1101         BUILD_BUG_ON(sizeof(struct bbr) > ICSK_CA_PRIV_SIZE);
1102         return tcp_register_congestion_control(&tcp_bbr_cong_ops);
1103 }
1104
1105 static void __exit bbr_unregister(void)
1106 {
1107         tcp_unregister_congestion_control(&tcp_bbr_cong_ops);
1108 }
1109
1110 module_init(bbr_register);
1111 module_exit(bbr_unregister);
1112
1113 MODULE_AUTHOR("Van Jacobson <vanj@google.com>");
1114 MODULE_AUTHOR("Neal Cardwell <ncardwell@google.com>");
1115 MODULE_AUTHOR("Yuchung Cheng <ycheng@google.com>");
1116 MODULE_AUTHOR("Soheil Hassas Yeganeh <soheil@google.com>");
1117 MODULE_LICENSE("Dual BSD/GPL");
1118 MODULE_DESCRIPTION("TCP BBR (Bottleneck Bandwidth and RTT)");