rwebtransport 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Cargo.lock +666 -0
- package/Cargo.toml +31 -0
- package/LICENSE +202 -0
- package/NOTICE +41 -0
- package/README.md +550 -0
- package/crates/echo-server/Cargo.toml +20 -0
- package/crates/echo-server/src/main.rs +666 -0
- package/crates/native/Cargo.toml +23 -0
- package/crates/native/src/config.rs +129 -0
- package/crates/native/src/driver.rs +463 -0
- package/crates/native/src/lib.rs +821 -0
- package/crates/native/src/server.rs +718 -0
- package/crates/native/src/session.rs +1191 -0
- package/crates/native/src/tls.rs +96 -0
- package/crates/wtcore/Cargo.toml +15 -0
- package/crates/wtcore/src/h3.rs +226 -0
- package/crates/wtcore/src/lib.rs +9 -0
- package/dist/datagrams.d.ts +16 -0
- package/dist/errors.d.ts +10 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +1512 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +1473 -0
- package/dist/index.mjs.map +1 -0
- package/dist/loader.d.ts +2 -0
- package/dist/native.d.ts +226 -0
- package/dist/server.d.ts +44 -0
- package/dist/streams.d.ts +14 -0
- package/dist/types.d.ts +24 -0
- package/dist/webtransport.d.ts +20 -0
- package/package.json +79 -0
- package/prebuilds/win32-x64/rwebtransport.node +0 -0
- package/scripts/bench.mjs +180 -0
- package/scripts/build.js +67 -0
- package/scripts/postinstall.js +67 -0
- package/scripts/setup-unix.sh +129 -0
- package/scripts/setup-windows.ps1 +229 -0
- package/vendor/quiche/AGENTS.md +75 -0
- package/vendor/quiche/COPYING +23 -0
- package/vendor/quiche/Cargo.lock +1212 -0
- package/vendor/quiche/Cargo.toml +215 -0
- package/vendor/quiche/README.md +466 -0
- package/vendor/quiche/examples/Makefile +46 -0
- package/vendor/quiche/examples/README.md +20 -0
- package/vendor/quiche/examples/cert-big.crt +90 -0
- package/vendor/quiche/examples/cert.crt +18 -0
- package/vendor/quiche/examples/cert.key +28 -0
- package/vendor/quiche/examples/client.c +343 -0
- package/vendor/quiche/examples/client.rs +281 -0
- package/vendor/quiche/examples/gen-certs.sh +15 -0
- package/vendor/quiche/examples/http3-client.c +473 -0
- package/vendor/quiche/examples/http3-client.rs +349 -0
- package/vendor/quiche/examples/http3-server.c +614 -0
- package/vendor/quiche/examples/http3-server.rs +680 -0
- package/vendor/quiche/examples/qpack-decode.rs +87 -0
- package/vendor/quiche/examples/qpack-encode.rs +88 -0
- package/vendor/quiche/examples/rootca.crt +21 -0
- package/vendor/quiche/examples/server.c +529 -0
- package/vendor/quiche/examples/server.rs +529 -0
- package/vendor/quiche/include/quiche.h +1282 -0
- package/vendor/quiche/quiche.svg +1 -0
- package/vendor/quiche/src/buffers.rs +105 -0
- package/vendor/quiche/src/build.rs +66 -0
- package/vendor/quiche/src/cid.rs +1079 -0
- package/vendor/quiche/src/crypto/boringssl.rs +373 -0
- package/vendor/quiche/src/crypto/mod.rs +671 -0
- package/vendor/quiche/src/dgram.rs +118 -0
- package/vendor/quiche/src/error.rs +263 -0
- package/vendor/quiche/src/ffi.rs +2290 -0
- package/vendor/quiche/src/flowcontrol.rs +246 -0
- package/vendor/quiche/src/frame.rs +2172 -0
- package/vendor/quiche/src/h3/AGENTS.md +54 -0
- package/vendor/quiche/src/h3/ffi.rs +442 -0
- package/vendor/quiche/src/h3/frame.rs +1404 -0
- package/vendor/quiche/src/h3/mod.rs +8223 -0
- package/vendor/quiche/src/h3/qpack/decoder.rs +288 -0
- package/vendor/quiche/src/h3/qpack/encoder.rs +235 -0
- package/vendor/quiche/src/h3/qpack/mod.rs +202 -0
- package/vendor/quiche/src/h3/qpack/static_table.rs +323 -0
- package/vendor/quiche/src/h3/stream.rs +1595 -0
- package/vendor/quiche/src/lib.rs +9556 -0
- package/vendor/quiche/src/minmax.rs +446 -0
- package/vendor/quiche/src/packet.rs +2334 -0
- package/vendor/quiche/src/path.rs +1374 -0
- package/vendor/quiche/src/pmtud.rs +652 -0
- package/vendor/quiche/src/rand.rs +64 -0
- package/vendor/quiche/src/range_buf.rs +186 -0
- package/vendor/quiche/src/ranges.rs +755 -0
- package/vendor/quiche/src/recovery/AGENTS.md +80 -0
- package/vendor/quiche/src/recovery/bandwidth.rs +565 -0
- package/vendor/quiche/src/recovery/bytes_in_flight.rs +179 -0
- package/vendor/quiche/src/recovery/congestion/cubic.rs +1038 -0
- package/vendor/quiche/src/recovery/congestion/delivery_rate.rs +514 -0
- package/vendor/quiche/src/recovery/congestion/hystart.rs +241 -0
- package/vendor/quiche/src/recovery/congestion/mod.rs +361 -0
- package/vendor/quiche/src/recovery/congestion/prr.rs +238 -0
- package/vendor/quiche/src/recovery/congestion/recovery.rs +1170 -0
- package/vendor/quiche/src/recovery/congestion/reno.rs +291 -0
- package/vendor/quiche/src/recovery/congestion/test_sender.rs +201 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr/bandwidth_sampler.rs +1947 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr/windowed_filter.rs +158 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr.rs +37 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr2/drain.rs +120 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr2/mode.rs +318 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr2/network_model.rs +784 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr2/probe_bw.rs +729 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr2/probe_rtt.rs +175 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr2/startup.rs +190 -0
- package/vendor/quiche/src/recovery/gcongestion/bbr2.rs +855 -0
- package/vendor/quiche/src/recovery/gcongestion/mod.rs +275 -0
- package/vendor/quiche/src/recovery/gcongestion/pacer.rs +294 -0
- package/vendor/quiche/src/recovery/gcongestion/recovery.rs +1384 -0
- package/vendor/quiche/src/recovery/mod.rs +3086 -0
- package/vendor/quiche/src/recovery/rtt.rs +152 -0
- package/vendor/quiche/src/stream/mod.rs +2210 -0
- package/vendor/quiche/src/stream/recv_buf.rs +1236 -0
- package/vendor/quiche/src/stream/send_buf.rs +849 -0
- package/vendor/quiche/src/test_utils.rs +681 -0
- package/vendor/quiche/src/tests.rs +12922 -0
- package/vendor/quiche/src/tls/boringssl.rs +375 -0
- package/vendor/quiche/src/tls/mod.rs +1245 -0
- package/vendor/quiche/src/transport_params.rs +628 -0
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
// Copyright (C) 2024, Cloudflare, Inc.
|
|
2
|
+
// All rights reserved.
|
|
3
|
+
//
|
|
4
|
+
// Redistribution and use in source and binary forms, with or without
|
|
5
|
+
// modification, are permitted provided that the following conditions are
|
|
6
|
+
// met:
|
|
7
|
+
//
|
|
8
|
+
// * Redistributions of source code must retain the above copyright notice,
|
|
9
|
+
// this list of conditions and the following disclaimer.
|
|
10
|
+
//
|
|
11
|
+
// * Redistributions in binary form must reproduce the above copyright
|
|
12
|
+
// notice, this list of conditions and the following disclaimer in the
|
|
13
|
+
// documentation and/or other materials provided with the distribution.
|
|
14
|
+
//
|
|
15
|
+
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
|
16
|
+
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
17
|
+
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
18
|
+
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
19
|
+
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
20
|
+
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
21
|
+
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
22
|
+
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
23
|
+
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
24
|
+
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
25
|
+
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
26
|
+
|
|
27
|
+
mod bbr;
|
|
28
|
+
mod bbr2;
|
|
29
|
+
pub mod pacer;
|
|
30
|
+
mod recovery;
|
|
31
|
+
|
|
32
|
+
use std::fmt::Debug;
|
|
33
|
+
use std::str::FromStr;
|
|
34
|
+
use std::time::Instant;
|
|
35
|
+
|
|
36
|
+
pub use self::recovery::GRecovery;
|
|
37
|
+
use crate::recovery::bandwidth::Bandwidth;
|
|
38
|
+
|
|
39
|
+
use crate::recovery::rtt::RttStats;
|
|
40
|
+
use crate::recovery::RecoveryStats;
|
|
41
|
+
|
|
42
|
+
#[derive(Debug)]
|
|
43
|
+
pub struct Lost {
|
|
44
|
+
pub(super) packet_number: u64,
|
|
45
|
+
pub(super) bytes_lost: usize,
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
#[derive(Debug)]
|
|
49
|
+
pub struct Acked {
|
|
50
|
+
pub(super) pkt_num: u64,
|
|
51
|
+
pub(super) time_sent: Instant,
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
pub(super) trait CongestionControl: Debug {
|
|
55
|
+
/// Returns the name of the current state of the congestion control state
|
|
56
|
+
/// machine. Used to annotate qlogs after state transitions.
|
|
57
|
+
#[cfg(feature = "qlog")]
|
|
58
|
+
fn state_str(&self) -> &'static str;
|
|
59
|
+
|
|
60
|
+
/// Returns the size of the current congestion window in bytes. Note, this
|
|
61
|
+
/// is not the *available* window. Some send algorithms may not use a
|
|
62
|
+
/// congestion window and will return 0.
|
|
63
|
+
fn get_congestion_window(&self) -> usize;
|
|
64
|
+
|
|
65
|
+
/// Returns the size of the current congestion window in packets. Note, this
|
|
66
|
+
/// is not the *available* window. Some send algorithms may not use a
|
|
67
|
+
/// congestion window and will return 0.
|
|
68
|
+
fn get_congestion_window_in_packets(&self) -> usize;
|
|
69
|
+
|
|
70
|
+
/// Make decision on whether the sender can send right now. Note that even
|
|
71
|
+
/// when this method returns true, the sending can be delayed due to pacing.
|
|
72
|
+
fn can_send(&self, bytes_in_flight: usize) -> bool;
|
|
73
|
+
|
|
74
|
+
/// Inform that we sent `bytes` to the wire, and if the packet is
|
|
75
|
+
/// retransmittable. `bytes_in_flight` is the number of bytes in flight
|
|
76
|
+
/// before the packet was sent. Note: this function must be called for
|
|
77
|
+
/// every packet sent to the wire.
|
|
78
|
+
fn on_packet_sent(
|
|
79
|
+
&mut self, sent_time: Instant, bytes_in_flight: usize,
|
|
80
|
+
packet_number: u64, bytes: usize, is_retransmissible: bool,
|
|
81
|
+
);
|
|
82
|
+
|
|
83
|
+
/// Inform that `packet_number` has been neutered.
|
|
84
|
+
fn on_packet_neutered(&mut self, _packet_number: u64) {}
|
|
85
|
+
|
|
86
|
+
/// Indicates an update to the congestion state, caused either by an
|
|
87
|
+
/// incoming ack or loss event timeout. `rtt_updated` indicates whether a
|
|
88
|
+
/// new `latest_rtt` sample has been taken, `prior_in_flight` the bytes in
|
|
89
|
+
/// flight prior to the congestion event. `acked_packets` and `lost_packets`
|
|
90
|
+
/// are any packets considered acked or lost as a result of the
|
|
91
|
+
/// congestion event.
|
|
92
|
+
#[allow(clippy::too_many_arguments)]
|
|
93
|
+
fn on_congestion_event(
|
|
94
|
+
&mut self, rtt_updated: bool, prior_in_flight: usize,
|
|
95
|
+
bytes_in_flight: usize, event_time: Instant, acked_packets: &[Acked],
|
|
96
|
+
lost_packets: &[Lost], least_unacked: u64, rtt_stats: &RttStats,
|
|
97
|
+
recovery_stats: &mut RecoveryStats,
|
|
98
|
+
);
|
|
99
|
+
|
|
100
|
+
/// Called when an RTO fires. Resets the retransmission alarm if there are
|
|
101
|
+
/// remaining unacked packets.
|
|
102
|
+
fn on_retransmission_timeout(&mut self, packets_retransmitted: bool);
|
|
103
|
+
|
|
104
|
+
/// Called when connection migrates and cwnd needs to be reset.
|
|
105
|
+
#[allow(dead_code)]
|
|
106
|
+
fn on_connection_migration(&mut self);
|
|
107
|
+
|
|
108
|
+
/// Adjust the current cwnd to a new maximal size
|
|
109
|
+
fn limit_cwnd(&mut self, _max_cwnd: usize) {}
|
|
110
|
+
|
|
111
|
+
fn is_in_recovery(&self) -> bool;
|
|
112
|
+
|
|
113
|
+
#[allow(dead_code)]
|
|
114
|
+
fn is_cwnd_limited(&self, bytes_in_flight: usize) -> bool;
|
|
115
|
+
|
|
116
|
+
fn pacing_rate(
|
|
117
|
+
&self, bytes_in_flight: usize, rtt_stats: &RttStats,
|
|
118
|
+
) -> Bandwidth;
|
|
119
|
+
|
|
120
|
+
fn bandwidth_estimate(&self, rtt_stats: &RttStats) -> Bandwidth;
|
|
121
|
+
|
|
122
|
+
fn max_bandwidth(&self) -> Bandwidth;
|
|
123
|
+
|
|
124
|
+
fn update_mss(&mut self, new_mss: usize);
|
|
125
|
+
|
|
126
|
+
fn on_app_limited(&mut self, _bytes_in_flight: usize) {}
|
|
127
|
+
|
|
128
|
+
#[cfg(feature = "qlog")]
|
|
129
|
+
fn ssthresh(&self) -> Option<u64> {
|
|
130
|
+
None
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/// BBR settings used to customize the algorithm's behavior.
|
|
135
|
+
///
|
|
136
|
+
/// This functionality is experimental and will be removed in the future.
|
|
137
|
+
///
|
|
138
|
+
/// A congestion control algorithm has dual-responsibility of effective network
|
|
139
|
+
/// utilization and avoiding congestion. Custom values should be choosen
|
|
140
|
+
/// carefully since incorrect values can lead to network degradation for all
|
|
141
|
+
/// connections on the shared network.
|
|
142
|
+
#[derive(Debug, Default, Copy, Clone, PartialEq)]
|
|
143
|
+
#[repr(C)]
|
|
144
|
+
#[doc(hidden)]
|
|
145
|
+
pub struct BbrParams {
|
|
146
|
+
/// Controls the BBR startup gain.
|
|
147
|
+
pub startup_cwnd_gain: Option<f32>,
|
|
148
|
+
|
|
149
|
+
/// Controls the BBR startup pacing gain.
|
|
150
|
+
pub startup_pacing_gain: Option<f32>,
|
|
151
|
+
|
|
152
|
+
/// Controls the BBR full bandwidth threshold.
|
|
153
|
+
pub full_bw_threshold: Option<f32>,
|
|
154
|
+
|
|
155
|
+
/// Controls the number of rounds to stay in STARTUP before
|
|
156
|
+
/// exiting due to bandwidth plateau.
|
|
157
|
+
pub startup_full_bw_rounds: Option<usize>,
|
|
158
|
+
|
|
159
|
+
/// Controls the BBR startup loss count necessary to exit startup.
|
|
160
|
+
pub startup_full_loss_count: Option<usize>,
|
|
161
|
+
|
|
162
|
+
/// Controls the BBR drain cwnd gain.
|
|
163
|
+
pub drain_cwnd_gain: Option<f32>,
|
|
164
|
+
|
|
165
|
+
/// Controls the BBR drain pacing gain.
|
|
166
|
+
pub drain_pacing_gain: Option<f32>,
|
|
167
|
+
|
|
168
|
+
/// Controls if BBR should respect Reno coexistence.
|
|
169
|
+
pub enable_reno_coexistence: Option<bool>,
|
|
170
|
+
|
|
171
|
+
/// Controls if BBR should enable code in Bandwidth Sampler that
|
|
172
|
+
/// attempts to avoid overestimating bandwidth on ack compression.
|
|
173
|
+
pub enable_overestimate_avoidance: Option<bool>,
|
|
174
|
+
|
|
175
|
+
/// Controls if BBR should enable a possible fix in Bandwidth
|
|
176
|
+
/// Sampler that attempts to bandwidth over estimation avoidance.
|
|
177
|
+
pub choose_a0_point_fix: Option<bool>,
|
|
178
|
+
|
|
179
|
+
/// Controls the BBR bandwidth probe up pacing gain.
|
|
180
|
+
pub probe_bw_probe_up_pacing_gain: Option<f32>,
|
|
181
|
+
|
|
182
|
+
/// Controls the BBR bandwidth probe down pacing gain.
|
|
183
|
+
pub probe_bw_probe_down_pacing_gain: Option<f32>,
|
|
184
|
+
|
|
185
|
+
/// Controls the BBR probe bandwidth DOWN/CRUISE/REFILL cwnd gain.
|
|
186
|
+
pub probe_bw_cwnd_gain: Option<f32>,
|
|
187
|
+
|
|
188
|
+
/// Controls the BBR probe bandwidth UP cwnd gain.
|
|
189
|
+
pub probe_bw_up_cwnd_gain: Option<f32>,
|
|
190
|
+
|
|
191
|
+
/// Controls the BBR probe RTT pacing gain.
|
|
192
|
+
pub probe_rtt_pacing_gain: Option<f32>,
|
|
193
|
+
|
|
194
|
+
/// Controls the BBR probe RTT cwnd gain.
|
|
195
|
+
pub probe_rtt_cwnd_gain: Option<f32>,
|
|
196
|
+
|
|
197
|
+
/// Controls the number of rounds BBR should stay in probe up if
|
|
198
|
+
/// bytes_in_flight doesn't drop below target.
|
|
199
|
+
pub max_probe_up_queue_rounds: Option<usize>,
|
|
200
|
+
|
|
201
|
+
/// Controls the BBR loss threshold.
|
|
202
|
+
pub loss_threshold: Option<f32>,
|
|
203
|
+
|
|
204
|
+
/// Controls if BBR should use bytes delievered as an estimate for
|
|
205
|
+
/// inflight_hi.
|
|
206
|
+
pub use_bytes_delivered_for_inflight_hi: Option<bool>,
|
|
207
|
+
|
|
208
|
+
/// Controls if BBR should adjust startup pacing at round end.
|
|
209
|
+
pub decrease_startup_pacing_at_end_of_round: Option<bool>,
|
|
210
|
+
|
|
211
|
+
/// Controls the BBR bandwidth lo reduction strategy.
|
|
212
|
+
pub bw_lo_reduction_strategy: Option<BbrBwLoReductionStrategy>,
|
|
213
|
+
|
|
214
|
+
/// Determines whether app limited rounds with no bandwidth growth count
|
|
215
|
+
/// towards the rounds threshold to exit startup.
|
|
216
|
+
pub ignore_app_limited_for_no_bandwidth_growth: Option<bool>,
|
|
217
|
+
|
|
218
|
+
/// Initial pacing rate for a new connection before an RTT
|
|
219
|
+
/// estimate is available. This rate serves as an upper bound on
|
|
220
|
+
/// the initial pacing rate, which is calculated by dividing the
|
|
221
|
+
/// initial cwnd by the first RTT estimate.
|
|
222
|
+
pub initial_pacing_rate_bytes_per_second: Option<u64>,
|
|
223
|
+
|
|
224
|
+
/// If true, scale the pacing rate when updating mss when doing pmtud.
|
|
225
|
+
pub scale_pacing_rate_by_mss: Option<bool>,
|
|
226
|
+
|
|
227
|
+
/// Disable `has_stayed_long_enough_in_probe_down` which can cause ProbeDown
|
|
228
|
+
/// to exit early.
|
|
229
|
+
pub disable_probe_down_early_exit: Option<bool>,
|
|
230
|
+
|
|
231
|
+
/// Set the expected send time for packets when using BBR to `now`
|
|
232
|
+
/// instead of `get_next_release_time()`. Setting the time based
|
|
233
|
+
/// on `get_next_release_time()` can result in artificially low
|
|
234
|
+
/// minRTT measurements which will make BBR misbehave.
|
|
235
|
+
pub time_sent_set_to_now: Option<bool>,
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
/// Controls BBR's bandwidth reduction strategy on congestion event.
|
|
239
|
+
///
|
|
240
|
+
/// This functionality is experimental and will be removed in the future.
|
|
241
|
+
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
|
242
|
+
#[repr(C)]
|
|
243
|
+
#[doc(hidden)]
|
|
244
|
+
pub enum BbrBwLoReductionStrategy {
|
|
245
|
+
/// Uses the default strategy based on `BBRBeta`.
|
|
246
|
+
Default = 0,
|
|
247
|
+
|
|
248
|
+
/// Considers min-rtt to estimate bandwidth reduction.
|
|
249
|
+
MinRttReduction = 1,
|
|
250
|
+
|
|
251
|
+
/// Considers inflight data to estimate bandwidth reduction.
|
|
252
|
+
InflightReduction = 2,
|
|
253
|
+
|
|
254
|
+
/// Considers cwnd to estimate bandwidth reduction.
|
|
255
|
+
CwndReduction = 3,
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
#[doc(hidden)]
|
|
259
|
+
impl FromStr for BbrBwLoReductionStrategy {
|
|
260
|
+
type Err = crate::Error;
|
|
261
|
+
|
|
262
|
+
/// Converts a string to `BbrBwLoReductionStrategy`.
|
|
263
|
+
///
|
|
264
|
+
/// If `name` is not valid, `Error::CongestionControl` is returned.
|
|
265
|
+
fn from_str(name: &str) -> Result<Self, Self::Err> {
|
|
266
|
+
match name {
|
|
267
|
+
"default" => Ok(BbrBwLoReductionStrategy::Default),
|
|
268
|
+
"minrtt" => Ok(BbrBwLoReductionStrategy::MinRttReduction),
|
|
269
|
+
"inflight" => Ok(BbrBwLoReductionStrategy::InflightReduction),
|
|
270
|
+
"cwnd" => Ok(BbrBwLoReductionStrategy::CwndReduction),
|
|
271
|
+
|
|
272
|
+
_ => Err(crate::Error::CongestionControl),
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
}
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
|
|
2
|
+
// Use of this source code is governed by a BSD-style license that can be
|
|
3
|
+
// found in the LICENSE file.
|
|
4
|
+
|
|
5
|
+
// Copyright (C) 2023, Cloudflare, Inc.
|
|
6
|
+
// All rights reserved.
|
|
7
|
+
//
|
|
8
|
+
// Redistribution and use in source and binary forms, with or without
|
|
9
|
+
// modification, are permitted provided that the following conditions are
|
|
10
|
+
// met:
|
|
11
|
+
//
|
|
12
|
+
// * Redistributions of source code must retain the above copyright notice,
|
|
13
|
+
// this list of conditions and the following disclaimer.
|
|
14
|
+
//
|
|
15
|
+
// * Redistributions in binary form must reproduce the above copyright
|
|
16
|
+
// notice, this list of conditions and the following disclaimer in the
|
|
17
|
+
// documentation and/or other materials provided with the distribution.
|
|
18
|
+
//
|
|
19
|
+
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
|
20
|
+
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
21
|
+
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
22
|
+
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
23
|
+
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
24
|
+
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
25
|
+
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
26
|
+
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
27
|
+
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
28
|
+
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
29
|
+
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
30
|
+
|
|
31
|
+
use std::time::Instant;
|
|
32
|
+
|
|
33
|
+
use crate::recovery::gcongestion::bbr2::BBRv2;
|
|
34
|
+
use crate::recovery::gcongestion::Bandwidth;
|
|
35
|
+
use crate::recovery::gcongestion::CongestionControl;
|
|
36
|
+
use crate::recovery::rtt::RttStats;
|
|
37
|
+
use crate::recovery::RecoveryStats;
|
|
38
|
+
use crate::recovery::ReleaseDecision;
|
|
39
|
+
use crate::recovery::ReleaseTime;
|
|
40
|
+
|
|
41
|
+
use super::Acked;
|
|
42
|
+
use super::Lost;
|
|
43
|
+
|
|
44
|
+
/// Congestion window fraction that the pacing sender allows in bursts during
|
|
45
|
+
/// pacing.
|
|
46
|
+
const LUMPY_PACING_CWND_FRACTION: f64 = 0.25;
|
|
47
|
+
|
|
48
|
+
/// Number of packets that the pacing sender allows in bursts during pacing.
|
|
49
|
+
/// This is ignored if a flow's estimated bandwidth is lower than 1200 kbps.
|
|
50
|
+
const LUMPY_PACING_SIZE: usize = 2;
|
|
51
|
+
|
|
52
|
+
/// The minimum estimated client bandwidth below which the pacing sender will
|
|
53
|
+
/// not allow bursts.
|
|
54
|
+
const LUMPY_PACING_MIN_BANDWIDTH_KBPS: Bandwidth =
|
|
55
|
+
Bandwidth::from_kbits_per_second(1_200);
|
|
56
|
+
|
|
57
|
+
/// Configured maximum size of the burst coming out of quiescence. The burst is
|
|
58
|
+
/// never larger than the current CWND in packets.
|
|
59
|
+
const INITIAL_UNPACED_BURST: usize = 10;
|
|
60
|
+
|
|
61
|
+
#[derive(Debug)]
|
|
62
|
+
pub struct Pacer {
|
|
63
|
+
/// Should this [`Pacer`] be making any release decisions?
|
|
64
|
+
enabled: bool,
|
|
65
|
+
/// Underlying sender
|
|
66
|
+
sender: BBRv2,
|
|
67
|
+
/// The maximum rate the [`Pacer`] will use.
|
|
68
|
+
max_pacing_rate: Option<Bandwidth>,
|
|
69
|
+
/// Number of unpaced packets to be sent before packets are delayed.
|
|
70
|
+
burst_tokens: usize,
|
|
71
|
+
/// When can the next packet be sent.
|
|
72
|
+
ideal_next_packet_send_time: ReleaseTime,
|
|
73
|
+
initial_burst_size: usize,
|
|
74
|
+
/// Number of unpaced packets to be sent before packets are delayed. This
|
|
75
|
+
/// token is consumed after [`Self::burst_tokens`] ran out.
|
|
76
|
+
lumpy_tokens: usize,
|
|
77
|
+
/// Indicates whether pacing throttles the sending. If true, make up for
|
|
78
|
+
/// lost time.
|
|
79
|
+
pacing_limited: bool,
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
impl Pacer {
|
|
83
|
+
/// Create a new [`Pacer`] with and underlying [`Congestion`]
|
|
84
|
+
/// implementation, and an optional throttling as specified by
|
|
85
|
+
/// `max_pacing_rate`.
|
|
86
|
+
pub(crate) fn new(
|
|
87
|
+
enabled: bool, congestion: BBRv2, max_pacing_rate: Option<Bandwidth>,
|
|
88
|
+
) -> Self {
|
|
89
|
+
Pacer {
|
|
90
|
+
enabled,
|
|
91
|
+
sender: congestion,
|
|
92
|
+
max_pacing_rate,
|
|
93
|
+
burst_tokens: INITIAL_UNPACED_BURST,
|
|
94
|
+
ideal_next_packet_send_time: ReleaseTime::Immediate,
|
|
95
|
+
initial_burst_size: INITIAL_UNPACED_BURST,
|
|
96
|
+
lumpy_tokens: 0,
|
|
97
|
+
pacing_limited: false,
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
pub fn get_next_release_time(&self) -> ReleaseDecision {
|
|
102
|
+
if !self.enabled {
|
|
103
|
+
return ReleaseDecision {
|
|
104
|
+
time: ReleaseTime::Immediate,
|
|
105
|
+
allow_burst: true,
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
let allow_burst = self.burst_tokens > 0 || self.lumpy_tokens > 0;
|
|
110
|
+
ReleaseDecision {
|
|
111
|
+
time: self.ideal_next_packet_send_time,
|
|
112
|
+
allow_burst,
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
#[cfg(feature = "qlog")]
|
|
117
|
+
pub fn state_str(&self) -> &'static str {
|
|
118
|
+
self.sender.state_str()
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
pub fn get_congestion_window(&self) -> usize {
|
|
122
|
+
self.sender.get_congestion_window()
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
pub fn on_packet_sent(
|
|
126
|
+
&mut self, sent_time: Instant, bytes_in_flight: usize,
|
|
127
|
+
packet_number: u64, bytes: usize, is_retransmissible: bool,
|
|
128
|
+
rtt_stats: &RttStats,
|
|
129
|
+
) {
|
|
130
|
+
self.sender.on_packet_sent(
|
|
131
|
+
sent_time,
|
|
132
|
+
bytes_in_flight,
|
|
133
|
+
packet_number,
|
|
134
|
+
bytes,
|
|
135
|
+
is_retransmissible,
|
|
136
|
+
);
|
|
137
|
+
|
|
138
|
+
if !self.enabled || !is_retransmissible {
|
|
139
|
+
return;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
// If in recovery, the connection is not coming out of quiescence.
|
|
143
|
+
if bytes_in_flight == 0 && !self.sender.is_in_recovery() {
|
|
144
|
+
// Add more burst tokens anytime the connection is leaving quiescence,
|
|
145
|
+
// but limit it to the equivalent of a single bulk write,
|
|
146
|
+
// not exceeding the current CWND in packets.
|
|
147
|
+
self.burst_tokens = self
|
|
148
|
+
.initial_burst_size
|
|
149
|
+
.min(self.sender.get_congestion_window_in_packets());
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
if self.burst_tokens > 0 {
|
|
153
|
+
self.burst_tokens -= 1;
|
|
154
|
+
self.ideal_next_packet_send_time = ReleaseTime::Immediate;
|
|
155
|
+
self.pacing_limited = false;
|
|
156
|
+
return;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
// The next packet should be sent as soon as the current packet has been
|
|
160
|
+
// transferred. PacingRate is based on bytes in flight including this
|
|
161
|
+
// packet.
|
|
162
|
+
let delay = self
|
|
163
|
+
.pacing_rate(bytes_in_flight + bytes, rtt_stats)
|
|
164
|
+
.transfer_time(bytes as u64);
|
|
165
|
+
|
|
166
|
+
if !self.pacing_limited || self.lumpy_tokens == 0 {
|
|
167
|
+
// Reset lumpy_tokens_ if either application or cwnd throttles sending
|
|
168
|
+
// or token runs out.
|
|
169
|
+
self.lumpy_tokens = 1.max(LUMPY_PACING_SIZE.min(
|
|
170
|
+
(self.sender.get_congestion_window_in_packets() as f64 *
|
|
171
|
+
LUMPY_PACING_CWND_FRACTION) as usize,
|
|
172
|
+
));
|
|
173
|
+
|
|
174
|
+
if self.sender.bandwidth_estimate(rtt_stats) <
|
|
175
|
+
LUMPY_PACING_MIN_BANDWIDTH_KBPS
|
|
176
|
+
{
|
|
177
|
+
// Below 1.2Mbps, send 1 packet at once, because one full-sized
|
|
178
|
+
// packet is about 10ms of queueing.
|
|
179
|
+
self.lumpy_tokens = 1;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
if bytes_in_flight + bytes >= self.sender.get_congestion_window() {
|
|
183
|
+
// Don't add lumpy_tokens if the congestion controller is CWND
|
|
184
|
+
// limited.
|
|
185
|
+
self.lumpy_tokens = 1;
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
self.lumpy_tokens -= 1;
|
|
190
|
+
self.ideal_next_packet_send_time.set_max(sent_time);
|
|
191
|
+
self.ideal_next_packet_send_time.inc(delay);
|
|
192
|
+
// Stop making up for lost time if underlying sender prevents sending.
|
|
193
|
+
self.pacing_limited = self.sender.can_send(bytes_in_flight + bytes);
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
#[allow(clippy::too_many_arguments)]
|
|
197
|
+
#[inline]
|
|
198
|
+
pub fn on_congestion_event(
|
|
199
|
+
&mut self, rtt_updated: bool, prior_in_flight: usize,
|
|
200
|
+
bytes_in_flight: usize, event_time: Instant, acked_packets: &[Acked],
|
|
201
|
+
lost_packets: &[Lost], least_unacked: u64, rtt_stats: &RttStats,
|
|
202
|
+
recovery_stats: &mut RecoveryStats,
|
|
203
|
+
) {
|
|
204
|
+
self.sender.on_congestion_event(
|
|
205
|
+
rtt_updated,
|
|
206
|
+
prior_in_flight,
|
|
207
|
+
bytes_in_flight,
|
|
208
|
+
event_time,
|
|
209
|
+
acked_packets,
|
|
210
|
+
lost_packets,
|
|
211
|
+
least_unacked,
|
|
212
|
+
rtt_stats,
|
|
213
|
+
recovery_stats,
|
|
214
|
+
);
|
|
215
|
+
|
|
216
|
+
if !self.enabled {
|
|
217
|
+
return;
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
if !lost_packets.is_empty() {
|
|
221
|
+
// Clear any burst tokens when entering recovery.
|
|
222
|
+
self.burst_tokens = 0;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
if let Some(max_pacing_rate) = self.max_pacing_rate {
|
|
226
|
+
if rtt_updated {
|
|
227
|
+
let max_rate = max_pacing_rate * 1.25f32;
|
|
228
|
+
let max_cwnd =
|
|
229
|
+
max_rate.to_bytes_per_period(rtt_stats.smoothed_rtt);
|
|
230
|
+
self.sender.limit_cwnd(max_cwnd as usize);
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
pub fn on_packet_neutered(&mut self, packet_number: u64) {
|
|
236
|
+
self.sender.on_packet_neutered(packet_number);
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
pub fn on_retransmission_timeout(&mut self, packets_retransmitted: bool) {
|
|
240
|
+
self.sender.on_retransmission_timeout(packets_retransmitted)
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
pub fn pacing_rate(
|
|
244
|
+
&self, bytes_in_flight: usize, rtt_stats: &RttStats,
|
|
245
|
+
) -> Bandwidth {
|
|
246
|
+
let sender_rate = self.sender.pacing_rate(bytes_in_flight, rtt_stats);
|
|
247
|
+
match self.max_pacing_rate {
|
|
248
|
+
Some(rate) if self.enabled => rate.min(sender_rate),
|
|
249
|
+
_ => sender_rate,
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
pub fn bandwidth_estimate(&self, rtt_stats: &RttStats) -> Bandwidth {
|
|
254
|
+
self.sender.bandwidth_estimate(rtt_stats)
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
pub fn max_bandwidth(&self) -> Bandwidth {
|
|
258
|
+
self.sender.max_bandwidth()
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
#[cfg(feature = "qlog")]
|
|
262
|
+
pub fn send_rate(&self) -> Option<Bandwidth> {
|
|
263
|
+
self.sender.send_rate()
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
#[cfg(feature = "qlog")]
|
|
267
|
+
pub fn ack_rate(&self) -> Option<Bandwidth> {
|
|
268
|
+
self.sender.ack_rate()
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
pub fn on_app_limited(&mut self, bytes_in_flight: usize) {
|
|
272
|
+
self.pacing_limited = false;
|
|
273
|
+
self.sender.on_app_limited(bytes_in_flight);
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
pub fn update_mss(&mut self, new_mss: usize) {
|
|
277
|
+
self.sender.update_mss(new_mss)
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
#[cfg(feature = "qlog")]
|
|
281
|
+
pub fn ssthresh(&self) -> Option<u64> {
|
|
282
|
+
self.sender.ssthresh()
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
#[cfg(test)]
|
|
286
|
+
pub fn is_app_limited(&self, bytes_in_flight: usize) -> bool {
|
|
287
|
+
!self.is_cwnd_limited(bytes_in_flight)
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
#[cfg(test)]
|
|
291
|
+
fn is_cwnd_limited(&self, bytes_in_flight: usize) -> bool {
|
|
292
|
+
!self.pacing_limited && self.sender.is_cwnd_limited(bytes_in_flight)
|
|
293
|
+
}
|
|
294
|
+
}
|