-
-
Notifications
You must be signed in to change notification settings - Fork 14.1k
Switch the destructors implementation for thread locals on Windows to use FLS #148799
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
base: main
Are you sure you want to change the base?
Switch the destructors implementation for thread locals on Windows to use FLS #148799
Conversation
|
r? @ChrisDenton rustbot has assigned @ChrisDenton. Use |
|
The job Click to see the possible cause of the failure (guessed by this bot) |
|
Hi @ChrisDenton, any chance you can take a look at this? Tests are only failing because of missing support in Miri (which I have implemented in a branch) Thanks! |
Summary
Switch the thread local destructors implementation on Windows to use the Fiber Local Storage APIs, which provide native support for setting a callback to be called on thread termination, replacing the current
tls_callbacksymbol-based implementation.Current Implementation
On Windows, in order to support thread locals with destructors,
the standard library uses a special
tls_callbacksymbol that is used to call thedestructors::run()hook on thread termination.This has two downsides:
LocalKey's documentation.as an example of point 2, this code, which uses
JoinHandle::joinin a thread local Drop impl, will deadlock on stable:Join-on-Drop Deadlock Example
Proposed Change
We can use the
Fls{Alloc,Set,Get,Free}functions (see https://devblogs.microsoft.com/oldnewthing/20191011-00/?p=102989)to implement the dtor callback needed for thread locals that have a Drop implementation.
We allocate a single key, and use its destructor callback to run all the registered destructors when a thread is shutting down.
With this implementation, the above code sample will not deadlock (but it still might not be a good idea to do this!).
Other Notes
The implementation is based on the
key::racyandguard::applecode, because we need aLazyKey-like racey static and anenablefunction.While TLS slots are limited to 1088,
FLS slots are currently limited to 4000
per process.
Miri
Because miri is aware to the thread local implementation, I also implemented these functions and support for them in the interpreter here:
https://github.com/rust-lang/miri/compare/master...ohadravid:miri:windows-fls-support?expand=1
I guess that this will need to be merged before this PR (if this is accepted) - let me know and I'll open that PR as well.
Targets without
target_thread_localIn
*-gnuWindows targets, thetarget_thread_localfeature is unavailable.We could also change the "key" (non-
target_thread_local) Windows impl atlibrary\std\src\sys\thread_local\key\windows.rsto be based on the Fls functions. I can add it to this PR, or as a separate PR, if you think this is preferable.
Also, I used a
Cellin a#[thread_local]to store the resulting key, like the other implementations.This works, but I'm not sure if this is 100% OK given that we have these targets as well.