docs(rsync_io): audit SSH socketpair vs anonymous pipes for stdio transport (#1938)#3525
Merged
Conversation
…nsport (#1938) Formalizes the SSH stdio transport audit at docs/audits/ssh-socketpair-vs-pipes.md under tracker #1938, consolidating prior #1686 working notes (PR #3438), the io_uring boundary documented for #1858 (PR #3418), and the stderr socketpair shipped under #1689 (PR #3383). Restructures the document into the formal seven-section layout (summary, upstream reference, current implementation, trade-offs, decision matrix, recommendation, implementation notes) plus findings and references. Recommends keeping anonymous pipes for the SSH wire and not pursuing the socketpair migration: splice(2) and vmsplice(2) require a pipe end, the zero-copy plan in #1860 depends on that, and the unified-FD argument is subsumed by the async-transport refactor (#2068, #1655). Closes #1687 (prototype socketpair wire) as do-not-implement and #1902 (verify wire claim against rsync_io source) as verified. Citations were re-checked against worktree source: builder.rs:300-301 (Stdio::piped on the wire), aux_channel.rs:263-285 (UnixStream::pair for stderr, Unix only), connection.rs:30-39 (SshConnection struct), mod.rs:57-75 (io_uring boundary). Upstream evidence verified against target/interop/upstream-src/rsync-3.4.1/: pipe.c:48-97 (piped_child), util1.c:74-96 (fd_pair), main.c:504-663 (do_cmd dispatch), clientserver.c:116-148 (daemon TCP wire), socket.c:736-846 (sock_exec test escape).
oferchen
added a commit
that referenced
this pull request
May 5, 2026
…nsport (#1938) (#3525) Formalizes the SSH stdio transport audit at docs/audits/ssh-socketpair-vs-pipes.md under tracker #1938, consolidating prior #1686 working notes (PR #3438), the io_uring boundary documented for #1858 (PR #3418), and the stderr socketpair shipped under #1689 (PR #3383). Restructures the document into the formal seven-section layout (summary, upstream reference, current implementation, trade-offs, decision matrix, recommendation, implementation notes) plus findings and references. Recommends keeping anonymous pipes for the SSH wire and not pursuing the socketpair migration: splice(2) and vmsplice(2) require a pipe end, the zero-copy plan in #1860 depends on that, and the unified-FD argument is subsumed by the async-transport refactor (#2068, #1655). Closes #1687 (prototype socketpair wire) as do-not-implement and #1902 (verify wire claim against rsync_io source) as verified. Citations were re-checked against worktree source: builder.rs:300-301 (Stdio::piped on the wire), aux_channel.rs:263-285 (UnixStream::pair for stderr, Unix only), connection.rs:30-39 (SshConnection struct), mod.rs:57-75 (io_uring boundary). Upstream evidence verified against target/interop/upstream-src/rsync-3.4.1/: pipe.c:48-97 (piped_child), util1.c:74-96 (fd_pair), main.c:504-663 (do_cmd dispatch), clientserver.c:116-148 (daemon TCP wire), socket.c:736-846 (sock_exec test escape).
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.
Closes #1938.
Summary
Formalizes the SSH stdio transport audit at
docs/audits/ssh-socketpair-vs-pipes.mdunder tracker #1938. Consolidates prior #1686 working notes (PR #3438), the io_uring boundary documented for #1858 (PR #3418), and the stderr socketpair shipped under #1689 (PR #3383). Restructures the document into the formal seven-section layout (summary, upstream reference, current implementation, trade-offs, decision matrix, recommendation, implementation notes) plus findings and references.Recommends keeping anonymous pipes for the SSH wire and not pursuing the socketpair migration. The decisive argument is that
splice(2)/vmsplice(2)require one of the two FDs to be a pipe; oc-rsync's zero-copy roadmap in #1860 depends on the wire being a pipe so the file<->wire splice path remains direct. A socketpair-backed wire would force a double-splice through an intermediate user-spacepipe(2), eliminating the zero-copy benefit. The "unified poll FD" advantage of socketpair only matters inside an event loop, and the async-transport refactor (#2068, #1655) consolidates readiness tracking regardless of primitive.The audit closes the two pending follow-ups in this tracker family:
rsync_iosource) - verified:crates/rsync_io/src/ssh/builder.rs:300-301usesStdio::piped()for stdin and stdout (anonymous pipes); upstream usessocketpair(AF_UNIX, SOCK_STREAM, 0)viautil1.c::fd_paircalled frompipe.c::piped_child. The divergence is intentional.What stays on the roadmap (untouched by this audit):
docs/audits/iouring-pipe-stdio.md).docs/audits/splice-ssh-stdio.md).docs/audits/async-ssh-transport.md).Test plan
target/interop/upstream-src/rsync-3.4.1/source files.crates/rsync_io/src/ssh/citations verified against worktree line numbers.docs:prefix; branch namedocs/ssh-socketpair-1938.