Skip to content

Modularize package tooling and bandwidth limiter#1858

Merged
oferchen merged 1 commit into
masterfrom
optimize-and-clean-up-for-production-release
Nov 1, 2025
Merged

Modularize package tooling and bandwidth limiter#1858
oferchen merged 1 commit into
masterfrom
optimize-and-clean-up-for-production-release

Conversation

@oferchen
Copy link
Copy Markdown
Owner

@oferchen oferchen commented Nov 1, 2025

Summary

  • split the cargo xtask package implementation into focused argument, build orchestration, tarball authoring, and test modules to stay under the hygiene limits while preserving behaviour
  • reorganize the bandwidth limiter into change/core/sleep submodules that expose the same API surface with clearer responsibilities for limiter state, pacing, and throttling updates
  • document the new decomposition constraints in internal docs so future changes extend the new modules instead of reviving monolithic files

Testing

  • cargo test -p xtask
  • cargo test -p rsync-bandwidth
  • MAX_RUST_LINES=600 bash tools/enforce_limits.sh

https://chatgpt.com/codex/tasks/task_e_690579ad02dc832386292513f66088b1

@oferchen oferchen merged commit 8500839 into master Nov 1, 2025
@oferchen oferchen deleted the optimize-and-clean-up-for-production-release branch November 1, 2025 03:21
oferchen added a commit that referenced this pull request Apr 28, 2026
…ine (#3418)

Adds two doc-only notes covering recurring questions:

- crates/rsync_io/src/ssh/mod.rs: explains why SSH transfers cannot use
  the fast_io socket reader/writer paths. The data channel is the
  inherited stdio pipe pair from the spawned ssh child, not an AF_INET
  socket, so the io_uring socket fast path is unreachable. Mirrors
  upstream main.c:504 do_cmd(). Cross-references tasks #1859
  (pipe-FD io_uring) and #1860 (splice-based zero-copy) and notes that
  daemon TCP and local-disk transfers still benefit from fast_io.

- crates/transfer/src/generator/mod.rs: documents the sender-side
  INC_RECURSE state machine (Idle -> ScanDir -> SendChunk -> WaitAck
  -> NextDir -> Done) with upstream citations to flist.c:2192
  send_file_list(), sender.c:199 send_files(), generator.c:2226
  generate_files(), receiver.c:522 recv_files(), and compat.c:161
  set_allow_inc_recurse(). Documents that the sender side is
  implemented but disabled in build_capability_string until interop
  is validated (task #1862); the 'i' capability is not advertised
  when oc-rsync is sender.

Closes #1858, #1865.
oferchen added a commit that referenced this pull request May 1, 2026
…ine (#3418)

Adds two doc-only notes covering recurring questions:

- crates/rsync_io/src/ssh/mod.rs: explains why SSH transfers cannot use
  the fast_io socket reader/writer paths. The data channel is the
  inherited stdio pipe pair from the spawned ssh child, not an AF_INET
  socket, so the io_uring socket fast path is unreachable. Mirrors
  upstream main.c:504 do_cmd(). Cross-references tasks #1859
  (pipe-FD io_uring) and #1860 (splice-based zero-copy) and notes that
  daemon TCP and local-disk transfers still benefit from fast_io.

- crates/transfer/src/generator/mod.rs: documents the sender-side
  INC_RECURSE state machine (Idle -> ScanDir -> SendChunk -> WaitAck
  -> NextDir -> Done) with upstream citations to flist.c:2192
  send_file_list(), sender.c:199 send_files(), generator.c:2226
  generate_files(), receiver.c:522 recv_files(), and compat.c:161
  set_allow_inc_recurse(). Documents that the sender side is
  implemented but disabled in build_capability_string until interop
  is validated (task #1862); the 'i' capability is not advertised
  when oc-rsync is sender.

Closes #1858, #1865.
oferchen added a commit that referenced this pull request May 1, 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).
oferchen added a commit that referenced this pull request May 5, 2026
…ine (#3418)

Adds two doc-only notes covering recurring questions:

- crates/rsync_io/src/ssh/mod.rs: explains why SSH transfers cannot use
  the fast_io socket reader/writer paths. The data channel is the
  inherited stdio pipe pair from the spawned ssh child, not an AF_INET
  socket, so the io_uring socket fast path is unreachable. Mirrors
  upstream main.c:504 do_cmd(). Cross-references tasks #1859
  (pipe-FD io_uring) and #1860 (splice-based zero-copy) and notes that
  daemon TCP and local-disk transfers still benefit from fast_io.

- crates/transfer/src/generator/mod.rs: documents the sender-side
  INC_RECURSE state machine (Idle -> ScanDir -> SendChunk -> WaitAck
  -> NextDir -> Done) with upstream citations to flist.c:2192
  send_file_list(), sender.c:199 send_files(), generator.c:2226
  generate_files(), receiver.c:522 recv_files(), and compat.c:161
  set_allow_inc_recurse(). Documents that the sender side is
  implemented but disabled in build_capability_string until interop
  is validated (task #1862); the 'i' capability is not advertised
  when oc-rsync is sender.

Closes #1858, #1865.
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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant