Repository navigation
ShardedLock: Fix Debug implementation for ShardedLock{Read,Write}Guard - #1350
Merged
taiki-e merged 1 commit intoOct 31, 2026
Merged
Conversation
The Debug impls of ShardedLockReadGuard and ShardedLockWriteGuard
(crossbeam-utils/src/sync/sharded_lock.rs:506 and :542 before this
change) print `.field("lock", &self.lock)`, which goes through
ShardedLock's own Debug impl, and that one calls try_read(). A
ShardedLockWriteGuard holds the write lock of every shard, so that
try_read() always returns WouldBlock and a write guard always prints
ShardedLockWriteGuard { lock: ShardedLock { data: <locked> } }
instead of the value its holder has exclusive access to. A read guard
takes a second read lock on its own shard just to print itself, and
also prints `<locked>` when that attempt fails, for example on Linux
while a writer is waiting on that shard.
This is the implementation std's RwLock guards had until
rust-lang/rust#83561 (Rust 1.53) changed it for the same reason, as
rust-lang/rust#57703 had done for MutexGuard. std's guards now use
`(**self).fmt(f)` with a `T: ?Sized + fmt::Debug` bound (the `?Sized`
came in rust-lang/rust#117138). Do the same here. This matches the
Display impls of both guards just below them, which already use
`(**self).fmt(f)` with `T: ?Sized`, and makes the guards Debug for
unsized T such as `[i32]`, which ShardedLock supports (see the existing
unsized_type test).
The new guard_debug test checks the output of both guards for a
Vec<i32> lock and for a [i32] lock.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Contributor
Author
|
The miri channel failure looks unrelated: this only touches ShardedLock's Debug impl, and the same job has been failing intermittently in the scheduled runs on main (e.g. 2026-10-22). |
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.
ShardedLockReadGuardandShardedLockWriteGuardimplementDebugasf.debug_struct(..).field("lock", &self.lock), so printing a guard goes throughShardedLock's ownDebugimpl, which callstry_read(). A write guard holds the write lock of every shard, so thattry_read()always returnsWouldBlockand the guard never shows the value its holder has exclusive access to:A read guard takes a second read lock on its own shard just to print itself, and prints
<locked>too when that attempt fails, for example on Linux while a writer is waiting on that shard. Neither guard isDebugfor unsizedT, althoughShardedLock<[i32]>is supported (see theunsized_typetest) and theDisplayimpls of both guards already haveT: ?Sized.std's
RwLockguards had this same implementation until rust-lang/rust#83561 (Rust 1.53) replaced it with(**self).fmt(f)for the same reason, as rust-lang/rust#57703 had done forMutexGuard; rust-lang/rust#117138 later added the?Sizedbound. This PR does the same for both guards incrossbeam-utils/src/sync/sharded_lock.rs:(**self).fmt(f)withT: ?Sized + fmt::Debug, identical to theDisplayimpls right below them.ShardedLock's ownDebugimpl is unchanged.The new
guard_debugtest incrossbeam-utils/tests/sharded_lock.rsasserts the output of both guards for aVec<i32>lock and, with the same setup asunsized_type, for a[i32]lock. It is single-threaded, and each guard is a temporary of its own statement, so the write lock is never requested while the read guard is alive.This was not compiled or run locally: there was no Rust toolchain in the environment it was prepared in, so CI is the first build. Checked by reading instead:
Displayimpls in the same file and std's currentRwLockReadGuard/RwLockWriteGuardDebugimpls.[i32]lines of the test make the same callsunsized_typealready makes.Debugfor[i32]. TheVec<i32>assertions alone would fail withShardedLockReadGuard { lock: ShardedLock { data: [1, 2, 3] } }andShardedLockWriteGuard { lock: ShardedLock { data: <locked> } }.Nothing public is removed. The relaxed bound only adds impls.
🤖 Generated with Claude Code