Skip to content

docs(fast_io): document mmap page-fault impact on io_uring SQPOLL (#1661)#3493

Merged
oferchen merged 2 commits into
masterfrom
docs/mmap-page-fault-sqpoll-1661
May 1, 2026
Merged

docs(fast_io): document mmap page-fault impact on io_uring SQPOLL (#1661)#3493
oferchen merged 2 commits into
masterfrom
docs/mmap-page-fault-sqpoll-1661

Conversation

@oferchen
Copy link
Copy Markdown
Owner

@oferchen oferchen commented May 1, 2026

Summary

  • Adds docs/audits/mmap-page-fault-iouring-sqpoll.md
  • Documents the SQPOLL kthread page-fault hazard when SQEs reference non-resident mmap'd basis-file pages
  • Records prefault-or-avoid-mmap constraint as prerequisite for any future SQPOLL wiring

Closes #1661. Companion to #3440 (mmap + io_uring co-usage audit).

Test plan

  • Documentation-only change; no code paths affected
  • Markdown renders cleanly

)

Documents the hazard that arises when IORING_SETUP_SQPOLL is enabled
and SQEs reference mmap'd basis-file pages that are not yet resident:
the kthread context cannot service major page faults the way a
userspace task can, leading to stalls, fall-back to task-work, or
-EFAULT completions.

Companion to docs/audits/mmap-iouring-co-usage.md (#3440). Records
the constraint so that whoever wires SQPOLL prefaults or avoids mmap
on the basis side first.

Salvaged from worktree branch docs/mmap-page-fault-sqpoll.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 1, 2026
@oferchen oferchen merged commit 1e1b852 into master May 1, 2026
4 checks passed
@oferchen oferchen deleted the docs/mmap-page-fault-sqpoll-1661 branch May 1, 2026 21:09
oferchen added a commit that referenced this pull request May 5, 2026
) (#3493)

Documents the hazard that arises when IORING_SETUP_SQPOLL is enabled
and SQEs reference mmap'd basis-file pages that are not yet resident:
the kthread context cannot service major page faults the way a
userspace task can, leading to stalls, fall-back to task-work, or
-EFAULT completions.

Companion to docs/audits/mmap-iouring-co-usage.md (#3440). Records
the constraint so that whoever wires SQPOLL prefaults or avoids mmap
on the basis side first.

Salvaged from worktree branch docs/mmap-page-fault-sqpoll.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant