Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add benches #58

Merged
merged 3 commits into from
Nov 30, 2024
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
9 changes: 9 additions & 0 deletions adb_client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,12 @@ serde = { version = "1.0.210", features = ["derive"] }
serde_repr = { version = "0.1.19" }
sha1 = { version = "0.10.6", features = ["oid"] }
thiserror = { version = "2.0.1" }

[dev-dependencies]
anyhow = { version = "1.0.93" }
criterion = { version = "0.5.1" } # Used for benchmarks

[[bench]]
harness = false
name = "benchmark_adb_push"
path = "../benches/benchmark_adb_push.rs"
135 changes: 135 additions & 0 deletions benches/benchmark_adb_push.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
use adb_client::{ADBDeviceExt, ADBServer, ADBUSBDevice};
use anyhow::Result;
use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
use rand::{thread_rng, Rng};
use std::fs::File;
use std::io::Write;
use std::process::Command;
use std::time::Duration;

const LOCAL_TEST_FILE_PATH: &str = "test_file.bin";
const REMOTE_TEST_FILE_PATH: &str = "/data/local/tmp/test_file.bin";

/// Generate random test file with given size
fn generate_test_file(size_in_bytes: usize) -> Result<()> {
let mut test_file = File::create(LOCAL_TEST_FILE_PATH)?;

let mut rng = thread_rng();

const BUFFER_SIZE: usize = 64 * 1024;
let mut buffer = [0u8; BUFFER_SIZE];
let mut remaining_bytes = size_in_bytes;

while remaining_bytes > 0 {
let bytes_to_write = remaining_bytes.min(BUFFER_SIZE);
rng.fill(&mut buffer[..bytes_to_write]);
test_file.write_all(&buffer[..bytes_to_write])?;
remaining_bytes -= bytes_to_write;
}

Ok(())
}

/// Use `adb_client` crate to push a file on device
fn bench_adb_client_push() -> Result<()> {
let mut client = ADBServer::default();
let mut device = client.get_device()?;
let f = File::open(LOCAL_TEST_FILE_PATH)?;
Ok(device.push(f, REMOTE_TEST_FILE_PATH)?)
}

/// Use `adb_client` crate to push a file on device using an USB device.
/// Only one android device must be connected when launching this benchmark as we're using `autodetect()` method.
fn bench_adb_client_push_over_usb() -> Result<()> {
let mut device = ADBUSBDevice::autodetect()?;
let f = File::open(LOCAL_TEST_FILE_PATH)?;
Ok(device.push(f, REMOTE_TEST_FILE_PATH)?)
}

/// Use standard `adb` command ti push a file on device
fn bench_adb_push_command() -> Result<()> {
let output = Command::new("adb")
.arg("push")
.arg(LOCAL_TEST_FILE_PATH)
.arg(REMOTE_TEST_FILE_PATH)
.output()?;

if !output.status.success() {
eprintln!("error while starting adb push command");
}
Ok(())
}

/// benchmarking `adb push INPUT DEST` and adb_client `ADBServerDevice.push(INPUT, DEST)`
fn benchmark_adb_push(c: &mut Criterion) {
for (file_size, sample_size) in [
(10 * 1024 * 1024, 100), // 10MB -> 100 iterations
(500 * 1024 * 1024, 50), // 500MB -> 50 iterations
(1000 * 1024 * 1024, 20), // 1GB -> 20 iterations
] {
eprintln!(
"Benchmarking file_size={} and sample_size={}",
file_size, sample_size
);

generate_test_file(file_size).expect("Cannot generate test file");

let mut group = c.benchmark_group("ADB Push Benchmark");
group.sample_size(sample_size);

group.bench_function(BenchmarkId::new("adb_client", "push"), |b| {
b.iter(|| {
bench_adb_client_push().expect("Error while benchmarking adb_client push");
});
});

group.bench_function(BenchmarkId::new("adb", "push"), |b| {
b.iter(|| {
bench_adb_push_command().expect("Error while benchmarking adb push command");
});
});

group.finish();
}
}

/// benchmarking `adb push INPUT DEST` and adb_client `ADBUSBDevice.push(INPUT, DEST)`
fn benchmark_adb_push_over_usb(c: &mut Criterion) {
for (file_size, sample_size) in [
// (10 * 1024 * 1024, 100), // 10MB -> 100 iterations
// (500 * 1024 * 1024, 50), // 500MB -> 50 iterations
(1000 * 1024 * 1024, 20), // 1GB -> 20 iterations
] {
eprintln!(
"Benchmarking file_size={} and sample_size={}",
file_size, sample_size
);

generate_test_file(file_size).expect("Cannot generate test file");

let mut group = c.benchmark_group("ADB Push Benchmark");
group.sample_size(sample_size);

group.bench_function(BenchmarkId::new("adb_client", "push"), |b| {
b.iter(|| {
bench_adb_client_push_over_usb()
.expect("Error while benchmarking adb_client push over USB");
});
});

group.bench_function(BenchmarkId::new("adb", "push"), |b| {
b.iter(|| {
bench_adb_push_command().expect("Error while benchmarking adb push command");
});
});

group.finish();
}
}

criterion_group!(
name = benches;
config = Criterion::default().measurement_time(Duration::from_secs(1000));
targets = benchmark_adb_push, benchmark_adb_push_over_usb
);
criterion_main!(benches);