YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-03-31 17:55:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: mention that udp io_uring implementation might be unsound

Browse source
This commit is contained in:
Joakim Frostegård 2023-08-28 23:58:12 +02:00
parent cdc817cbdf
commit c9ae2e6830
1 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -13,11 +13,11 @@ of sub-implementations for different protocols:
[mio]: https://github.com/tokio-rs/mio
[glommio]: https://github.com/DataDog/glommio
| Name | Protocol | OS requirements |
|--------------|-----------------------------------|--------------------------------------|
| aquatic_udp | [BitTorrent over UDP] | Unix-like / Linux 6.0+ with io_uring |
| aquatic_http | [BitTorrent over HTTP] 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] over TLS | Linux 5.8+ |
| aquatic_ws | [WebTorrent], optionally over TLS | Linux 5.8+ |
Features at a glance:
@ -192,9 +192,10 @@ This is the most mature of the implementations. I consider it ready for producti
#### io_uring
An experimental io_uring backend is available. It currently requires Linux
6.0 or later and will attempt to fall back to the [mio] backend if run with
older kernels. To enable it, pass the `io-uring` feature when compiling:
An experimental (and possibly unsound) io_uring backend is available. It
currently requires Linux 6.0 or later and will attempt to fall back to the
[mio] backend if run with older kernels. To enable it, pass the `io-uring`
feature when compiling:
```sh
cargo build --release -p aquatic_udp --features "io-uring"
@ -204,7 +205,7 @@ cargo build --release -p aquatic_udp --features "io-uring"
![UDP BitTorrent tracker throughput comparison](./documents/aquatic-udp-load-test-illustration-2023-01-11.png)
The mio backend was used. More details are available [here](./documents/aquatic-udp-load-test-2023-01-11.pdf).
The default backend was used. More details are available [here](./documents/aquatic-udp-load-test-2023-01-11.pdf).
---