docs(s2n-quic-xdp): add README for AF_XDP IO provider usage#3104
Open
kaukabrizvi wants to merge 4 commits into
Open
docs(s2n-quic-xdp): add README for AF_XDP IO provider usage#3104kaukabrizvi wants to merge 4 commits into
kaukabrizvi wants to merge 4 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release Summary:
Resolved issues:
#2976
Description of changes:
Replaces the README.md placeholder with documentation for using the AF_XDP IO provider: pointer to xdp.rs as the reference wiring (per #1765), prerequisites (kernel, capabilities, Git LFS), a veth + netns smoke-test recipe, and lo and syscall::max_queues callouts.
Call-outs:
I started this work by creating a runnable example under examples/xdp-echo/, but the setup ended up being a near copy of xdp.rs. Per #1765 that wiring is intentionally the reference which applications should adapt, with the "easy mode" helper deferred as future work. The actual gap right now which surfaced the issue is discoverability and operational details (LFS, lo, max_queues / veth) to use the provider. Documenting those requirements seems like the reaosnable next step for. However, once we have "easy mode" set up then an example becomes more feasible.
Testing:
Documentation only. Verified the smoke-test recipe end-to-end (QUIC handshake + stream echo over AF_XDP across a veth pair).
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.