Revision control
Copy as Markdown
Other Tools
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use std::{hint::black_box, time::Duration};
use criterion::{criterion_group, criterion_main, BatchSize::SmallInput, Criterion};
use neqo_transport::{ConnectionParameters, State};
use test_fixture::{
boxed,
sim::{
connection::{Node, ReachState, ReceiveData, SendData},
network::{RandomDelay, TailDrop},
Simulator,
},
};
const ZERO: Duration = Duration::from_millis(0);
const JITTER: Duration = Duration::from_millis(10);
const TRANSFER_AMOUNT: usize = 1 << 22; // 4Mbyte
#[expect(
clippy::needless_pass_by_value,
reason = "Passing String where &str would do is fine here."
)]
fn benchmark_transfer(c: &mut Criterion, label: &str, seed: Option<impl AsRef<str>>) {
for pacing in [false, true] {
let setup = || {
let nodes = boxed![
Node::new_client(
ConnectionParameters::default()
.pmtud(true)
.pacing(pacing)
.mlkem(false),
boxed![ReachState::new(State::Confirmed)],
boxed![SendData::new(TRANSFER_AMOUNT)]
),
TailDrop::dsl_uplink(),
RandomDelay::new(ZERO..JITTER),
Node::new_server(
ConnectionParameters::default()
.pmtud(true)
.pacing(pacing)
.mlkem(false),
boxed![ReachState::new(State::Confirmed)],
boxed![ReceiveData::new(TRANSFER_AMOUNT)]
),
TailDrop::dsl_downlink(),
RandomDelay::new(ZERO..JITTER),
];
let mut sim = Simulator::new(label, nodes);
if let Some(seed) = &seed {
sim.seed_str(seed);
}
sim.setup()
};
// Benchmark with wallclock time, i.e. measure the compute efficiency.
{
let mut group =
c.benchmark_group(format!("transfer/pacing-{pacing}/{label}/wallclock-time"));
group.noise_threshold(0.03);
group.bench_function("run", |b| {
b.iter_batched(
setup,
|s| {
black_box(s.run());
},
SmallInput,
);
});
}
// Benchmark with simulated time, i.e. measure the network protocol
// efficiency.
//
// Note: Given that this is using simulated time, we can measure actual
// throughput.
{
let mut group =
c.benchmark_group(format!("transfer/pacing-{pacing}/{label}/simulated-time"));
group.throughput(criterion::Throughput::Bytes(TRANSFER_AMOUNT as u64));
group.bench_function("run", |b| {
b.iter_custom(|iters| {
let mut d_sum = Duration::ZERO;
for _i in 0..iters {
// run() returns the simulated time, excluding setup time.
// No need for black_box(), because this doesn't measure compute.
d_sum += setup().run();
}
d_sum
});
});
}
}
}
fn benchmark_transfer_variable(c: &mut Criterion) {
benchmark_transfer(c, "varying-seeds", std::env::var("SIMULATION_SEED").ok());
}
fn benchmark_transfer_fixed(c: &mut Criterion) {
benchmark_transfer(
c,
"same-seed",
Some("62df6933ba1f543cece01db8f27fb2025529b27f93df39e19f006e1db3b8c843"),
);
}
criterion_group! {
name = transfer;
config = Criterion::default().warm_up_time(Duration::from_secs(5)).measurement_time(Duration::from_secs(15));
targets = benchmark_transfer_variable, benchmark_transfer_fixed
}
criterion_main!(transfer);