Windows: Implement condvar, mutex and rwlock using futex #121956

ChrisDenton · 2024-03-03T22:18:07Z

Well, the Windows equivalent: WaitOnAddress, WakeByAddressSingle and WakeByAddressAll.

Note that Windows flavoured futexes can be different sizes (1, 2, 4 or 8 bytes). I took advantage of that in the Mutex implementation.

I also edited the Mutex implementation a bit more than necessary. I was having trouble keeping in my head what 0, 1 and 2 meant so I replaced them with consts.

I think we're maybe spinning a bit much. WaitOnAddress seems to be looping quite a bit too. But for now I've keep the implementations the same. I do wonder if it'd be worth reducing or removing our spinning on Windows.

This also adds a new shim to miri, because of course it does.

Fixes #121949

rustbot · 2024-03-03T22:18:15Z

r? @Nilstrieb

rustbot has assigned @Nilstrieb.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2024-03-03T22:18:17Z

The Miri subtree was changed

cc @rust-lang/miri

RalfJung

Miri shim LGTM :)

library/std/src/sys/locks/mutex/futex.rs

ChrisDenton · 2024-03-04T16:40:03Z

Incidentally @joboet, I would consider this a successful test case for the sys restructuring. Reusing the futex implementations on Windows was super easy 😁

Nilstrieb

Most of the changes look good to me, but I'm not comfortable approving Windows futex.rs because I don't know very much about Windows and/or the futex interface. maybe @joboet is?

Well, the Windows equivalent: `WaitOnAddress`, `WakeByAddressSingle` and `WakeByAddressAll`.

joboet

Sure, I'll take a look!

library/std/src/sys/pal/windows/futex.rs

joboet

r=me after fixing the nit, looks great!

library/std/src/sys/pal/windows/futex.rs

ChrisDenton · 2024-03-05T20:55:28Z

Switching sync implementations is a big enough deal that I think this should prefer to avoid being rolled up, if possible.

@bors r=joboet rollup=iffy

bors · 2024-03-05T20:55:31Z

📌 Commit cf83d83 has been approved by joboet

It is now in the queue for this repository.

bors · 2024-03-06T12:19:43Z

⌛ Testing commit cf83d83 with merge 3314d5c...

bors · 2024-03-06T14:50:43Z

☀️ Test successful - checks-actions
Approved by: joboet
Pushing 3314d5c to master...

rust-timer · 2024-03-06T16:25:08Z

Finished benchmarking commit (3314d5c): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.0%	[0.0%, 0.0%]	1
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-4.0%	[-8.9%, -1.4%]	7
Improvements ✅ (secondary)	-2.9%	[-3.3%, -2.5%]	9
All ❌✅ (primary)	-3.5%	[-8.9%, 0.0%]	8

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.0%	[0.0%, 0.0%]	2
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-0.1%	[-0.1%, -0.0%]	3
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-0.0%	[-0.1%, 0.0%]	5

Bootstrap: 646.206s -> 646.923s (0.11%)
Artifact size: 175.06 MiB -> 175.06 MiB (-0.00%)

Since rust-lang/rust#121956 we don't need it any more, and we are generally short on Windows staff so reducing the amount of code we have to test and maintain sounds like a good idea. The InitOnce stuff is still used by `thread_local_key::StaticKey`.

windows: remove support for slim rwlock Since rust-lang/rust#121956 we don't need it any more, and we are generally short on Windows staff so reducing the amount of code we have to test and maintain sounds like a good idea. The InitOnce stuff is still used by `thread_local_key::StaticKey` on 64bit windows-gnu.

Since rust-lang#121956 we don't need it any more, and we are generally short on Windows staff so reducing the amount of code we have to test and maintain sounds like a good idea. The InitOnce stuff is still used by `thread_local_key::StaticKey`.

windows: remove support for slim rwlock Since rust-lang#121956 we don't need it any more, and we are generally short on Windows staff so reducing the amount of code we have to test and maintain sounds like a good idea. The InitOnce stuff is still used by `thread_local_key::StaticKey` on 64bit windows-gnu.

windows: remove support for slim rwlock Since rust-lang/rust#121956 we don't need it any more, and we are generally short on Windows staff so reducing the amount of code we have to test and maintain sounds like a good idea. The InitOnce stuff is still used by `thread_local_key::StaticKey` on 64bit windows-gnu.

Pkgsrc changes: * Adapt checksums and patches, some have beene intregrated upstream. Upstream chnages: Version 1.78.0 (2024-05-02) =========================== Language -------- - [Stabilize `#[cfg(target_abi = ...)]`] (rust-lang/rust#119590) - [Stabilize the `#[diagnostic]` namespace and `#[diagnostic::on_unimplemented]` attribute] (rust-lang/rust#119888) - [Make async-fn-in-trait implementable with concrete signatures] (rust-lang/rust#120103) - [Make matching on NaN a hard error, and remove the rest of `illegal_floating_point_literal_pattern`] (rust-lang/rust#116284) - [static mut: allow mutable reference to arbitrary types, not just slices and arrays] (rust-lang/rust#117614) - [Extend `invalid_reference_casting` to include references casting to bigger memory layout] (rust-lang/rust#118983) - [Add `non_contiguous_range_endpoints` lint for singleton gaps after exclusive ranges] (rust-lang/rust#118879) - [Add `wasm_c_abi` lint for use of older wasm-bindgen versions] (rust-lang/rust#117918) This lint currently only works when using Cargo. - [Update `indirect_structural_match` and `pointer_structural_match` lints to match RFC] (rust-lang/rust#120423) - [Make non-`PartialEq`-typed consts as patterns a hard error] (rust-lang/rust#120805) - [Split `refining_impl_trait` lint into `_reachable`, `_internal` variants] (rust-lang/rust#121720) - [Remove unnecessary type inference when using associated types inside of higher ranked `where`-bounds] (rust-lang/rust#119849) - [Weaken eager detection of cyclic types during type inference] (rust-lang/rust#119989) - [`trait Trait: Auto {}`: allow upcasting from `dyn Trait` to `dyn Auto`] (rust-lang/rust#119338) Compiler -------- - [Made `INVALID_DOC_ATTRIBUTES` lint deny by default] (rust-lang/rust#111505) - [Increase accuracy of redundant `use` checking] (rust-lang/rust#117772) - [Suggest moving definition if non-found macro_rules! is defined later] (rust-lang/rust#121130) - [Lower transmutes from int to pointer type as gep on null] (rust-lang/rust#121282) Target changes: - [Windows tier 1 targets now require at least Windows 10] (rust-lang/rust#115141) - [Enable CMPXCHG16B, SSE3, SAHF/LAHF and 128-bit Atomics in tier 1 Windows] (rust-lang/rust#120820) - [Add `wasm32-wasip1` tier 2 (without host tools) target] (rust-lang/rust#120468) - [Add `wasm32-wasip2` tier 3 target] (rust-lang/rust#119616) - [Rename `wasm32-wasi-preview1-threads` to `wasm32-wasip1-threads`] (rust-lang/rust#122170) - [Add `arm64ec-pc-windows-msvc` tier 3 target] (rust-lang/rust#119199) - [Add `armv8r-none-eabihf` tier 3 target for the Cortex-R52] (rust-lang/rust#110482) - [Add `loongarch64-unknown-linux-musl` tier 3 target] (rust-lang/rust#121832) Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support. Libraries --------- - [Bump Unicode to version 15.1.0, regenerate tables] (rust-lang/rust#120777) - [Make align_offset, align_to well-behaved in all cases] (rust-lang/rust#121201) - [PartialEq, PartialOrd: document expectations for transitive chains] (rust-lang/rust#115386) - [Optimize away poison guards when std is built with panic=abort] (rust-lang/rust#100603) - [Replace pthread `RwLock` with custom implementation] (rust-lang/rust#110211) - [Implement unwind safety for Condvar on all platforms] (rust-lang/rust#121768) - [Add ASCII fast-path for `char::is_grapheme_extended`] (rust-lang/rust#121138) Stabilized APIs --------------- - [`impl Read for &Stdin`] (https://doc.rust-lang.org/stable/std/io/struct.Stdin.html#impl-Read-for-%26Stdin) - [Accept non `'static` lifetimes for several `std::error::Error` related implementations] (rust-lang/rust#113833) - [Make `impl<Fd: AsFd>` impl take `?Sized`] (rust-lang/rust#114655) - [`impl From<TryReserveError> for io::Error`] (https://doc.rust-lang.org/stable/std/io/struct.Error.html#impl-From%3CTryReserveError%3E-for-Error) These APIs are now stable in const contexts: - [`Barrier::new()`] (https://doc.rust-lang.org/stable/std/sync/struct.Barrier.html#method.new) Cargo ----- - [Stabilize lockfile v4](rust-lang/cargo#12852) - [Respect `rust-version` when generating lockfile] (rust-lang/cargo#12861) - [Control `--charset` via auto-detecting config value] (rust-lang/cargo#13337) - [Support `target.<triple>.rustdocflags` officially] (rust-lang/cargo#13197) - [Stabilize global cache data tracking] (rust-lang/cargo#13492) Misc ---- - [rustdoc: add `--test-builder-wrapper` arg to support wrappers such as RUSTC_WRAPPER when building doctests] (rust-lang/rust#114651) Compatibility Notes ------------------- - [Many unsafe precondition checks now run for user code with debug assertions enabled] (rust-lang/rust#120594) This change helps users catch undefined behavior in their code, though the details of how much is checked are generally not stable. - [riscv only supports split_debuginfo=off for now] (rust-lang/rust#120518) - [Consistently check bounds on hidden types of `impl Trait`] (rust-lang/rust#121679) - [Change equality of higher ranked types to not rely on subtyping] (rust-lang/rust#118247) - [When called, additionally check bounds on normalized function return type] (rust-lang/rust#118882) - [Expand coverage for `arithmetic_overflow` lint] (rust-lang/rust#119432) Internal Changes ---------------- These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools. - [Update to LLVM 18](rust-lang/rust#120055) - [Build `rustc` with 1CGU on `x86_64-pc-windows-msvc`] (rust-lang/rust#112267) - [Build `rustc` with 1CGU on `x86_64-apple-darwin`] (rust-lang/rust#112268) - [Introduce `run-make` V2 infrastructure, a `run_make_support` library and port over 2 tests as example] (rust-lang/rust#113026) - [Windows: Implement condvar, mutex and rwlock using futex] (rust-lang/rust#121956)

rustbot assigned Nilstrieb Mar 3, 2024

rustbot added O-windows Operating system: Windows S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Mar 3, 2024

This comment has been minimized.

Sign in to view

ChrisDenton force-pushed the srwlock branch 2 times, most recently from 508a095 to f15b4f7 Compare March 3, 2024 22:28

ChrisDenton changed the title ~~Windows: Implement mutex using futex~~ Windows: Implement condvar, mutex and rwlock using futex Mar 3, 2024

ChrisDenton force-pushed the srwlock branch 4 times, most recently from 0aa6381 to 2c7e068 Compare March 4, 2024 05:01

RalfJung reviewed Mar 4, 2024

View reviewed changes

SkiFire13 reviewed Mar 4, 2024

View reviewed changes

library/std/src/sys/locks/mutex/futex.rs Outdated Show resolved Hide resolved

ChrisDenton force-pushed the srwlock branch from 2c7e068 to 620193b Compare March 4, 2024 16:38

Nilstrieb reviewed Mar 4, 2024

View reviewed changes

ChrisDenton force-pushed the srwlock branch from 258cb55 to e4d485d Compare March 5, 2024 00:18

ChrisDenton added 2 commits March 5, 2024 00:19

Windows: Implement mutex using futex

f700641

Well, the Windows equivalent: `WaitOnAddress`, `WakeByAddressSingle` and `WakeByAddressAll`.

Update debuginfo tests

2a09857

ChrisDenton force-pushed the srwlock branch from e4d485d to 2a09857 Compare March 5, 2024 00:20

joboet requested changes Mar 5, 2024

View reviewed changes

library/std/src/sys/pal/windows/futex.rs Show resolved Hide resolved

library/std/src/sys/pal/windows/futex.rs Outdated Show resolved Hide resolved

joboet self-assigned this Mar 5, 2024

joboet approved these changes Mar 5, 2024

View reviewed changes

library/std/src/sys/pal/windows/futex.rs Outdated Show resolved Hide resolved

Add Waitable trait

cf83d83

ChrisDenton force-pushed the srwlock branch from 25628ef to cf83d83 Compare March 5, 2024 20:49

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 Mar 5, 2024

bors added the merged-by-bors This PR was explicitly merged by bors. label Mar 6, 2024

bors merged commit 3314d5c into rust-lang:master Mar 6, 2024
12 checks passed

rustbot added this to the 1.78.0 milestone Mar 6, 2024

ChrisDenton added the relnotes Marks issues that should be documented in the release notes of the next release. label Mar 6, 2024

ChrisDenton deleted the srwlock branch March 6, 2024 15:05

RalfJung mentioned this pull request Mar 9, 2024

windows: remove support for slim rwlock rust-lang/miri#3370

Merged

seritools mentioned this pull request Apr 2, 2024

Notes for future Rust version upgrades rust9x/rust#19

Open

1 task

This was referenced Apr 14, 2024

feat!: bump Rust polars to 0.39.0 pola-rs/r-polars#1034

Merged

"undefined reference to `WaitOnAddress'" error with nightly toolchain nightly-2024-03-28 on Windows GNU target #123923

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Windows: Implement condvar, mutex and rwlock using futex #121956

Windows: Implement condvar, mutex and rwlock using futex #121956

ChrisDenton commented Mar 3, 2024 •

edited

rustbot commented Mar 3, 2024

rustbot commented Mar 3, 2024

This comment has been minimized.

RalfJung left a comment

ChrisDenton commented Mar 4, 2024

Nilstrieb left a comment

joboet left a comment

joboet left a comment

ChrisDenton commented Mar 5, 2024

bors commented Mar 5, 2024

bors commented Mar 6, 2024

bors commented Mar 6, 2024

rust-timer commented Mar 6, 2024

Windows: Implement condvar, mutex and rwlock using futex #121956

Windows: Implement condvar, mutex and rwlock using futex #121956

Conversation

ChrisDenton commented Mar 3, 2024 • edited

rustbot commented Mar 3, 2024

rustbot commented Mar 3, 2024

This comment has been minimized.

RalfJung left a comment

Choose a reason for hiding this comment

ChrisDenton commented Mar 4, 2024

Nilstrieb left a comment

Choose a reason for hiding this comment

joboet left a comment

Choose a reason for hiding this comment

joboet left a comment

Choose a reason for hiding this comment

ChrisDenton commented Mar 5, 2024

bors commented Mar 5, 2024

bors commented Mar 6, 2024

bors commented Mar 6, 2024

rust-timer commented Mar 6, 2024

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

ChrisDenton commented Mar 3, 2024 •

edited