Add `rustc_diagnostic_item` to `sys::Mutex` methods#141690

Patrick-6 · 2025-05-28T13:32:28Z

For an ongoing project for adding a concurrency model checker to Miri we need to be able to intercept locking/unlocking operations on standard library mutexes.

This PR adds diagnostic items to the relevant calls lock, try_lock and unlock for the sys::Mutex implementation on the targets we care about.
This PR also makes the internals of pthread::Mutex less public, to reduce the chance of anyone locking/unlocking a mutex without going through the intercepted methods.

r? @RalfJung

RalfJung · 2025-05-28T13:39:53Z

This LGTM, but someone on t-libs should be on-board with having Miri-specific diagnostic items in the code. We have clippy-specific diagnostic items so I hope this is acceptable. :)

r? @tgross35 or @joboet or @m-ou-se

m-ou-se · 2025-05-28T13:51:24Z

Please add a comment above each attribute explaining that it is for Miri's concurrency model checker.

r=me with those comments added.

tgross35 · 2025-05-28T13:52:01Z

library/std/src/sys/sync/mutex/pthread.rs


 pub struct Mutex {
-    pub pal: OnceBox<pal::Mutex>,
+    pub(in crate::sys::sync) pal: OnceBox<pal::Mutex>,


Is this needed for Miri or just a pedantic change? Makes sense in either case.

Just a pedantic change.

To give more context -- the model checking for mutexes would become weird or even unsound if the mutex API is bypassed by directly accessing the underlying mutex operations, so we wanted to reduce the risk of that happening.

Patrick-6 · 2025-05-28T15:08:49Z

I've added the comments.

r? @m-ou-se

rustbot · 2025-05-28T15:08:52Z

Requested reviewer is already assigned to this pull request.

Please choose another assignee.

m-ou-se · 2025-05-28T15:10:05Z

@bors r+ rollup

bors · 2025-05-28T15:10:08Z

📌 Commit 8237107 has been approved by m-ou-se

It is now in the queue for this repository.

Add `rustc_diagnostic_item` to `sys::Mutex` methods For an ongoing project for adding a concurrency model checker to Miri we need to be able to intercept locking/unlocking operations on standard library mutexes. This PR adds diagnostic items to the relevant calls `lock`, `try_lock` and `unlock` for the `sys::Mutex` implementation on the targets we care about. This PR also makes the internals of `pthread::Mutex` less public, to reduce the chance of anyone locking/unlocking a mutex without going through the intercepted methods. r? `@RalfJung`

Rollup of 8 pull requests Successful merges: - #125087 (Optimize `Seek::stream_len` impl for `File`) - #138285 (Stabilize `repr128`) - #139994 (add `CStr::display`) - #141477 (Path::with_extension: show that it adds an extension where one did no…) - #141533 (clean up old rintf leftovers) - #141690 (Add `rustc_diagnostic_item` to `sys::Mutex` methods) - #141693 (Subtree update of `rust-analyzer`) - #141702 (Add eholk to compiler reviewer rotation) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 16 pull requests Successful merges: - #136429 (GCI: At their def site, actually wfcheck the where-clause & always eval free lifetime-generic constants) - #138139 (Emit warning while outputs is not exe and prints linkage info) - #141104 (Test(fs): Fix `test_eq_windows_file_type` for Windows 7) - #141477 (Path::with_extension: show that it adds an extension where one did no…) - #141533 (clean up old rintf leftovers) - #141612 (Call out possibility of invariant result in variance markers) - #141638 (Use `builtin_index` instead of hand-rolling it) - #141643 (ci: verify that codebuild jobs use ghcr.io) - #141675 (Reorder `ast::ItemKind::{Struct,Enum,Union}` fields.) - #141680 (replace TraitRef link memory.md) - #141682 (interpret/allocation: Fixup type for `alloc_bytes`) - #141683 (Handle ed2021 precise capturing of unsafe binder) - #141684 (rustbook: Bump versions of `onig` and `onig_sys`) - #141687 (core: unstably expose atomic_compare_exchange so stdarch can use it) - #141690 (Add `rustc_diagnostic_item` to `sys::Mutex` methods) - #141702 (Add eholk to compiler reviewer rotation) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #141690 - Patrick-6:intercept-mutex, r=m-ou-se Add `rustc_diagnostic_item` to `sys::Mutex` methods For an ongoing project for adding a concurrency model checker to Miri we need to be able to intercept locking/unlocking operations on standard library mutexes. This PR adds diagnostic items to the relevant calls `lock`, `try_lock` and `unlock` for the `sys::Mutex` implementation on the targets we care about. This PR also makes the internals of `pthread::Mutex` less public, to reduce the chance of anyone locking/unlocking a mutex without going through the intercepted methods. r? ``@RalfJung``

Add `rustc_diagnostic_item` to `sys::Mutex` methods For an ongoing project for adding a concurrency model checker to Miri we need to be able to intercept locking/unlocking operations on standard library mutexes. This PR adds diagnostic items to the relevant calls `lock`, `try_lock` and `unlock` for the `sys::Mutex` implementation on the targets we care about. This PR also makes the internals of `pthread::Mutex` less public, to reduce the chance of anyone locking/unlocking a mutex without going through the intercepted methods. r? ``@RalfJung``

Rollup of 16 pull requests Successful merges: - rust-lang/rust#136429 (GCI: At their def site, actually wfcheck the where-clause & always eval free lifetime-generic constants) - rust-lang/rust#138139 (Emit warning while outputs is not exe and prints linkage info) - rust-lang/rust#141104 (Test(fs): Fix `test_eq_windows_file_type` for Windows 7) - rust-lang/rust#141477 (Path::with_extension: show that it adds an extension where one did no…) - rust-lang/rust#141533 (clean up old rintf leftovers) - rust-lang/rust#141612 (Call out possibility of invariant result in variance markers) - rust-lang/rust#141638 (Use `builtin_index` instead of hand-rolling it) - rust-lang/rust#141643 (ci: verify that codebuild jobs use ghcr.io) - rust-lang/rust#141675 (Reorder `ast::ItemKind::{Struct,Enum,Union}` fields.) - rust-lang/rust#141680 (replace TraitRef link memory.md) - rust-lang/rust#141682 (interpret/allocation: Fixup type for `alloc_bytes`) - rust-lang/rust#141683 (Handle ed2021 precise capturing of unsafe binder) - rust-lang/rust#141684 (rustbook: Bump versions of `onig` and `onig_sys`) - rust-lang/rust#141687 (core: unstably expose atomic_compare_exchange so stdarch can use it) - rust-lang/rust#141690 (Add `rustc_diagnostic_item` to `sys::Mutex` methods) - rust-lang/rust#141702 (Add eholk to compiler reviewer rotation) r? `@ghost` `@rustbot` modify labels: rollup

Patrick-6 added 2 commits May 28, 2025 15:12

Add diagnostic items to sys::Mutex

2e99a88

Make pthread Mutex internals less public

149b5b2

rustbot assigned RalfJung May 28, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels May 28, 2025

rustbot assigned tgross35 and unassigned RalfJung May 28, 2025

m-ou-se assigned m-ou-se and unassigned tgross35 May 28, 2025

tgross35 reviewed May 28, 2025

View reviewed changes

Add comments to diagnostic items

8237107

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 28, 2025

tgross35 mentioned this pull request May 28, 2025

Rollup of 8 pull requests #141710

Closed

jhpratt mentioned this pull request May 29, 2025

Rollup of 16 pull requests #141716

Merged

bors merged commit e7ef07a into rust-lang:master May 29, 2025
7 checks passed

rustbot added this to the 1.89.0 milestone May 29, 2025

Patrick-6 mentioned this pull request Oct 2, 2025

Implement std::sync::Mutex interception for GenMC mode. rust-lang/miri#4614

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `rustc_diagnostic_item` to `sys::Mutex` methods#141690