docs: refresh IOCP wiring and signal-handler unsafe attribution#4574
Merged
Conversation
- README status table and Known Limitations now state IOCP is wired for the receive-side disk-write pipeline (transfer::disk_commit dispatches Writer::Iocp on Windows) in addition to socket transports, not just compiled. The stale #1868 issue reference is dropped; the read-path extension is tracked under WPG-1. - README and SECURITY.md unsafe-code inventories reflect PR #4571: signal-handler installation lives in fast_io::signal as a safe wrapper, core::signal carries no unsafe override, and platform's bullet drops "signal handlers" from its description. - SECURITY.md notes the test-only #[allow(unsafe_code)] on embedding's tests::EnvGuard helper so the deny-only list is accurate for production code without misrepresenting test scaffolding.
github-actions
Bot
added
the
documentation
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
1 participant
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
Three factual corrections to README.md and SECURITY.md against current
origin/masterstate.IOCP wiring is broader than the prose claims. Both the README status table (row Async I/O backend) and the Known Limitations section described Windows IOCP as either compiled, not wired or wired only for sockets. In current master,
transfer::disk_commit::Writer::Iocpdispatches the receive-side disk-write pipeline through IOCP on Windows; only the read path still falls back to standard buffered I/O. The stale issue reference#1868(which was actually a packaging-flow issue, merged 2025-11-01) is dropped; the read-path extension is now tracked under WPG-1.Signal-handler unsafe lives in
fast_io, notplatformorcore. Both files still attributed signal-handler unsafe toplatform(and SECURITY.md implicitly tocore::signal's previous#![allow(unsafe_code)]). The signal-installation FFI has been hoisted intofast_io::signal::install_signal_handler;core::signalnow lives under plain#![deny(unsafe_code)], and theplatformbullet no longer claims signal handling. Thefast_iobullets in both files now mentionsignal::install_signal_handleralongside the rest of the syscall surface.embeddingcarries a test-only#[allow(unsafe_code)]. SECURITY.md listedembeddingin the deny-only list, which is correct for production code but misleading -tests::EnvGuarduses#[cfg(test)]-onlyunsafe { std::env::set_var(...) }under a process-wide mutex. The bullet now calls out that carve-out explicitly.No code changes. Both files are markdown-only edits.
Test plan