Auto-port 5.0: IoUring: extend user data from short to long#16806
Merged
Conversation
Motivation: This PR extends io_uring `userData` handling from `short` to `long` without changing the existing fast path for short values. We reuse Netty's `IoUringIoHandler` to drive some one-shot io_uring operations through a shared `DefaultIoUringIoRegistration` per `EventLoop`. In this model, `short` user data is too limited for real usage: it is not enough for some tracking payloads and cannot reliably carry values such as an `fd` or other larger identifiers. Modification: - Keep the existing packed fast path when `userData` still fits in `short`. - Add a slow path for larger `long userData` values. - Track slow-path SQEs with a lightweight per-SQE table (`PendingOpSlots`) and resolve completions through the live registration table. - Keep the io_uring channel code and `IoUringIoOps` path compatible with long `userData`. Result: Keep `long` user data support for custom `IoHandle`, preserve near-baseline performance for the `short` user data path, and confine the remaining extra bookkeeping cost to the `long` user data slow path. Design: I also evaluated other tracking strategies, including open addressing and `HashMap` / `LongObjectMap`-style mappings. In practice, they were not a better fit for this workload: - Open addressing with tombstones still introduced extra probe / insert / remove bookkeeping, and its CPU cost became more visible once removals were frequent or the live set grew larger. - `HashMap` / `LongObjectMap`-style solutions added extra lookup / indirection overhead on the slow path and were not competitive enough for this use case. - `HashMap` / `LongObjectMap`-style solutions add extra gc overhead on the slow path and were not competitive enough for this use case. - Some alternatives improved one side of the workload, but paid for it either with higher steady-state CPU cost or with a more expensive remove path. The current approach is a better overall tradeoff for the target scenario: - custom `IoHandle` usage is relatively uncommon - collisions are expected to be rare - resizes should therefore also be uncommon - for non-network io_uring operations, SQEs usually have a short pending lifetime That makes a simple array-backed per-SQE tracking scheme a good fit here: it keeps the common case straightforward and avoids introducing extra hot-path cost for more general but heavier data structures. `CustomIoHandleBenchmark` on the current branch and 4.2 base Fast path vs baseline | pendingOpsDepth | baseline fast | current fast | delta | | --- | ---: | ---: | ---: | | 4096 | 1,023,617 ops/s | 1,024,338 ops/s | +0.07% | | 65536 | 974,757 ops/s | 970,427 ops/s | -0.44% | Slow path vs current fast path | pendingOpsDepth | fast path | slow path | delta | | --- | ---: | ---: | ---: | | 4096 | 1,024,338 ops/s | 944,886 ops/s | -7.76% | | 65536 | 970,427 ops/s | 886,176 ops/s | -8.68% | These numbers are in the expected range for the added slow-path bookkeeping, while keeping the existing short-value fast path intact. https://gist.github.com/dreamlike-ocean/05e7e272e0e6a9f45f40192229c938dc fix #16634 --------- Co-authored-by: Chris Vest <christianvest_hansen@apple.com> (cherry picked from commit 7f00b24)
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
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.
Auto-port of #16682 to 5.0
Cherry-picked commit: 7f00b24
Motivation:
This PR extends io_uring
userDatahandling fromshorttolongwithout changing the existing fast path for short values.We reuse Netty's
IoUringIoHandlerto drive some one-shot io_uring operations through a sharedDefaultIoUringIoRegistrationperEventLoop. In this model,shortuser data is too limited for real usage: it is not enough for some tracking payloads and cannot reliably carry values such as anfdor other larger identifiers.Modification:
userDatastill fits inshort.long userDatavalues.PendingOpSlots) and resolve completions through the live registration table.IoUringIoOpspath compatible with longuserData.Result:
Keep
longuser data support for customIoHandle, preserve near-baseline performance for theshortuser data path, and confine the remaining extra bookkeeping cost to thelonguser data slow path.Design:
I also evaluated other tracking strategies, including open addressing and
HashMap/LongObjectMap-style mappings.In practice, they were not a better fit for this workload:
HashMap/LongObjectMap-style solutions added extra lookup / indirection overhead on the slow path and were not competitive enough for this use case.HashMap/LongObjectMap-style solutions add extra gc overhead on the slow path and were not competitive enough for this use case.The current approach is a better overall tradeoff for the target scenario:
IoHandleusage is relatively uncommonThat makes a simple array-backed per-SQE tracking scheme a good fit here: it keeps the common case straightforward and avoids introducing extra hot-path cost for more general but heavier data structures.
CustomIoHandleBenchmarkon the current branch and 4.2 baseFast path vs baseline
Slow path vs current fast path
These numbers are in the expected range for the added slow-path bookkeeping, while keeping the existing short-value fast path intact.
https://gist.github.com/dreamlike-ocean/05e7e272e0e6a9f45f40192229c938dc
fix #16634