Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from Mar 6, 2024

Conversation

ChrisDenton
Copy link
Contributor

@ChrisDenton ChrisDenton commented Mar 3, 2024

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
Copy link
Collaborator

rustbot commented Mar 3, 2024

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 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
@rustbot
Copy link
Collaborator

rustbot commented Mar 3, 2024

The Miri subtree was changed

cc @rust-lang/miri

@rust-log-analyzer

This comment has been minimized.

@ChrisDenton ChrisDenton force-pushed the srwlock branch 2 times, most recently from 508a095 to f15b4f7 Compare March 3, 2024 22:28
@ChrisDenton ChrisDenton changed the title Windows: Implement mutex using futex Windows: Implement condvar, mutex and rwlock using futex Mar 3, 2024
@ChrisDenton ChrisDenton force-pushed the srwlock branch 4 times, most recently from 0aa6381 to 2c7e068 Compare March 4, 2024 05:01
Copy link
Member

@RalfJung RalfJung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Miri shim LGTM :)

@ChrisDenton
Copy link
Contributor Author

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

Copy link
Member

@Nilstrieb Nilstrieb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`.
Copy link
Contributor

@joboet joboet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I'll take a look!

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 joboet self-assigned this Mar 5, 2024
Copy link
Contributor

@joboet joboet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

r=me after fixing the nit, looks great!

library/std/src/sys/pal/windows/futex.rs Outdated Show resolved Hide resolved
@ChrisDenton
Copy link
Contributor Author

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
Copy link
Contributor

bors commented Mar 5, 2024

📌 Commit cf83d83 has been approved by joboet

It is now in the queue for this repository.

@bors 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
Copy link
Contributor

bors commented Mar 6, 2024

⌛ Testing commit cf83d83 with merge 3314d5c...

@bors
Copy link
Contributor

bors commented Mar 6, 2024

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

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Mar 6, 2024
@bors bors merged commit 3314d5c into rust-lang:master Mar 6, 2024
12 checks passed
@rustbot rustbot added this to the 1.78.0 milestone Mar 6, 2024
@ChrisDenton ChrisDenton added the relnotes Marks issues that should be documented in the release notes of the next release. label Mar 6, 2024
@ChrisDenton ChrisDenton deleted the srwlock branch March 6, 2024 15:05
@rust-timer
Copy link
Collaborator

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%)

RalfJung added a commit to RalfJung/miri that referenced this pull request Mar 9, 2024
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`.
bors added a commit to rust-lang/miri that referenced this pull request Mar 12, 2024
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.
RalfJung added a commit to RalfJung/rust that referenced this pull request Mar 15, 2024
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`.
RalfJung pushed a commit to RalfJung/rust that referenced this pull request Mar 15, 2024
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.
RalfJung pushed a commit to RalfJung/rust-analyzer that referenced this pull request Apr 27, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged-by-bors This PR was explicitly merged by bors. O-windows Operating system: Windows relnotes Marks issues that should be documented in the release notes of the next release. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RwLock can sometimes deadlock on Windows with only read locks holding or waiting for the lock
9 participants