Skip to content

feat(transfer): instrument prepare_pending_acl cost (INC_RECURSE I5)#4142

Merged
oferchen merged 2 commits into
masterfrom
feat/inc-recurse-prepare-acl-2200
May 16, 2026
Merged

feat(transfer): instrument prepare_pending_acl cost (INC_RECURSE I5)#4142
oferchen merged 2 commits into
masterfrom
feat/inc-recurse-prepare-acl-2200

Conversation

@oferchen
Copy link
Copy Markdown
Owner

Summary

Test plan

  • cargo nextest run -p transfer --all-features -E 'test(prepare_acl)' covers both new unit tests.
  • CI fmt+clippy, nextest (stable), Windows, macOS, Linux musl all pass.
  • Manual smoke: run a recursive transfer with --acls -vv --debug=GENR and confirm the new generator prepare_pending_acl totals: calls=N elapsed_ns=M line is emitted at end-of-transfer.

Closes #2200

Adds INC_RECURSE diagnostic counter I5 (#2200): two process-global
AtomicU64 counters that track every prepare_pending_acl invocation on
the generator file-list path and the cumulative wall time spent inside
the helper across all generator transfers.

The counters fire from a single record_prepare_acl helper bumped from
prepare_pending_acl itself, which wraps the existing body in an
Instant::now() pair. The early-return path (entry.is_symlink() or
!flags.acls) is still counted so per-segment call rate stays comparable
to entry count, but contributes a near-zero ns delta.

Totals are sampled in GeneratorContext::run via prepare_acl_totals() in
the same finalize block used by PR #4103 (I1 first-byte latency),
PR #4120 (I4 NDX partition_point) and PR #4121 (I3 flush rate), and
emitted via:

- debug_log!(Genr, 1, "generator prepare_pending_acl totals: \
  calls=N elapsed_ns=M")
- tracing::debug! event on rsync::generator::prepare_acl when the
  optional tracing feature is enabled

Two unit tests in crates/transfer/src/generator/tests.rs cover the
new counters:

- prepare_acl_call_counter_increments asserts the call counter and the
  cumulative elapsed_ns counter grow by at least N and sum-of-durations
  after N synthetic record_prepare_acl invocations. The assertion uses
  >= because the counter is shared across the process and other tests
  may run concurrently.
- prepare_acl_totals_observable_without_prep asserts the totals
  snapshot is a pure read - constructing a generator does not bump the
  counter on its own, so two adjacent reads with no intervening prep
  call must return identical values.

No new CLI flag, no wire-format change, no change to the public
prepare_pending_acl signature.

Closes #2200
@github-actions github-actions Bot added the enhancement New feature or request label May 16, 2026
@oferchen oferchen merged commit 56f0414 into master May 16, 2026
38 of 39 checks passed
@oferchen oferchen deleted the feat/inc-recurse-prepare-acl-2200 branch May 16, 2026 09:17
oferchen added a commit that referenced this pull request May 16, 2026
…RSE I2) (#4143)

Adds INC_RECURSE diagnostic counter I2 (#2197): two process-global
AtomicU64 counters that track every encode_and_send_segment invocation
on the generator file-list path and the cumulative wall time spent
inside the helper across all generator transfers.

The counters fire from a single record_segment_dispatch helper bumped
from encode_and_send_segment itself, which wraps the existing body in
an Instant::now() pair. The zero-entry early-return path is still
counted so per-transfer dispatch rate stays comparable to segment
scheduler activity, but contributes a near-zero ns delta.

Totals are sampled in GeneratorContext::run via
segment_dispatch_totals() in the same finalize block used by PR #4103
(I1 first-byte latency), PR #4120 (I4 NDX partition_point), PR #4121
(I3 flush rate) and PR #4142 (I5 prepare_pending_acl), and emitted
via:

- debug_log!(Genr, 1, "generator encode_and_send_segment totals: \
  calls=N elapsed_ns=M")
- tracing::debug! event on rsync::generator::segment_dispatch when
  the optional tracing feature is enabled

Two unit tests in crates/transfer/src/generator/tests.rs cover the
new counters:

- segment_dispatch_call_counter_increments asserts the call counter
  and the cumulative elapsed_ns counter grow by at least N and
  sum-of-durations after N synthetic record_segment_dispatch
  invocations. The assertion uses >= because the counter is shared
  across the process and other tests may run concurrently.
- segment_dispatch_totals_observable_without_dispatch asserts the
  totals snapshot is a pure read - constructing a generator does not
  bump the counter on its own, so two adjacent reads with no
  intervening dispatch call must return identical values.

No new CLI flag, no wire-format change, no change to the public
encode_and_send_segment signature.

Closes #2197
@oferchen oferchen mentioned this pull request May 16, 2026
oferchen added a commit that referenced this pull request May 18, 2026
…4142)

* feat(transfer): instrument prepare_pending_acl cost (INC_RECURSE I5)

Adds INC_RECURSE diagnostic counter I5 (#2200): two process-global
AtomicU64 counters that track every prepare_pending_acl invocation on
the generator file-list path and the cumulative wall time spent inside
the helper across all generator transfers.

The counters fire from a single record_prepare_acl helper bumped from
prepare_pending_acl itself, which wraps the existing body in an
Instant::now() pair. The early-return path (entry.is_symlink() or
!flags.acls) is still counted so per-segment call rate stays comparable
to entry count, but contributes a near-zero ns delta.

Totals are sampled in GeneratorContext::run via prepare_acl_totals() in
the same finalize block used by PR #4103 (I1 first-byte latency),
PR #4120 (I4 NDX partition_point) and PR #4121 (I3 flush rate), and
emitted via:

- debug_log!(Genr, 1, "generator prepare_pending_acl totals: \
  calls=N elapsed_ns=M")
- tracing::debug! event on rsync::generator::prepare_acl when the
  optional tracing feature is enabled

Two unit tests in crates/transfer/src/generator/tests.rs cover the
new counters:

- prepare_acl_call_counter_increments asserts the call counter and the
  cumulative elapsed_ns counter grow by at least N and sum-of-durations
  after N synthetic record_prepare_acl invocations. The assertion uses
  >= because the counter is shared across the process and other tests
  may run concurrently.
- prepare_acl_totals_observable_without_prep asserts the totals
  snapshot is a pure read - constructing a generator does not bump the
  counter on its own, so two adjacent reads with no intervening prep
  call must return identical values.

No new CLI flag, no wire-format change, no change to the public
prepare_pending_acl signature.

Closes #2200

* fix(transfer): rewrap rustdoc list items for prepare_pending_acl counters
oferchen added a commit that referenced this pull request May 18, 2026
…RSE I2) (#4143)

Adds INC_RECURSE diagnostic counter I2 (#2197): two process-global
AtomicU64 counters that track every encode_and_send_segment invocation
on the generator file-list path and the cumulative wall time spent
inside the helper across all generator transfers.

The counters fire from a single record_segment_dispatch helper bumped
from encode_and_send_segment itself, which wraps the existing body in
an Instant::now() pair. The zero-entry early-return path is still
counted so per-transfer dispatch rate stays comparable to segment
scheduler activity, but contributes a near-zero ns delta.

Totals are sampled in GeneratorContext::run via
segment_dispatch_totals() in the same finalize block used by PR #4103
(I1 first-byte latency), PR #4120 (I4 NDX partition_point), PR #4121
(I3 flush rate) and PR #4142 (I5 prepare_pending_acl), and emitted
via:

- debug_log!(Genr, 1, "generator encode_and_send_segment totals: \
  calls=N elapsed_ns=M")
- tracing::debug! event on rsync::generator::segment_dispatch when
  the optional tracing feature is enabled

Two unit tests in crates/transfer/src/generator/tests.rs cover the
new counters:

- segment_dispatch_call_counter_increments asserts the call counter
  and the cumulative elapsed_ns counter grow by at least N and
  sum-of-durations after N synthetic record_segment_dispatch
  invocations. The assertion uses >= because the counter is shared
  across the process and other tests may run concurrently.
- segment_dispatch_totals_observable_without_dispatch asserts the
  totals snapshot is a pure read - constructing a generator does not
  bump the counter on its own, so two adjacent reads with no
  intervening dispatch call must return identical values.

No new CLI flag, no wire-format change, no change to the public
encode_and_send_segment signature.

Closes #2197
oferchen added a commit that referenced this pull request May 18, 2026
…4142)

* feat(transfer): instrument prepare_pending_acl cost (INC_RECURSE I5)

Adds INC_RECURSE diagnostic counter I5 (#2200): two process-global
AtomicU64 counters that track every prepare_pending_acl invocation on
the generator file-list path and the cumulative wall time spent inside
the helper across all generator transfers.

The counters fire from a single record_prepare_acl helper bumped from
prepare_pending_acl itself, which wraps the existing body in an
Instant::now() pair. The early-return path (entry.is_symlink() or
!flags.acls) is still counted so per-segment call rate stays comparable
to entry count, but contributes a near-zero ns delta.

Totals are sampled in GeneratorContext::run via prepare_acl_totals() in
the same finalize block used by PR #4103 (I1 first-byte latency),
PR #4120 (I4 NDX partition_point) and PR #4121 (I3 flush rate), and
emitted via:

- debug_log!(Genr, 1, "generator prepare_pending_acl totals: \
  calls=N elapsed_ns=M")
- tracing::debug! event on rsync::generator::prepare_acl when the
  optional tracing feature is enabled

Two unit tests in crates/transfer/src/generator/tests.rs cover the
new counters:

- prepare_acl_call_counter_increments asserts the call counter and the
  cumulative elapsed_ns counter grow by at least N and sum-of-durations
  after N synthetic record_prepare_acl invocations. The assertion uses
  >= because the counter is shared across the process and other tests
  may run concurrently.
- prepare_acl_totals_observable_without_prep asserts the totals
  snapshot is a pure read - constructing a generator does not bump the
  counter on its own, so two adjacent reads with no intervening prep
  call must return identical values.

No new CLI flag, no wire-format change, no change to the public
prepare_pending_acl signature.

Closes #2200

* fix(transfer): rewrap rustdoc list items for prepare_pending_acl counters
oferchen added a commit that referenced this pull request May 18, 2026
…RSE I2) (#4143)

Adds INC_RECURSE diagnostic counter I2 (#2197): two process-global
AtomicU64 counters that track every encode_and_send_segment invocation
on the generator file-list path and the cumulative wall time spent
inside the helper across all generator transfers.

The counters fire from a single record_segment_dispatch helper bumped
from encode_and_send_segment itself, which wraps the existing body in
an Instant::now() pair. The zero-entry early-return path is still
counted so per-transfer dispatch rate stays comparable to segment
scheduler activity, but contributes a near-zero ns delta.

Totals are sampled in GeneratorContext::run via
segment_dispatch_totals() in the same finalize block used by PR #4103
(I1 first-byte latency), PR #4120 (I4 NDX partition_point), PR #4121
(I3 flush rate) and PR #4142 (I5 prepare_pending_acl), and emitted
via:

- debug_log!(Genr, 1, "generator encode_and_send_segment totals: \
  calls=N elapsed_ns=M")
- tracing::debug! event on rsync::generator::segment_dispatch when
  the optional tracing feature is enabled

Two unit tests in crates/transfer/src/generator/tests.rs cover the
new counters:

- segment_dispatch_call_counter_increments asserts the call counter
  and the cumulative elapsed_ns counter grow by at least N and
  sum-of-durations after N synthetic record_segment_dispatch
  invocations. The assertion uses >= because the counter is shared
  across the process and other tests may run concurrently.
- segment_dispatch_totals_observable_without_dispatch asserts the
  totals snapshot is a pure read - constructing a generator does not
  bump the counter on its own, so two adjacent reads with no
  intervening dispatch call must return identical values.

No new CLI flag, no wire-format change, no change to the public
encode_and_send_segment signature.

Closes #2197
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant