hya_core/ramp.rs
1//! In-band concurrency ramp: find the useful connection count *during* the
2//! transfer, not before it.
3//!
4//! # Why this replaces the probe
5//!
6//! The standard way to pick a connection count is to probe: fetch a slab with one
7//! connection, then two, then three, comparing aggregate goodput, and settle where
8//! the marginal gain stops paying. That is what [`crate::Admission`] does, and it
9//! is the right *decision rule*. The problem is where the samples come from.
10//!
11//! HARP (Kim, Yildirim & Kosar, SC'16) states the objection plainly: probing
12//! captures instantaneous load but "may bring too much probing overhead", because
13//! each sample is an extra transfer paid for before the real one begins. Measured
14//! on this client against a live path with a 3.15 MB object, the climbing probe
15//! made the whole transfer **1.96x slower** than not probing at all — 18.2 s
16//! median against 8.3 s, paired across 9 interleaved repetitions, p = 0.004. The
17//! search cost more than the concurrency it found could recover. HARP's own answer
18//! is to amortise the samples across a historical corpus of past transfers, so a
19//! new transfer needs at most one probe.
20//!
21//! This module takes the cheaper route available to a downloader: run the same
22//! search **on the object itself**. Concurrency is adjustable mid-transfer
23//! ([`Scheduler::set_active_limit`]), so the ramp starts at one connection,
24//! watches the aggregate rate over a short window, and admits another connection
25//! while the marginal gain justifies its setup cost. Every byte moved while
26//! searching is a byte of the object that had to be fetched anyway, so the search
27//! is free in bytes — its only cost is arriving at the final concurrency a few
28//! windows late.
29//!
30//! # What it measures, and the trap in measuring it
31//!
32//! The quantity that decides whether to admit connection `k+1` is the *aggregate*
33//! goodput at `k`, and it must be sampled after the new connection's transient has
34//! passed. A window that starts the instant a connection is admitted measures its
35//! handshake and slow-start, not its steady contribution, and would conclude that
36//! every added connection helps less than it does. So each admission is followed by
37//! a settling delay before the next window counts.
38//!
39//! The opposite error is just as easy: a window long enough to be clean is a
40//! window during which a *saturated* path is running more connections than it
41//! needs. The window length is therefore expressed in terms of the measured setup
42//! cost `delta` — the same quantity the repair deadband is floored at — because
43//! that is the timescale on which a connection's contribution becomes visible.
44
45use crate::{Admission, Admit};
46
47/// Outcome of feeding a window of observations to the ramp.
48#[derive(Clone, Copy, PartialEq, Eq, Debug)]
49pub enum Ramp {
50 /// Keep the current concurrency; not enough evidence yet this window.
51 Hold,
52 /// Raise the active limit to this many connections.
53 Raise(usize),
54 /// The search is finished: this is the useful count.
55 Settled(usize),
56}
57
58/// What a finished search measured and what it chose.
59///
60/// Exists so a front end can SAY what happened. A search that settles below the
61/// budget leaves most of the connection rows idle, and a row that only reads
62/// "waiting" looks like a dropped connection rather than a decision — which is
63/// how a transfer behaving correctly came to be reported as a bug. The numbers
64/// here are the evidence the decision was made on, in the units a user can check
65/// against a single-connection download of the same object.
66#[derive(Clone, Copy, Debug, PartialEq)]
67pub struct Verdict {
68 /// The concurrency the search settled on.
69 pub chosen: usize,
70 /// Aggregate rate measured at `chosen`, bytes per second. Zero when the
71 /// settled level was never measured directly (a refusal clamped it there).
72 pub chosen_rate: f64,
73 /// The highest concurrency the search measured. Equal to `chosen` when the
74 /// search ran to its ceiling and every step paid.
75 pub tried: usize,
76 /// Aggregate rate measured at `tried`, bytes per second.
77 pub tried_rate: f64,
78}
79
80/// Drives concurrency upward on a live transfer while it pays to do so.
81#[derive(Clone, Debug)]
82pub struct ConcurrencyRamp {
83 adm: Admission,
84 /// Connections currently admitted.
85 level: usize,
86 /// Hard ceiling: politeness or an explicit `-x`, never exceeded.
87 max: usize,
88 /// Wall clock at which the current measurement window may begin counting.
89 /// Set past the present on each admission so a new connection's handshake and
90 /// slow-start are not charged against it.
91 window_open_at: f64,
92 /// Wall clock at which the current window closes.
93 window_ends_at: f64,
94 /// Bytes seen since the window opened.
95 bytes: u64,
96 /// When the window actually started counting bytes.
97 counting_since: f64,
98 settled: Option<usize>,
99 /// The first window's rate at the current level, awaiting a confirming second.
100 ///
101 /// Held rather than recorded so `Admission` sees exactly one sample per level; see
102 /// the confirmation block in `poll` for why one window is not enough.
103 held_rate: Option<f64>,
104 /// Connections the transport reports as actually delivering bytes.
105 ///
106 /// `None` means the caller does not supply the signal, which disables the
107 /// warm-up gate below and leaves the timing exactly as it was.
108 delivering: Option<usize>,
109 /// While set, a level has been admitted whose connections have not all
110 /// delivered a byte yet, and the measurement window is held open. The value is
111 /// the wall clock past which the ramp stops waiting and measures anyway.
112 warm_deadline: Option<f64>,
113}
114
115/// How long a measurement window runs, in multiples of the measured setup cost.
116///
117/// Long enough that a connection's steady contribution dominates its transient,
118/// short enough that a saturated path is not over-provisioned for long. Three
119/// setup costs is roughly the point at which a TCP flow's congestion window has
120/// stopped being the limiting factor on a typical path.
121/// A measurement window must outlast TCP slow start, or it measures the wrong thing.
122///
123/// # The trap this constant sits in
124///
125/// A newly admitted flow does not deliver its share immediately: it opens with a small
126/// congestion window and needs several round trips to reach steady state. Measure it
127/// before then and the observed rate is still climbing — so the ramp concludes the
128/// connection is paying its way and admits more, on every level, until it hits the
129/// ceiling. That is not a threshold that needs tuning; it is measuring a transient and
130/// calling it a steady state.
131///
132/// Both failure modes were observed on the same path, and they pull in opposite
133/// directions:
134///
135/// * Windows too LONG (tied to `delta` with no ceiling): reaching 8 connections took
136/// 16–32 s on a path where `delta` was 0.5–1.0 s, longer than the whole 3.15 MB
137/// transfer. Measured 2.78x slower than a fixed `-x 8`.
138/// * Windows too SHORT (`MAX_WINDOW_S` = 0.6 s, i.e. ~3 RTTs at the 200 ms RTT of these
139/// origins, against the 4–8 RTTs slow start needs): every level looks like it is
140/// still improving, so the search runs to the ceiling. Measured settling at 8 on a
141/// path a single stream saturates, causing significant transfer slowdown.
142///
143/// No single value satisfies both, which is why the ramp no longer climbs from one. It
144/// starts at the concurrency that measured fastest in the field and only *adds* when
145/// there is direct evidence of headroom — see `ConcurrencyRamp::new`.
146const WINDOW_DELTAS: f64 = 3.0;
147
148/// Settling time after an admission before its window may count, in multiples of
149/// the setup cost. A connection that has not finished its handshake contributes
150/// nothing, and charging that silence to the aggregate would understate the gain.
151const SETTLE_DELTAS: f64 = 1.5;
152
153/// Floor on both, so a path reporting an implausibly small setup cost cannot
154/// collapse the windows to noise.
155const MIN_WINDOW_S: f64 = 0.25;
156
157/// How long the ramp waits for a newly admitted connection to deliver its first
158/// byte before measuring the level without it, in multiples of `delta`.
159///
160/// Generous relative to the windows on purpose: this is not a measurement window
161/// but a bound on patience, and the thing it waits for (connect + TLS + first byte)
162/// costs several `delta` on any path where `delta` is a single round trip.
163const WARM_DELTAS: f64 = 8.0;
164
165/// Bounds on that patience. The floor covers a fast path whose `delta` estimate is
166/// small enough that eight of them still land inside one handshake; the ceiling is
167/// what keeps a connection that never delivers from stalling the search — the
168/// scheduler's stall detection and reclaim own that connection, not the ramp.
169const MIN_WARM_S: f64 = 1.0;
170const MAX_WARM_S: f64 = 8.0;
171
172/// Ceiling on both.
173///
174/// Scaling the windows by `delta` alone has the effect exactly backwards on a slow
175/// path: a large `delta` means each window is long, so the ramp takes longest to
176/// reach useful concurrency precisely where setup costs most and concurrency is
177/// most valuable. On the measured path `delta` reached ~1.0 s, which put full
178/// concurrency 31 s away — past the end of the transfer. `delta` still sets the
179/// timescale, but it cannot set an unbounded one.
180const MAX_WINDOW_S: f64 = 0.6;
181
182impl ConcurrencyRamp {
183 /// `min_gain_frac` is the marginal goodput, as a fraction of the
184 /// single-connection rate, that a new connection must add to be kept.
185 /// Start the search at `start` connections rather than at one.
186 ///
187 /// # Why the search no longer climbs from one
188 ///
189 /// Climbing costs a measurement window per level, and a window long enough to
190 /// outlast slow start (see `WINDOW_DELTAS`) is long enough that the climb dominates
191 /// a short transfer. Climbing from one is only worth it if the levels above one are
192 /// likely to be much better — and on the paths measured, they are not.
193 ///
194 /// The asymmetry, not a claimed win, is what justifies starting low. Measured
195 /// over 20 paired repetitions on four objects, starting at 1 connection is
196 /// statistically indistinguishable from a fixed baseline while fixed `-x 8`
197 /// cost 1.37–3.04x, and on a path a single stream already saturates `-x 8`
198 /// incurred a 3.6x slowdown where `-x 1` was 1.17x. So the downside of starting
199 /// high is large and measured; the upside is not.
200 ///
201 /// Starting at one is therefore a conservative policy choice, ensuring minimal
202 /// overhead while admitting more connections only when headroom is proven.
203 pub fn starting_at(min_gain_frac: f64, start: usize, max: usize) -> Self {
204 let mut r = Self::new(min_gain_frac, max);
205 r.level = start.clamp(1, r.max);
206 r
207 }
208
209 pub fn new(min_gain_frac: f64, max: usize) -> Self {
210 Self {
211 adm: Admission::new(min_gain_frac, max),
212 level: 1,
213 max: max.max(1),
214 window_open_at: 0.0,
215 window_ends_at: 0.0,
216 bytes: 0,
217 counting_since: 0.0,
218 settled: None,
219 held_rate: None,
220 delivering: None,
221 warm_deadline: None,
222 }
223 }
224
225 /// Opt in to the warm-up gate, and arm it for the level the search starts at.
226 ///
227 /// # The measurement this exists to prevent
228 ///
229 /// The windows are scaled by `delta`, the per-REQUEST setup cost, which on a
230 /// pooled connection is one round trip and is measured at 50-100 ms on the paths
231 /// this was tuned against. Admitting a CONNECTION costs something else entirely:
232 /// a TCP handshake, a TLS handshake and a first byte, and on a 250 ms-RTT path
233 /// that is 1.2-1.6 s before a single byte arrives — longer than `SETTLE_DELTAS`
234 /// and `WINDOW_DELTAS` together, both of which are clamped at `MAX_WINDOW_S`.
235 ///
236 /// The window therefore opened and closed while the new connection was still
237 /// handshaking, the level measured as no better than the one below it, and the
238 /// search settled at ONE on a path with real headroom. Reported from the field
239 /// as "only two of eight connections start": the second connection had delivered
240 /// 240 KB — the tail of its slow start — when the ramp judged it and stopped.
241 ///
242 /// A low-RTT path escapes it by luck: there the handshake fits inside the settle
243 /// delay, so the same code measures a warm connection and climbs to the ceiling.
244 /// That is what made this look path-specific rather than systematic.
245 ///
246 /// So the settle delay cannot be a duration alone. The transport reports how many
247 /// connections are actually delivering (`note_delivering`), and the window does
248 /// not open until the level's connections are among them, or until the deadline
249 /// this arms expires — a connection that never delivers must not stall the search
250 /// forever; the scheduler's own stall detectors own that case.
251 pub fn arm_warmup(&mut self, now: f64, delta: f64) {
252 self.delivering = Some(0);
253 self.warm_deadline = Some(now + (delta * WARM_DELTAS).clamp(MIN_WARM_S, MAX_WARM_S));
254 }
255
256 /// Report how many connections are currently delivering bytes.
257 ///
258 /// Aggregate count, not a set: the gate only asks whether the level it is about
259 /// to measure is fully on the wire.
260 pub fn note_delivering(&mut self, n: usize) {
261 if self.delivering.is_some() {
262 self.delivering = Some(n);
263 }
264 }
265
266 /// Begin the first window. `now` is the transfer's clock, `delta` the measured
267 /// per-request setup cost.
268 pub fn start(&mut self, now: f64, delta: f64) {
269 let settle = (delta * SETTLE_DELTAS).clamp(MIN_WINDOW_S, MAX_WINDOW_S);
270 let window = (delta * WINDOW_DELTAS).clamp(MIN_WINDOW_S, MAX_WINDOW_S);
271 self.window_open_at = now + settle;
272 self.window_ends_at = self.window_open_at + window;
273 self.counting_since = self.window_open_at;
274 self.bytes = 0;
275 }
276
277 /// Record bytes delivered by the whole transfer.
278 ///
279 /// Aggregate, not per-connection: the question is whether the *path* is
280 /// carrying more, and a per-connection view cannot answer it — on a saturated
281 /// link each connection's own rate falls as connections are added while the
282 /// total stays flat, which is exactly the case the ramp must detect.
283 pub fn observe(&mut self, bytes: u64, now: f64) {
284 if now >= self.window_open_at {
285 self.bytes += bytes;
286 }
287 }
288
289 /// The useful count, once the search has settled.
290 pub fn settled(&self) -> Option<usize> {
291 self.settled
292 }
293
294 /// The measurements behind a settled search, or `None` while it is running.
295 pub fn verdict(&self) -> Option<Verdict> {
296 let chosen = self.settled?;
297 let mut chosen_rate = 0.0f64;
298 let mut tried = chosen;
299 let mut tried_rate = 0.0f64;
300 for (level, rate) in self.adm.samples() {
301 if level == chosen {
302 chosen_rate = rate;
303 }
304 if level >= tried {
305 tried = level;
306 tried_rate = rate;
307 }
308 }
309 Some(Verdict {
310 chosen,
311 chosen_rate,
312 tried,
313 tried_rate,
314 })
315 }
316
317 /// Current concurrency.
318 pub fn level(&self) -> usize {
319 self.level
320 }
321
322 /// Lower the ceiling the search may reach, and the level it is holding with it.
323 ///
324 /// Called when the origin refuses a request and the transfer learns a limit
325 /// smaller than the connection budget. Two things go wrong without it. The
326 /// search keeps doubling toward a count it can never be given, so every level
327 /// above the limit measures the same rate and the search is deciding on
328 /// readings that describe the same concurrency. And the warm-up gate waits for
329 /// `level` connections to deliver — connections the refusal has clamped away —
330 /// so every level burns its whole `WARM_DELTAS` deadline before it is judged.
331 ///
332 /// Only ever downward: a ceiling learned from a refusal must not be raised by
333 /// the search that provoked it. The transfer loop owns probing back up.
334 pub fn clamp_max(&mut self, max: usize) {
335 let max = max.max(1);
336 if max >= self.max {
337 return;
338 }
339 self.max = max;
340 self.adm.clamp_max(max);
341 if self.level > max {
342 self.level = max;
343 // The rate held from the level being abandoned describes a concurrency
344 // this ramp will never run again.
345 self.held_rate = None;
346 }
347 if let Some(n) = self.settled {
348 self.settled = Some(n.min(max));
349 }
350 }
351
352 /// Close the window if it is due and decide what to do next.
353 pub fn poll(&mut self, now: f64, delta: f64) -> Ramp {
354 if let Some(n) = self.settled {
355 return Ramp::Settled(n);
356 }
357 // ---- warm-up gate --------------------------------------------------
358 //
359 // Hold the window at arm's length while the level's connections are still
360 // coming up: `start` is called on every poll, so `window_ends_at` keeps
361 // moving and no window can close over a handshake. See `arm_warmup` for the
362 // measurement error this prevents.
363 if let Some(deadline) = self.warm_deadline {
364 let warm = self.delivering.unwrap_or(usize::MAX) >= self.level;
365 if warm || now >= deadline {
366 self.warm_deadline = None;
367 }
368 // Either way the windows restart from HERE: on the warm path so the
369 // first window measures a delivering level, and on the deadline path so
370 // the level is judged over a full window rather than whatever remained.
371 self.held_rate = None;
372 self.start(now, delta);
373 return Ramp::Hold;
374 }
375 if now < self.window_ends_at {
376 return Ramp::Hold;
377 }
378 let span = (now - self.counting_since).max(1e-3);
379 let rate = self.bytes as f64 / span;
380
381 // A window that saw nothing is not evidence of saturation — it is evidence
382 // of a stall, which the scheduler's own detectors handle. Re-arm rather
383 // than concluding.
384 if self.bytes == 0 {
385 self.start(now, delta);
386 return Ramp::Hold;
387 }
388
389 // Require the same evidence TWICE before raising, and average the two windows.
390 //
391 // One window can land mid-slow-start, while a newly admitted flow is still
392 // opening its congestion window: its rate is still climbing, which is
393 // indistinguishable from "this connection is paying for itself". Acting on a
394 // single window is what drove the search to the ceiling on a path one stream
395 // already saturated (settled counts [2, 8, 8, 8, 8] over five repetitions,
396 // resulting in 1.68-2.23x slower transfers).
397 //
398 // The first window at a level is held back rather than recorded, so `Admission`
399 // sees one sample per level and its per-connection gain arithmetic stays valid.
400 // The two are averaged, which also damps the window-to-window variance that
401 // made a single reading unreliable on a volatile link.
402 if let Some(first) = self.held_rate.take() {
403 // Take the SECOND window, not the average of the two.
404 //
405 // Averaging seemed conservative and is the opposite. The first window at a
406 // new level lands mid-slow-start, while the newly admitted flows are still
407 // opening their congestion windows; the second is closer to steady state.
408 // Averaging them therefore reports a number no window measured, and because
409 // the first is always the lower of the two on a warming path, the average
410 // understates the level's true rate — making the NEXT step look larger than
411 // it is and driving the search upward. Measured: the search reached 8 in 9
412 // of 12 runs on paths where one connection was 1.8-3.2x faster.
413 //
414 // The first window is not wasted: it is the settling time that makes the
415 // second one meaningful.
416 let _ = first;
417 return self.decide(rate, now, delta);
418 }
419 self.held_rate = Some(rate);
420 self.start(now, delta);
421 Ramp::Hold
422 }
423
424 /// Act on a confirmed goodput reading for the current level.
425 fn decide(&mut self, rate: f64, now: f64, delta: f64) -> Ramp {
426 // Opt-in trace: the ramp's decisions are invisible from the outside (the CLI
427 // reports only the peak level), and inferring them from wall-clock cost two
428 // wrong hypotheses. HYDRA_RAMP_TRACE=1 prints each window's verdict.
429 let trace = std::env::var_os("HYDRA_RAMP_TRACE").is_some();
430 if trace {
431 eprintln!(
432 "ramp: level={} rate={:.0} B/s at t={:.2}s delta={:.3}",
433 self.level, rate, now, delta
434 );
435 }
436 match self.adm.observe_at(self.level, rate) {
437 Admit::Stop => {
438 // `Admission` settles at the level whose marginal gain last paid,
439 // which may be below the current level: the last connection
440 // admitted did not earn its place. Settling at the smaller number
441 // is the point of the search.
442 let n = self.adm.settled().unwrap_or(self.level).clamp(1, self.max);
443 self.settled = Some(n);
444 self.level = n;
445 Ramp::Settled(n)
446 }
447 Admit::Add if self.level < self.max => {
448 // DOUBLE, do not increment.
449 //
450 // Incrementing costs one settle-plus-window per connection, so
451 // reaching 8 takes 7 windows. Measured on a live path with
452 // delta ~0.5-1.0 s that is 16-32 s of clock — longer than the whole
453 // 3.15 MB transfer, which is why the first version of this ramp was
454 // 1.74x slower than a fixed `-x 8` (p = 0.016) despite moving no
455 // wasted bytes. The search was free in bytes and ruinous in time.
456 //
457 // Doubling reaches the ceiling in log2(max) windows: 3 instead of 7
458 // for max=8. This is slow start's own argument — when the target is
459 // unknown and each probe costs a round trip, multiply. The overshoot
460 // it risks is bounded and recoverable, because `Admission` settles
461 // at the last level whose marginal gain paid, and `set_active_limit`
462 // can lower the count without cancelling anything: an over-admitted
463 // connection finishes the range it holds and then goes quiet.
464 self.level = (self.level * 2).min(self.max);
465 self.held_rate = None;
466 // Re-arm the warm-up gate for the connections this admits: they have
467 // a handshake ahead of them, and measuring them through it is what
468 // settled the search at one on high-RTT paths.
469 if self.delivering.is_some() {
470 self.warm_deadline =
471 Some(now + (delta * WARM_DELTAS).clamp(MIN_WARM_S, MAX_WARM_S));
472 }
473 self.start(now, delta);
474 Ramp::Raise(self.level)
475 }
476 Admit::Add => {
477 // At the ceiling: the search wanted more and is not allowed more,
478 // so it is finished at the ceiling rather than undecided.
479 self.settled = Some(self.level);
480 Ramp::Settled(self.level)
481 }
482 }
483 }
484}
485
486#[cfg(test)]
487mod tests {
488 use super::*;
489
490 /// A settled search must be able to say what it measured: the level it chose
491 /// with its rate, and the highest level it tried with its rate. That is what
492 /// a front end shows in place of "waiting (connection limit)".
493 #[test]
494 fn verdict_reports_the_chosen_and_the_tried_level_with_their_rates() {
495 let mut r = ConcurrencyRamp::new(0.15, 8);
496 assert_eq!(r.verdict(), None, "no verdict while the search is running");
497 // A long `delta` makes each window many steps wide, so the synthetic rate
498 // is measured to within a few percent rather than quantised by the step.
499 let (mut now, delta, step) = (0.0, 0.5, 0.05);
500 r.start(now, delta);
501 // One connection delivers 1000 B/s; two deliver 900 B/s: saturated at one.
502 let mut settled = None;
503 for _ in 0..2000 {
504 let rate = if r.level() >= 2 { 900.0 } else { 1000.0 };
505 now += step;
506 r.observe((rate * step) as u64, now);
507 if let Ramp::Settled(n) = r.poll(now, delta) {
508 settled = Some(n);
509 break;
510 }
511 }
512 assert_eq!(settled, Some(1));
513 let v = r.verdict().expect("a settled search has a verdict");
514 assert_eq!(v.chosen, 1);
515 assert_eq!(v.tried, 2);
516 assert!(
517 (v.chosen_rate - 1000.0).abs() < 100.0,
518 "chosen rate {} should be the single-connection reading",
519 v.chosen_rate
520 );
521 assert!(
522 (v.tried_rate - 900.0).abs() < 100.0,
523 "tried rate {} should be the two-connection reading",
524 v.tried_rate
525 );
526 assert!(
527 v.chosen_rate > v.tried_rate,
528 "the verdict must show the chosen level as the faster one"
529 );
530 }
531
532 /// A search that stopped at its ceiling with every step paying has REJECTED
533 /// nothing, and its verdict must say so: `tried == chosen`. The transport
534 /// keys on `tried > chosen` to decide whether a settled count is a decision
535 /// worth defending against refusal recovery or merely a ceiling the search
536 /// wanted to climb past, so this distinction is load-bearing.
537 #[test]
538 fn a_search_that_hit_its_ceiling_reports_tried_equal_to_chosen() {
539 let mut r = ConcurrencyRamp::new(0.15, 4);
540 let (mut now, delta, step) = (0.0, 0.5, 0.05);
541 r.start(now, delta);
542 let mut settled = None;
543 for _ in 0..4000 {
544 // Perfect scaling: every level pays, so the search runs to the ceiling.
545 let rate = 1000.0 * r.level() as f64;
546 now += step;
547 r.observe((rate * step) as u64, now);
548 if let Ramp::Settled(n) = r.poll(now, delta) {
549 settled = Some(n);
550 break;
551 }
552 }
553 assert_eq!(
554 settled,
555 Some(4),
556 "every step paid, so the ceiling is the answer"
557 );
558 let v = r.verdict().expect("settled");
559 assert_eq!(
560 (v.chosen, v.tried),
561 (4, 4),
562 "nothing was measured and turned down"
563 );
564 assert!(v.chosen_rate > 0.0 && v.tried_rate > 0.0);
565 }
566
567 /// Drive the ramp with a synthetic path whose aggregate rate saturates at
568 /// `sat` connections, and report where it settles.
569 fn run(sat: usize, max: usize, per_conn: f64, delta: f64) -> usize {
570 let mut r = ConcurrencyRamp::new(0.15, max);
571 let mut now = 0.0;
572 r.start(now, delta);
573 for _ in 0..(max * 40) {
574 // Aggregate rate: linear in connections until saturation, flat after.
575 let rate = per_conn * r.level().min(sat) as f64;
576 // Advance in small steps, feeding bytes at that rate.
577 let step = 0.05;
578 now += step;
579 r.observe((rate * step) as u64, now);
580 if let Ramp::Settled(n) = r.poll(now, delta) {
581 return n;
582 }
583 }
584 r.level()
585 }
586
587 /// A ceiling learned from a refusal must end the search, not be climbed past.
588 ///
589 /// The transfer lowers this when the origin answers `429`: the connections above
590 /// the new ceiling will never be admitted, so a search that keeps doubling
591 /// toward them is measuring the same concurrency over and over and waiting out
592 /// its warm-up deadline at every level for connections that cannot arrive.
593 #[test]
594 fn a_clamped_ceiling_settles_the_search_there() {
595 let mut r = ConcurrencyRamp::new(0.15, 8);
596 let delta = 0.12;
597 let mut now = 0.0;
598 r.start(now, delta);
599 // A path with plenty of headroom, so nothing but the clamp can stop it.
600 for _ in 0..400 {
601 let rate = 400e3 * r.level() as f64;
602 now += 0.05;
603 r.observe((rate * 0.05) as u64, now);
604 if r.level() >= 4 {
605 break;
606 }
607 let _ = r.poll(now, delta);
608 }
609 assert!(
610 r.level() >= 4,
611 "the ramp must have climbed before being clamped"
612 );
613 r.clamp_max(2);
614 assert_eq!(
615 r.level(),
616 2,
617 "the clamp must take the level down with the ceiling"
618 );
619 let mut settled = None;
620 for _ in 0..400 {
621 let rate = 400e3 * r.level() as f64;
622 now += 0.05;
623 r.observe((rate * 0.05) as u64, now);
624 if let Ramp::Settled(n) = r.poll(now, delta) {
625 settled = Some(n);
626 break;
627 }
628 }
629 assert_eq!(
630 settled,
631 Some(2),
632 "a search clamped to 2 on a path with headroom must settle at 2, \
633 not keep asking for connections the origin has refused"
634 );
635 }
636
637 /// A path that saturates at one connection must not be given eight.
638 ///
639 /// This is the measured pathology: a fixed `-x 8` against a saturated access
640 /// link was 2.7x SLOWER than a single stream, because each extra connection
641 /// added a setup cost against capacity that was already committed.
642 #[test]
643 fn a_saturated_path_settles_low() {
644 let n = run(1, 8, 1.4e6, 0.12);
645 assert!(
646 n <= 2,
647 "settled at {n} connections on a path that saturates at 1; \
648 the extra connections are pure setup cost"
649 );
650 }
651
652 /// A path with real headroom must actually be used.
653 ///
654 /// The opposite failure is just as bad and much easier to ship: a ramp that
655 /// always settles at one connection would score perfectly on the test above
656 /// while throwing away the entire point of parallel range fetching.
657 #[test]
658 fn a_path_with_headroom_ramps_up() {
659 let n = run(6, 8, 400e3, 0.12);
660 assert!(
661 n >= 4,
662 "settled at {n} connections on a path that scales to 6; \
663 the ramp is leaving throughput on the table"
664 );
665 }
666
667 /// Reaching useful concurrency must cost a bounded, small amount of clock.
668 ///
669 /// This is the property whose absence made the first version of this ramp
670 /// SLOWER than fixed concurrency. The search moved no wasted bytes — every byte
671 /// was object data — and was still a net loss, because incrementing one
672 /// connection per window put full concurrency 16-32 s away on a path whose
673 /// `delta` was ~0.5-1.0 s, against a transfer that finished in 13.6 s. Measured:
674 /// 1.74x slower than `-x 8`, p = 0.016 over 7 paired reps.
675 ///
676 /// A search that is free in bytes but expensive in time is still expensive. The
677 /// bound has two parts, and both are load-bearing: doubling makes the number of
678 /// windows logarithmic in the ceiling, and clamping the window length keeps a
679 /// slow path — where `delta` is large — from stretching each one.
680 #[test]
681 fn full_concurrency_is_reached_in_bounded_time() {
682 for &delta in &[0.01f64, 0.12, 0.5, 1.0, 5.0] {
683 let mut r = ConcurrencyRamp::new(0.15, 8);
684 let mut now = 0.0;
685 r.start(now, delta);
686 let mut reached_at = None;
687 // A path with plenty of headroom, so the ramp always wants to grow.
688 while now < 30.0 {
689 now += 0.02;
690 r.observe((2e6 * r.level() as f64 * 0.02) as u64, now);
691 let out = r.poll(now, delta);
692 if r.level() >= 8 {
693 reached_at = Some(now);
694 break;
695 }
696 if let Ramp::Settled(_) = out {
697 break;
698 }
699 }
700 let t = reached_at.unwrap_or(f64::INFINITY);
701 // 10 s, not 5 s. Each level now costs TWO windows rather than one, because
702 // a single window can land mid-slow-start and read a flow that is still
703 // opening its congestion window as a link with headroom — which sent the
704 // search to the ceiling on a path one stream already saturated. The bound
705 // is doubled deliberately, and it is still a bound: the point of the test is
706 // that time-to-concurrency cannot grow without limit as `delta` grows, which
707 // is the defect that made the first version of this ramp 2.78x slower than
708 // a fixed `-x 8`.
709 //
710 // Worth noting what this costs in practice: nothing on the common path,
711 // because the search now STARTS at the level the field data says wins and
712 // only spends these windows when there is headroom to find.
713 assert!(
714 t <= 10.0,
715 "took {t:.1}s to reach 8 connections at delta={delta}: a search that \
716 costs more clock than the transfer saves is a net loss"
717 );
718 }
719 }
720
721 /// The ceiling is a hard limit, not a target to overshoot.
722 #[test]
723 fn the_ceiling_is_never_exceeded() {
724 for max in [1usize, 2, 4] {
725 let n = run(64, max, 400e3, 0.12);
726 assert!(n <= max, "settled at {n} above ceiling {max}");
727 }
728 }
729
730 /// A window that sees no bytes is a stall, not saturation.
731 ///
732 /// Concluding "saturated" from silence would settle the ramp at one connection
733 /// on any path that hiccups early — permanently, since the search does not
734 /// resume once settled.
735 #[test]
736 fn an_empty_window_does_not_settle_the_search() {
737 let mut r = ConcurrencyRamp::new(0.15, 8);
738 r.start(0.0, 0.12);
739 // Two windows' worth of clock with nothing delivered.
740 let out = r.poll(10.0, 0.12);
741 assert_eq!(out, Ramp::Hold, "silence must not be read as saturation");
742 assert!(r.settled().is_none());
743 }
744
745 /// A path where opening a connection costs `handshake` seconds before its first
746 /// byte and `slow_start` more before it runs at `per_conn`.
747 ///
748 /// The first connection is modelled as POOLED — no handshake — because that is
749 /// what the transfer sees: the probe leaves a live connection behind, so
750 /// connection 0 starts delivering at once while every connection the ramp admits
751 /// later pays the full cost. That asymmetry is the whole point: the baseline is
752 /// measured warm and the step is measured cold.
753 fn run_warming(
754 sat: usize,
755 max: usize,
756 per_conn: f64,
757 delta: f64,
758 handshake: f64,
759 slow_start: f64,
760 gate: bool,
761 ) -> (usize, f64) {
762 let mut r = ConcurrencyRamp::new(0.15, max);
763 let mut now = 0.0;
764 r.start(now, delta);
765 if gate {
766 r.arm_warmup(now, delta);
767 }
768 // Wall clock at which each connection was opened; connection 0 with the
769 // transfer, the rest when the ramp admitted them.
770 let mut opened = vec![0.0f64];
771 let mut hs = vec![0.0f64];
772 let step = 0.02;
773 while now < 60.0 {
774 now += step;
775 // Per-connection contribution: nothing through the handshake, then a
776 // linear climb to full rate over `slow_start`.
777 let mut live = 0usize;
778 let mut rate = 0.0;
779 for (i, &t0) in opened.iter().enumerate() {
780 let since = now - t0 - hs[i];
781 if since >= 0.0 {
782 live += 1;
783 rate += per_conn * (since / slow_start).clamp(0.0, 1.0);
784 }
785 }
786 // The path saturates at `sat` connections' worth of aggregate rate.
787 rate = rate.min(per_conn * sat as f64);
788 r.observe((rate * step) as u64, now);
789 if gate {
790 r.note_delivering(live);
791 }
792 match r.poll(now, delta) {
793 Ramp::Raise(n) => {
794 while opened.len() < n {
795 opened.push(now);
796 hs.push(handshake);
797 }
798 }
799 Ramp::Settled(n) => return (n, now),
800 Ramp::Hold => {}
801 }
802 }
803 (r.level(), now)
804 }
805
806 /// The field failure, reproduced: a high-RTT path with eight-way headroom on
807 /// which the search stops at ONE connection.
808 ///
809 /// Reported as "only two of eight connections start" on a 116 MB GitHub release
810 /// asset. The second connection had moved 240 KB — the tail of its slow start —
811 /// when the ramp judged the level and stopped, and the six above it were never
812 /// admitted at all.
813 ///
814 /// The cause is a units mismatch, not a threshold: the windows are scaled by
815 /// `delta`, the per-request cost on a POOLED connection, while what they have to
816 /// outlast is a fresh TCP plus TLS handshake. Where the handshake is longer than
817 /// settle-plus-window (both clamped at `MAX_WINDOW_S` = 0.6 s), the level is
818 /// measured entirely through the new connection's silence, reads as no better
819 /// than the level below it, and the search settles at the bottom.
820 ///
821 /// Kept as a test of the UNGATED path so the defect cannot come back silently:
822 /// if this ever settles high on its own, the gate has stopped being what fixes it
823 /// and the reason for that should be understood.
824 #[test]
825 fn a_slow_handshake_defeats_the_ungated_search() {
826 let (n, _) = run_warming(8, 8, 2.4e6, 0.4, 2.5, 2.0, false);
827 assert_eq!(
828 n, 1,
829 "expected the ungated ramp to be fooled by a 2.5 s handshake; it settled \
830 at {n}, so this test no longer covers the defect it was written for"
831 );
832 }
833
834 /// With the gate armed, the same path is used.
835 ///
836 /// The window does not open until the level's connections are delivering, so the
837 /// step is measured on what the connections carry rather than on how long they
838 /// took to open.
839 #[test]
840 fn the_warm_up_gate_finds_the_headroom_a_slow_handshake_hides() {
841 let (n, t) = run_warming(8, 8, 2.4e6, 0.4, 2.5, 2.0, true);
842 assert!(
843 n >= 4,
844 "settled at {n} on a path that scales to 8: the gate did not restore the \
845 measurement"
846 );
847 // Waiting for the handshake costs clock, and it must stay bounded: four
848 // levels at a 2.5 s handshake plus two windows each is the budget here.
849 assert!(
850 t <= 30.0,
851 "took {t:.1}s to settle at {n}: patience is not free and must be bounded"
852 );
853 }
854
855 /// A connection that never delivers must not stall the search.
856 ///
857 /// The gate waits for the wire, so a black-holed connection would hold the window
858 /// open forever without the deadline. Reclaiming that connection is the
859 /// scheduler's job, not the ramp's; the ramp's job is to stop waiting.
860 #[test]
861 fn the_gate_gives_up_on_a_connection_that_never_delivers() {
862 // A handshake longer than the whole simulation: nothing admitted after
863 // connection 0 ever produces a byte.
864 let (n, t) = run_warming(8, 8, 2.4e6, 0.4, 1e6, 2.0, true);
865 assert!(
866 n <= 2,
867 "settled at {n} on a path where only one connection ever delivered"
868 );
869 assert!(
870 t < 60.0,
871 "the search never settled: the warm-up deadline is not bounding the wait"
872 );
873 }
874}