feat: distinguish disabled vs failed registration in RegisteredBufferStats#4065
Merged
oferchen merged 1 commit intoMay 14, 2026
Merged
Conversation
Add a `RegisteredBufferStatus` enum (Enabled / Disabled /
RegistrationFailed { reason }) and surface it on `IoUringReader` and
`IoUringWriter` via `registered_buffer_status()`. Both writers and
readers route construction through a new
`RegisteredBufferGroup::try_new_with_status` helper that captures the
kernel's formatted errno on failure.
Previously, `Option<RegisteredBufferGroup>` collapsed two distinct
operator-visible cases - "caller opted out via
`IoUringConfig::register_buffers = false`" and "kernel rejected
registration (low RLIMIT_MEMLOCK, IORING_MAX_REG_BUFFERS exceeded,
seccomp, etc.)" - into the same `None`, leaving no signal to diagnose
why a transfer was using the unfixed `IORING_OP_READ` / `IORING_OP_WRITE`
fallback. The enum closes that observability gap. Mirrored stub on
non-Linux so cross-platform telemetry stays cfg-free.
Refs: oc-rsync #2156. Closes the open IU2 row in
`docs/audits/io-uring-fixed-buffer-invariants-audit.md`.
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.
Summary
RegisteredBufferStatus { Enabled | Disabled | RegistrationFailed { reason } }so observability can tell why a transfer is using non-registered buffers.IoUringReader/IoUringWriterconstruction through a newRegisteredBufferGroup::try_new_with_statushelper that captures the kernel's formattederrnoon failure, and expose the value viaregistered_buffer_status().docs/audits/io-uring-fixed-buffer-invariants-audit.mdas RESOLVED.Previously,
Option<RegisteredBufferGroup>collapsed two operator-visible cases - caller-opted-out viaIoUringConfig::register_buffers = false, and kernel-rejected registration (lowRLIMIT_MEMLOCK,IORING_MAX_REG_BUFFERSexceeded, seccomp, etc.) - into the sameNone, leaving no signal to diagnose why the unfixedIORING_OP_READ/IORING_OP_WRITEpath was in use. The new enum closes that observability gap.Refs #2156. Sibling design notes in
docs/audits/iouring-fixed-buffer-registration.mdSection 5a.Test plan
try_new_with_status_disabled_when_flag_off- confirmsenabled=falsereturnsDisabled, neverRegistrationFailed.try_new_with_status_enabled_on_success- confirms successful registration yieldsEnabledand a live group.try_new_with_status_registration_failed_carries_reason- forces failure via the wrapper'sMAX_REGISTERED_BUFFERSceiling and confirms the formattederrnoreaches the caller.with_ring_skips_registration_when_disabled- extended to assert the writer's status isDisabled.registered_buffer_status_failed_when_kernel_rejects- confirms the writer's status isRegistrationFailedwhen registration is requested but rejected.