Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion quest/m2/quic-realtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,17 @@ spike assumed no consumer; teleoperation uplinks are one):
upgrading `Delay`, so current users see no behavior change.
- Docs: inline only. The congestion-control lines in `doc/bin/cli.md` and
`doc/lib/*` gain the new variant; no new page.
- SCReAMv2 landed as `moq_congestion::Scream`
([moq-dev/moq#7547](https://github.com/moq-dev/moq/pull/7547)). moq-quic's
`tests::scream` measures it on the sim beside BBR3, and moq-tokio's
`scream` integration tests over the real presets. Its estimate is a window
over the RTT rather than a delivery rate: under application-limited media,
each keyframe's burst raises it past the path's capacity, which matters
for re-enabling a rung. Its frame p95 on the sim rose under #7606's
corrected pacer, from 853 to 1327 ms on `cellular-step` and from 300 to
1361 ms on `cellular-deep`: its keyframes (5x a delta frame) no longer
overshoot its pacing of 1.5x the target rate, and the draft's media-queue
terms that would answer that sender backlog were left out.

The shared pacer's low-rate correction and BBR3's one-datagram minimum send
quantum are implemented together in [moq-dev/moq#7606](https://github.com/moq-dev/moq/pull/7606).
Expand Down Expand Up @@ -117,7 +128,6 @@ owns that feedback.
## Required

- [BBR3 delay bound](/quest/m2/quic-realtime/bbr-delay-bound.md) - BBR3 with inflight capped when the forward delay gradient shows queue growth
- [SCReAMv2 candidate](/quest/m2/quic-realtime/scream.md) - the RFC 8298bis delay path ported to `moq-congestion`
- [io_uring runs an application's controller](/quest/m2/quic-realtime/uring-controller.md) - moq-uring takes a controller factory, so the winner installs the same way on both runtimes
- [moqsink encoder feedback](/quest/m2/quic-realtime/moqsink-feedback.md) - GStreamer publishers retune their encoder to the target rate

Expand Down
25 changes: 0 additions & 25 deletions quest/m2/quic-realtime/scream.md

This file was deleted.

5 changes: 4 additions & 1 deletion rs/justfile
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ doctest *args:
miri *args:
bash sh/rs/miri.sh "$@"

# Run the moq-quic simulation's random workloads from a fresh seed, printing the settings that replay it, then the bandwidth probe's acceptance suite and the receive-timestamps comparison.
# Run the moq-quic simulation's random workloads from a fresh seed, printing the settings that replay it, then the bandwidth probe's acceptance suite, the receive-timestamps comparison, and the realtime controllers' comparison.
quic-sim:
#!/usr/bin/env bash
set -euo pipefail
Expand All @@ -341,6 +341,9 @@ quic-sim:
bash sh/rs/nextest.sh cargo nextest run --locked --release -p moq-quic --lib -E 'test(/^tests::sim::/)'
# The bandwidth probe's acceptance suite, over fixed seeds: the merge gate runs only its short cases.
bash sh/rs/nextest.sh cargo nextest run --locked --release -p moq-quic --lib --run-ignored only -E 'test(/^tests::probe::/)'
# SCReAMv2's queue, throughput and reaction on the cellular presets: on the sim beside BBR3, then over real sockets through moq-shaper, one preset at a time.
bash sh/rs/nextest.sh cargo nextest run --locked --release -p moq-quic --lib --run-ignored only --no-capture -E 'test(/^tests::scream::/)'
bash sh/rs/nextest.sh cargo nextest run --locked --release -p moq-tokio --test integration --run-ignored only --no-capture --test-threads 1 -E 'test(/^scream::/)'
# Forward delay against RTT as a queue-growth signal: deterministic in the simulation, then over real sockets through each cellular moq-shaper preset, one at a time so they do not add to each other's noise.
bash sh/rs/nextest.sh cargo nextest run --locked --release -p moq-quic --lib --run-ignored only --no-capture -E 'test(/^tests::receive_ts::/)'
bash sh/rs/nextest.sh cargo nextest run --locked --release -p moq-tokio --test integration --run-ignored only --no-capture --test-threads 1 -E 'test(/^receive_ts::/)'
Expand Down
6 changes: 3 additions & 3 deletions rs/moq-congestion/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# moq-congestion

BBR3, Cubic, GCC, and Unlimited congestion controllers, consumed by moq-quic and the native transport drivers.
BBR3, Cubic, GCC, SCReAMv2, and Unlimited congestion controllers, consumed by moq-quic and the native transport drivers.

The controllers take explicit `kio::clock::Instant` values and never drive a runtime. The `Controller` trait names no transport types: `on_sent` returns an opaque per-packet state that the transport stores and hands back with each acknowledgement or loss, and the controller paces its own sends.

Construct controllers with `Factory::build` on an `Arc<bbr3::Config>`, `Arc<cubic::Config>`, `Arc<gcc::Config>`, or `Arc<Unlimited>`. `Bbr3`, `Cubic`, `Gcc`, `Unlimited`, and `Metrics` live at the crate root.
Construct controllers with `Factory::build` on an `Arc<bbr3::Config>`, `Arc<cubic::Config>`, `Arc<gcc::Config>`, `Arc<scream::Config>`, or `Arc<Unlimited>`. `Bbr3`, `Cubic`, `Gcc`, `Scream`, `Unlimited`, and `Metrics` live at the crate root.

For callers of the unpublished API, replace `Bbr3Config` with `bbr3::Config`, `CubicConfig` with `cubic::Config`, `ControllerFactory` with `Factory`, and `ControllerMetrics` with `Metrics`. Remove `Controller::into_any` from custom implementations; inspect the controller's behavior or metrics instead of downcasting. `clone_box` still copies controller state for path migration. The test-only `Bbr3::probing_rtt` and `min_rtt` accessors are removed; model internals are tested in this crate.

The code was extracted from [moq-quic](../moq-quic), under the same MIT or Apache-2.0 license. Cubic originated in quinn; BBR3 was ported from moq-dev/noq and carries the fixes listed in [moq-quic's fork history](../moq-quic/README.md).
The code was extracted from [moq-quic](../moq-quic), under the same MIT or Apache-2.0 license. Cubic originated in quinn; BBR3 was ported from moq-dev/noq and carries the fixes listed in [moq-quic's fork history](../moq-quic/README.md). SCReAMv2's delay-based path was ported from draft-ietf-ccwg-rfc8298bis-screamv2 and checked against Ericsson's [reference implementation](https://github.com/EricssonResearch/scream).

GCC is libwebrtc's Google Congestion Control, a delay-based controller that reads the peer's receive timestamps (draft-ietf-quic-receive-ts). `src/gcc` vendors a Rust port of WebRTC's `goog_cc` under WebRTC's BSD license, kept in [`src/gcc/LICENSE`](src/gcc/LICENSE) with its `PATENTS` grant; its module docs record the WebRTC revision it tracks and what it trims.

Expand Down
5 changes: 4 additions & 1 deletion rs/moq-congestion/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@ pub mod cubic;
pub mod gcc;
mod pacer;
mod rate;
pub mod scream;
mod unlimited;

pub use bbr3::Bbr3;
pub use cubic::Cubic;
pub use gcc::Gcc;
pub use rate::Packet;
pub use scream::Scream;
pub use unlimited::Unlimited;

/// Common interface for different congestion controllers
Expand Down Expand Up @@ -283,11 +285,12 @@ mod tests {
/// The largest UDP payload (RFC 9000), whose two datagrams outgrow every 1200-based default
const MTU: u16 = 65527;

fn factories() -> [(&'static str, Arc<dyn Factory>); 4] {
fn factories() -> [(&'static str, Arc<dyn Factory>); 5] {
[
("bbr3", Arc::new(bbr3::Config::default())),
("cubic", Arc::new(cubic::Config::default())),
("gcc", Arc::new(gcc::Config::default())),
("scream", Arc::new(scream::Config::default())),
("unlimited", Arc::new(Unlimited)),
]
}
Expand Down
Loading
Loading