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.

Sign up for GitHub

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

docs(s2n-quic): add a comment about docke+GSO #2487

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

docs(s2n-quic): add a comment about docke+GSO #2487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions docs/user-guide/debugging-gso.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Generic Segmentation Offload (GSO) and Generic Receive Offload (GRO) are network stack features that can improve the efficiency of transmitting and receiving packets. GSO/GRO are enabled by default in `s2n-quic` on operating systems that have good support for these features (namely Linux variants). `s2n-quic` will also automatically disable these features if the operating system emits a socket error indicating they are not supported.

Some operating systems may silently fail when using GSO/GRO, leading to performance degradation. In these cases, `s2n-quic` will not automatically disable GSO/GRO. You can manually disable GSO/GRO on the IO provider to evaluate if that has a positive impact on performance:
Some operating systems and environments, such as Docker bridge networking, may silently fail when using GSO/GRO, leading to performance degradation or failures. In these cases, `s2n-quic` will not automatically disable GSO/GRO. You can manually disable GSO/GRO on the IO provider to evaluate if that has a positive impact on performance:

```rust
let io = s2n_quic::provider::io::Default::builder()
Expand All @@ -13,4 +13,6 @@ let io = s2n_quic::provider::io::Default::builder()
let mut server = Server::builder()
.with_io(io)?
.start()?;
```
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we want to document this right now. It's a bit of a blunt instrument and will disable all feature probing. I think we could improve usability, where you can specify something like S2N_QUIC_PLATFORM_FEATURES_OVERRIDE=default,-gso,-gro

In the case of running tests in broken GSO environments, setting `S2N_QUIC_PLATFORM_FEATURES_OVERRIDE=""` as an environment variable will disable the feature.
Loading