docs(transfer): document ReorderBuffer head-of-line blocking semantics (#1883)#3519
Merged
Conversation
oferchen
added a commit
that referenced
this pull request
May 5, 2026
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.
Summary
Adds
docs/architecture/reorder-buffer.mddocumenting the head-of-line(HoL) blocking behaviour of the concurrent delta pipeline's reorder buffer
and contrasting it against upstream rsync 3.4.1's strictly-sequential
per-file pipeline.
Tracker: oc-rsync task #1883.
The doc covers:
the ring-buffer
ReorderBuffer(crates/engine/src/concurrent_delta/reorder.rs:65)owned by the
delta-reorderconsumer thread(
crates/engine/src/concurrent_delta/consumer.rs:147-188), and thealternative sliding-window
BoundedReorderBuffer(
crates/transfer/src/reorder_buffer.rs:57) with its explicitBackpressureError.next_expectedstalls everycompleted successor in the bounded window (default
2 * rayon::current_num_threads()slots), andforce_insert(
reorder.rs:334) trades the memory bound for forward progress whenthe head slot is empty and the window fills.
recv_filesloop(
target/interop/upstream-src/rsync-3.4.1/receiver.c:522): higherthroughput under uniform file sizes, but a "stop-then-burst" UX pattern
on skewed distributions.
--delay-updatesruns (mirroring upstream'shandle_delayed_updatesatreceiver.c:422), phase 2 redo, and the small-file regime where it iseffectively invisible.
spill-to-tempfile for stalled successors), Ensure release task uploads cross-compiled binaries #1885 (stall-duration metrics),
and Ensure release checksums are verifiable #1886 (bypass parallel pipeline when
--delay-updatesis off). Allthree are described as open design items, not merged code.
Documentation only - no code changes, no other docs cross-linked.
Test plan
git diffconfirms onlydocs/architecture/reorder-buffer.mdis added.stable, interop. Docs-only PR; no code paths touched.