Merge pull request #163 from greatest-ape/load-test-fixes

load tester: refactor, add udp sets, improve docs, add command options; update README

README.md

@@ -9,11 +9,11 @@ of sub-implementations for different protocols:
 [aquatic_http]: ./crates/http
 [aquatic_ws]: ./crates/ws
 
-| Name           | Protocol                                  | OS requirements |
-|----------------|-------------------------------------------|-----------------|
-| [aquatic_udp]  | BitTorrent over UDP                       | Unix-like       |
-| [aquatic_http] | BitTorrent over HTTP, optionally over TLS | Linux 5.8+      |
-| [aquatic_ws]   | WebTorrent, optionally over TLS           | Linux 5.8+      |
+| Name           | Protocol                                  | OS requirements    |
+|----------------|-------------------------------------------|--------------------|
+| [aquatic_udp]  | BitTorrent over UDP                       | Unix-like          |
+| [aquatic_http] | BitTorrent over HTTP, optionally over TLS | Linux 5.8 or later |
+| [aquatic_ws]   | WebTorrent, optionally over TLS           | Linux 5.8 or later |
 
 Features at a glance:
 
@@ -27,6 +27,7 @@ Features at a glance:
 Known users:
 
 - [explodie.org public tracker](https://explodie.org/opentracker.html) (`udp://explodie.org:6969`), typically [serving ~100,000 requests per second](https://explodie.org/tracker-stats.html)
+- [tracker.webtorrent.dev](https://tracker.webtorrent.dev) (`wss://tracker.webtorrent.dev`)
 
 ## Performance of the UDP implementation
 

crates/load_tester/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aquatic_load_tester"
-description = "Load test runner for aquatic BitTorrent tracker"
+description = "Automated load testing of aquatic and other BitTorrent trackers (Linux only)"
 keywords = ["peer-to-peer", "torrent", "bittorrent"]
 version.workspace = true
 authors.workspace = true

crates/load_tester/README.md

@@ -0,0 +1,3 @@
+# aquatic_load_tester
+
+Automated load testing of aquatic and other BitTorrent trackers. Linux only.

crates/load_tester/src/main.rs

@@ -4,16 +4,28 @@ pub mod run;
 pub mod set;
 
 use clap::{Parser, Subcommand};
+use common::CpuMode;
 
 #[derive(Parser)]
 #[command(author, version, about)]
 struct Args {
+    /// How to choose which virtual CPUs to allow trackers and load test
+    /// executables on
+    #[arg(long, default_value_t = CpuMode::Split)]
+    cpu_mode: CpuMode,
+    /// Minimum number of tracker cpu cores to run load tests for
+    #[arg(long)]
+    min_cores: Option<usize>,
+    /// Maximum number of tracker cpu cores to run load tests for
+    #[arg(long)]
+    max_cores: Option<usize>,
     #[command(subcommand)]
     command: Command,
 }
 
 #[derive(Subcommand)]
 enum Command {
+    /// Benchmark UDP BitTorrent trackers aquatic_udp and opentracker
     #[cfg(feature = "udp")]
     Udp(protocols::udp::UdpCommand),
 }
@@ -23,6 +35,8 @@ fn main() {
 
     match args.command {
         #[cfg(feature = "udp")]
-        Command::Udp(command) => command.run().unwrap(),
+        Command::Udp(command) => command
+            .run(args.cpu_mode, args.min_cores, args.max_cores)
+            .unwrap(),
     }
 }