Skip to content

docs: recommend io_uring defaults and name unavailable builds - #62

Merged
leiysky merged 1 commit into
mainfrom
dev/io-uring-defaults
Sep 21, 2026
Merged

leiysky merged 1 commit into
mainfrom
dev/io-uring-defaults

Conversation

@leiysky

@leiysky leiysky commented Sep 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Unavailable IoEngineOptions::IoUring selections still fail with ErrorKind::Unsupported; the I/O source now names the missing crate feature, OS, or architecture.
  • Unset benchmark io_uring knobs follow IoUringOptions::default() (1 ring / 64 in-flight for read and write). Reproduce the old 4/256 topology by setting those knobs explicitly.
  • Docs and rustdoc start from one ring and read.max_in_flight equal to concurrent L2 gets, leave write/reclaim at library defaults, and treat SQPOLL/IOPOLL as independent advanced flags.

Test plan

  • cargo x check
  • cargo x test
  • cargo x lint
  • Linux: cargo test --package cache2 --lib --no-default-features covers the missing-feature source string

Callers were pairing SQPOLL/IOPOLL with ring count and reading a combined unsupported string. Start from one ring and read depth, and say whether the missing requirement is the crate feature, OS, or architecture.
@leiysky
leiysky merged commit 85a7966 into main Sep 21, 2026
8 checks passed
@leiysky
leiysky deleted the dev/io-uring-defaults branch September 21, 2026 06:50
tisonkun added a commit that referenced this pull request Sep 21, 2026
Integrate io_uring configuration guidance, shared benchmark defaults, and availability diagnostics from #62. The changes merge without conflicts with the lifecycle and I/O refactoring.

Validation: cargo x check, cargo x test, cargo x lint, and Linux workspace checks with no default features and all features.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant